LCP (PPP Link Control Protocol) More...

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

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

Variables
typedef	__packed_struct
	Maximum-Receive-Unit option. More...

uint8_t	length

uint16_t	mru

	LcpMruOption

uint32_t	accm

	LcpAccmOption

uint16_t	protocol

uint8_t	data []

	LcpAuthProtocolOption

	LcpQualityProtocolOption

uint32_t	magicNumber

	LcpMagicNumberOption

	LcpPfcOption

	LcpAcfcOption

Detailed Description

LCP (PPP Link Control Protocol)

License

SPDX-License-Identifier: GPL-2.0-or-later

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: 2.4.0

Definition in file lcp.h.

Enumeration Type Documentation

◆ LcpOptionType

enum 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 48 of file lcp.h.

Function Documentation

◆ lcpClose()

error_t lcpClose ( PppContext * context )

LCP Close event.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 103 of file lcp.c.

◆ lcpInitRestartCount()

void lcpInitRestartCount	(	PppContext *	context,
		uint_t	value
	)

Initialize-Restart-Count callback function.

Parameters

[in]	context	PPP context
[in]	value	Restart counter value

Definition at line 996 of file lcp.c.

◆ lcpOpen()

error_t lcpOpen ( PppContext * context )

LCP Open event.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 79 of file lcp.c.

◆ lcpParseAccmOption()

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

Parse Async-Control-Character-Map option.

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[out]	outPacket	Pointer to the Configure-Nak or Configure-Reject packet

Returns: Error code

Definition at line 1466 of file lcp.c.

◆ lcpParseAcfcOption()

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

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

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[out]	outPacket	Pointer to the Configure-Nak or Configure-Reject packet

Returns: Error code

Definition at line 1743 of file lcp.c.

◆ lcpParseAuthProtocolOption()

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

Parse Authentication-Protocol option.

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[out]	outPacket	Pointer to the Configure-Nak or Configure-Reject packet

Returns: Error code

Definition at line 1510 of file lcp.c.

◆ lcpParseMagicNumberOption()

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

Parse Magic-Number option.

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[out]	outPacket	Pointer to the Configure-Nak or Configure-Reject packet

Returns: Error code

Definition at line 1656 of file lcp.c.

◆ lcpParseMruOption()

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

Parse Maximum-Receive-Unit option.

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[out]	outPacket	Pointer to the Configure-Nak or Configure-Reject packet

Returns: Error code

Definition at line 1400 of file lcp.c.

◆ lcpParseOption()

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

Parse LCP configuration option.

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[in]	inPacketLen	Remaining bytes to process in the incoming packet
[out]	outPacket	Pointer to the Configure-Ack, Nak or Reject packet

Returns: Error code

Definition at line 1328 of file lcp.c.

◆ lcpParsePfcOption()

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

Parse Protocol-Field-Compression option.

Parameters

[in]	context	PPP context
[in]	option	Option to be checked
[out]	outPacket	Pointer to the Configure-Nak or Configure-Reject packet

Returns: Error code

Definition at line 1700 of file lcp.c.

◆ lcpProcessCodeRej()

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

Process Code-Reject packet.

Parameters

[in]	context	PPP context
[in]	codeRejPacket	Packet received from the peer

Returns: Error code

Definition at line 635 of file lcp.c.

◆ lcpProcessConfigureAck()

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

Process Configure-Ack packet.

Parameters

[in]	context	PPP context
[in]	configureAckPacket	Packet received from the peer

Returns: Error code

Definition at line 345 of file lcp.c.

◆ lcpProcessConfigureNak()

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

Process Configure-Nak packet.

Parameters

[in]	context	PPP context
[in]	configureNakPacket	Packet received from the peer

Returns: Error code

Definition at line 371 of file lcp.c.

◆ lcpProcessConfigureReject()

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

Process Configure-Reject packet.

Parameters

[in]	context	PPP context
[in]	configureRejPacket	Packet received from the peer

Returns: Error code

Definition at line 492 of file lcp.c.

◆ lcpProcessConfigureReq()

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

Process Configure-Request packet.

Parameters

[in]	context	PPP context
[in]	configureReqPacket	Packet received from the peer

Returns: Error code

Definition at line 249 of file lcp.c.

◆ lcpProcessDiscardReq()

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

