OAL_KITLETH_GET_FRAME (Compact 2013)

  • Article

10/16/2014

This function pointer checks to see if a frame has been received, and if one has been received it copies the frame to a buffer.

Syntax

typedef UINT16 (*OAL_KITLETH_GET_FRAME)(
  UINT8 *pData,
  UINT16 *pSize
);

Parameters

  • pData
    [out] Pointer to the packet data.
  • pSize
    [out] Pointer to the length of the data, in bytes.

Return Value

Returns the number of bytes received.

Remarks

The pfnGetFrame member of the OAL_KITL_ETH_DRIVER structure points to the custom function that implements OAL_KITLETH_GET_FRAME.

An optimization that may be performed in the Ethernet driver is to filter out all received broadcast packets except for ARPs.

Requirements

Header

oal_kitl.h

Library

Developer Implemented

See Also

Reference

KITL Functions for Ethernet Drivers
KITL Functions for Production-Quality OAL