Network Component  
MDK Middleware for IPv4 and IPv6 Networking
 
Loading...
Searching...
No Matches
Functions
NetARP: ARP Address Resolution
Debug Events

Events generated by the Network - Ethernet Address Resolution functions. More...

Functions

__STATIC_INLINE void EvrNetARP_InitCache (uint16_t if_id, uint32_t num_entries)
 Event on ARP cache initialize (Op)
 
__STATIC_INLINE void EvrNetARP_ReceiveFrame (uint16_t if_id, uint16_t opcode, uint32_t length)
 Event on ARP receive frame (Op)
 
__STATIC_INLINE void EvrNetARP_FrameTooShort (uint16_t if_id, uint32_t length, uint32_t min_length)
 Event on ARP receive frame is too short (Error)
 
__STATIC_INLINE void EvrNetARP_FrameCorrupted (uint16_t if_id)
 Event on ARP received frame corrupted (Error)
 
__STATIC_INLINE void EvrNetARP_ShowFrameHeader (const void *arp_header)
 Event on ARP display send/receive frame header (Detail)
 
__STATIC_INLINE void EvrNetARP_SenderAddressInvalid (uint16_t if_id)
 Event on ARP invalid IP or MAC address of sender received (Op)
 
__STATIC_INLINE void EvrNetARP_CacheEntryUpdate (uint16_t if_id, uint32_t entry)
 Event on ARP cache entry update (Op)
 
