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
NetSLIP: SLIP Interface

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

Functions

__STATIC_INLINE void EvrNetSLIP_InitInterface (void)
 Event on SLIP interface initialize (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_Ip4ConfigError (void)
 Event on SLIP IPv4 configuration error (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_ThreadCreateFailed (void)
 Event on SLIP thread create failed (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_GetOptionInvalidParameter (void)
 Event on SLIP get_option invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_SetOptionInvalidParameter (void)
 Event on SLIP set_option invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_SetIp4Address (const uint8_t *ip4_addr)
 Event on SLIP set interface IPv4 address (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_SetIp4PrimaryDNS (const uint8_t *ip4_addr)
 Event on SLIP set interface primary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_SetIp4SecondaryDNS (const uint8_t *ip4_addr)
 Event on SLIP set interface secondary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_SetIp4Mtu (uint16_t mtu)
 Event on SLIP set interface MTU (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_Connect (const char *dial_number, uint32_t length)
 Event on SLIP start connecting (API) More...
 
__STATIC_INLINE void EvrNetSLIP_ConnectInvalidParameter (void)
 Event on SLIP connect invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_ConnectWrongState (void)
 Event on SLIP connect in wrong state (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_Listen (void)
 Event on SLIP start listening (API) More...
 
__STATIC_INLINE void EvrNetSLIP_ListenWrongState (void)
 Event on SLIP listen in wrong state (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_Close (void)
 Event on SLIP close connection (API) More...
 
__STATIC_INLINE void EvrNetSLIP_SendFrame (uint32_t length, uint8_t ip_version)
 Event on SLIP send frame (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_InvalidIpVersion (uint8_t ip_version)
 Event on SLIP invalid IP version (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_SendDataTooLarge (uint32_t length, uint32_t max_length)
 Event on SLIP send payload too large (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_NoMemoryError (void)
 Event on SLIP out of memory for send (Error) More...
 
__STATIC_INLINE void EvrNetSLIP_QueueAddTransmit (void)
 Event on SLIP add frame to transmit queue (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_ModemOffline (void)
 Event on SLIP link change to modem offline (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_ReceiveFrame (uint32_t length)
 Event on SLIP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetSLIP_UninitInterface (void)
 Event on SLIP interface de-initialize (Op) More...
 

Description

Events generated by the Network - SLIP Interface functions.

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

Function Documentation

__STATIC_INLINE void EvrNetSLIP_Close ( void  )

Event on SLIP close connection (API)

The event Close is created when the function netSLIP_Close is executed.

Value in the Event Recorder shows:

  • stop
__STATIC_INLINE void EvrNetSLIP_Connect ( const char *  dial_number,
uint32_t  length 
)

Event on SLIP start connecting (API)

Parameters
dial_numberpointer to a number to dial string
lengthlength of the dial_number string

The event Connect is created when the function netSLIP_Connect is executed.

Value in the Event Recorder shows:

  • dial-number: dial-up number to establish a modem connection.
__STATIC_INLINE void EvrNetSLIP_ConnectInvalidParameter ( void  )

Event on SLIP connect invalid parameter (Error)

The event ConnectInvalidParameter is created when invalid input parameter is provided for the netSLIP_Connect function.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetSLIP_ConnectWrongState ( void  )

Event on SLIP connect in wrong state (Error)

The event ConnectWrongState is created when the function netSLIP_Connect is executed, but the SLIP interface is already connected.

Value in the Event Recorder shows:

  • connected
__STATIC_INLINE void EvrNetSLIP_GetOptionInvalidParameter ( void  )

Event on SLIP get_option invalid parameter (Error)

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 SLIP interface is executed.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetSLIP_InitInterface ( void  )

Event on SLIP interface initialize (Op)

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

Value in the Event Recorder shows:

  • slip: SLIP interface name.
__STATIC_INLINE void EvrNetSLIP_InvalidIpVersion ( uint8_t  ip_version)

Event on SLIP invalid IP version (Error)

Parameters
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.

Value in the Event Recorder shows:

  • ver: requested IP protocol version.
__STATIC_INLINE void EvrNetSLIP_Ip4ConfigError ( void  )

Event on SLIP IPv4 configuration error (Error)

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

The error is in one of the following configurations:

  • IP Address
  • 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:

  • ip4
__STATIC_INLINE void EvrNetSLIP_Listen ( void  )

Event on SLIP start listening (API)

The event Listen is created when the function netSLIP_Listen is executed.

Value in the Event Recorder shows:

  • start
__STATIC_INLINE void EvrNetSLIP_ListenWrongState ( void  )

Event on SLIP listen in wrong state (Error)

The event ListenWrongState is created when the function netSLIP_Listen is executed, but the SLIP interface is already connected.

Value in the Event Recorder shows:

  • connected
__STATIC_INLINE void EvrNetSLIP_ModemOffline ( void  )

Event on SLIP link change to modem offline (Op)

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

Value in the Event Recorder shows:

  • off-line
__STATIC_INLINE void EvrNetSLIP_NoMemoryError ( void  )

Event on SLIP out of memory for send (Error)

The event NoMemoryError is created when the internal send_frame function wants to allocate the memory for the frame to be sent to the SLIP interface, but no memory is available. Therefore, the frame is not sent.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetSLIP_QueueAddTransmit ( void  )

Event on SLIP add frame to transmit queue (Op)

The event QueueAddTransmit is created when the internal send_frame function adds the frame to be sent to the transmit queue of the SLIP interface. The transmit queue is processed and frames are transmitted in the SLIP interface thread.

Value in the Event Recorder shows:

  • success
__STATIC_INLINE void EvrNetSLIP_ReceiveFrame ( uint32_t  length)

Event on SLIP receive frame (Op)

Parameters
lengthframe length in bytes

The event ReceiveFrame is created when the network library receives the frame on the SLIP interface.

Value in the Event Recorder shows:

  • len: length of the received frame in bytes.
__STATIC_INLINE void EvrNetSLIP_SendDataTooLarge ( uint32_t  length,
uint32_t  max_length 
)

Event on SLIP send payload too large (Error)

Parameters
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 SLIP MTU (1500 bytes).

Value in the Event Recorder shows:

  • len: length of the data to send in bytes.
  • max: maximum allowed data length in bytes.
__STATIC_INLINE void EvrNetSLIP_SendFrame ( uint32_t  length,
uint8_t  ip_version 
)

Event on SLIP send frame (Op)

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

The event SendFrame is created when the frame is sent to the SLIP interface.

Value in the Event Recorder shows:

  • len: length of the frame to send in bytes.
  • ver: IP protocol version (IPv4, IPv6).
__STATIC_INLINE void EvrNetSLIP_SetIp4Address ( const uint8_t *  ip4_addr)

Event on SLIP set interface IPv4 address (Op)

Parameters
ip4_addrpointer to IPv4 address

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

Value in the Event Recorder shows:

  • ip: static IPv4 address to be set.
__STATIC_INLINE void EvrNetSLIP_SetIp4Mtu ( uint16_t  mtu)

Event on SLIP set interface MTU (Op)

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

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

Value in the Event Recorder shows:

  • mtu: IPv4 MTU to be set.
__STATIC_INLINE void EvrNetSLIP_SetIp4PrimaryDNS ( const uint8_t *  ip4_addr)

Event on SLIP set interface primary DNS server (Op)

Parameters
ip4_addrpointer to IPv4 address of a DNS server

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

Value in the Event Recorder shows:

  • pri_dns: IPv4 address of the primary DNS server.
__STATIC_INLINE void EvrNetSLIP_SetIp4SecondaryDNS ( const uint8_t *  ip4_addr)

Event on SLIP set interface secondary DNS server (Op)

Parameters
ip4_addrpointer to IPv4 address of a DNS server

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

Value in the Event Recorder shows:

  • sec_dns: IPv4 address of the secondary DNS server.
__STATIC_INLINE void EvrNetSLIP_SetOptionInvalidParameter ( void  )

Event on SLIP set_option invalid parameter (Error)

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 SLIP interface is executed.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetSLIP_ThreadCreateFailed ( void  )

Event on SLIP thread create failed (Error)

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

Value in the Event Recorder shows:

  • thread: netSLIP_Thread.
__STATIC_INLINE void EvrNetSLIP_UninitInterface ( void  )

Event on SLIP interface de-initialize (Op)

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

Value in the Event Recorder shows:

  • slip: SLIP interface name.