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
NetPPP: PPP Interface

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

Functions

__STATIC_INLINE void EvrNetPPP_InitInterface (void)
 Event on PPP interface initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ThreadCreateFailed (void)
 Event on PPP thread create failed (Error) More...
 
__STATIC_INLINE void EvrNetPPP_GetOptionInvalidParameter (void)
 Event on PPP get_option invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetPPP_SetOptionInvalidParameter (void)
 Event on PPP set_option invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetPPP_SetIp4Address (const uint8_t *ip4_addr)
 Event on PPP set interface IPv4 address (Op) More...
 
__STATIC_INLINE void EvrNetPPP_SetIp4PrimaryDNS (const uint8_t *ip4_addr)
 Event on PPP set interface primary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetPPP_SetIp4SecondaryDNS (const uint8_t *ip4_addr)
 Event on PPP set interface secondary DNS server (Op) More...
 
__STATIC_INLINE void EvrNetPPP_SetIp4Mtu (uint16_t mtu)
 Event on PPP set interface MTU (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ReceiveFrame (uint16_t protocol, uint32_t length)
 Event on PPP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on PPP receive frame too short (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChecksumFailed (uint32_t length)
 Event on PPP frame checksum check failed (Error) More...
 
__STATIC_INLINE void EvrNetPPP_CtrlByteInvalid (uint8_t ctrl, uint8_t ctrl_valid)
 Event on PPP frame control byte invalid (Error) More...
 
__STATIC_INLINE void EvrNetPPP_SendFrame (uint16_t protocol, uint32_t length)
 Event on PPP send frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_InvalidIpVersion (uint8_t ip_version)
 Event on PPP invalid IP version (Error) More...
 
__STATIC_INLINE void EvrNetPPP_NetworkLayerDown (void)
 Event on PPP network layer down (Error) More...
 
__STATIC_INLINE void EvrNetPPP_SendDataTooLarge (uint32_t length, uint32_t max_length)
 Event on PPP send payload too large (Error) More...
 
__STATIC_INLINE void EvrNetPPP_NoMemoryError (void)
 Event on PPP out of memory for send (Error) More...
 
__STATIC_INLINE void EvrNetPPP_QueueAddTransmit (void)
 Event on PPP add frame to transmit queue (Op) More...
 
__STATIC_INLINE void EvrNetPPP_RejectProtocol (uint16_t protocol)
 Event on PPP reject unsupported protocol type (Op) More...
 
__STATIC_INLINE void EvrNetPPP_RejectCode (uint16_t protocol, uint8_t code)
 Event on PPP reject unsupported cp code (Op) More...
 
__STATIC_INLINE void EvrNetPPP_Connect (const char *dial_number, uint32_t length)
 Event on PPP start connecting (API) More...
 
__STATIC_INLINE void EvrNetPPP_ConnectInvalidParameter (void)
 Event on PPP connect invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetPPP_ConnectWrongState (void)
 Event on PPP connect in wrong state (Error) More...
 
__STATIC_INLINE void EvrNetPPP_Listen (void)
 Event on PPP start listening (API) More...
 
__STATIC_INLINE void EvrNetPPP_ListenInvalidParameter (void)
 Event on PPP listen invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetPPP_ListenWrongState (void)
 Event on PPP listen in wrong state (Error) More...
 
__STATIC_INLINE void EvrNetPPP_Close (void)
 Event on PPP close connection (API) More...
 
__STATIC_INLINE void EvrNetPPP_ShowUsername (const char *username, uint32_t length)
 Event on PPP display username (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ShowPassword (const char *password, uint32_t length)
 Event on PPP display password (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ModemOffline (void)
 Event on PPP link change to modem offline (Op) More...
 
__STATIC_INLINE void EvrNetPPP_DataLinkDown (void)
 Event on PPP data-link layer down (Op) More...
 
__STATIC_INLINE void EvrNetPPP_UninitInterface (void)
 Event on PPP interface de-initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpInit (void)
 Event on PPP-LCP initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendConfigRequest (void)
 Event on PPP-LCP send configuration request (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpNoRetriesLeft (void)
 Event on PPP-LCP no retries left for LCP negotiation (Error) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionCharMap (uint32_t char_map)
 Event on PPP-LCP option character map (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionPfc (void)
 Event on PPP-LCP option PFC (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionAcfc (void)
 Event on PPP-LCP option ACFC (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionMagicNumber (uint32_t magic_number)
 Event on PPP-LCP option magic number (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionAuthPap (void)
 Event on PPP-LCP option Authentication PAP (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionAuthChapMd5 (void)
 Event on PPP-LCP option Authentication CHAP (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendEchoRequest (uint32_t magic_number)
 Event on PPP-LCP send echo request (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendTerminateRequest (void)
 Event on PPP-LCP send LCP terminate request (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendFrame (const void *lcp_header)
 Event on PPP-LCP send frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpReceiveFrame (const void *lcp_header)
 Event on PPP-LCP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpDataLinkUp (void)
 Event on PPP-LCP data-link layer established (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionMru (uint16_t mru_size)
 Event on PPP-LCP option MRU (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionAuth (uint16_t auth_type)
 Event on PPP-LCP option authentication type (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionAuthChapNotMd5 (void)
 Event on PPP-LCP option CHAP authentication not MD5 type (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpOptionUnknown (uint8_t lcp_option)
 Event on PPP-LCP unknown option received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendReject (void)
 Event on PPP-LCP send reject (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendNak (void)
 Event on PPP-LCP send not acknowledge (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendAck (void)
 Event on PPP-LCP send acknowledge (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpWrongAckReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-LCP wrong acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpWrongNakReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-LCP wrong not-acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpConfigAuthFailed (void)
 Event on PPP-LCP authentication type negotiation failed (Error) More...
 
__STATIC_INLINE void EvrNetPPP_LcpWrongRejectReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-LCP wrong reject received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpEchoMagicNumber (uint32_t magic_number)
 Event on PPP-LCP echo magic number (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpWrongPeerMagicNumber (uint32_t magic, uint32_t magic_valid)
 Event on PPP-LCP wrong peer magic number (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendEchoReply (void)
 Event on PPP-LCP send echo reply (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpWrongEchoReplyReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-LCP wrong echo reply received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpSendTerminateAck (void)
 Event on PPP-LCP send terminate acknowledge (Op) More...
 
__STATIC_INLINE void EvrNetPPP_LcpUninit (void)
 Event on PPP-LCP de-initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapInit (void)
 Event on PPP-PAP initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapSendAuthRequest (const char *peer_id, uint32_t length)
 Event on PPP-PAP send authentication request (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapShowPassword (const char *password, uint32_t length)
 Event on PPP-PAP display password (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapSendFrame (const void *pap_header)
 Event on PPP-PAP send frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapReceiveFrame (const void *pap_header)
 Event on PPP-PAP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapLoginSuccess (void)
 Event on PPP-PAP login success (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapLoginFailed (void)
 Event on PPP-PAP login failed (Error) More...
 
__STATIC_INLINE void EvrNetPPP_PapWrongAckReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-PAP wrong acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapWrongNakReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-PAP wrong not-acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_PapUninit (void)
 Event on PPP-PAP de-initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapInit (void)
 Event on PPP-CHAP initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapSendChallenge (const char *name, uint32_t length)
 Event on PPP-CHAP send challenge (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapSendFrame (const void *chap_header)
 Event on PPP-CHAP send frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapReceiveFrame (const void *chap_header)
 Event on PPP-CHAP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapWrongResponseReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-CHAP wrong response received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapWrongSuccessReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-CHAP wrong success received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapWrongFailureReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-CHAP wrong failure received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapLoginSuccess (void)
 Event on PPP-CHAP login success (Op) More...
 
__STATIC_INLINE void EvrNetPPP_ChapLoginFailed (void)
 Event on PPP-CHAP login failed (Error) More...
 
__STATIC_INLINE void EvrNetPPP_ChapUninit (void)
 Event on PPP-CHAP de-initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpInit (void)
 Event on PPP-IPCP initialize (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpIp4ConfigError (void)
 Event on PPP-IPCP interface IPv4 configuration error (Error) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpSendConfigRequest (void)
 Event on PPP-IPCP send configuration request (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpOptionIpAddress (const uint8_t *ip4_addr)
 Event on PPP-IPCP option IP-address (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpOptionPrimaryDns (const uint8_t *ip4_addr)
 Event on PPP-IPCP option primary DNS server address (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpOptionSecondaryDns (const uint8_t *ip4_addr)
 Event on PPP-IPCP option secondary DNS server address (Detail) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpSendFrame (const void *ipcp_header)
 Event on PPP-IPCP send frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpReceiveFrame (const void *ipcp_header)
 Event on PPP-IPCP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpOptionUnknown (uint8_t ipcp_option)
 Event on PPP-IPCP unknown option received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpSendReject (void)
 Event on PPP-IPCP send reject (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpSendNak (void)
 Event on PPP-IPCP send not acknowledge (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpSendAck (void)
 Event on PPP-IPCP send acknowledge (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpWrongAckReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-IPCP wrong acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpNetworkLayerUp (void)
 Event on PPP-IPCP network-layer established (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpWrongNakReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-IPCP wrong not-acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpWrongRejectReceived (uint8_t id, uint8_t id_valid)
 Event on PPP-IPCP wrong reject received (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpWrongSubnet (const uint8_t *ip4_addr)
 Event on PPP-IPCP advertised IP-address not in subnet (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpPrimaryDnsRejected (void)
 Event on PPP-IPCP primary DNS server option rejected (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpSecondaryDnsRejected (void)
 Event on PPP-IPCP secondary DNS server option rejected (Op) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpIpAddressRejected (void)
 Event on PPP-IPCP IP-address option rejected (Error) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpNotRequestedOption (uint8_t ipcp_option)
 Event on PPP-IPCP not requested option rejected (Error) More...
 
__STATIC_INLINE void EvrNetPPP_IpcpUninit (void)
 Event on PPP-IPCP de-initialize (Op) More...
 

Description

Events generated by the Network - PPP Interface functions.

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

Function Documentation

__STATIC_INLINE void EvrNetPPP_ChapInit ( void  )

Event on PPP-CHAP initialize (Op)

Remarks
Challenge-Handshake Authentication Protocol

The event ChapInit is created when the PPP interface is initialized or when the network library wants to shut down or restart the PPP interface. This event indicates that the CHAP authentication protocol is initialized.

Value in the Event Recorder shows:

  • ppp-chap
__STATIC_INLINE void EvrNetPPP_ChapLoginFailed ( void  )

Event on PPP-CHAP login failed (Error)

The event ChapLoginFailed is created when the user authentication failed.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_ChapLoginSuccess ( void  )

Event on PPP-CHAP login success (Op)

The event ChapLoginSuccess is created when the user is successfully authenticated using the CHAP-MD5 protocol.

Value in the Event Recorder shows:

  • succes
__STATIC_INLINE void EvrNetPPP_ChapReceiveFrame ( const void *  chap_header)

Event on PPP-CHAP receive frame (Op)

Parameters
chap_headerpointer to CHAP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event ChapReceiveFrame is created when the network library receives the CHAP frame on the PPP interface. This event displays detailed information about the CHAP protocol header.

Value in the Event Recorder shows:

  • code: Code (CHALLENGE, RESPONSE, SUCCESS, FAILED).
  • id: Identification number.
  • len: Length of the frame including CHAP header in bytes.
__STATIC_INLINE void EvrNetPPP_ChapSendChallenge ( const char *  name,
uint32_t  length 
)

Event on PPP-CHAP send challenge (Op)

Parameters
namesystem identification string
lengthlength of the system identification string

The event ChapSendChallenge is created when the network library sends the CHAP challenge frame on the PPP interface in server mode.

Value in the Event Recorder shows:

  • name: host name built into CHAP challenge.
__STATIC_INLINE void EvrNetPPP_ChapSendFrame ( const void *  chap_header)

Event on PPP-CHAP send frame (Op)

Parameters
chap_headerpointer to CHAP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event ChapSendFrame is created when the network library sends the CHAP frame on the PPP interface. This event displays detailed information about the CHAP protocol header.

Value in the Event Recorder shows:

  • code: Code (CHALLENGE, RESPONSE, SUCCESS, FAILED).
  • id: Identification number.
  • len: Length of the frame including CHAP header in bytes.
__STATIC_INLINE void EvrNetPPP_ChapUninit ( void  )

Event on PPP-CHAP de-initialize (Op)

Remarks
Challenge-Handshake Authentication Protocol

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

Value in the Event Recorder shows:

  • ppp-chap
__STATIC_INLINE void EvrNetPPP_ChapWrongFailureReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-CHAP wrong failure received (Op)

Parameters
idreceived CHAP identifier
id_validvalid CHAP identifier

The event ChapWrongFailureReceived is created when the network library receives the CHAP authentication failure, but the CHAP identification value is not identical to the identification value of our CHAP challenge. The authentication failure is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_ChapWrongResponseReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-CHAP wrong response received (Op)

Parameters
idreceived CHAP identifier
id_validvalid CHAP identifier

The event ChapWrongResponseReceived is created when the network library receives the CHAP authentication response, but the CHAP identification value is not identical to the identification value of our CHAP challenge. The authentication response is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_ChapWrongSuccessReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-CHAP wrong success received (Op)

Parameters
idreceived CHAP identifier
id_validvalid CHAP identifier

The event ChapWrongSuccessReceived is created when the network library receives the CHAP authentication success, but the CHAP identification value is not identical to the identification value of our CHAP challenge. The authentication success is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_ChecksumFailed ( uint32_t  length)

Event on PPP frame checksum check failed (Error)

Parameters
lengthframe length in bytes

The event ChecksumFailed is created when the network library has checked the checksum on the received PPP frame and the verification failed. The PPP frame is therefore discarded.

Value in the Event Recorder shows:

  • len: length of the received frame in bytes.
__STATIC_INLINE void EvrNetPPP_Close ( void  )

Event on PPP close connection (API)

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

Value in the Event Recorder shows:

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

Event on PPP start connecting (API)

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

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

Value in the Event Recorder shows:

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

Event on PPP connect invalid parameter (Error)

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

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_ConnectWrongState ( void  )

Event on PPP connect in wrong state (Error)

The event ConnectWrongState is created when the function netPPP_Connect is executed, but the PPP interface is already connected.

Value in the Event Recorder shows:

  • connected
__STATIC_INLINE void EvrNetPPP_CtrlByteInvalid ( uint8_t  ctrl,
uint8_t  ctrl_valid 
)

Event on PPP frame control byte invalid (Error)

Parameters
ctrlreceived control byte
ctrl_validvalid control byte

The event CtrlByteInvalid is created when the Control field value in the received PPP frame is not valid (should be 3).

Value in the Event Recorder shows:

  • ctrl: received control byte.
  • valid: expected control byte.
__STATIC_INLINE void EvrNetPPP_DataLinkDown ( void  )

Event on PPP data-link layer down (Op)

The event DataLinkDown is created when the network library detects that the PPP data-link connection is not established. This means the LCP protocol is not in open state and all IPCP frames are thus discarded.

Value in the Event Recorder shows:

  • discard
__STATIC_INLINE void EvrNetPPP_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on PPP receive frame too short (Op)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame

The event FrameTooShort is created when the network library receives the frame on the PPP interface that is too short. The PPP 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 EvrNetPPP_GetOptionInvalidParameter ( void  )

Event on PPP 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 PPP interface is executed.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_InitInterface ( void  )

Event on PPP interface initialize (Op)

Remarks
Point-to-Point Protocol

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

Value in the Event Recorder shows:

  • ppp: PPP interface name.
__STATIC_INLINE void EvrNetPPP_InvalidIpVersion ( uint8_t  ip_version)

Event on PPP 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 EvrNetPPP_IpcpInit ( void  )

Event on PPP-IPCP initialize (Op)

Remarks
PPP Internet Protocol Control Protocol

The event IpcpInit is created when the PPP interface is initialized or when the network library wants to shut down or restart the PPP interface. This event indicates that the IPCP protocol is initialized.

Value in the Event Recorder shows:

  • ppp-ipcp
__STATIC_INLINE void EvrNetPPP_IpcpIp4ConfigError ( void  )

Event on PPP-IPCP interface IPv4 configuration error (Error)

The event IpcpIp4ConfigError is created when an error is found in IPv4 configuration for the PPP 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 EvrNetPPP_IpcpIpAddressRejected ( void  )

Event on PPP-IPCP IP-address option rejected (Error)

The event IpcpIpAddressRejected is created when the remote peer has rejected the configuration of the local IP address. This is a critical error and the data-link is terminated.

__STATIC_INLINE void EvrNetPPP_IpcpNetworkLayerUp ( void  )

Event on PPP-IPCP network-layer established (Op)

The event IpcpNetworkLayerUp is created when the network protocol layer is configured. At this point, IPCP negotiations have been completed and we can exchange IP frames.

__STATIC_INLINE void EvrNetPPP_IpcpNotRequestedOption ( uint8_t  ipcp_option)

Event on PPP-IPCP not requested option rejected (Error)

Parameters
ipcp_optionrejected option value

The event IpcpNotRequestedOption is created when the remote peer responds to a configuration option that we did not request. This is a critical error and the data-link is terminated.

Value in the Event Recorder shows:

  • opt: received IPCP configuration option.
__STATIC_INLINE void EvrNetPPP_IpcpOptionIpAddress ( const uint8_t *  ip4_addr)

Event on PPP-IPCP option IP-address (Detail)

Parameters
ip4_addrpointer to IPv4 address

The event IpcpOptionIpAddress is created when the network library wants to display detailed information about the IP address option that is negotiating.

Value in the Event Recorder shows:

  • ip: IPv4 address value.
__STATIC_INLINE void EvrNetPPP_IpcpOptionPrimaryDns ( const uint8_t *  ip4_addr)

Event on PPP-IPCP option primary DNS server address (Detail)

Parameters
ip4_addrpointer to IPv4 address

The event IpcpOptionPrimaryDns is created when the network library wants to display detailed information about the primary DNS server option that is negotiating.

Value in the Event Recorder shows:

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

Event on PPP-IPCP option secondary DNS server address (Detail)

Parameters
ip4_addrpointer to IPv4 address

The event IpcpOptionSecondaryDns is created when the network library wants to display detailed information about the secondary DNS server option that is negotiating.

Value in the Event Recorder shows:

  • sec_dns: IPv4 address of the secondary DNS server.
__STATIC_INLINE void EvrNetPPP_IpcpOptionUnknown ( uint8_t  ipcp_option)

Event on PPP-IPCP unknown option received (Op)

Parameters
ipcp_optionunknown IPCP option

The event IpcpOptionUnknown is created when the IPCP configuration option that is not supported is received. This option is rejected.

Value in the Event Recorder shows:

  • opt: unknown IPCP option.
__STATIC_INLINE void EvrNetPPP_IpcpPrimaryDnsRejected ( void  )

Event on PPP-IPCP primary DNS server option rejected (Op)

The event IpcpPrimaryDnsRejected is created when the remote peer has rejected the configuration of the primary DNS server. Therefore, primary DNS server will not be configured in IPCP negotiation.

__STATIC_INLINE void EvrNetPPP_IpcpReceiveFrame ( const void *  ipcp_header)

Event on PPP-IPCP receive frame (Op)

Parameters
ipcp_headerpointer to IPCP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event IpcpReceiveFrame is created when the network library receives the IPCP frame on the PPP interface. This event displays detailed information about the IPCP protocol header.

Value in the Event Recorder shows:

  • code: Code (CONF_RQ/ACK/NAK/REJ, TERM_RQ/ACK, CODE_REJ).
  • id: Identification number.
  • len: Length of the frame including IPCP header in bytes.
__STATIC_INLINE void EvrNetPPP_IpcpSecondaryDnsRejected ( void  )

Event on PPP-IPCP secondary DNS server option rejected (Op)

The event IpcpSecondaryDnsRejected is created when the remote peer has rejected the configuration of the secondary DNS server. Therefore, secondary DNS server will not be configured in IPCP negotiation.

__STATIC_INLINE void EvrNetPPP_IpcpSendAck ( void  )

Event on PPP-IPCP send acknowledge (Op)

The event IpcpSendAck is created when the network library wants to acknowledge the configuration option. This is done by sending an IPCP acknowledge frame to the remote peer.

__STATIC_INLINE void EvrNetPPP_IpcpSendConfigRequest ( void  )

Event on PPP-IPCP send configuration request (Op)

The event IpcpSendConfigRequest is created when the network library sends a request to configure the internet protocol in the IPCP negotiation process.

The options that are negotiated are:

  • Local IP address
  • Primary DNS server
  • Secondary DNS server

Value in the Event Recorder shows:

  • send
__STATIC_INLINE void EvrNetPPP_IpcpSendFrame ( const void *  ipcp_header)

Event on PPP-IPCP send frame (Op)

Parameters
ipcp_headerpointer to IPCP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event IpcpSendFrame is created when the network library sends the IPCP frame on the PPP interface. This event displays detailed information about the IPCP protocol header.

Value in the Event Recorder shows:

  • code: Code (CONF_RQ/ACK/NAK/REJ, TERM_RQ/ACK, CODE_REJ).
  • id: Identification number.
  • len: Length of the frame including IPCP header in bytes.
__STATIC_INLINE void EvrNetPPP_IpcpSendNak ( void  )

Event on PPP-IPCP send not acknowledge (Op)

The event IpcpSendNak is created when the network library wants to not acknowledge the configuration option. This is done by sending an IPCP not acknowledge frame to the remote peer.

__STATIC_INLINE void EvrNetPPP_IpcpSendReject ( void  )

Event on PPP-IPCP send reject (Op)

The event IpcpSendReject is created when the network library wants to reject the configuration option. This is done by sending an IPCP reject frame to the remote peer.

__STATIC_INLINE void EvrNetPPP_IpcpUninit ( void  )

Event on PPP-IPCP de-initialize (Op)

Remarks
PPP Internet Protocol Control Protocol

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

Value in the Event Recorder shows:

  • ppp-ipcp
__STATIC_INLINE void EvrNetPPP_IpcpWrongAckReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-IPCP wrong acknowledge received (Op)

Parameters
idreceived IPCP identifier
id_validvalid IPCP identifier

The event IpcpWrongAckReceived is created when the network library receives the configuration acknowledge, but the IPCP identification value is not identical to the identification value of our IPCP request. The configuration ack is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_IpcpWrongNakReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-IPCP wrong not-acknowledge received (Op)

Parameters
idreceived IPCP identifier
id_validvalid IPCP identifier

The event IpcpWrongNakReceived is created when the network library receives the configuration not acknowledge, but the IPCP identification value is not identical to the identification value of our IPCP request. The configuration nak is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_IpcpWrongRejectReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-IPCP wrong reject received (Op)

Parameters
idreceived IPCP identifier
id_validvalid IPCP identifier

The event IpcpWrongRejectReceived is created when the network library receives the configuration reject, but the IPCP identification value is not identical to the identification value of our IPCP request. The configuration reject is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_IpcpWrongSubnet ( const uint8_t *  ip4_addr)

Event on PPP-IPCP advertised IP-address not in subnet (Op)

Parameters
ip4_addrpointer to IPv4 address

The event IpcpWrongSubnet is created when the remote peer advertised the IP address which is not in our subnet. This is a critical error and the data-link is terminated.

Value in the Event Recorder shows:

  • ip: advertised IP address.
__STATIC_INLINE void EvrNetPPP_LcpConfigAuthFailed ( void  )

Event on PPP-LCP authentication type negotiation failed (Error)

The event LcpConfigAuthFailed is created when the network library has not negotiated the type of authentication. This is a critical error, and the network library terminates the connection.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_LcpDataLinkUp ( void  )

Event on PPP-LCP data-link layer established (Op)

The event LcpDataLinkUp is created when the network library detects that the PPP data-link connection is established in server mode and needs to be restarted.

__STATIC_INLINE void EvrNetPPP_LcpEchoMagicNumber ( uint32_t  magic_number)

Event on PPP-LCP echo magic number (Op)

Parameters
magic_numberpeer echo magic number

The event LcpEchoMagicNumber is created when the network library wants to display detailed information about the received magic number in the LCP echo request.

Value in the Event Recorder shows:

  • magic_num: peer magic number received in the echo request.
__STATIC_INLINE void EvrNetPPP_LcpInit ( void  )

Event on PPP-LCP initialize (Op)

Remarks
Point-to-Point Link Control Protocol

The event LcpInit is created when the PPP interface is initialized or when the network library wants to shut down or restart the PPP interface. This event indicates that the LCP protocol is initialized.

Value in the Event Recorder shows:

  • ppp-lcp
__STATIC_INLINE void EvrNetPPP_LcpNoRetriesLeft ( void  )

Event on PPP-LCP no retries left for LCP negotiation (Error)

The event LcpNoRetriesLeft is created when all retries are used in the LCP negotiation process. After this event, the PPP interface shuts down.

Value in the Event Recorder shows:

  • retries: 0
__STATIC_INLINE void EvrNetPPP_LcpOptionAcfc ( void  )

Event on PPP-LCP option ACFC (Detail)

The event LcpOptionAcfc is created when the network library wants to inform that the Address and Control Field Compression option is being negotiated.

Value in the Event Recorder shows:

  • enable
__STATIC_INLINE void EvrNetPPP_LcpOptionAuth ( uint16_t  auth_type)

Event on PPP-LCP option authentication type (Op)

Parameters
auth_typeauthentication type code
  • 0xC023: PAP
  • 0xC223: CHAP

The event LcpOptionAuth is created when the network library wants to inform about the type of PPP authentication being negotiated.

Value in the Event Recorder shows:

  • auth_type: authentication type (PAP, CHAP-MD5).
__STATIC_INLINE void EvrNetPPP_LcpOptionAuthChapMd5 ( void  )

Event on PPP-LCP option Authentication CHAP (Detail)

Remarks
Challenge Handshake Authentication Protocol with MD5

The event LcpOptionAuthChapMd5 is created when the network library wants to inform that the CHAP-MD5 authentication option is being negotiated.

Value in the Event Recorder shows:

  • enable
__STATIC_INLINE void EvrNetPPP_LcpOptionAuthChapNotMd5 ( void  )

Event on PPP-LCP option CHAP authentication not MD5 type (Op)

The event LcpOptionAuthChapNotMd5 is created when the remote peer requires a CHAP authentication that is not based on MD5 encryption.

__STATIC_INLINE void EvrNetPPP_LcpOptionAuthPap ( void  )

Event on PPP-LCP option Authentication PAP (Detail)

Remarks
Password Authentication Protocol - plain text

The event LcpOptionAuthPap is created when the network library wants to inform that the PAP authentication option is being negotiated.

Value in the Event Recorder shows:

  • enable
__STATIC_INLINE void EvrNetPPP_LcpOptionCharMap ( uint32_t  char_map)

Event on PPP-LCP option character map (Detail)

Parameters
char_mapcharacter bit-map for non printable characters
  • bit 0: ascii character 0
  • bit 1: ascii character 1
  • bit 2: ascii character 2
  • ...
  • bit 31: ascii character 31

The event LcpOptionCharMap is created when the network library wants to display detailed information about the character mapping option that is negotiating.

Value in the Event Recorder shows:

  • char_map: character mapping in hexadecimal form.
__STATIC_INLINE void EvrNetPPP_LcpOptionMagicNumber ( uint32_t  magic_number)

Event on PPP-LCP option magic number (Detail)

Parameters
magic_numbermagic random number

The event LcpOptionCharMap is created when the network library wants to display detailed information about the magic number option that is negotiating.

Value in the Event Recorder shows:

  • magic_num: 32-bit magic number.
__STATIC_INLINE void EvrNetPPP_LcpOptionMru ( uint16_t  mru_size)

Event on PPP-LCP option MRU (Op)

Parameters
mru_sizemaximum receive unit size

The event LcpOptionMru is created when the network library received the maximum receive unit (MRU) option. This is just an advice for optimum performance. Nevertheless, the interface should accept frames up to 1500 bytes.

Value in the Event Recorder shows:

  • mru: maximum receive unit.
__STATIC_INLINE void EvrNetPPP_LcpOptionPfc ( void  )

Event on PPP-LCP option PFC (Detail)

The event LcpOptionPfc is created when the network library wants to inform that the Protocol Field Compression option is being negotiated.

Value in the Event Recorder shows:

  • enable
__STATIC_INLINE void EvrNetPPP_LcpOptionUnknown ( uint8_t  lcp_option)

Event on PPP-LCP unknown option received (Op)

Parameters
lcp_optionunknown LCP option value

The event LcpOptionUnknown is created when the LCP configuration option that is not supported is received. This option is rejected.

Value in the Event Recorder shows:

  • opt: unknown LCP option.
__STATIC_INLINE void EvrNetPPP_LcpReceiveFrame ( const void *  lcp_header)

Event on PPP-LCP receive frame (Op)

Parameters
lcp_headerpointer to LCP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event LcpReceiveFrame is created when the network library receives the LCP frame on the PPP interface. This event displays detailed information about the LCP protocol header.

Value in the Event Recorder shows:

  • code: Code (CONF_RQ/ACK/NAK/REJ, TERM_RQ/ACK, CODE_REJ, PROT_REJ, ECHO_RQ/REP, DISC_RQ).
  • id: Identification number.
  • len: Length of the frame including LCP header in bytes.
__STATIC_INLINE void EvrNetPPP_LcpSendAck ( void  )

Event on PPP-LCP send acknowledge (Op)

The event LcpSendAck is created when the network library wants to acknowledge the configuration option. This is done by sending a LCP acknowledge frame to the remote peer.

__STATIC_INLINE void EvrNetPPP_LcpSendConfigRequest ( void  )

Event on PPP-LCP send configuration request (Op)

The event LcpSendConfigRequest is created when the network library sends a request to configure the LCP in the LCP negotiation process. This event can be repeated several times before the LCP negotiation ends and the LCP goes into the open state.

The options that are negotiated are:

  • Async control character map (ASYNC)
  • Protocol field compression (PFC)
  • Address and Control field compression (ACFC)
  • Magic number
  • Authentication protocol (PAP or CHAP)

Value in the Event Recorder shows:

  • send
__STATIC_INLINE void EvrNetPPP_LcpSendEchoReply ( void  )

Event on PPP-LCP send echo reply (Op)

The event LcpSendEchoReply is created when the network library receives the LCP echo request, and wants to send the LCP echo reply.

__STATIC_INLINE void EvrNetPPP_LcpSendEchoRequest ( uint32_t  magic_number)

Event on PPP-LCP send echo request (Op)

Parameters
magic_numbermagic random number

The event LcpSendEchoRequest is created when the network library wants to verify if the remote peer is still connected. This is done by sending the LCP echo request to the remote peer.

Value in the Event Recorder shows:

  • magic_num: local magic number built into the echo request.
__STATIC_INLINE void EvrNetPPP_LcpSendFrame ( const void *  lcp_header)

Event on PPP-LCP send frame (Op)

Parameters
lcp_headerpointer to LCP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event LcpSendFrame is created when the network library sends the LCP frame on the PPP interface. This event displays detailed information about the LCP protocol header.

Value in the Event Recorder shows:

  • code: Code (CONF_RQ/ACK/NAK/REJ, TERM_RQ/ACK, CODE_REJ, PROT_REJ, ECHO_RQ/REP, DISC_RQ).
  • id: Identification number.
  • len: Length of the frame including LCP header in bytes.
__STATIC_INLINE void EvrNetPPP_LcpSendNak ( void  )

Event on PPP-LCP send not acknowledge (Op)

The event LcpSendNak is created when the network library wants to not acknowledge the configuration option. This is done by sending a LCP not acknowledge frame to the remote peer.

__STATIC_INLINE void EvrNetPPP_LcpSendReject ( void  )

Event on PPP-LCP send reject (Op)

The event LcpSendReject is created when the network library wants to reject the configuration option. This is done by sending a LCP reject frame to the remote peer.

__STATIC_INLINE void EvrNetPPP_LcpSendTerminateAck ( void  )

Event on PPP-LCP send terminate acknowledge (Op)

The event LcpSendTerminateAck is created when the network library receives the LCP terminate request, and wants to send the LCP terminate acknowledge.

__STATIC_INLINE void EvrNetPPP_LcpSendTerminateRequest ( void  )

Event on PPP-LCP send LCP terminate request (Op)

The event LcpSendTerminateRequest is created when the network library wants to close the data-link connection. This is done by sending the LCP terminate request to the remote peer.

__STATIC_INLINE void EvrNetPPP_LcpUninit ( void  )

Event on PPP-LCP de-initialize (Op)

Remarks
Point-to-Point Link Control Protocol

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

Value in the Event Recorder shows:

  • ppp-lcp
__STATIC_INLINE void EvrNetPPP_LcpWrongAckReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-LCP wrong acknowledge received (Op)

Parameters
idreceived LCP identifier
id_validvalid LCP identifier

The event LcpWrongAckReceived is created when the network library receives the configuration acknowledge, but the LCP identification value is not identical to the identification value of our LCP request. The configuration ack is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_LcpWrongEchoReplyReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-LCP wrong echo reply received (Op)

Parameters
idreceived LCP identifier
id_validvalid LCP identifier

The event LcpWrongEchoReplyReceived is created when the network library receives the LCP echo reply, but the LCP identification value or LCP magic number are not identical to ours. The echo reply is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_LcpWrongNakReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-LCP wrong not-acknowledge received (Op)

Parameters
idreceived LCP identifier
id_validvalid LCP identifier

The event LcpWrongNakReceived is created when the network library receives the configuration not acknowledge, but the LCP identification value is not identical to the identification value of our LCP request. The configuration nak is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_LcpWrongPeerMagicNumber ( uint32_t  magic,
uint32_t  magic_valid 
)

Event on PPP-LCP wrong peer magic number (Op)

Parameters
magicreceived peer magic number
magic_validvalid peer magic number

The event LcpWrongPeerMagicNumber is created when the network library receives the LCP echo request, but received magic number is not the same magic number from the LCP negotiation. The LCP echo request is therefore ignored.

Value in the Event Recorder shows:

  • magic_num: received peer magic number.
  • valid: expected peer magic number.
__STATIC_INLINE void EvrNetPPP_LcpWrongRejectReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-LCP wrong reject received (Op)

Parameters
idreceived LCP identifier
id_validvalid LCP identifier

The event LcpWrongRejectReceived is created when the network library receives the configuration reject, but the LCP identification value is not identical to the identification value of our LCP request. The configuration reject is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_Listen ( void  )

Event on PPP start listening (API)

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

Value in the Event Recorder shows:

  • start
__STATIC_INLINE void EvrNetPPP_ListenInvalidParameter ( void  )

Event on PPP listen invalid parameter (Error)

The event ListenInvalidParameter is created when invalid input parameter is provided for the netPPP_Listen function.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_ListenWrongState ( void  )

Event on PPP listen in wrong state (Error)

The event ListenWrongState is created when the function netPPP_Listen is executed, but the PPP interface is already connected.

Value in the Event Recorder shows:

  • connected
__STATIC_INLINE void EvrNetPPP_ModemOffline ( void  )

Event on PPP 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 EvrNetPPP_NetworkLayerDown ( void  )

Event on PPP network layer down (Error)

The event NetworkLayerDown is created when the internal send_frame function wants to send an IP frame, but the state of the PPP network layer is down. This means the NCP has not configured the network protocol layer yet. Therefore, the IP frame is not sent.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_NoMemoryError ( void  )

Event on PPP 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 PPP interface, but no memory is available. Therefore, the frame is not sent.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_PapInit ( void  )

Event on PPP-PAP initialize (Op)

Remarks
Password Authentication Protocol

The event PapInit is created when the PPP interface is initialized or when the network library wants to shut down or restart the PPP interface. This event indicates that the PAP authentication protocol is initialized.

Value in the Event Recorder shows:

  • ppp-pap
__STATIC_INLINE void EvrNetPPP_PapLoginFailed ( void  )

Event on PPP-PAP login failed (Error)

The event PapLoginFailed is created when the user authentication failed.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_PapLoginSuccess ( void  )

Event on PPP-PAP login success (Op)

The event PapLoginSuccess is created when the user is successfully authenticated using the PAP protocol.

Value in the Event Recorder shows:

  • succes
__STATIC_INLINE void EvrNetPPP_PapReceiveFrame ( const void *  pap_header)

Event on PPP-PAP receive frame (Op)

Parameters
pap_headerpointer to PAP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event PapReceiveFrame is created when the network library receives the PAP frame on the PPP interface. This event displays detailed information about the PAP protocol header.

Value in the Event Recorder shows:

  • code: Code (AUTH_RQ, AUTH_ACK, AUTH_NAK).
  • id: Identification number.
  • len: Length of the frame including PAP header in bytes.
__STATIC_INLINE void EvrNetPPP_PapSendAuthRequest ( const char *  peer_id,
uint32_t  length 
)

Event on PPP-PAP send authentication request (Op)

Parameters
peer_idpeer identifier string (username)
lengthlength of the peer_id string

The event PapSendAuthRequest is created when the network library wants to send the PAP authentication request in client mode. The username is provided when the functions netPPP_Connect or netPPP_Listen are executed.

Value in the Event Recorder shows:

  • peer_id: peer identification value.
__STATIC_INLINE void EvrNetPPP_PapSendFrame ( const void *  pap_header)

Event on PPP-PAP send frame (Op)

Parameters
pap_headerpointer to PAP frame header of 4 bytes
  • Code (1 byte)
  • Id (1 byte)
  • Len (2 bytes)

The event PapSendFrame is created when the network library sends the PAP frame on the PPP interface. This event displays detailed information about the PAP protocol header.

Value in the Event Recorder shows:

  • code: Code (AUTH_RQ, AUTH_ACK, AUTH_NAK).
  • id: Identification number.
  • len: Length of the frame including PAP header in bytes.
__STATIC_INLINE void EvrNetPPP_PapShowPassword ( const char *  password,
uint32_t  length 
)

Event on PPP-PAP display password (Op)

Parameters
passwordauthentication password
lengthlength of authentication password

The event PapShowPassword is created when the network library wants to display the password that is used in PAP authentication request. The password is provided when the functions netPPP_Connect or netPPP_Listen are executed.

Value in the Event Recorder shows:

  • password: password for the PAP authentication.
__STATIC_INLINE void EvrNetPPP_PapUninit ( void  )

Event on PPP-PAP de-initialize (Op)

Remarks
Password Authentication Protocol

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

Value in the Event Recorder shows:

  • ppp-pap
__STATIC_INLINE void EvrNetPPP_PapWrongAckReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-PAP wrong acknowledge received (Op)

Parameters
idreceived PAP identifier
id_validvalid PAP identifier

The event PapWrongAckReceived is created when the network library receives the authentication acknowledge, but the PAP identification value is not identical to the identification value of our PAP request. The authentication ack is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_PapWrongNakReceived ( uint8_t  id,
uint8_t  id_valid 
)

Event on PPP-PAP wrong not-acknowledge received (Op)

Parameters
idreceived PAP identifier
id_validvalid PAP identifier

The event PapWrongNakReceived is created when the network library receives the authentication not acknowledge, but the PAP identification value is not identical to the identification value of our PAP request. The authentication nak is therefore ignored.

Value in the Event Recorder shows:

  • id: received identification number.
  • valid: expected identification number.
__STATIC_INLINE void EvrNetPPP_QueueAddTransmit ( void  )

Event on PPP 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 PPP interface. The transmit queue is processed and frames are transmitted in the PPP interface thread.

Value in the Event Recorder shows:

  • success
__STATIC_INLINE void EvrNetPPP_ReceiveFrame ( uint16_t  protocol,
uint32_t  length 
)

Event on PPP receive frame (Op)

Parameters
protocolPPP protocol type
  • 0xC021: LCP
  • 0xC023: PAP
  • 0xC223: CHAP
  • 0x8021: IPCP
  • 0x0021: IP
lengthframe length in bytes

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

Value in the Event Recorder shows:

  • proto: protocol type (LCP, PAP, CHAP, IPCP, IP).
  • len: length of the received PPP frame in bytes.
__STATIC_INLINE void EvrNetPPP_RejectCode ( uint16_t  protocol,
uint8_t  code 
)

Event on PPP reject unsupported cp code (Op)

Parameters
protocolPPP protocol type
  • 0xC021: LCP
  • 0x8021: IPCP
codeunsupported control code

The event RejectCode is created when the network library rejects the control code that is not supported.

Value in the Event Recorder shows:

  • code: rejected control code.
  • proto: protocol type for which the control code is rejected (LCP, IPCP).
__STATIC_INLINE void EvrNetPPP_RejectProtocol ( uint16_t  protocol)

Event on PPP reject unsupported protocol type (Op)

Parameters
protocolunsupported protocol type

The event RejectProtocol is created when the network library rejects the type of PPP protocol that is not supported. This event is also generated when the PPP protocol type is supported, but in the current state of the PPP is not allowed.

Value in the Event Recorder shows:

  • proto: rejected protocol type.
__STATIC_INLINE void EvrNetPPP_SendDataTooLarge ( uint32_t  length,
uint32_t  max_length 
)

Event on PPP 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 PPP 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 EvrNetPPP_SendFrame ( uint16_t  protocol,
uint32_t  length 
)

Event on PPP send frame (Op)

Parameters
protocolPPP protocol type
  • 0xC021: LCP
  • 0xC023: PAP
  • 0xC223: CHAP
  • 0x8021: IPCP
  • 0x0021: IP
lengthframe length in bytes

The event SendFrame is created when the PPP frame header is constructed and the frame is sent for transmission.

Value in the Event Recorder shows:

  • proto: protocol type (LCP, PAP, CHAP, IPCP, IP).
  • len: length of the frame to send in bytes.
__STATIC_INLINE void EvrNetPPP_SetIp4Address ( const uint8_t *  ip4_addr)

Event on PPP 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 PPP interface. This happens when the function netIF_SetOption for the PPP interface is executed.

Value in the Event Recorder shows:

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

Event on PPP set interface MTU (Op)

Parameters
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 PPP interface. This happens when the function netIF_SetOption for the PPP interface is executed.

Value in the Event Recorder shows:

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

Event on PPP 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 PPP interface. This happens when the function netIF_SetOption for the PPP interface is executed.

Value in the Event Recorder shows:

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

Event on PPP 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 PPP interface. This happens when the function netIF_SetOption for the PPP interface is executed.

Value in the Event Recorder shows:

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

Event on PPP 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 PPP interface is executed.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetPPP_ShowPassword ( const char *  password,
uint32_t  length 
)

Event on PPP display password (Op)

Parameters
passwordpointer to a password string
lengthlength of the password string

The event ShowPassword is created when the network library wants to display the password that is used in the netPPP_Connect and netPPP_Listen to authenticate user.

Value in the Event Recorder shows:

  • password: password for the PPP access.
__STATIC_INLINE void EvrNetPPP_ShowUsername ( const char *  username,
uint32_t  length 
)

Event on PPP display username (Op)

Parameters
usernamepointer to a username string
lengthlength of the username string

The event ShowUsername is created when the network library wants to display the user name that is used in the netPPP_Connect and netPPP_Listen to authenticate user.

Value in the Event Recorder shows:

  • username: user name for the PPP access.
__STATIC_INLINE void EvrNetPPP_ThreadCreateFailed ( void  )

Event on PPP thread create failed (Error)

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

Value in the Event Recorder shows:

  • thread: netPPP_Thread.
__STATIC_INLINE void EvrNetPPP_UninitInterface ( void  )

Event on PPP interface de-initialize (Op)

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

Value in the Event Recorder shows:

  • ppp: PPP interface name.