The DestroyRxBuffers function pointer is contained in the RTND_CALLBACKS structure. It is meant to be called by a driver to destroy one or more NL2 Transmit Buffers that were previously created by CreateRxBuffers.
Syntax
VOID (*DestroyRxBuffers)(
RTND_INTERFACE_OBJECT *pNL2InterfaceObject,
ULONG RxQueueIndex,
RTND_BUFFER_HEADER *pBufferHeader
)Parameters
pNL2InterfaceObject
An opaque pointer to the interface object provided by a Network Link Layer (NL2) call to RtndManageInterface.
RxQueueIndex
The index of the Receive Queue for which the buffers are freed.
pBufferHeader
The address of the first buffer header of a linked list of buffer headers describing the NL2 Buffers to destroy.
Remarks
The NL2 Transmit Buffers to destroy may have been allocated upon request from the NL2 or from the driver (through CreateRxBuffers), and they may belong to one or more buffer sets.
This callback calls the driver's RtndFreeRxFrameDataBuffers function to free the frame data buffers when all the buffers from a buffer set are marked as pending free. The headers are freed by the NL2 itself.
Important: The driver must only call this callback from RtndStartInterface or RtndStopInterface. Calling it from other locations may result in undesired behavior.
Requirements
| Minimum supported version | Header |
|---|---|
|
eRTOS 1.0 SDK |
Rtnd.h |
See Also:
