Network Component  Version 7.3
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetARP: ARP Address Resolution

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

Functions

__STATIC_INLINE void EvrNetARP_InitCache (uint32_t entries)
 Event on ARP cache initialize (Op) More...
 
__STATIC_INLINE void EvrNetARP_ReceiveFrame (uint16_t arp_opcode)
 Event on ARP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetARP_FrameTooShort (uint32_t length)
 Event on ARP received frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetARP_FrameCorrupted (void)
 Event on ARP received frame corrupted (Error) More...
 
__STATIC_INLINE void EvrNetARP_HeaderInfo (const void *arp_header)
 Event on ARP send/receive frame header info (Detail) More...
 
__STATIC_INLINE void EvrNetARP_CacheEntryUpdate (uint32_t entry)
 Event on ARP cache entry update (Op) More...
 
__STATIC_INLINE void EvrNetARP_ProbeResponseReceived (const uint8_t *ip4_address)
 Event on ARP probe response received (Op) More...
 
__STATIC_INLINE void EvrNetARP_WrongIpAddress (const uint8_t *ip4_address)
 Event on ARP wrong destination IPv4 address received (Op) More...
 
__STATIC_INLINE void EvrNetARP_WrongMacAddress (const uint8_t *mac_address)
 Event on ARP wrong destination MAC address received (Op) More...
 
__STATIC_INLINE void EvrNetARP_OpcodeUnknown (uint16_t arp_opcode)
 Event on ARP unknown opcode received (Op) More...
 
