Network Component  Version 7.11.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetIP6: IP6 Core

Events generated by the Network - IPv6 Core functions. More...

Functions

__STATIC_INLINE void EvrNetIP6_InitCore (void)
 Event on IP6 core initialize (Op) More...
 
__STATIC_INLINE void EvrNetIP6_ReceiveFrame (uint32_t length)
 Event on IP6 receive frame (Op) More...
 
__STATIC_INLINE void EvrNetIP6_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on IP6 receive frame too short (Error) More...
 
__STATIC_INLINE void EvrNetIP6_InvalidIpVersion (uint8_t ip_version)
 Event on IP6 invalid protocol version (Error) More...
 
__STATIC_INLINE void EvrNetIP6_ShowFrameHeader (const void *ip6_header)
 Event on IP6 display frame header (Detail) More...
 
__STATIC_INLINE void EvrNetIP6_WrongDestinationAddress (const uint8_t *ip6_addr)
 Event on IP6 wrong destination address (Op) More...
 
__STATIC_INLINE void EvrNetIP6_InterfaceNotSupported (uint32_t interface)
 Event on IP6 network interface not supported (Error) More...
 
__STATIC_INLINE void EvrNetIP6_WrongMulticastProtocol (uint8_t ip6_protocol)
 Event on IP6 wrong multicast protocol type (Error) More...
 
__STATIC_INLINE void EvrNetIP6_SendFrame (uint8_t ip6_protocol, uint32_t length)
 Event on IP6 send frame (Op) More...
 
__STATIC_INLINE void EvrNetIP6_ProtocolUnknown (uint8_t ip6_protocol)
 Event on IP6 unknown protocol type in sending frame (Error) More...
 
__STATIC_INLINE void EvrNetIP6_SourceAddressNull (void)
 Event on IP6 source address not provided (Error) More...
 
__STATIC_INLINE void EvrNetIP6_DestinationAddressNull (void)
 Event on IP6 destination address not provided (Error) More...
 
__STATIC_INLINE void EvrNetIP6_UninitCore (void)
 Event on IP6 core de-initialize (Op) More...
 

Description

Events generated by the Network - IPv6 Core functions.

The Network IPv6 Core functions generate events that report events in the network core of Internet Protocol version 6 and help in troubleshooting.

Function Documentation

__STATIC_INLINE void EvrNetIP6_DestinationAddressNull ( void  )

Event on IP6 destination address not provided (Error)

The event DestinationAddressNull is created when the internal send_frame function wants to send the IPv6 frame and finds out, that the destination address is not specified. The IPv6 header can not be created and therefore the frame is not sent.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetIP6_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on IP6 receive frame too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame

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

Value in the Event Recorder shows:

  • len: length of the received frame in bytes.
  • min: minimum valid frame length in bytes.
__STATIC_INLINE void EvrNetIP6_InitCore ( void  )

Event on IP6 core initialize (Op)

The event InitCore is created when the IPv6 core is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

  • ip6
__STATIC_INLINE void EvrNetIP6_InterfaceNotSupported ( uint32_t  interface)

Event on IP6 network interface not supported (Error)

Parameters
interfacenetwork interface identifier

The event InterfaceNotSupported is created when the network library receives an IPv6 frame on the network interface that does not support the IPv6. The IPv6 frame is therefore discarded.

Value in the Event Recorder shows:

  • interface: network interface identifier.
__STATIC_INLINE void EvrNetIP6_InvalidIpVersion ( uint8_t  ip_version)

Event on IP6 invalid protocol version (Error)

Parameters
ip_versionIPv6 protocol version value

The event InvalidIpVersion is created when the network library receives an IPv6 frame that has an unrecognized IP version encoded in the IPv6 header. The IP version should be 6, all other values are invalid. The frame is therefore discarded.

Value in the Event Recorder shows:

  • ver: received IPv6 protocol version.
__STATIC_INLINE void EvrNetIP6_ProtocolUnknown ( uint8_t  ip6_protocol)

Event on IP6 unknown protocol type in sending frame (Error)

Parameters
ip6_protocolunknown IPv6 protocol type value

The event ProtocolUnknown is created when the network library wants to send the IPv6 frame, but the provided IPv6 protocol type is not supported. The frame is therefore not sent.

Value in the Event Recorder shows:

  • proto: unknown protocol type.
__STATIC_INLINE void EvrNetIP6_ReceiveFrame ( uint32_t  length)

Event on IP6 receive frame (Op)

Parameters
lengthframe length in bytes

The event ReceiveFrame is created when the network library receives the IPv6 frame. The frame can come from any interface.

Value in the Event Recorder shows:

  • len: length of the received IPv6 frame in bytes.
__STATIC_INLINE void EvrNetIP6_SendFrame ( uint8_t  ip6_protocol,
uint32_t  length 
)

Event on IP6 send frame (Op)

Parameters
ip6_protocolIPv6 protocol type
  • 6: TCP
  • 17: UDP
  • 58: ICMP6
lengthframe length

The event SendFrame is created when the internal send_frame function wants to send the IPv6 frame. The IPv6 header is constructed and the frame is sent to the transfer interface.

Value in the Event Recorder shows:

  • proto: IPv6 protocol type (TCP, UDP, ICMPv6).
  • len: length of the IPv6 frame payload.
__STATIC_INLINE void EvrNetIP6_ShowFrameHeader ( const void *  ip6_header)

Event on IP6 display frame header (Detail)

Parameters
ip6_headerpointer to IPv6 frame header of 40 bytes
  • VerClass (1 byte)
  • ClassFlow (1 byte)
  • Flow (2 bytes)
  • Len (2 bytes)
  • NextHdr (1 byte)
  • HopLim (1 byte)
  • SrcAddr (16 bytes)
  • DstAddr (16 bytes)

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

Value in the Event Recorder shows:

  • dst: destination IPv6 address.
  • src: source IPv6 address.
  • proto: protocol type (TCP, UDP, ICMPv6).
  • hops: hop limit.
  • len: length of the received frame in bytes.
__STATIC_INLINE void EvrNetIP6_SourceAddressNull ( void  )

Event on IP6 source address not provided (Error)

The event SourceAddressNull is created when the internal send_frame function wants to send the IPv6 frame and finds out, that the local address is not specified. The IPv6 header can not be created and therefore the frame is not sent.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetIP6_UninitCore ( void  )

Event on IP6 core de-initialize (Op)

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

Value in the Event Recorder shows:

  • ip6
__STATIC_INLINE void EvrNetIP6_WrongDestinationAddress ( const uint8_t *  ip6_addr)

Event on IP6 wrong destination address (Op)

Parameters
ip6_addrpointer to IPv6 destination address

The event WrongDestinationAddress is created when the network library receives an IPv6 frame that has an invalid destination address. The IPv6 frame is therefore discarded.

Value in the Event Recorder shows:

  • ip: received destination IPv6 address.
__STATIC_INLINE void EvrNetIP6_WrongMulticastProtocol ( uint8_t  ip6_protocol)

Event on IP6 wrong multicast protocol type (Error)

Parameters
ip6_protocolreceived protocol type
Remarks
Only UDP multicast frames are allowed.

The event WrongMulticastProtocol is created when the network library receives an IPv6 multicast frame that has an invalid protocol type. The IPv6 frame is therefore discarded.

Value in the Event Recorder shows:

  • proto: received protocol type (TCP, ICMPv6).