Process Discard-Request packet.

Parameters

[in]	context	PPP context
[in]	discardReqPacket	Packet received from the peer

Returns: Error code

Definition at line 788 of file lcp.c.

◆ lcpProcessEchoRep()

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

Process Echo-Reply packet.

Parameters

[in]	context	PPP context
[in]	echoRepPacket	Packet received from the peer

Returns: Error code

Definition at line 770 of file lcp.c.

◆ lcpProcessEchoReq()

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

Process Echo-Request packet.

Parameters

[in]	context	PPP context
[in]	echoReqPacket	Packet received from the peer

Returns: Error code

Definition at line 747 of file lcp.c.

◆ lcpProcessPacket()

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

Process an incoming LCP packet.

Parameters

[in]	context	PPP context
[in]	packet	LCP packet received from the peer
[in]	length	Length of the packet, in bytes

Definition at line 155 of file lcp.c.

◆ lcpProcessProtocolRej()

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

Process Protocol-Reject packet.

Parameters

[in]	context	PPP context
[in]	protocolRejPacket	Packet received from the peer

Returns: Error code

Definition at line 682 of file lcp.c.

◆ lcpProcessTerminateAck()

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

Process Terminate-Ack packet.

Parameters

[in]	context	PPP context
[in]	terminateAckPacket	Packet received from the peer

Returns: Error code

Definition at line 612 of file lcp.c.

◆ lcpProcessTerminateReq()

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

Process Terminate-Request packet.

Parameters

[in]	context	PPP context
[in]	terminateReqPacket	Packet received from the peer

Returns: Error code

Definition at line 590 of file lcp.c.

◆ lcpProcessUnknownCode()

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

Process packet with unknown code.

Parameters

[in]	context	PPP context
[in]	packet	Un-interpretable packet received from the peer

Returns: Error code

Definition at line 806 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]	context	PPP context
[in]	protocol	Rejected protocol
[in]	information	Rejected information
[in]	length	Length of the rejected information

Returns: Error code

Definition at line 830 of file lcp.c.

◆ lcpSendCodeRej()

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

Send-Code-Reject callback function.

Parameters

[in]	context	PPP context
[in]	packet	Un-interpretable packet received from the peer

Returns: Error code

Definition at line 1289 of file lcp.c.

◆ lcpSendConfigureAck()

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

Send-Configure-Ack callback function.

Parameters

[in]	context	PPP context
[in]	configureReqPacket	Configure-Request packet received from the peer

Returns: Error code

Definition at line 1167 of file lcp.c.

◆ lcpSendConfigureNak()

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

Send-Configure-Nak callback function.

Parameters

[in]	context	PPP context
[in]	configureReqPacket	Configure-Request packet received from the peer

Returns: Error code

Definition at line 1186 of file lcp.c.

◆ lcpSendConfigureRej()

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

Send-Configure-Reject callback function.

Parameters

[in]	context	PPP context
[in]	configureReqPacket	Configure-Request packet received from the peer

Returns: Error code

Definition at line 1205 of file lcp.c.

◆ lcpSendConfigureReq()

error_t lcpSendConfigureReq ( PppContext * context )

Send-Configure-Request callback function.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 1032 of file lcp.c.

◆ lcpSendEchoRep()

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

Send-Echo-Reply callback function.

Parameters

[in]	context	PPP context
[in]	echoReqPacket	Echo-Request packet received from the peer

Returns: Error code

Definition at line 1309 of file lcp.c.

◆ lcpSendTerminateAck()

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

Send-Terminate-Ack callback function.

Parameters

[in]	context	PPP context
[in]	terminateReqPacket	Terminate-Request packet received from the peer

Returns: Error code

Definition at line 1255 of file lcp.c.

◆ lcpSendTerminateReq()

error_t lcpSendTerminateReq ( PppContext * context )

Send-Terminate-Request callback function.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 1223 of file lcp.c.

◆ lcpThisLayerDown()

void lcpThisLayerDown ( PppContext * context )

This-Layer-Down callback function.

Parameters

[in] context PPP context

Definition at line 929 of file lcp.c.

◆ lcpThisLayerFinished()

void lcpThisLayerFinished ( PppContext * context )

This-Layer-Finished callback function.

Parameters

[in] context PPP context