__STATIC_INLINE void EvrNetARP_SendReply (uint16_t arp_opcode)
 Event on ARP send reply message (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheEntryRefreshed (uint32_t entry)
 Event on ARP cache entry refreshed (Op) More...
 
__STATIC_INLINE void EvrNetARP_WrongResponse (void)
 Event on ARP wrong response received (Error) More...
 
__STATIC_INLINE void EvrNetARP_SendRequest (uint16_t arp_opcode)
 Event on ARP send request message (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheAllocFailed (void)
 Event on ARP allocate free cache entry failed (Error) More...
 
__STATIC_INLINE void EvrNetARP_CacheIpRefreshed (const uint8_t *ip4_address)
 Event on ARP cached IP address refreshed (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheAdd (const uint8_t *ip4_address)
 Event on ARP cache add IP address (Op) More...
 
__STATIC_INLINE void EvrNetARP_ShowMacAddress (const uint8_t *mac_address)
 Event on ARP cache display MAC address (Op) More...
 
__STATIC_INLINE void EvrNetARP_GatewayUnknown (void)
 Event on ARP cache add gateway unknown (Error) More...
 
__STATIC_INLINE void EvrNetARP_EntryAdded (uint32_t entry)
 Event on ARP cache entry added (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheEarly (const uint8_t *ip4_address)
 Event on ARP early cache IP address of the sender (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheFind (const uint8_t *ip4_address)
 Event on ARP find IP address in cache (Op) More...
 
__STATIC_INLINE void EvrNetARP_UsingGateway (const uint8_t *ip4_address)
 Event on ARP using gateway to access external address (Op) More...
 
__STATIC_INLINE void EvrNetARP_UnresolvedMacAddress (const uint8_t *ip4_address)
 Event on ARP unresolved MAC address in cache (Op) More...
 
__STATIC_INLINE void EvrNetARP_EntryFound (uint32_t entry)
 Event on ARP cache entry found (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheIp (const uint8_t *ip4_address)
 Event on netARP_CacheIP start (API) More...
 
__STATIC_INLINE void EvrNetARP_CacheIpInvalidParameter (void)
 Event on netARP_CacheIP invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetARP_CacheMac (const uint8_t *mac_address)
 Event on netARP_CacheMAC start (API) More...
 
__STATIC_INLINE void EvrNetARP_CacheMacInvalidParameter (void)
 Event on netARP_CacheMAC invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetARP_UnresolvedIpAddress (const uint8_t *mac_address)
 Event on ARP unresolved IP address in cache (Op) More...
 
__STATIC_INLINE void EvrNetARP_GetIp (const uint8_t *mac_address)
 Event on netARP_GetIP start (API) More...
 
__STATIC_INLINE void EvrNetARP_GetIpInvalidParameter (void)
 Event on netARP_GetIP invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetARP_ShowIpAddress (const uint8_t *ip4_address)
 Event on ARP cache display IP address (Op) More...
 
__STATIC_INLINE void EvrNetARP_EntryNotFound (void)
 Event on ARP cache entry not found (Op) More...
 
__STATIC_INLINE void EvrNetARP_GetMac (const uint8_t *ip4_address)
 Event on netARP_GetMAC start (API) More...
 
__STATIC_INLINE void EvrNetARP_GetMacInvalidParameter (void)
 Event on netARP_GetMAC invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetARP_Probe (const uint8_t *ip4_address)
 Event on netARP_Probe start (API) More...
 
__STATIC_INLINE void EvrNetARP_ProbeInvalidParameter (void)
 Event on netARP_Probe invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetARP_ProbeBusy (void)
 Event on netARP_Probe process busy (Error) More...
 
__STATIC_INLINE void EvrNetARP_ProbeRetransmit (const uint8_t *ip4_address)
 Event on ARP probe retransmit (Op) More...
 
__STATIC_INLINE void EvrNetARP_ProbeTimeout (const uint8_t *ip4_address)
 Event on ARP probe timeout (Op) More...
 
__STATIC_INLINE void EvrNetARP_CacheEntryTimeout (uint32_t entry, uint32_t type)
 Event on ARP cache entry timeout (Op) More...
 
__STATIC_INLINE void EvrNetARP_EntryReleased (uint32_t entry)
 Event on ARP cache entry released (Op) More...
 
__STATIC_INLINE void EvrNetARP_ResolveEntry (uint32_t entry)
 Event on resolve ARP cache entry (Op) More...
 
__STATIC_INLINE void EvrNetARP_RefreshEntry (uint32_t entry)
 Event on refresh ARP cache entry (Op) More...
 

Description

Events generated by the Network - Ethernet Address Resolution functions.

Function Documentation

__STATIC_INLINE void EvrNetARP_CacheAdd ( const uint8_t *  ip4_address)

Event on ARP cache add IP address (Op)

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_CacheAllocFailed ( void  )

Event on ARP allocate free cache entry failed (Error)

__STATIC_INLINE void EvrNetARP_CacheEarly ( const uint8_t *  ip4_address)

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

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_CacheEntryRefreshed ( uint32_t  entry)

Event on ARP cache entry refreshed (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_CacheEntryTimeout ( uint32_t  entry,
uint32_t  type 
)

Event on ARP cache entry timeout (Op)

Parameters
entrycache entry number
typecache entry type
  • 0: Fixed IP
  • 1: Temporary IP
  • 2: In use temporary IP
__STATIC_INLINE void EvrNetARP_CacheEntryUpdate ( uint32_t  entry)

Event on ARP cache entry update (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_CacheFind ( const uint8_t *  ip4_address)

Event on ARP find IP address in cache (Op)

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_CacheIp ( const uint8_t *  ip4_address)

Event on netARP_CacheIP start (API)

Parameters
ip4_addresspointer to requested IPv4 address
__STATIC_INLINE void EvrNetARP_CacheIpInvalidParameter ( void  )

Event on netARP_CacheIP invalid parameter (Error)

__STATIC_INLINE void EvrNetARP_CacheIpRefreshed ( const uint8_t *  ip4_address)

Event on ARP cached IP address refreshed (Op)

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_CacheMac ( const uint8_t *  mac_address)

Event on netARP_CacheMAC start (API)

Parameters
mac_addresspointer to requested MAC address
__STATIC_INLINE void EvrNetARP_CacheMacInvalidParameter ( void  )

Event on netARP_CacheMAC invalid parameter (Error)

__STATIC_INLINE void EvrNetARP_EntryAdded ( uint32_t  entry)

Event on ARP cache entry added (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_EntryFound ( uint32_t  entry)

Event on ARP cache entry found (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_EntryNotFound ( void  )

Event on ARP cache entry not found (Op)

__STATIC_INLINE void EvrNetARP_EntryReleased ( uint32_t  entry)

Event on ARP cache entry released (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_FrameCorrupted ( void  )

Event on ARP received frame corrupted (Error)

__STATIC_INLINE void EvrNetARP_FrameTooShort ( uint32_t  length)

Event on ARP received frame is too short (Error)

Parameters
lengthframe length in bytes
__STATIC_INLINE void EvrNetARP_GatewayUnknown ( void  )

Event on ARP cache add gateway unknown (Error)

__STATIC_INLINE void EvrNetARP_GetIp ( const uint8_t *  mac_address)

Event on netARP_GetIP start (API)

Parameters
mac_addresspointer to requested MAC address
__STATIC_INLINE void EvrNetARP_GetIpInvalidParameter ( void  )

Event on netARP_GetIP invalid parameter (Error)

__STATIC_INLINE void EvrNetARP_GetMac ( const uint8_t *  ip4_address)

Event on netARP_GetMAC start (API)

Parameters
ip4_addresspointer to requested IPv4 address
__STATIC_INLINE void EvrNetARP_GetMacInvalidParameter ( void  )

Event on netARP_GetMAC invalid parameter (Error)

__STATIC_INLINE void EvrNetARP_HeaderInfo ( const void *  arp_header)

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

Parameters
arp_headerpointer to ARP frame header of 28 bytes
  • HwAddrSpace (2 bytes)
  • ProtAddrSpace (2 bytes)
  • HwLen (1 byte)
  • ProtLen (1 byte)
  • OpCode (2 bytes)
  • SrcHwAddr (6 bytes)
  • SrcIpAddr (4 bytes)
  • DstHwAddr (6 bytes)
  • DstIpAddr (4 bytes)
__STATIC_INLINE void EvrNetARP_InitCache ( uint32_t  entries)

Event on ARP cache initialize (Op)

Parameters
entriesnumber of entries available in cache
__STATIC_INLINE void EvrNetARP_OpcodeUnknown ( uint16_t  arp_opcode)

Event on ARP unknown opcode received (Op)

Parameters
arp_opcodeunknown operation code value
__STATIC_INLINE void EvrNetARP_Probe ( const uint8_t *  ip4_address)

Event on netARP_Probe start (API)

Parameters
ip4_addresspointer to requested IPv4 address
__STATIC_INLINE void EvrNetARP_ProbeBusy ( void  )

Event on netARP_Probe process busy (Error)

__STATIC_INLINE void EvrNetARP_ProbeInvalidParameter ( void  )

Event on netARP_Probe invalid parameter (Error)

__STATIC_INLINE void EvrNetARP_ProbeResponseReceived ( const uint8_t *  ip4_address)

Event on ARP probe response received (Op)

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_ProbeRetransmit ( const uint8_t *  ip4_address)

Event on ARP probe retransmit (Op)

Parameters
ip4_addresspointer to IPv4 address of probed host
__STATIC_INLINE void EvrNetARP_ProbeTimeout ( const uint8_t *  ip4_address)

Event on ARP probe timeout (Op)

Parameters
ip4_addresspointer to IPv4 address of probed host
__STATIC_INLINE void EvrNetARP_ReceiveFrame ( uint16_t  arp_opcode)

Event on ARP receive frame (Op)

Parameters
arp_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
__STATIC_INLINE void EvrNetARP_RefreshEntry ( uint32_t  entry)

Event on refresh ARP cache entry (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_ResolveEntry ( uint32_t  entry)

Event on resolve ARP cache entry (Op)

Parameters
entrycache entry number
__STATIC_INLINE void EvrNetARP_SendReply ( uint16_t  arp_opcode)

Event on ARP send reply message (Op)

Parameters
arp_opcodeoperation code of sending message
  • 0x0002: ARP Reply
  • 0x0009: Inverse ARP Response
__STATIC_INLINE void EvrNetARP_SendRequest ( uint16_t  arp_opcode)

Event on ARP send request message (Op)

Parameters
arp_opcodeoperation code of sending message
  • 0x0001: ARP Request
  • 0x0008: Inverse ARP Request
__STATIC_INLINE void EvrNetARP_ShowIpAddress ( const uint8_t *  ip4_address)

Event on ARP cache display IP address (Op)

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_ShowMacAddress ( const uint8_t *  mac_address)

Event on ARP cache display MAC address (Op)

Parameters
mac_addresspointer to MAC address
__STATIC_INLINE void EvrNetARP_UnresolvedIpAddress ( const uint8_t *  mac_address)

Event on ARP unresolved IP address in cache (Op)

Parameters
mac_addresspointer to MAC cache address
__STATIC_INLINE void EvrNetARP_UnresolvedMacAddress ( const uint8_t *  ip4_address)

Event on ARP unresolved MAC address in cache (Op)

Parameters
ip4_addresspointer to requested IPv4 address
__STATIC_INLINE void EvrNetARP_UsingGateway ( const uint8_t *  ip4_address)

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

Parameters
ip4_addresspointer to IPv4 address of a gateway
__STATIC_INLINE void EvrNetARP_WrongIpAddress ( const uint8_t *  ip4_address)

Event on ARP wrong destination IPv4 address received (Op)

Parameters
ip4_addresspointer to IPv4 address
__STATIC_INLINE void EvrNetARP_WrongMacAddress ( const uint8_t *  mac_address)

Event on ARP wrong destination MAC address received (Op)

Parameters
mac_addresspointer to MAC address
__STATIC_INLINE void EvrNetARP_WrongResponse ( void  )

Event on ARP wrong response received (Error)