lcp.h File Reference

LCP (PPP Link Control Protocol) More...

#include "core/net.h"
#include "ppp/ppp.h"

Go to the source code of this file.

Typedefs

struct {
   uint8_t   type
 
   uint8_t   length
 
   uint16_t   mru
 
LcpMruOption
 Maximum-Receive-Unit option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   uint32_t   accm
 
LcpAccmOption
 Async-Control-Character-Map option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   uint16_t   protocol
 
   uint8_t   data []
 
LcpAuthProtocolOption
 Authentication-Protocol option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   uint16_t   protocol
 
   uint8_t   data []
 
LcpQualityProtocolOption
 Quality-Protocol option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   uint32_t   magicNumber
 
LcpMagicNumberOption
 Magic-Number option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
LcpPfcOption
 Protocol-Field-Compression option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
LcpAcfcOption
 Address-and-Control-Field-Compression option. More...
 

Enumerations

enum  LcpOptionType {
  LCP_OPTION_MRU = 1, LCP_OPTION_ACCM = 2, LCP_OPTION_AUTH_PROTOCOL = 3, LCP_OPTION_QUALITY_PROTOCOL = 4,
  LCP_OPTION_MAGIC_NUMBER = 5, LCP_OPTION_PFC = 7, LCP_OPTION_ACFC = 8
}
 LCP option types. More...
 

Functions

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

Detailed Description

LCP (PPP Link Control Protocol)

License

Copyright (C) 2010-2018 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.9.0

Definition in file lcp.h.

Typedef Documentation

◆ LcpAccmOption

typedef { ... } LcpAccmOption

Async-Control-Character-Map option.

◆ LcpAcfcOption

typedef { ... } LcpAcfcOption

Address-and-Control-Field-Compression option.

◆ LcpAuthProtocolOption

typedef { ... } LcpAuthProtocolOption

Authentication-Protocol option.

◆ LcpMagicNumberOption

typedef { ... } LcpMagicNumberOption

Magic-Number option.

◆ LcpMruOption

typedef { ... } LcpMruOption

Maximum-Receive-Unit option.

◆ LcpPfcOption

typedef { ... } LcpPfcOption

Protocol-Field-Compression option.

◆ LcpQualityProtocolOption

typedef { ... } LcpQualityProtocolOption

Quality-Protocol option.

Enumeration Type Documentation

◆ LcpOptionType

LCP option types.

Enumerator
LCP_OPTION_MRU 

Maximum-Receive-Unit.

LCP_OPTION_ACCM 

Async-Control-Character-Map.

LCP_OPTION_AUTH_PROTOCOL 

Authentication-Protocol.

LCP_OPTION_QUALITY_PROTOCOL 

Quality-Protocol.

LCP_OPTION_MAGIC_NUMBER 

Magic-Number.

LCP_OPTION_PFC 

Protocol-Field-Compression.

LCP_OPTION_ACFC 

Address-and-Control-Field-Compression.

Definition at line 46 of file lcp.h.

Function Documentation

◆ lcpClose()

error_t lcpClose ( PppContext context)

LCP Close event.

Parameters
[in]contextPPP context
Returns
Error code

Definition at line 101 of file lcp.c.

◆ lcpInitRestartCount()

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.

◆ lcpOpen()

error_t lcpOpen ( PppContext context)

LCP Open event.

Parameters
[in]contextPPP context
Returns
Error code

Definition at line 77 of file lcp.c.

◆ lcpParseAccmOption()

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.

◆ lcpParseAcfcOption()

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.

◆ lcpParseAuthProtocolOption()

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.

◆ lcpParseMagicNumberOption()

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.

◆ lcpParseMruOption()

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.

◆ lcpParseOption()

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.

◆ lcpParsePfcOption()

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.

◆ lcpProcessCodeRej()

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.

◆ lcpProcessConfigureAck()

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.

◆ lcpProcessConfigureNak()

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.

◆ lcpProcessConfigureReject()

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.

◆ lcpProcessConfigureReq()

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.

◆ lcpProcessDiscardReq()

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.

◆ lcpProcessEchoRep()

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.

◆ lcpProcessEchoReq()

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.

◆ lcpProcessPacket()

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.

◆ lcpProcessProtocolRej()

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.

◆ lcpProcessTerminateAck()

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.

◆ lcpProcessTerminateReq()

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.

◆ lcpProcessUnknownCode()

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.

◆ lcpProcessUnknownProtocol()

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.

◆ lcpSendCodeRej()

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.

◆ lcpSendConfigureAck()

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.

◆ lcpSendConfigureNak()

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.

◆ lcpSendConfigureRej()

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.

◆ lcpSendConfigureReq()

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.

◆ lcpSendEchoRep()

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.

◆ lcpSendTerminateAck()

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.

◆ lcpSendTerminateReq()

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.

◆ lcpThisLayerDown()

void lcpThisLayerDown ( PppContext context)

This-Layer-Down callback function.

Parameters
[in]contextPPP context

Definition at line 919 of file lcp.c.

◆ lcpThisLayerFinished()

void lcpThisLayerFinished ( PppContext context)

This-Layer-Finished callback function.

Parameters
[in]contextPPP context

Definition at line 965 of file lcp.c.

◆ lcpThisLayerStarted()

void lcpThisLayerStarted ( PppContext context)

This-Layer-Started callback function.

Parameters
[in]contextPPP context

Definition at line 953 of file lcp.c.

◆ lcpThisLayerUp()

void lcpThisLayerUp ( PppContext context)

This-Layer-Up callback function.

Parameters
[in]contextPPP context

Definition at line 856 of file lcp.c.

◆ lcpTick()

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.

◆ lcpZeroRestartCount()

void lcpZeroRestartCount ( PppContext context)

Zero-Restart-Count callback function.

Parameters
[in]contextPPP context

Definition at line 1001 of file lcp.c.

Variable Documentation

◆ accm

uint32_t accm

Definition at line 84 of file lcp.h.

◆ data

uint8_t data[]

Definition at line 97 of file lcp.h.

◆ length

uint8_t length

Definition at line 71 of file lcp.h.

◆ magicNumber

uint32_t magicNumber

Definition at line 122 of file lcp.h.

◆ mru

uint16_t mru

Definition at line 72 of file lcp.h.

◆ protocol

uint16_t protocol

Definition at line 96 of file lcp.h.

◆ type

uint8_t type

Definition at line 70 of file lcp.h.