__STATIC_INLINE void EvrNetARP_ProbeResponseReceived (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP probe response received (Op)
 
__STATIC_INLINE void EvrNetARP_WrongIpAddress (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP wrong destination IP address received (Op)
 
__STATIC_INLINE void EvrNetARP_WrongMacAddress (uint16_t if_id, const uint8_t *mac_addr)
 Event on ARP wrong destination MAC address received (Op)
 
__STATIC_INLINE void EvrNetARP_OpcodeUnknown (uint16_t if_id, uint16_t opcode)
 Event on ARP unknown opcode received (Op)
 
__STATIC_INLINE void EvrNetARP_SendReply (uint16_t if_id, uint16_t opcode)
 Event on ARP send reply message (Op)
 
__STATIC_INLINE void EvrNetARP_CacheEntryRefreshed (uint16_t if_id, uint32_t entry)
 Event on ARP cache entry refreshed (Op)
 
__STATIC_INLINE void EvrNetARP_WrongResponse (uint16_t if_id)
 Event on ARP wrong response received (Error)
 
__STATIC_INLINE void EvrNetARP_SendRequest (uint16_t if_id, uint16_t opcode)
 Event on ARP send request message (Op)
 
__STATIC_INLINE void EvrNetARP_CacheAllocFailed (uint16_t if_id)
 Event on ARP allocate free cache entry failed (Error)
 
__STATIC_INLINE void EvrNetARP_CacheIpRefreshed (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP refresh cached IP address (Op)
 
__STATIC_INLINE void EvrNetARP_CacheAdd (uint16_t if_id, const uint8_t *ip4_addr, const uint8_t *mac_addr)
 Event on ARP add host address to ARP cache (Op)
 
__STATIC_INLINE void EvrNetARP_GatewayUnknown (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP cache add gateway unknown (Error)
 
__STATIC_INLINE void EvrNetARP_CacheEntryAdded (uint16_t if_id, uint32_t entry)
 Event on ARP cache entry added (Op)
 
__STATIC_INLINE void EvrNetARP_CacheEarly (uint16_t if_id, const uint8_t *ip4_addr, const uint8_t *mac_addr)
 Event on ARP early cache address of the sender (Op)
 
__STATIC_INLINE void EvrNetARP_CacheFind (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP find IP address in cache (Op)
 
__STATIC_INLINE void EvrNetARP_UsingGateway (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP use gateway to access external address (Op)
 
__STATIC_INLINE void EvrNetARP_UnresolvedMacAddress (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP unresolved MAC address in cache (Error)
 
__STATIC_INLINE void EvrNetARP_EntryFound (uint16_t if_id, uint32_t entry)
 Event on ARP cache entry found (Op)
 
__STATIC_INLINE void EvrNetARP_CacheIp (uint16_t if_id, const uint8_t *ip4_addr)
 Event on netARP_CacheIP execute (API)
 
__STATIC_INLINE void EvrNetARP_CacheIpInvalidParameter (uint16_t if_id)
 Event on netARP_CacheIP invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_CacheMac (uint16_t if_id, const uint8_t *mac_addr)
 Event on netARP_CacheMAC execute (API)
 
__STATIC_INLINE void EvrNetARP_CacheMacInvalidParameter (uint16_t if_id)
 Event on netARP_CacheMAC invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_UnresolvedIpAddress (uint16_t if_id, const uint8_t *mac_addr)
 Event on ARP unresolved IP address in cache (Op)
 
__STATIC_INLINE void EvrNetARP_GetIp (uint16_t if_id, const uint8_t *mac_addr, const uint8_t *ip4_addr)
 Event on netARP_GetIP resolving success (API)
 
__STATIC_INLINE void EvrNetARP_GetIpInvalidParameter (uint16_t if_id)
 Event on netARP_GetIP invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_GetIpEntryNotFound (uint16_t if_id, const uint8_t *mac_addr)
 Event on netARP_GetIP entry with MAC address not found in cache (Op)
 
__STATIC_INLINE void EvrNetARP_GetMac (uint16_t if_id, const uint8_t *ip4_addr, const uint8_t *mac_addr)
 Event on netARP_GetMAC resolving success (API)
 
__STATIC_INLINE void EvrNetARP_GetMacInvalidParameter (uint16_t if_id)
 Event on netARP_GetMAC invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_GetMacEntryNotFound (uint16_t if_id, const uint8_t *ip4_addr)
 Event on netARP_GetMAC entry with IP address not found in cache (Op)
 
__STATIC_INLINE void EvrNetARP_Probe (uint16_t if_id, const uint8_t *ip4_addr)
 Event on netARP_Probe execute (API)
 
__STATIC_INLINE void EvrNetARP_ProbeInvalidParameter (uint16_t if_id)
 Event on netARP_Probe invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_ProbeBusy (uint16_t if_id)
 Event on ARP probe process busy (Error)
 
__STATIC_INLINE void EvrNetARP_ProbeRetransmit (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP probe retransmit (Op)
 
__STATIC_INLINE void EvrNetARP_ProbeTimeout (uint16_t if_id, const uint8_t *ip4_addr)
 Event on ARP probe timeout (Op)
 
__STATIC_INLINE void EvrNetARP_AddCache (uint16_t if_id, const uint8_t *ip4_addr, const uint8_t *mac_addr)
 Event on ARP add static host address to ARP cache (API)
 
__STATIC_INLINE void EvrNetARP_AddCacheInvalidParam (uint16_t if_id)
 Event on netARP_AddCache invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_AddCacheInvalidIpAddress (uint16_t if_id)
 Event on netARP_AddCache invalid IP address error (Error)
 
__STATIC_INLINE void EvrNetARP_AddCacheInvalidMacAddress (uint16_t if_id)
 Event on netARP_AddCache invalid MAC address error (Error)
 
__STATIC_INLINE void EvrNetARP_ClearCache (uint16_t if_id, uint32_t deleted, uint32_t available)
 Event on ARP clear cache request (API)
 
__STATIC_INLINE void EvrNetARP_ClearCacheInvalidParam (uint16_t if_id)
 Event on netARP_ClearCache invalid parameter (Error)
 
__STATIC_INLINE void EvrNetARP_ClearCacheClientBusy (uint16_t if_id)
 Event on ARP clear cache client busy (Error)
 
__STATIC_INLINE void EvrNetARP_CacheEntryTimeout (uint16_t if_id, uint32_t entry, const uint8_t *ip4_addr, const uint8_t *mac_addr, uint32_t type)
 Event on ARP cache entry timeout (Op)
 
__STATIC_INLINE void EvrNetARP_EntryReleased (uint16_t if_id, uint32_t entry)
 Event on ARP cache entry released (Op)
 
__STATIC_INLINE void EvrNetARP_ResolveEntry (uint16_t if_id, uint32_t entry)
 Event on resolve ARP cache entry (Op)
 
__STATIC_INLINE void EvrNetARP_RefreshEntry (uint16_t if_id, uint32_t entry)
 Event on refresh ARP cache entry (Op)
 
__STATIC_INLINE void EvrNetARP_UninitCache (uint16_t if_id)
 Event on ARP cache de-initialize (Op)
 

Description

Events generated by the Network - Ethernet Address Resolution functions.

The Network ARP Address Resolution functions generate events that report events in the ARP address resolver and ARP cache and help in troubleshooting.

Function Documentation

◆ EvrNetARP_AddCache()

__STATIC_INLINE void EvrNetARP_AddCache ( uint16_t  if_id,
const uint8_t *  ip4_addr,
const uint8_t *  mac_addr 
)

Event on ARP add static host address to ARP cache (API)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address of the host
mac_addrpointer to MAC address of the host

The event AddCache is created when the function netARP_AddCache is executed. This function adds a static entry to the ARP cache.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host to be added to the cache.
  • mac: MAC address of the host to be added to the cache.

◆ EvrNetARP_AddCacheInvalidIpAddress()

__STATIC_INLINE void EvrNetARP_AddCacheInvalidIpAddress ( uint16_t  if_id)

Event on netARP_AddCache invalid IP address error (Error)

Parameters
if_idnetwork interface identifier

The event AddCacheInvalidIpAddress is created when the function netARP_AddCache is executed and the IP address parameter of the function is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_AddCacheInvalidMacAddress()

__STATIC_INLINE void EvrNetARP_AddCacheInvalidMacAddress ( uint16_t  if_id)

Event on netARP_AddCache invalid MAC address error (Error)

Parameters
if_idnetwork interface identifier

The event AddCacheInvalidMacAddress is created when the function netARP_AddCache is executed and the MAC address parameter of the function is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_AddCacheInvalidParam()

__STATIC_INLINE void EvrNetARP_AddCacheInvalidParam ( uint16_t  if_id)

Event on netARP_AddCache invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event AddCacheInvalidParam is created when the function netARP_AddCache is executed and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_CacheAdd()

__STATIC_INLINE void EvrNetARP_CacheAdd ( uint16_t  if_id,
const uint8_t *  ip4_addr,
const uint8_t *  mac_addr 
)

Event on ARP add host address to ARP cache (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address
mac_addrpointer to MAC address

The event CacheAdd is created when the network library wants to add a new host to the ARP cache table.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host to be added to the cache.
  • mac: MAC address of the host to be added to the cache.

◆ EvrNetARP_CacheAllocFailed()

__STATIC_INLINE void EvrNetARP_CacheAllocFailed ( uint16_t  if_id)

Event on ARP allocate free cache entry failed (Error)

Parameters
if_idnetwork interface identifier

The event CacheAllocFailed is created when the network library wants to add new host to the ARP cache table, but it fails. Therefore, the new host is not cached. In order to get rid of such events, you must increase the size of the ARP cache table in the ethernet interface configuration.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_CacheEarly()

__STATIC_INLINE void EvrNetARP_CacheEarly ( uint16_t  if_id,
const uint8_t *  ip4_addr,
const uint8_t *  mac_addr 
)

Event on ARP early cache address of the sender (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address
mac_addrpointer to MAC address

The event CacheEarly is created when the network library wants to add a new host to the ARP cache table, when it receives a valid unicast IP frame. This method is called early caching and is used to improve the functioning of the network library.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host to be added to the cache.
  • mac: MAC address of the host to be added to the cache.

◆ EvrNetARP_CacheEntryAdded()

__STATIC_INLINE void EvrNetARP_CacheEntryAdded ( uint16_t  if_id,
uint32_t  entry 
)

Event on ARP cache entry added (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event CacheEntryAdded is created when the network library successfully added the new host to the ARP cache table.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: assigned cache entry identifier.

◆ EvrNetARP_CacheEntryRefreshed()

__STATIC_INLINE void EvrNetARP_CacheEntryRefreshed ( uint16_t  if_id,
uint32_t  entry 
)

Event on ARP cache entry refreshed (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event CacheEntryRefreshed is created when the network library receives the ARP reply or inverse ARP response, and refresh the entry in the local cache.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.

◆ EvrNetARP_CacheEntryTimeout()

__STATIC_INLINE void EvrNetARP_CacheEntryTimeout ( uint16_t  if_id,
uint32_t  entry,
const uint8_t *  ip4_addr,
const uint8_t *  mac_addr,
uint32_t  type 
)

Event on ARP cache entry timeout (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number
ip4_addrpointer to IP address
mac_addrpointer to MAC address
typecache entry type
  • 0: Fixed IP
  • 1: Temporary IP
  • 2: In-use temporary IP

The event CacheEntryTimeout is created when the validity of the ARP cached host has expired. The host will be refreshed or removed from the cache.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.
  • type: type of host cache entry (FixIP, TempIP, InuseIP).
  • ip: IP address of the host cache entry.
  • mac: MAC address of the host cache entry.

◆ EvrNetARP_CacheEntryUpdate()

__STATIC_INLINE void EvrNetARP_CacheEntryUpdate ( uint16_t  if_id,
uint32_t  entry 
)

Event on ARP cache entry update (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event CacheEntryUpdate is created when the network library receives the gratuitous ARP request and update the local cache entry.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.

◆ EvrNetARP_CacheFind()

__STATIC_INLINE void EvrNetARP_CacheFind ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP find IP address in cache (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address

The event CacheFind is created when the network library wants to find the host in the ARP cache table to resolve its MAC address. If the host is not in the ARP cache, the network library creates a new entry in the table and starts the resolution process.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being searched in the cache.

◆ EvrNetARP_CacheIp()

__STATIC_INLINE void EvrNetARP_CacheIp ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on netARP_CacheIP execute (API)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to requested IP address

The event CacheIp is created when the function netARP_CacheIP is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being requested.

◆ EvrNetARP_CacheIpInvalidParameter()

__STATIC_INLINE void EvrNetARP_CacheIpInvalidParameter ( uint16_t  if_id)

Event on netARP_CacheIP invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event CacheIpInvalidParameter is created when the function netARP_CacheIP is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_CacheIpRefreshed()

__STATIC_INLINE void EvrNetARP_CacheIpRefreshed ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP refresh cached IP address (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address

The event CacheIpRefreshed is created when the network library wants to add a new host to the ARP cache table, but finds it already cached. Therefore, the new host is only refreshed in the cache table.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host to be added to the cache.

◆ EvrNetARP_CacheMac()

__STATIC_INLINE void EvrNetARP_CacheMac ( uint16_t  if_id,
const uint8_t *  mac_addr 
)

Event on netARP_CacheMAC execute (API)

Parameters
if_idnetwork interface identifier
mac_addrpointer to requested MAC address

The event CacheMac is created when the function netARP_CacheMAC is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • mac: MAC address of the host being requested.

◆ EvrNetARP_CacheMacInvalidParameter()

__STATIC_INLINE void EvrNetARP_CacheMacInvalidParameter ( uint16_t  if_id)

Event on netARP_CacheMAC invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event CacheMacInvalidParameter is created when the function netARP_CacheMAC is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_ClearCache()

__STATIC_INLINE void EvrNetARP_ClearCache ( uint16_t  if_id,
uint32_t  deleted,
uint32_t  available 
)

Event on ARP clear cache request (API)

Parameters
if_idnetwork interface identifier
deletednumber of entries deleted from cache
availablenumber of entries available in cache

The event ClearCache is created when the function netARP_ClearCache is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • deleted: number of deleted cache entries.
  • max: maximum number of ARP cache entries.

◆ EvrNetARP_ClearCacheClientBusy()

__STATIC_INLINE void EvrNetARP_ClearCacheClientBusy ( uint16_t  if_id)

Event on ARP clear cache client busy (Error)

Parameters
if_idnetwork interface identifier

The event ClearCacheClientBusy is created when the function netARP_ClearCache is executed, and the internal cache process is still in progress. For example, netARP_Probe is still running and not yet complete.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_ClearCacheInvalidParam()

__STATIC_INLINE void EvrNetARP_ClearCacheInvalidParam ( uint16_t  if_id)

Event on netARP_ClearCache invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event ClearCacheInvalidParam is created when the function netARP_ClearCache is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_EntryFound()

__STATIC_INLINE void EvrNetARP_EntryFound ( uint16_t  if_id,
uint32_t  entry 
)

Event on ARP cache entry found (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event EntryFound is created when the network library wants to notify that it has found the host in the ARP cache table.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.

◆ EvrNetARP_EntryReleased()

__STATIC_INLINE void EvrNetARP_EntryReleased ( uint16_t  if_id,
uint32_t  entry 
)

Event on ARP cache entry released (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event EntryReleased is created when the cached host entry is released from the ARP cache.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.

◆ EvrNetARP_FrameCorrupted()

__STATIC_INLINE void EvrNetARP_FrameCorrupted ( uint16_t  if_id)

Event on ARP received frame corrupted (Error)

Parameters
if_idnetwork interface identifier

The event FrameCorrupted is created when the network library receives the ARP frame, checks the ARP header and finds errors in it. The frame is therefore discarded.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_FrameTooShort()

__STATIC_INLINE void EvrNetARP_FrameTooShort ( uint16_t  if_id,
uint32_t  length,
uint32_t  min_length 
)

Event on ARP receive frame is too short (Error)

Parameters
if_idnetwork interface identifier
lengthframe length in bytes
min_lengthminimum length of the frame

The event FrameTooShort is created when the network library receives the ARP frame that is too short. The frame is discarded.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • len: length of the received frame in bytes.
  • min: minimum valid frame length in bytes.

◆ EvrNetARP_GatewayUnknown()

__STATIC_INLINE void EvrNetARP_GatewayUnknown ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP cache add gateway unknown (Error)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address of a gateway

The event GatewayUnknown is created when the network library wants to add a new non-local host to the ARP cache table. The network library uses the gateway to access the host, but finds that the gateway address is not specified.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • gw: IP address of the default gateway.

◆ EvrNetARP_GetIp()

__STATIC_INLINE void EvrNetARP_GetIp ( uint16_t  if_id,
const uint8_t *  mac_addr,
const uint8_t *  ip4_addr 
)

Event on netARP_GetIP resolving success (API)

Parameters
if_idnetwork interface identifier
mac_addrpointer to requested MAC address
ip4_addrpointer to resolved IP address

The event GetIp is created when the function netARP_GetIP is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: returned IP address of the host.
  • mac: MAC address of the host being requested.

◆ EvrNetARP_GetIpEntryNotFound()

__STATIC_INLINE void EvrNetARP_GetIpEntryNotFound ( uint16_t  if_id,
const uint8_t *  mac_addr 
)

Event on netARP_GetIP entry with MAC address not found in cache (Op)

Parameters
if_idnetwork interface identifier
mac_addrpointer to requested MAC address

The event GetIpEntryNotFound is created when the function netARP_GetIP is executed, but the requested MAC address of the host in the cache is missing.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • mac: MAC address of the host being requested.

◆ EvrNetARP_GetIpInvalidParameter()

__STATIC_INLINE void EvrNetARP_GetIpInvalidParameter ( uint16_t  if_id)

Event on netARP_GetIP invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event GetIpInvalidParameter is created when the function netARP_GetIP is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_GetMac()

__STATIC_INLINE void EvrNetARP_GetMac ( uint16_t  if_id,
const uint8_t *  ip4_addr,
const uint8_t *  mac_addr 
)

Event on netARP_GetMAC resolving success (API)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to requested IP address
mac_addrpointer to resolved MAC address

The event GetMac is created when the function netARP_GetMAC is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • mac: returned MAC address of the host.
  • ip: IP address of the host being requested.

◆ EvrNetARP_GetMacEntryNotFound()

__STATIC_INLINE void EvrNetARP_GetMacEntryNotFound ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on netARP_GetMAC entry with IP address not found in cache (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to requested IP address

The event GetMacEntryNotFound is created when the function netARP_GetMAC is executed, but the requested IP address of the host in the cache is missing.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being requested.

◆ EvrNetARP_GetMacInvalidParameter()

__STATIC_INLINE void EvrNetARP_GetMacInvalidParameter ( uint16_t  if_id)

Event on netARP_GetMAC invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event GetMacInvalidParameter is created when the function netARP_GetMAC is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_InitCache()

__STATIC_INLINE void EvrNetARP_InitCache ( uint16_t  if_id,
uint32_t  num_entries 
)

Event on ARP cache initialize (Op)

Parameters
if_idnetwork interface identifier
num_entriesnumber of entries available in cache

The event InitCache is created when the ARP service is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entries: number of entries available in ARP cache table.

◆ EvrNetARP_OpcodeUnknown()

__STATIC_INLINE void EvrNetARP_OpcodeUnknown ( uint16_t  if_id,
uint16_t  opcode 
)

Event on ARP unknown opcode received (Op)

Parameters
if_idnetwork interface identifier
opcodeunknown operation code value

The event OpcodeUnknown is created when the network library receives the ARP frame with unknown operation code. The frame is therefore discarded.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • opcode: received ARP operation code.

◆ EvrNetARP_Probe()

__STATIC_INLINE void EvrNetARP_Probe ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on netARP_Probe execute (API)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to requested IP address

The event Probe is created when the function netARP_Probe is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being tested.

◆ EvrNetARP_ProbeBusy()

__STATIC_INLINE void EvrNetARP_ProbeBusy ( uint16_t  if_id)

Event on ARP probe process busy (Error)

Parameters
if_idnetwork interface identifier

The event ProbeBusy is created when the function netARP_Probe is executed, and the internal probe process is still busy.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_ProbeInvalidParameter()

__STATIC_INLINE void EvrNetARP_ProbeInvalidParameter ( uint16_t  if_id)

Event on netARP_Probe invalid parameter (Error)

Parameters
if_idnetwork interface identifier

The event ProbeInvalidParameter is created when the function netARP_Probe is executed, and the function input parameter is invalid.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_ProbeResponseReceived()

__STATIC_INLINE void EvrNetARP_ProbeResponseReceived ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP probe response received (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address

The event ProbeResponseReceived is created when the network library receives the response to our ARP probe request. This is an indication that the tested IP address is already in use.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the responding host.

◆ EvrNetARP_ProbeRetransmit()

__STATIC_INLINE void EvrNetARP_ProbeRetransmit ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP probe retransmit (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address of probed host

The event ProbeRetransmit is created when the network library resends the request for testing the IP address, if it is in use.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being tested.

◆ EvrNetARP_ProbeTimeout()

__STATIC_INLINE void EvrNetARP_ProbeTimeout ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP probe timeout (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address of probed host

The event ProbeTimeout is created when the network library has left the IP address test procedure, since no host responded. The tested IP address is considered to be free.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being tested.

◆ EvrNetARP_ReceiveFrame()

__STATIC_INLINE void EvrNetARP_ReceiveFrame ( uint16_t  if_id,
uint16_t  opcode,
uint32_t  length 
)

Event on ARP receive frame (Op)

Parameters
if_idnetwork interface identifier
opcodeoperation code of received message
  • 0x0001: ARP Request
  • 0x0002: ARP Reply
  • 0x0003: Reverse ARP Request
  • 0x0004: Reverse ARP Reply
  • 0x0008: Inverse ARP Request
  • 0x0009: Inverse ARP Response
lengthframe length in bytes

The event ReceiveFrame is created when the network library receives the ARP frame.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • opcode: operation code (ARP_REQUEST, ARP_REPLY, RARP_REQUEST, RARP_REPLY, InARP_REQUEST, InARP_RESPONSE).
  • len: length of the received frame in bytes.

◆ EvrNetARP_RefreshEntry()

__STATIC_INLINE void EvrNetARP_RefreshEntry ( uint16_t  if_id,
uint32_t  entry 
)

Event on refresh ARP cache entry (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event RefreshEntry is created when the network library wants to refresh the required ARP entry in the cache. This happens when the ARP entry expires, and the type of entry is Fixed-IP or Inuse-IP.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.

◆ EvrNetARP_ResolveEntry()

__STATIC_INLINE void EvrNetARP_ResolveEntry ( uint16_t  if_id,
uint32_t  entry 
)

Event on resolve ARP cache entry (Op)

Parameters
if_idnetwork interface identifier
entrycache entry number

The event ResolveEntry is created when the network library wants to resolve the required ARP entry in the cache. This usually happens when the ARP entry is created, but it is not yet resolved or has expired.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • entry: identifier of the host cache entry.

◆ EvrNetARP_SenderAddressInvalid()

__STATIC_INLINE void EvrNetARP_SenderAddressInvalid ( uint16_t  if_id)

Event on ARP invalid IP or MAC address of sender received (Op)

Parameters
if_idnetwork interface identifier

The event SenderAddressInvalid is created when the network library receives the ARP frame, checks the protocol and hardware address of the sender and finds that they are invalid. The frame is therefore discarded. This usually happens in network attacks.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_SendReply()

__STATIC_INLINE void EvrNetARP_SendReply ( uint16_t  if_id,
uint16_t  opcode 
)

Event on ARP send reply message (Op)

Parameters
if_idnetwork interface identifier
opcodeoperation code of sending message
  • 0x0002: ARP Reply
  • 0x0009: Inverse ARP Response

The event SendReply is created when the network library wants to send an ARP reply message.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • opcode: operation code (ARP_REPLY, InARP_RESPONSE).

◆ EvrNetARP_SendRequest()

__STATIC_INLINE void EvrNetARP_SendRequest ( uint16_t  if_id,
uint16_t  opcode 
)

Event on ARP send request message (Op)

Parameters
if_idnetwork interface identifier
opcodeoperation code of sending message
  • 0x0001: ARP Request
  • 0x0008: Inverse ARP Request

The event SendRequest is created when the network library wants to send an ARP request message.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • opcode: operation code (ARP_REQUEST, InARP_REQUEST).

◆ EvrNetARP_ShowFrameHeader()

__STATIC_INLINE void EvrNetARP_ShowFrameHeader ( const void *  arp_header)

Event on ARP display send/receive frame header (Detail)

Parameters
arp_headerpointer to ARP frame header of 28 bytes
  • HwType (2 bytes)
  • ProtType (2 bytes)
  • HwLen (1 byte)
  • ProtLen (1 byte)
  • OpCode (2 bytes)
  • SendHwAddr (6 bytes)
  • SendIpAddr (4 bytes)
  • TargHwAddr (6 bytes)
  • TargIpAddr (4 bytes)

The event ShowFrameHeader is created when the network library wants to display detailed information about the ARP header.

Value in the Event Recorder shows:

  • op: operation code (ARP_REQUEST, ARP_REPLY, RARP_REQUEST, RARP_REPLY, InARP_REQUEST, InARP_RESPONSE).
  • spa: sender protocol IP address.
  • tpa: target protocol IP address.
  • sha: sender hardware MAC address.
  • tha: target hardware MAC address.

◆ EvrNetARP_UninitCache()

__STATIC_INLINE void EvrNetARP_UninitCache ( uint16_t  if_id)

Event on ARP cache de-initialize (Op)

Parameters
if_idnetwork interface identifier

The event UninitCache is created when the function netUninitialize is executed.

Value in the Event Recorder shows:

  • netif: network interface identifier.

◆ EvrNetARP_UnresolvedIpAddress()

__STATIC_INLINE void EvrNetARP_UnresolvedIpAddress ( uint16_t  if_id,
const uint8_t *  mac_addr 
)

Event on ARP unresolved IP address in cache (Op)

Parameters
if_idnetwork interface identifier
mac_addrpointer to MAC cache address

The event UnresolvedIpAddress is created when the network library wants to find the host in the ARP cache table to resolve its IP address, but the host is in the process of resolving. IP address is not yet valid.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • mac: MAC address of the host being searched in the cache.

◆ EvrNetARP_UnresolvedMacAddress()

__STATIC_INLINE void EvrNetARP_UnresolvedMacAddress ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP unresolved MAC address in cache (Error)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to requested IP address

The event UnresolvedMacAddress is created when the network library wants to find the host in the ARP cache table to resolve its MAC address, but the host is in the process of resolving. MAC address is not yet valid.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: IP address of the host being searched in the cache.

◆ EvrNetARP_UsingGateway()

__STATIC_INLINE void EvrNetARP_UsingGateway ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP use gateway to access external address (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address of a gateway

The event UsingGateway is created when the network library wants to find the non-local host in the ARP cache table. The network library uses the gateway to access the host.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • gw: IP address of the default gateway.

◆ EvrNetARP_WrongIpAddress()

__STATIC_INLINE void EvrNetARP_WrongIpAddress ( uint16_t  if_id,
const uint8_t *  ip4_addr 
)

Event on ARP wrong destination IP address received (Op)

Parameters
if_idnetwork interface identifier
ip4_addrpointer to IP address

The event WrongIpAddress is created when the network library receives the ARP frame, but the target IP address is not the same as our local IP address. The frame is therefore discarded.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • ip: received target IP address.

◆ EvrNetARP_WrongMacAddress()

__STATIC_INLINE void EvrNetARP_WrongMacAddress ( uint16_t  if_id,
const uint8_t *  mac_addr 
)

Event on ARP wrong destination MAC address received (Op)

Parameters
if_idnetwork interface identifier
mac_addrpointer to MAC address

The event WrongMacAddress is created when the network library receives Inverse ARP frame, but the target MAC address is not the same as our local MAC address. The frame is therefore discarded.

Value in the Event Recorder shows:

  • netif: network interface identifier.
  • mac: received target MAC address.

◆ EvrNetARP_WrongResponse()

__STATIC_INLINE void EvrNetARP_WrongResponse ( uint16_t  if_id)

Event on ARP wrong response received (Error)

Parameters
if_idnetwork interface identifier

The event WrongResponse is created when the network library receives a valid ARP response, but the ARP service waits for none. The received ARP frame is therefore discarded. This usually happens in network attacks.

Value in the Event Recorder shows:

  • netif: network interface identifier.