Network Component  Version 7.13.1
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetETH: ETH Interface

Events generated by the Network - Ethernet Interface functions. More...

Functions

__STATIC_INLINE void EvrNetETH_InitInterface (uint8_t if_num)
 Event on Ethernet interface initialize (Op) More...
 
__STATIC_INLINE void EvrNetETH_MacAddressConfigError (uint8_t if_num)
 Event on Ethernet MAC address configuration error (Error) More...
 
__STATIC_INLINE void EvrNetETH_VlanConfigError (uint8_t if_num)
 Event on Ethernet VLAN configuration error (Error) More...
 
__STATIC_INLINE void EvrNetETH_VlanInitError (uint8_t if_num)
 Event on Ethernet VLAN initialization error (Error) More...
 
__STATIC_INLINE void EvrNetETH_PhyDriverConfigError (uint8_t if_num)
 Event on Ethernet PHY configuration error (Error) More...
 
__STATIC_INLINE void EvrNetETH_PhyDriverInitError (uint8_t if_num)
 Event on Ethernet PHY initialization error (Error) More...
 
__STATIC_INLINE void EvrNetETH_Ip4ConfigError (uint8_t if_num)
 Event on Ethernet IPv4 configuration error (Error) More...
 
__STATIC_INLINE void EvrNetETH_Ip6ConfigError (uint8_t if_num)
 Event on Ethernet IPv6 configuration error (Error) More...
 
__STATIC_INLINE void EvrNetETH_ThreadCreateFailed (uint8_t if_num)
 Event on Ethernet thread create failed (Error) More...
 