Definition at line 975 of file lcp.c.

◆ lcpThisLayerStarted()

void lcpThisLayerStarted ( PppContext * context )

This-Layer-Started callback function.

Parameters

[in] context PPP context

Definition at line 963 of file lcp.c.

◆ lcpThisLayerUp()

void lcpThisLayerUp ( PppContext * context )

This-Layer-Up callback function.

Parameters

[in] context PPP context

Definition at line 858 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] context PPP context

Definition at line 125 of file lcp.c.

◆ lcpZeroRestartCount()

void lcpZeroRestartCount ( PppContext * context )

Zero-Restart-Count callback function.

Parameters

[in] context PPP context

Definition at line 1011 of file lcp.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct

Initial value:

{

uint8_t type

type

uint8_t type

Definition: coap_common.h:176

Maximum-Receive-Unit option.

Address-and-Control-Field-Compression option.

Protocol-Field-Compression option.

Magic-Number option.

Quality-Protocol option.

Authentication-Protocol option.

Async-Control-Character-Map option.

Definition at line 72 of file lcp.h.

◆ accm

uint32_t accm

Definition at line 88 of file lcp.h.

◆ data

uint8_t data[]

Definition at line 101 of file lcp.h.

◆ LcpAccmOption

LcpAccmOption

Definition at line 89 of file lcp.h.

◆ LcpAcfcOption

LcpAcfcOption

Definition at line 149 of file lcp.h.

◆ LcpAuthProtocolOption

LcpAuthProtocolOption

Definition at line 102 of file lcp.h.

◆ LcpMagicNumberOption

LcpMagicNumberOption

Definition at line 127 of file lcp.h.

◆ LcpMruOption

LcpMruOption

Definition at line 77 of file lcp.h.

◆ LcpPfcOption

LcpPfcOption

Definition at line 138 of file lcp.h.

◆ LcpQualityProtocolOption

LcpQualityProtocolOption

Definition at line 115 of file lcp.h.

◆ length

uint8_t length

Definition at line 75 of file lcp.h.

◆ magicNumber

uint32_t magicNumber

Definition at line 126 of file lcp.h.

◆ mru

uint16_t mru

Definition at line 76 of file lcp.h.

◆ protocol

uint16_t protocol

Definition at line 100 of file lcp.h.

Enumerations

Functions

Variables

Detailed Description

License

Enumeration Type Documentation

◆ LcpOptionType

Function Documentation

◆ lcpClose()

◆ lcpInitRestartCount()

◆ lcpOpen()

◆ lcpParseAccmOption()

◆ lcpParseAcfcOption()

◆ lcpParseAuthProtocolOption()

◆ lcpParseMagicNumberOption()

◆ lcpParseMruOption()

◆ lcpParseOption()

◆ lcpParsePfcOption()

◆ lcpProcessCodeRej()

◆ lcpProcessConfigureAck()

◆ lcpProcessConfigureNak()

◆ lcpProcessConfigureReject()

◆ lcpProcessConfigureReq()

◆ lcpProcessDiscardReq()

◆ lcpProcessEchoRep()

◆ lcpProcessEchoReq()

◆ lcpProcessPacket()

◆ lcpProcessProtocolRej()

◆ lcpProcessTerminateAck()

◆ lcpProcessTerminateReq()

◆ lcpProcessUnknownCode()

◆ lcpProcessUnknownProtocol()

◆ lcpSendCodeRej()

◆ lcpSendConfigureAck()

◆ lcpSendConfigureNak()

◆ lcpSendConfigureRej()

◆ lcpSendConfigureReq()

◆ lcpSendEchoRep()

◆ lcpSendTerminateAck()

◆ lcpSendTerminateReq()

◆ lcpThisLayerDown()

◆ lcpThisLayerFinished()

◆ lcpThisLayerStarted()

◆ lcpThisLayerUp()

◆ lcpTick()

◆ lcpZeroRestartCount()

Variable Documentation

◆ __packed_struct

◆ accm

◆ data

◆ LcpAccmOption

◆ LcpAcfcOption

◆ LcpAuthProtocolOption

◆ LcpMagicNumberOption

◆ LcpMruOption

◆ LcpPfcOption

◆ LcpQualityProtocolOption

◆ length

◆ magicNumber

◆ mru

◆ protocol