Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

lcp.c File Reference
Functions | Variables

lcp.c File Reference

LCP (PPP Link Control Protocol) More...

Go to the source code of this file.

Functions

error_t lcpOpen (PppContext *context)
 LCP Open event.
error_t lcpClose (PppContext *context)
 LCP Close event.
void lcpTick (PppContext *context)
 LCP timer handler.
void lcpProcessPacket (PppContext *context, const PppPacket *packet, size_t length)
 Process an incoming LCP packet.
error_t lcpProcessConfigureReq (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Process Configure-Request packet.
error_t lcpProcessConfigureAck (PppContext *context, const PppConfigurePacket *configureAckPacket)
 Process Configure-Ack packet.
error_t lcpProcessConfigureNak (PppContext *context, const PppConfigurePacket *configureNakPacket)
 Process Configure-Nak packet.
error_t lcpProcessConfigureReject (PppContext *context, const PppConfigurePacket *configureRejPacket)
 Process Configure-Reject packet.
error_t lcpProcessTerminateReq (PppContext *context, const PppTerminatePacket *terminateReqPacket)
 Process Terminate-Request packet.
error_t lcpProcessTerminateAck (PppContext *context, const PppTerminatePacket *terminateAckPacket)
 Process Terminate-Ack packet.
error_t lcpProcessCodeRej (PppContext *context, const PppCodeRejPacket *codeRejPacket)
 Process Code-Reject packet.
error_t lcpProcessProtocolRej (PppContext *context, const PppProtocolRejPacket *protocolRejPacket)
 Process Protocol-Reject packet.
error_t lcpProcessEchoReq (PppContext *context, const PppEchoPacket *echoReqPacket)
 Process Echo-Request packet.
error_t lcpProcessEchoRep (PppContext *context, const PppEchoPacket *echoRepPacket)
 Process Echo-Reply packet.
error_t lcpProcessDiscardReq (PppContext *context, const PppDiscardReqPacket *discardReqPacket)
 Process Discard-Request packet.
error_t lcpProcessUnknownCode (PppContext *context, const PppPacket *packet)
 Process packet with unknown code.
error_t lcpProcessUnknownProtocol (PppContext *context, uint16_t protocol, const uint8_t *information, size_t length)
 Process PPP frame with unknown protocol.
void lcpThisLayerUp (PppContext *context)
 This-Layer-Up callback function.
void lcpThisLayerDown (PppContext *context)
 This-Layer-Down callback function.
void lcpThisLayerStarted (PppContext *context)
 This-Layer-Started callback function.
void lcpThisLayerFinished (PppContext *context)
 This-Layer-Finished callback function.
void lcpInitRestartCount (PppContext *context, uint_t value)
 Initialize-Restart-Count callback function.
void lcpZeroRestartCount (PppContext *context)
 Zero-Restart-Count callback function.
error_t lcpSendConfigureReq (PppContext *context)
 Send-Configure-Request callback function.
error_t lcpSendConfigureAck (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Ack callback function.
error_t lcpSendConfigureNak (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Nak callback function.
error_t lcpSendConfigureRej (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Reject callback function.
error_t lcpSendTerminateReq (PppContext *context)
 Send-Terminate-Request callback function.
error_t lcpSendTerminateAck (PppContext *context, const PppTerminatePacket *terminateReqPacket)
 Send-Terminate-Ack callback function.
error_t lcpSendCodeRej (PppContext *context, const PppPacket *packet)
 Send-Code-Reject callback function.
error_t lcpSendEchoRep (PppContext *context, const PppEchoPacket *echoReqPacket)
 Send-Echo-Reply callback function.
error_t lcpParseOption (PppContext *context, PppOption *option, size_t inPacketLen, PppConfigurePacket *outPacket)
 Parse LCP configuration option.
error_t lcpParseMruOption (PppContext *context, LcpMruOption *option, PppConfigurePacket *outPacket)
 Parse Maximum-Receive-Unit option.
error_t lcpParseAccmOption (PppContext *context, LcpAccmOption *option, PppConfigurePacket *outPacket)
 Parse Async-Control-Character-Map option.
error_t lcpParseAuthProtocolOption (PppContext *context, LcpAuthProtocolOption *option, PppConfigurePacket *outPacket)
 Parse Authentication-Protocol option.
error_t lcpParseMagicNumberOption (PppContext *context, LcpMagicNumberOption *option, PppConfigurePacket *outPacket)
 Parse Magic-Number option.
error_t lcpParsePfcOption (PppContext *context, LcpPfcOption *option, PppConfigurePacket *outPacket)
 Parse Protocol-Field-Compression option.
error_t lcpParseAcfcOption (PppContext *context, LcpAcfcOption *option, PppConfigurePacket *outPacket)
 Parse Address-and-Control-Field-Compression option.

Variables

const PppCallbacks lcpCallbacks
 LCP FSM callbacks.

Detailed Description

LCP (PPP Link Control Protocol)

License

Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author:
Oryx Embedded SARL (www.oryx-embedded.com)
Version:
1.7.6

Definition in file lcp.c.

Function Documentation

error_t lcpClose ( PppContext *  context )

LCP Close event.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 101 of file lcp.c.

void lcpInitRestartCount ( PppContext *  context,
uint_t  value 
)

Initialize-Restart-Count callback function.

Parameters:
[in]contextPPP context
[in]valueRestart counter value

Definition at line 986 of file lcp.c.

error_t lcpOpen ( PppContext *  context )

LCP Open event.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 77 of file lcp.c.

error_t lcpParseAccmOption ( PppContext *  context,
LcpAccmOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Async-Control-Character-Map option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 1456 of file lcp.c.

error_t lcpParseAcfcOption ( PppContext *  context,
LcpAcfcOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Address-and-Control-Field-Compression option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 1733 of file lcp.c.

error_t lcpParseAuthProtocolOption ( PppContext *  context,
LcpAuthProtocolOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Authentication-Protocol option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 1500 of file lcp.c.

error_t lcpParseMagicNumberOption ( PppContext *  context,
LcpMagicNumberOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Magic-Number option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 1646 of file lcp.c.

error_t lcpParseMruOption ( PppContext *  context,
LcpMruOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Maximum-Receive-Unit option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 1390 of file lcp.c.

error_t lcpParseOption ( PppContext *  context,
PppOption *  option,
size_t  inPacketLen,
PppConfigurePacket *  outPacket 
)

Parse LCP configuration option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[in]inPacketLenRemaining bytes to process in the incoming packet
[out]outPacketPointer to the Configure-Ack, Nak or Reject packet
Returns:
Error code

Definition at line 1318 of file lcp.c.

error_t lcpParsePfcOption ( PppContext *  context,
LcpPfcOption *  option,
PppConfigurePacket *  outPacket 
)

Parse Protocol-Field-Compression option.

Parameters:
[in]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns:
Error code

Definition at line 1690 of file lcp.c.

error_t lcpProcessCodeRej ( PppContext *  context,
const PppCodeRejPacket *  codeRejPacket 
)

Process Code-Reject packet.

Parameters:
[in]contextPPP context
[in]codeRejPacketPacket received from the peer
Returns:
Error code

Definition at line 633 of file lcp.c.

error_t lcpProcessConfigureAck ( PppContext *  context,
const PppConfigurePacket *  configureAckPacket 
)

Process Configure-Ack packet.

Parameters:
[in]contextPPP context
[in]configureAckPacketPacket received from the peer
Returns:
Error code

Definition at line 343 of file lcp.c.

error_t lcpProcessConfigureNak ( PppContext *  context,
const PppConfigurePacket *  configureNakPacket 
)

Process Configure-Nak packet.

Parameters:
[in]contextPPP context
[in]configureNakPacketPacket received from the peer
Returns:
Error code

Definition at line 369 of file lcp.c.

error_t lcpProcessConfigureReject ( PppContext *  context,
const PppConfigurePacket *  configureRejPacket 
)

Process Configure-Reject packet.

Parameters:
[in]contextPPP context
[in]configureRejPacketPacket received from the peer
Returns:
Error code

Definition at line 490 of file lcp.c.

error_t lcpProcessConfigureReq ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Process Configure-Request packet.

Parameters:
[in]contextPPP context
[in]configureReqPacketPacket received from the peer
Returns:
Error code

Definition at line 247 of file lcp.c.

error_t lcpProcessDiscardReq ( PppContext *  context,
const PppDiscardReqPacket *  discardReqPacket 
)

Process Discard-Request packet.

Parameters:
[in]contextPPP context
[in]discardReqPacketPacket received from the peer
Returns:
Error code

Definition at line 786 of file lcp.c.

error_t lcpProcessEchoRep ( PppContext *  context,
const PppEchoPacket *  echoRepPacket 
)

Process Echo-Reply packet.

Parameters:
[in]contextPPP context
[in]echoRepPacketPacket received from the peer
Returns:
Error code

Definition at line 768 of file lcp.c.

error_t lcpProcessEchoReq ( PppContext *  context,
const PppEchoPacket *  echoReqPacket 
)

Process Echo-Request packet.

Parameters:
[in]contextPPP context
[in]echoReqPacketPacket received from the peer
Returns:
Error code

Definition at line 745 of file lcp.c.

void lcpProcessPacket ( PppContext *  context,
const PppPacket *  packet,
size_t  length 
)

Process an incoming LCP packet.

Parameters:
[in]contextPPP context
[in]packetLCP packet received from the peer
[in]lengthLength of the packet, in bytes

Definition at line 153 of file lcp.c.

error_t lcpProcessProtocolRej ( PppContext *  context,
const PppProtocolRejPacket *  protocolRejPacket 
)

Process Protocol-Reject packet.

Parameters:
[in]contextPPP context
[in]protocolRejPacketPacket received from the peer
Returns:
Error code

Definition at line 680 of file lcp.c.

error_t lcpProcessTerminateAck ( PppContext *  context,
const PppTerminatePacket *  terminateAckPacket 
)

Process Terminate-Ack packet.

Parameters:
[in]contextPPP context
[in]terminateAckPacketPacket received from the peer
Returns:
Error code

Definition at line 610 of file lcp.c.

error_t lcpProcessTerminateReq ( PppContext *  context,
const PppTerminatePacket *  terminateReqPacket 
)

Process Terminate-Request packet.

Parameters:
[in]contextPPP context
[in]terminateReqPacketPacket received from the peer
Returns:
Error code

Definition at line 588 of file lcp.c.

error_t lcpProcessUnknownCode ( PppContext *  context,
const PppPacket *  packet 
)

Process packet with unknown code.

Parameters:
[in]contextPPP context
[in]packetUn-interpretable packet received from the peer
Returns:
Error code

Definition at line 804 of file lcp.c.

error_t lcpProcessUnknownProtocol ( PppContext *  context,
uint16_t  protocol,
const uint8_t *  information,
size_t  length 
)

Process PPP frame with unknown protocol.

Parameters:
[in]contextPPP context
[in]protocolRejected protocol
[in]informationRejected information
[in]lengthLength of the rejected information
Returns:
Error code

Definition at line 828 of file lcp.c.

error_t lcpSendCodeRej ( PppContext *  context,
const PppPacket *  packet 
)

Send-Code-Reject callback function.

Parameters:
[in]contextPPP context
[in]packetUn-interpretable packet received from the peer
Returns:
Error code

Definition at line 1279 of file lcp.c.

error_t lcpSendConfigureAck ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Send-Configure-Ack callback function.

Parameters:
[in]contextPPP context
[in]configureReqPacketConfigure-Request packet received from the peer
Returns:
Error code

Definition at line 1157 of file lcp.c.

error_t lcpSendConfigureNak ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Send-Configure-Nak callback function.

Parameters:
[in]contextPPP context
[in]configureReqPacketConfigure-Request packet received from the peer
Returns:
Error code

Definition at line 1176 of file lcp.c.

error_t lcpSendConfigureRej ( PppContext *  context,
const PppConfigurePacket *  configureReqPacket 
)

Send-Configure-Reject callback function.

Parameters:
[in]contextPPP context
[in]configureReqPacketConfigure-Request packet received from the peer
Returns:
Error code

Definition at line 1195 of file lcp.c.

error_t lcpSendConfigureReq ( PppContext *  context )

Send-Configure-Request callback function.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 1022 of file lcp.c.

error_t lcpSendEchoRep ( PppContext *  context,
const PppEchoPacket *  echoReqPacket 
)

Send-Echo-Reply callback function.

Parameters:
[in]contextPPP context
[in]echoReqPacketEcho-Request packet received from the peer
Returns:
Error code

Definition at line 1299 of file lcp.c.

error_t lcpSendTerminateAck ( PppContext *  context,
const PppTerminatePacket *  terminateReqPacket 
)

Send-Terminate-Ack callback function.

Parameters:
[in]contextPPP context
[in]terminateReqPacketTerminate-Request packet received from the peer
Returns:
Error code

Definition at line 1245 of file lcp.c.

error_t lcpSendTerminateReq ( PppContext *  context )

Send-Terminate-Request callback function.

Parameters:
[in]contextPPP context
Returns:
Error code

Definition at line 1213 of file lcp.c.

void lcpThisLayerDown ( PppContext *  context )

This-Layer-Down callback function.

Parameters:
[in]contextPPP context

Definition at line 919 of file lcp.c.

void lcpThisLayerFinished ( PppContext *  context )

This-Layer-Finished callback function.

Parameters:
[in]contextPPP context

Definition at line 965 of file lcp.c.

void lcpThisLayerStarted ( PppContext *  context )

This-Layer-Started callback function.

Parameters:
[in]contextPPP context

Definition at line 953 of file lcp.c.

void lcpThisLayerUp ( PppContext *  context )

This-Layer-Up callback function.

Parameters:
[in]contextPPP context

Definition at line 856 of file lcp.c.

void lcpTick ( PppContext *  context )

LCP timer handler.

This routine must be periodically called by the TCP/IP stack to manage retransmissions

Parameters:
[in]contextPPP context

Definition at line 123 of file lcp.c.

void lcpZeroRestartCount ( PppContext *  context )

Zero-Restart-Count callback function.

Parameters:
[in]contextPPP context

Definition at line 1001 of file lcp.c.

Variable Documentation

const PppCallbacks lcpCallbacks
Initial value:
{
   lcpThisLayerUp,
   lcpThisLayerDown,
   lcpThisLayerStarted,
   lcpThisLayerFinished,
   lcpInitRestartCount,
   lcpZeroRestartCount,
   lcpSendConfigureReq,
   lcpSendConfigureAck,
   lcpSendConfigureNak,
   lcpSendConfigureRej,
   lcpSendTerminateReq,
   lcpSendTerminateAck,
   lcpSendCodeRej,
   lcpSendEchoRep
}

LCP FSM callbacks.

Definition at line 52 of file lcp.c.

Generated on Tue Jul 12 2022 17:10:20 by  doxygen 1.7.2