NetRingCollectionGetFragmentRing function (ringcollection.h)

The NetRingCollectionGetFragmentRing gets the fragment ring for a packet queue.

Syntax

NET_RING * NetRingCollectionGetFragmentRing(
  NET_RING_COLLECTION const *Rings
);

Parameters

Rings

A pointer to a NET_RING_COLLECTION structure that describes this packet queue's net rings.

Return value

Returns a pointer to the fragment NET_RING for the packet queue.

Remarks

Client drivers typically call this function when they need to work with a fragment ring directly, such as when the driver is posting information to hardware. For example, during transmit a driver might use the fragment ring's ElementIndexMask to retrieve the correct fragment that is being posted to hardware in order to populate the hardware descriptor.

For examples of using this function, see the Realtek sample driver.

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.29
Minimum UMDF version 2.33
Header ringcollection.h (include netadaptercx.h)
IRQL Any level as long as target memory is resident

See also

Introduction to net rings