Functions
NWAL Receive Low Level Helper API's
NWAL Low Level APIs

Functions

static nwal_Bool_t nwal_mGetAppidFmPkt (Ti_Pkt *pPkt, nwal_AppId *pAppId)
 nwal_mGetAppidFmPkt Get App ID from an incoming packet from NetCP
static pasahoLongInfo_t * nwal_mGetProtoInfo (Ti_Pkt *pPkt)
 nwal_mGetProtoInfo Get Protocol Info data from an incoming packet from NetCP
static uint16_t nwal_mGetL3OffBytes (pasahoLongInfo_t *protoInfo)
 nwal_mGetL3OffBytes Get offset to the L3 header. This is valid if packet had gone through Layer 2 classification at NetCP
static uint16_t nwal_mGetL4Offset (pasahoLongInfo_t *protoInfo)
 nwal_mGetL4Offset Get Offset to L4 protocol
static uint16_t nwal_mGetL4ProtoType (pasahoLongInfo_t *protoInfo)
 nwal_mGetL4ProtoType Get L4 protocol type
static uint16_t nwal_mGetPloadOffBytes (pasahoLongInfo_t *protoInfo)
 nwal_mGetPloadOffBytes Get offset to the payload. This is valid if packet had gone through Layer 4 classification at NetCP
static uint16_t nwal_mGetPloadLen (pasahoLongInfo_t *protoInfo)
 nwal_mGetPloadLen Get length of the payload. This is valid if packet had gone through Layer 4 classification at NetCP
static nwal_rxFlag1_t nwal_mGetCryptoStatus (pasahoLongInfo_t *protoInfo)
 nwal_mGetCryptoStatus Get the status of crypto action by NetCP for incoming packet
static nwal_Bool_t nwal_mIsMacBroadcast (pasahoLongInfo_t *protoInfo)
 nwal_mIsMacBroadcast Return nwal_TRUE for MAC broadcast packet
static nwal_Bool_t nwal_mIsFragmentPkt (pasahoLongInfo_t *protoInfo)
 nwal_mIsFragmentPkt Return nwal_TRUE for IP fragment packet received
static nwal_Bool_t nwal_mIsMacMulticast (pasahoLongInfo_t *protoInfo)
 nwal_mIsMacMulticast Return nwal_TRUE for MAC Multicast packet
static nwal_macPktType_t nwal_mGetRxEmacPort (pasahoLongInfo_t *protoInfo)
 nwal_mGetRxEmacPort Get the incoming port id for the packet
static nwal_Bool_t nwal_mIsL3CksumStatusPass (Ti_Pkt *pPkt)
 nwal_mIsL3CksumStatusPass Layer 3 Checksum result is PASS
static nwal_Bool_t nwal_mIsL4CksumStatusPass (Ti_Pkt *pPkt)
 nwal_mIsL4CksumStatusPass Layer 4 Checksum result is PASS

Function Documentation

static nwal_Bool_t nwal_mGetAppidFmPkt ( Ti_Pkt *  pPkt,
nwal_AppId pAppId 
) [inline, static]

nwal_mGetAppidFmPkt Get App ID from an incoming packet from NetCP

Inline macro API to get AppID from the incoming packet from NetCP.

Parameters:
[in]pPktPacket to be transmitted out of NetCP
[out]pAppIdApplication ID returned if found
Return values:
@seenwal_TRUE if found /
See also:
nwal_FALSE if not found in packet
Precondition:
Application should have received the packet through poll
static nwal_rxFlag1_t nwal_mGetCryptoStatus ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetCryptoStatus Get the status of crypto action by NetCP for incoming packet

Inline macro API to get crypto status of the packet

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
Flagwith indication of IPSec Crypto status
Precondition:
Application should have received the packet through poll
static uint16_t nwal_mGetL3OffBytes ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetL3OffBytes Get offset to the L3 header. This is valid if packet had gone through Layer 2 classification at NetCP

"protoInfo" below is return of NWAL_GET_PROTO_INFO() above