__STATIC_INLINE void EvrNetETH_GetOptionInvalidParameter (uint8_t if_num)
 Event on Ethernet get_option invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetETH_SetOptionInvalidParameter (uint8_t if_num)
 Event on Ethernet set_option invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetETH_SetMacAddress (uint8_t if_num, const uint8_t *mac_addr)
 Event on Ethernet set interface MAC address (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetVlanIdentifier (uint8_t if_num, uint16_t vlan_id)
 Event on Ethernet set VLAN identifier (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp4Address (uint8_t if_num, const uint8_t *ip4_addr)
 Event on Ethernet set interface IPv4 address (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp4SubnetMask (uint8_t if_num, const uint8_t *net_mask)
 Event on Ethernet set interface IPv4 subnet mask (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp4DefaultGateway (uint8_t if_num, const uint8_t *ip4_addr)
 Event on Ethernet set interface IPv4 default gateway (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp4PrimaryDNS (uint8_t if_num, const uint8_t *ip4_addr)
 Event on Ethernet set interface primary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp4SecondaryDNS (uint8_t if_num, const uint8_t *ip4_addr)
 Event on Ethernet set interface secondary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp4Mtu (uint8_t if_num, uint16_t mtu)
 Event on Ethernet set interface MTU (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp6Address (uint8_t if_num, const uint8_t *ip6_addr)
 Event on Ethernet set interface IPv6 static address (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp6DefaultGateway (uint8_t if_num, const uint8_t *ip6_addr)
 Event on Ethernet set interface IPv6 default gateway (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp6PrimaryDNS (uint8_t if_num, const uint8_t *ip6_addr)
 Event on Ethernet set interface primary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp6SecondaryDNS (uint8_t if_num, const uint8_t *ip6_addr)
 Event on Ethernet set interface secondary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetETH_SetIp6PrefixLength (uint8_t if_num, uint8_t pref_len)
 Event on Ethernet set interface IPv6 subnet prefix length (Op) More...
 
__STATIC_INLINE void EvrNetETH_SendFrame (uint8_t if_num, uint32_t length, uint8_t ip_version)
 Event on Ethernet send frame (Op) More...
 
__STATIC_INLINE void EvrNetETH_LinkDownError (uint8_t if_num)
 Event on Ethernet link down error (Error) More...
 
__STATIC_INLINE void EvrNetETH_SendDataTooLarge (uint8_t if_num, uint32_t length, uint32_t max_length)
 Event on Ethernet send payload too large error (Error) More...
 
__STATIC_INLINE void EvrNetETH_SendIp4Disabled (uint8_t if_num)
 Event on Ethernet send IPv4 disabled error (Error) More...
 
__STATIC_INLINE void EvrNetETH_Ip4LocalAddressUndefined (uint8_t if_num)
 Event on Ethernet local IPv4 address undefined (Error) More...
 
__STATIC_INLINE void EvrNetETH_Ip4MacAddressUnresolved (uint8_t if_num, const uint8_t *ip4_addr)
 Event on Ethernet MAC address unresolved (Error) More...
 
__STATIC_INLINE void EvrNetETH_EnqueueFrame (uint8_t if_num, uint8_t ca_entry, uint32_t length)
 Event on enqueued Ethernet frame for unresolved MAC address (Op) More...
 
__STATIC_INLINE void EvrNetETH_SendIp6Disabled (uint8_t if_num)
 Event on Ethernet send IPv6 disabled error (Error) More...
 
__STATIC_INLINE void EvrNetETH_Ip6LocalAddressUndefined (uint8_t if_num)
 Event on Ethernet local IPv6 address undefined (Error) More...
 
__STATIC_INLINE void EvrNetETH_Ip6MacAddressUnresolved (uint8_t if_num, const uint8_t *ip6_addr)
 Event on Ethernet MAC address unresolved (Error) More...
 
__STATIC_INLINE void EvrNetETH_InvalidIpVersion (uint8_t if_num, uint8_t ip_version)
 Event on Ethernet invalid IP version (Error) More...
 
__STATIC_INLINE void EvrNetETH_ShowFrameHeader (const void *eth_header)
 Event on Ethernet display send/receive frame header (Detail) More...
 
__STATIC_INLINE void EvrNetETH_LinkDownStatus (uint8_t if_num)
 Event on Ethernet link down status (Op) More...
 
__STATIC_INLINE void EvrNetETH_LinkUpStatus (uint8_t if_num, uint8_t link_info)
 Event on Ethernet link up status (Op) More...
 
__STATIC_INLINE void EvrNetETH_ReceiveFrame (uint8_t if_num, uint32_t length)
 Event on Ethernet receive frame (Op) More...
 
__STATIC_INLINE void EvrNetETH_VlanInvalid (uint8_t if_num)
 Event on Ethernet receive VLAN invalid (Op) More...
 
__STATIC_INLINE void EvrNetETH_Ip4Disabled (uint8_t if_num)
 Event on Ethernet receive IPv4 disabled (Op) More...
 
__STATIC_INLINE void EvrNetETH_Ip6Disabled (uint8_t if_num)
 Event on Ethernet receive IPv6 disabled (Op) More...
 
__STATIC_INLINE void EvrNetETH_ProtocolUnknown (uint8_t if_num, uint16_t protocol)
 Event on Ethernet receive protocol unknown (Op) More...
 
__STATIC_INLINE void EvrNetETH_SendRawFrame (uint8_t if_num, uint32_t length)
 Event on Ethernet send raw frame (API) More...
 
__STATIC_INLINE void EvrNetETH_SendRawInvalidParameter (uint8_t if_num)
 Event on Ethernet send raw frame invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetETH_OutputLowLevel (uint8_t if_num, uint32_t length)
 Event on output Ethernet frame (Op) More...
 
__STATIC_INLINE void EvrNetETH_UninitInterface (uint8_t if_num)
 Event on Ethernet interface de-initialize (Op) More...
 

Description

Events generated by the Network - Ethernet Interface functions.

The Network Ethernet Interface functions generate events that inform about events in the ethernet interface and help in troubleshooting.

Function Documentation

__STATIC_INLINE void EvrNetETH_EnqueueFrame ( uint8_t  if_num,
uint8_t  ca_entry,
uint32_t  length 
)

Event on enqueued Ethernet frame for unresolved MAC address (Op)

Parameters
if_numinterface number
ca_entrycache entry identifier
lengthframe length in bytes

The event EnqueueFrame is created when the internal send_frame function wants to send the frame to the local network, but the destination MAC address is not resolved. The ARP or NDP address resolver starts and enqueues the frame. When the address resolver completes, enqueued frames are sent to resolved destination MAC address.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • ca_entry: ARP/NDP cache entry identifier.
  • len: length of the queued frame in bytes.
__STATIC_INLINE void EvrNetETH_GetOptionInvalidParameter ( uint8_t  if_num)

Event on Ethernet get_option invalid parameter (Error)

Parameters
if_numinterface number

The event GetOptionInvalidParameter is created, when invalid input parameter is provided for the internal get_option function. This happens when the function netIF_GetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_InitInterface ( uint8_t  if_num)

Event on Ethernet interface initialize (Op)

Parameters
if_numinterface number

The event InitInterface is created when the ethernet interface is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_InvalidIpVersion ( uint8_t  if_num,
uint8_t  ip_version 
)

Event on Ethernet invalid IP version (Error)

Parameters
if_numinterface number
ip_versioninvalid IP protocol version value
  • 0: IPv4
  • 1: IPv6

The event InvalidIpVersion is created when the internal send_frame function wants to send the frame, but the requested Internet Protocol version is not recognized. This might happen when the requested IP protocol version is IPv6, but the Network Component library that is used supports IPv4 only.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • ver: requested IP protocol version.
__STATIC_INLINE void EvrNetETH_Ip4ConfigError ( uint8_t  if_num)

Event on Ethernet IPv4 configuration error (Error)

Parameters
if_numinterface number

The event Ip4ConfigError is created when an error is found in IPv4 configuration for the ethernet interface.

The error is in one of the following configurations:

  • IP Address
  • Subnet mask
  • Default Gateway
  • Primary DNS Server
  • Secondary DNS Server

The event is created when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_Ip4Disabled ( uint8_t  if_num)

Event on Ethernet receive IPv4 disabled (Op)

Parameters
if_numinterface number

The event Ip4Disabled is created when the network library receives the ethernet frame with protocol type ARP or IPv4, but IPv4 protocol is disabled in the ethernet interface configuration.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_Ip4LocalAddressUndefined ( uint8_t  if_num)

Event on Ethernet local IPv4 address undefined (Error)

Parameters
if_numinterface number

The event Ip4LocalAddressUndefined is created when the internal send_frame function wants to send the unicast frame, but the local IP address is not valid. This usually happens when the DHCP client does not yet assign the IP address.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • addr: 0.0.0.0 (undefined address).
__STATIC_INLINE void EvrNetETH_Ip4MacAddressUnresolved ( uint8_t  if_num,
const uint8_t *  ip4_addr 
)

Event on Ethernet MAC address unresolved (Error)

Parameters
if_numinterface number
ip4_addrpointer to IPv4 destination address

The event Ip4MacAddressUnresolved is created when the internal send_frame function wants to send the frame, but the destination MAC address is not resolved. This usually happens when the destination IP address is external and the gateway is not reachable.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • dst_addr: destination IPv4 address to send to.
__STATIC_INLINE void EvrNetETH_Ip6ConfigError ( uint8_t  if_num)

Event on Ethernet IPv6 configuration error (Error)

Parameters
if_numinterface number

The event Ip6ConfigError is created when an error is found in IPv6 configuration for the ethernet interface.

The error is in one of the following configurations:

  • IPv6 Address
  • Default Gateway
  • Primary DNS Server
  • Secondary DNS Server

The event is created when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_Ip6Disabled ( uint8_t  if_num)

Event on Ethernet receive IPv6 disabled (Op)

Parameters
if_numinterface number

The event Ip6Disabled is created when the network library receives the ethernet frame with protocol type IPv6, but IPv6 protocol is disabled in the ethernet interface configuration.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_Ip6LocalAddressUndefined ( uint8_t  if_num)

Event on Ethernet local IPv6 address undefined (Error)

Parameters
if_numinterface number

The event Ip6LocalAddressUndefined is created when the internal send_frame function wants to send the unicast frame, but the local IPv6 address is not valid. This usually happens when the DHCPv6 client does not yet assign the IPv6 address.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • addr: 0:0:0:0:0:0:0:0 (undefined address).
__STATIC_INLINE void EvrNetETH_Ip6MacAddressUnresolved ( uint8_t  if_num,
const uint8_t *  ip6_addr 
)

Event on Ethernet MAC address unresolved (Error)

Parameters
if_numinterface number
ip6_addrpointer to IPv6 destination address

The event Ip6MacAddressUnresolved is created when the internal send_frame function wants to send the frame, but the destination MAC address is not resolved. This happens when the Neighbor Discovery is in progress for the on-link destination IPv6 address or when the gateway is not reachable for external IPv6 address.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • dst_addr: destination IPv6 address to send to.
__STATIC_INLINE void EvrNetETH_LinkDownError ( uint8_t  if_num)

Event on Ethernet link down error (Error)

Parameters
if_numinterface number

The event LinkDownError is created when the network library wants to send the frame on the ethernet interface, but the link is down.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_LinkDownStatus ( uint8_t  if_num)

Event on Ethernet link down status (Op)

Parameters
if_numinterface number

The event LinkDownStatus is created when the network library detects a change in the state of the ethernet connection that is interrupted.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_LinkUpStatus ( uint8_t  if_num,
uint8_t  link_info 
)

Event on Ethernet link up status (Op)

Parameters
if_numinterface number
link_infolink information:
  • duplex (bit 2)
  • speed (bit 1,0)

The event LinkUpStatus is created when the network library detects a change in the state of the ethernet connection that becomes connected.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • speed: link speed (10 Mbit, 100 Mbit, 1 Gbit).
  • duplex: link duplex (Half, Full).
__STATIC_INLINE void EvrNetETH_MacAddressConfigError ( uint8_t  if_num)

Event on Ethernet MAC address configuration error (Error)

Parameters
if_numinterface number

The event MacAddressConfigError is created when an error is found in the ethernet MAC configuration while the ethernet interface is initializing. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_OutputLowLevel ( uint8_t  if_num,
uint32_t  length 
)

Event on output Ethernet frame (Op)

Parameters
if_numinterface number
lengthframe length in bytes

The event OutputLowLevel is created when the ethernet interface wants to pass a frame to the ethernet driver.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • len: length of the frame in bytes.
__STATIC_INLINE void EvrNetETH_PhyDriverConfigError ( uint8_t  if_num)

Event on Ethernet PHY configuration error (Error)

Parameters
if_numinterface number

The event PhyDriverConfigError is created when the ethernet interface failed to initialize the PHY driver, because the requested features are not supported in the driver. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_PhyDriverInitError ( uint8_t  if_num)

Event on Ethernet PHY initialization error (Error)

Parameters
if_numinterface number

The event PhyDriverConfigError is created when the ethernet interface failed to initialize the PHY driver. The event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_ProtocolUnknown ( uint8_t  if_num,
uint16_t  protocol 
)

Event on Ethernet receive protocol unknown (Op)

Parameters
if_numinterface number
protocolunknown ethernet protocol type

The event ProtocolUnknown is created when the network library receives an ethernet frame, but the received ethernet protocol type is not recognized.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • proto: received ethernet protocol type.
__STATIC_INLINE void EvrNetETH_ReceiveFrame ( uint8_t  if_num,
uint32_t  length 
)

Event on Ethernet receive frame (Op)

Parameters
if_numinterface number
lengthframe length in bytes

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

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • len: length of the received ethernet frame in bytes.
__STATIC_INLINE void EvrNetETH_SendDataTooLarge ( uint8_t  if_num,
uint32_t  length,
uint32_t  max_length 
)

Event on Ethernet send payload too large error (Error)

Parameters
if_numinterface number
lengthdata length in bytes
max_lengthmaximum length of data in bytes

The event SendDataTooLarge is created when the length of the data to send is larger than the ethernet MTU (1500 bytes).

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • len: length of the data to send in bytes.
  • max: maximum allowed data length in bytes.
__STATIC_INLINE void EvrNetETH_SendFrame ( uint8_t  if_num,
uint32_t  length,
uint8_t  ip_version 
)

Event on Ethernet send frame (Op)

Parameters
if_numinterface number
lengthframe length in bytes
ip_versioninternet protocol version
  • 0: IPv4
  • 1: IPv6

The event SendFrame is created when the ethernet frame header is constructed for the frame and the data is sent to the ethernet driver.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • len: length of the ethernet frame payload.
  • ver: IP protocol version (IPv4, IPv6).
__STATIC_INLINE void EvrNetETH_SendIp4Disabled ( uint8_t  if_num)

Event on Ethernet send IPv4 disabled error (Error)

Parameters
if_numinterface number

The event SendIp4Disabled is created when the internal send_frame function does not send the IPv4 frame, because IPv4 is disabled in the interface configuration.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_SendIp6Disabled ( uint8_t  if_num)

Event on Ethernet send IPv6 disabled error (Error)

Parameters
if_numinterface number

The event SendIp6Disabled is created when the internal send_frame function does not send the IPv6 frame, because IPv6 is disabled in the interface configuration.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_SendRawFrame ( uint8_t  if_num,
uint32_t  length 
)

Event on Ethernet send raw frame (API)

Parameters
if_numinterface number
lengthframe length in bytes

The event SendRawFrame is created when the function netETH_SendRaw is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • len: length of the data to send in bytes.
__STATIC_INLINE void EvrNetETH_SendRawInvalidParameter ( uint8_t  if_num)

Event on Ethernet send raw frame invalid parameter (Error)

Parameters
if_numinterface number

The event SendRawInvalidParameter is created when an invalid input parameter is specified for the netETH_SendRaw function.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_SetIp4Address ( uint8_t  if_num,
const uint8_t *  ip4_addr 
)

Event on Ethernet set interface IPv4 address (Op)

Parameters
if_numinterface number
ip4_addrpointer to IPv4 address

The event SetIp4Address is created when the static IPv4 address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • ip: static IPv4 address to be set.
__STATIC_INLINE void EvrNetETH_SetIp4DefaultGateway ( uint8_t  if_num,
const uint8_t *  ip4_addr 
)

Event on Ethernet set interface IPv4 default gateway (Op)

Parameters
if_numinterface number
ip4_addrpointer to IPv4 address of a gateway

The event SetIp4DefaultGateway is created when IPv4 default gateway address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • gw: IPv4 address of default gateway.
__STATIC_INLINE void EvrNetETH_SetIp4Mtu ( uint8_t  if_num,
uint16_t  mtu 
)

Event on Ethernet set interface MTU (Op)

Parameters
if_numinterface number
mtumaximum transmission unit
  • 0: fragmentation disabled
Remarks
MTU is limited in the range from 576 to 1500 bytes.

The event SetIp4Mtu is created when the Maximum Transmission Unit is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • mtu: IPv4 MTU to be set.
__STATIC_INLINE void EvrNetETH_SetIp4PrimaryDNS ( uint8_t  if_num,
const uint8_t *  ip4_addr 
)

Event on Ethernet set interface primary DNS server (Op)

Parameters
if_numinterface number
ip4_addrpointer to IPv4 address of a DNS server

The event SetIp4PrimaryDNS is created when IPv4 primary DNS server address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • pri_dns: IPv4 address of the primary DNS server.
__STATIC_INLINE void EvrNetETH_SetIp4SecondaryDNS ( uint8_t  if_num,
const uint8_t *  ip4_addr 
)

Event on Ethernet set interface secondary DNS server (Op)

Parameters
if_numinterface number
ip4_addrpointer to IPv4 address of a DNS server

The event SetIp4SecondaryDNS is created when IPv4 secondary DNS server address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • sec_dns: IPv4 address of the secondary DNS server.
__STATIC_INLINE void EvrNetETH_SetIp4SubnetMask ( uint8_t  if_num,
const uint8_t *  net_mask 
)

Event on Ethernet set interface IPv4 subnet mask (Op)

Parameters
if_numinterface number
net_maskpointer to IPv4 subnet mask

The event SetIp4SubnetMask is created when IPv4 subnet mask is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • mask: IPv4 subnet mask to be set.
__STATIC_INLINE void EvrNetETH_SetIp6Address ( uint8_t  if_num,
const uint8_t *  ip6_addr 
)

Event on Ethernet set interface IPv6 static address (Op)

Parameters
if_numinterface number
ip6_addrpointer to IPv6 address

The event SetIp6Address is created when the static IPv6 address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • ip: static IPv6 address to be set.
__STATIC_INLINE void EvrNetETH_SetIp6DefaultGateway ( uint8_t  if_num,
const uint8_t *  ip6_addr 
)

Event on Ethernet set interface IPv6 default gateway (Op)

Parameters
if_numinterface number
ip6_addrpointer to IPv6 address of a gateway

The event SetIp6DefaultGateway is created when IPv6 default gateway address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • gw: IPv6 address of default gateway.
__STATIC_INLINE void EvrNetETH_SetIp6PrefixLength ( uint8_t  if_num,
uint8_t  pref_len 
)

Event on Ethernet set interface IPv6 subnet prefix length (Op)

Parameters
if_numinterface number
pref_lensubnet prefix length

The event SetIp6PrefixLength is created when the IPv6 subnet prefix length is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • pref_len: IPv6 prefix length to be set.
__STATIC_INLINE void EvrNetETH_SetIp6PrimaryDNS ( uint8_t  if_num,
const uint8_t *  ip6_addr 
)

Event on Ethernet set interface primary DNS server (Op)

Parameters
if_numinterface number
ip6_addrpointer to IPv6 address of a DNS server

The event SetIp6PrimaryDNS is created when IPv6 primary DNS server address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • pri_dns: IPv6 address of the primary DNS server.
__STATIC_INLINE void EvrNetETH_SetIp6SecondaryDNS ( uint8_t  if_num,
const uint8_t *  ip6_addr 
)

Event on Ethernet set interface secondary DNS server (Op)

Parameters
if_numinterface number
ip6_addrpointer to IPv6 address of a DNS server

The event SetIp6SecondaryDNS is created when IPv6 secondary DNS server address is set for the ethernet interface. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • sec_dns: IPv6 address of the secondary DNS server.
__STATIC_INLINE void EvrNetETH_SetMacAddress ( uint8_t  if_num,
const uint8_t *  mac_addr 
)

Event on Ethernet set interface MAC address (Op)

Parameters
if_numinterface number
mac_addrpointer to MAC address

The event SetMacAddress is created when the MAC address for the ethernet interface is set in the driver. This happens when the ethernet interface is initialized or when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • mac: MAC address to be set.
__STATIC_INLINE void EvrNetETH_SetOptionInvalidParameter ( uint8_t  if_num)

Event on Ethernet set_option invalid parameter (Error)

Parameters
if_numinterface number

The event SetOptionInvalidParameter is created, when invalid input parameter is provided for the internal set_option function. This happens when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_SetVlanIdentifier ( uint8_t  if_num,
uint16_t  vlan_id 
)

Event on Ethernet set VLAN identifier (Op)

Parameters
if_numinterface number
vlan_idVLAN identifier
  • 0: VLAN tagging disabled
Remarks
VLAN identifier is limited in the range from 1 to 4093.

The event SetVlanIdentifier is created when the VLAN identifier for the ethernet interface is set in the driver. This happens when the ethernet interface is initialized or when the function netIF_SetOption for the ethernet interface is executed.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
  • vlan_id: VLAN identifier to be set.
__STATIC_INLINE void EvrNetETH_ShowFrameHeader ( const void *  eth_header)

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

Parameters
eth_headerpointer to ethernet frame header of 14 bytes
  • DstAddr (6 bytes)
  • SrcAddr (6 bytes)
  • Protocol (2 bytes)

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

Value in the Event Recorder shows:

  • dst: destination MAC address.
  • src: source MAC address.
  • proto: protocol type (ARP, IPv4, IPv6).
__STATIC_INLINE void EvrNetETH_ThreadCreateFailed ( uint8_t  if_num)

Event on Ethernet thread create failed (Error)

Parameters
if_numinterface number

The event ThreadCreateFailed is generated, if the function netInitialize failed to create the ethernet interface thread.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_UninitInterface ( uint8_t  if_num)

Event on Ethernet interface de-initialize (Op)

Parameters
if_numinterface number

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

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_VlanConfigError ( uint8_t  if_num)

Event on Ethernet VLAN configuration error (Error)

Parameters
if_numinterface number

The event VlanConfigError is created when the VLAN is enabled in the ethernet configuration, but it is not supported in the ethernet driver. An event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_VlanInitError ( uint8_t  if_num)

Event on Ethernet VLAN initialization error (Error)

Parameters
if_numinterface number

The event VlanInitError is created when the ethernet driver fails to initialize the VLAN tag. An event is generated when the function netInitialize is executed and is a critical failure.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.
__STATIC_INLINE void EvrNetETH_VlanInvalid ( uint8_t  if_num)

Event on Ethernet receive VLAN invalid (Op)

Parameters
if_numinterface number

The event VlanInvalid is created when the network library receives the ethernet frame with VLAN tag, but the received VLAN tag is not the same as the locally set VLAN tag.

Value in the Event Recorder shows:

  • if_num: ethernet interface number.