Inline macro API to get offset to the payload

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
Offsetto the layer 3 header in the packet
Precondition:
Application should have received the packet through poll
static uint16_t nwal_mGetL4Offset ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetL4Offset Get Offset to L4 protocol

Inline macro API to get offset to L4 protocol

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
L4Offset Value
See also:
nwal_mGetProtoInfo
Precondition:
Application should have received the packet through poll
static uint16_t nwal_mGetL4ProtoType ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetL4ProtoType Get L4 protocol type

Inline macro API to get L4 protocol type

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
L4Protocol type
See also:
nwal_mGetProtoInfo
Precondition:
See also:
nwal_mGetL4Offset Application should make sure that L4 offset is valid
static uint16_t nwal_mGetPloadLen ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetPloadLen Get length of the payload. This is valid if packet had gone through Layer 4 classification at NetCP

Inline macro API to get offset to the payload

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
Lengthof the payload in the packet
Precondition:
Application should have received the packet through poll
static uint16_t nwal_mGetPloadOffBytes ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetPloadOffBytes Get offset to the payload. This is valid if packet had gone through Layer 4 classification at NetCP

Inline macro API to get offset to the payload

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
Offsetto the payload in the packet
Precondition:
Application should have received the packet through poll
static pasahoLongInfo_t* nwal_mGetProtoInfo ( Ti_Pkt *  pPkt) [inline, static]

nwal_mGetProtoInfo Get Protocol Info data from an incoming packet from NetCP

Inline macro API to get Protocol Info from the incoming packet from NetCP.

Parameters:
[in]pPktPacket to be transmitted out of NetCP
Return values:
Pointerto protocol Info to be passed for other utilities. Since no error check is being done application would need to make sure that a valid non Null is being returned before accessing other RX utilities
Precondition:
Application should have received the packet through poll
static nwal_macPktType_t nwal_mGetRxEmacPort ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mGetRxEmacPort Get the incoming port id for the packet

Inline macro API to get incoming port id for the packet

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Return values:
Emacport for incoming packet
See also:
nwal_enetPort_t
Precondition:
Application should have received the packet through poll
static nwal_Bool_t nwal_mIsFragmentPkt ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mIsFragmentPkt Return nwal_TRUE for IP fragment packet received

Inline macro API to check for IP Fragment packet

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Precondition:
Application should have received the packet through poll
static nwal_Bool_t nwal_mIsL3CksumStatusPass ( Ti_Pkt *  pPkt) [inline, static]

nwal_mIsL3CksumStatusPass Layer 3 Checksum result is PASS

Inline macro API to check if Layer3 Checksum result is PASS

Parameters:
[in]pPktPacket to be transmitted out of NetCP
Return values:
nwal_TRUEfor successful checksum result, nwal_FALSE for failure
Precondition:
Application should have received non zero L3 offset bytes
See also:
nwal_mGetL3OffBytes
static nwal_Bool_t nwal_mIsL4CksumStatusPass ( Ti_Pkt *  pPkt) [inline, static]

nwal_mIsL4CksumStatusPass Layer 4 Checksum result is PASS

Inline macro API to check if Layer4 Checksum result is PASS

Parameters:
[in]pPktPacket to be transmitted out of NetCP
Return values:
@seenwal_TRUE for successful checksum result,
See also:
nwal_FALSE for failure
Precondition:
Application should have received non zero L4 offset bytes
See also:
nwal_mGetPloadOffBytes
static nwal_Bool_t nwal_mIsMacBroadcast ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mIsMacBroadcast Return nwal_TRUE for MAC broadcast packet

Inline macro API to check for MAC broadcast packet

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Precondition:
Application should have received the packet through poll
static nwal_Bool_t nwal_mIsMacMulticast ( pasahoLongInfo_t *  protoInfo) [inline, static]

nwal_mIsMacMulticast Return nwal_TRUE for MAC Multicast packet

Inline macro API to check for MAC multicast packet

Parameters:
[in]protoInfoNon Null Pointer to protocol Info returned from
See also:
nwal_mGetProtoInfo
Precondition:
Application should have received the packet through poll

Copyright 2014, Texas Instruments Incorporated