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 {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   char_t   name []
 
   uint8_t   tokenLen: 4
 
   uint8_t   type: 2
 
   uint8_t   version: 2
 
   uint8_t   code
 
   uint16_t   mid
 
   uint8_t   token []
 
   union {
      uint8_t   b [6]
 
      uint16_t   w [3]
 
   } 
 
   uint16_t   srcPort
 
   uint16_t   destPort
 
   uint32_t   seqNum
 
   uint32_t   ackNum
 
   uint8_t   reserved1: 4
 
   uint8_t   dataOffset: 4
 
   uint8_t   flags: 6
 
   uint8_t   reserved2: 2
 
   uint16_t   window
 
   uint16_t   checksum
 
   uint16_t   urgentPointer
 
   uint8_t   options []
 
   uint16_t   length
 
   uint8_t   data []
 
   uint8_t   op
 
   uint8_t   htype
 
   uint8_t   hlen
 
   uint8_t   hops
 
   uint32_t   xid
 
   uint16_t   secs
 
   uint16_t   flags
 
   Ipv4Addr   ciaddr
 
   Ipv4Addr   yiaddr
 
   Ipv4Addr   siaddr
 
   Ipv4Addr   giaddr
 
   MacAddr   chaddr
 
   uint8_t   unused [10]
 
   uint8_t   sname [64]
 
   uint8_t   file [128]
 
   uint32_t   magicCookie
 
   uint16_t   type
 
   uint16_t   hardwareType
 
   uint32_t   time
 
   MacAddr   linkLayerAddr
 
   uint16_t   id
 
   uint8_t   rd: 1
 
   uint8_t   tc: 1
 
   uint8_t   aa: 1
 
   uint8_t   opcode: 4
 
   uint8_t   qr: 1
 
   uint8_t   rcode: 4
 
   uint8_t   z: 3
 
   uint8_t   ra: 1
 
   uint16_t   qdcount
 
   uint16_t   ancount
 
   uint16_t   nscount
 
   uint16_t   arcount
 
   uint8_t   questions []
 
   uint16_t   controlWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bcdUsb
 
   uint8_t   bDeviceClass
 
   uint8_t   bDeviceSubClass
 
   uint8_t   bDeviceProtocol
 
   uint8_t   bMaxPacketSize0
 
   uint16_t   idVendor
 
   uint16_t   idProduct
 
   uint16_t   bcdDevice
 
   uint8_t   iManufacturer
 
   uint8_t   iProduct
 
   uint8_t   iSerialNumber
 
   uint8_t   bNumConfigurations
 
   uint8_t   maxRespTime
 
   Ipv4Addr   groupAddr
 
   uint16_t   hrd
 
   uint16_t   pro
 
   uint8_t   hln
 
   uint8_t   pln
 
   uint16_t   op
 
   MacAddr   sha
 
   Ipv4Addr   spa
 
   MacAddr   tha
 
   Ipv4Addr   tpa
 
   uint8_t   length
 
   uint8_t   value []
 
   uint16_t   first
 
   uint16_t   last
 
   uint16_t   next
 
   union {
      uint8_t   b [16]
 
      uint16_t   w [8]
 
      uint32_t   dw [4]
 
   } 
 
   uint16_t   maxRespDelay
 
   uint16_t   reserved
 
   Ipv6Addr   multicastAddr
 
   uint32_t   reserved
 
   uint16_t   pvid
 
   uint8_t   autoNegSupportStatus
 
   uint16_t   pmdAutoNegAdvCap
 
   uint16_t   operationalMauType
 
   uint16_t   capabilities
 
   uint8_t   deviceType
 
   uint8_t   lengthH: 1
 
   uint8_t   lengthL
 
   uint8_t   t: 1
 
   uint8_t   c: 1
 
   union {
      int32_t   integer
 
      uint8_t   octetString [1]
 
      uint8_t   oid [1]
 
      uint8_t   ipAddr [4]
 
      uint32_t   counter32
 
      uint32_t   gauge32
 
      uint32_t   unsigned32
 
      uint32_t   timeTicks
 
      uint64_t   counter64
 
   } 
 
   uint16_t   transactionId
 
   uint16_t   protocolId
 
   uint8_t   unitId
 
   uint8_t   pdu []
 
   uint8_t   retain: 1
 
   uint8_t   qos: 2
 
   uint8_t   dup: 1
 
   union {
      uint8_t   all
 
      struct {
         uint8_t   topicIdType: 2
 
         uint8_t   cleanSession: 1
 
         uint8_t   will: 1
 
         uint8_t   retain: 1
 
         uint8_t   qos: 2
 
         uint8_t   dup: 1
 
      } 
 
   } 
 
   uint8_t   b: 1
 
   uint8_t   identifier
 
   uint8_t   valueSize
 
   Ipv4Addr   srcIpAddr
 
   Ipv4Addr   destIpAddr
 
   Eui64   interfaceId
 
   uint16_t   mru
 
   uint8_t   peerIdLength
 
   uint8_t   peerId []
 
   uint32_t   seconds
 
   uint32_t   fraction
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint8_t   reserved: 3
 
   uint8_t   fin: 1
 
   uint8_t   payloadLen: 7
 
   uint8_t   mask: 1
 
   uint8_t   extPayloadLen []
 
   uint32_t   length
 
   uint8_t   payload []
 
   uint8_t   protocolVersionId
 
   uint8_t   bpduType
 
   StpBridgeId   rootId
 
   uint32_t   rootPathCost
 
   StpBridgeId   bridgeId
 
   uint16_t   portId
 
   uint16_t   messageAge
 
   uint16_t   maxAge
 
   uint16_t   helloTime
 
   uint16_t   forwardDelay
 
   uint8_t   version1Length
 
   uint16_t   priority
 
   MacAddr   addr
 
LcpMruOption
 Maximum-Receive-Unit option. More...
 
struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   uint8_t   length: 4
 
   uint8_t   delta: 4
 
   union {
      uint8_t   b [8]
 
      uint16_t   w [4]
 
      uint32_t   dw [2]
 
   } 
 
   uint8_t   kind
 
   uint8_t   value []
 
   uint8_t   code
 
   uint16_t   type
 
   uint32_t   enterpriseNumber
 
   uint8_t   identifier []
 
   uint16_t   qtype
 
   uint16_t   qclass
 
   uint16_t   statusWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   wTotalLength
 
   uint8_t   bNumInterfaces
 
   uint8_t   bConfigurationValue
 
   uint8_t   iConfiguration
 
   uint8_t   bmAttributes
 
   uint8_t   bMaxPower
 
   uint8_t   type
 
   uint16_t   checksum
 
   uint8_t   parameter
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   parameter
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint8_t   curHopLimit
 
   uint8_t   reserved: 2
 
   uint8_t   p: 1
 
   uint8_t   prf: 2
 
   uint8_t   h: 1
 
   uint8_t   o: 1
 
   uint8_t   m: 1
 
   uint16_t   routerLifetime
 
   uint32_t   reachableTime
 
   uint32_t   retransTimer
 
   uint8_t   flags
 
   uint16_t   ppvid
 
   uint8_t   mdiPowerSupport
 
   uint8_t   psePowerPair
 
   uint8_t   powerClass
 
   uint8_t   appType
 
   uint8_t   vlanIdH: 5
 
   uint8_t   x: 1
 
   uint8_t   t: 1
 
   uint8_t   u: 1
 
   uint8_t   l2PriorityH: 1
 
   uint8_t   vlanIdL: 7
 
   uint8_t   dscpValue: 6
 
   uint8_t   l2PriorityL: 2
 
   uint8_t   chassisIdSubtype
 
   uint8_t   chassisId []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfCoils
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint16_t   flags
 
   Ipv4Addr   addr
 
   uint8_t   valueSize
 
   uint16_t   protocol
 
   uint32_t   accm
 
   uint8_t   msgLength
 
   uint8_t   message []
 
   uint8_t   mode: 3
 
   uint8_t   vn: 3
 
   uint8_t   li: 2
 
   uint8_t   stratum
 
   uint8_t   poll
 
   int8_t   precision
 
   uint32_t   rootDelay
 
   uint32_t   rootDispersion
 
   uint32_t   referenceId
 
   NtpTimestamp   referenceTimestamp
 
   NtpTimestamp   originateTimestamp
 
   NtpTimestamp   receiveTimestamp
 
   NtpTimestamp   transmitTimestamp
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint16_t   value []
 
   uint16_t   group
 
   uint8_t   keyExchange []
 
   uint32_t   id
 
   uint32_t   dataLen
 
LcpAccmOption
 Async-Control-Character-Map option. More...
 
struct {
   uint32_t   totalSize
 
   ResRootEntry   rootEntry
 
   MacAddr   destAddr
 
   MacAddr   srcAddr
 
   uint16_t   type
 
   uint8_t   data []
 
   uint16_t   hardwareType
 
   MacAddr   linkLayerAddr
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata []
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bInterfaceNumber
 
   uint8_t   bAlternateSetting
 
   uint8_t   bNumEndpoints
 
   uint8_t   bInterfaceClass
 
   uint8_t   bInterfaceSubClass
 
   uint8_t   bInterfaceProtocol
 
   uint8_t   iInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   uint16_t   vlanId
 
   uint8_t   vlanNameLen
 
   char_t   vlanName []
 
   uint8_t   aggregationStatus
 
   uint32_t   aggregatedPortId
 
   uint8_t   locationDataFormat
 
   uint8_t   locationId []
 
   uint8_t   portIdSubtype
 
   uint8_t   portId []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   coilStatus []
 
   uint8_t   prefix
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint8_t   identifier
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint8_t   msgLength
 
   uint8_t   rejectedPacket []
 
   uint32_t   keyId
 
   uint8_t   messageDigest [16]
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   value []
 
   uint8_t   value []
 
LcpAuthProtocolOption
 Authentication-Protocol option. More...
 
struct {
   uint8_t   dsap
 
   uint8_t   ssap
 
   uint8_t   control
 
   uint8_t   msgType
 
   uint8_t   transactionId [3]
 
   uint8_t   options []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata [4]
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bEndpointAddress
 
   uint8_t   bmAttributes
 
   uint16_t   wMaxPacketSize
 
   uint8_t   bInterval
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   data []
 
   uint32_t   mtu
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   routingType
 
   uint8_t   segmentsLeft
 
   uint32_t   reserved
 
   Ipv6Addr   address []
 
   uint8_t   reserved1: 5
 
   uint8_t   o: 1
 
   uint8_t   s: 1
 
   uint8_t   r: 1
 
   uint8_t   reserved2 [3]
 
   Ipv6Addr   targetAddr
 
   uint8_t   protocolIdLen
 
   uint8_t   protocolId []
 
   uint16_t   maxFrameSize
 
   uint8_t   powerPriority: 4
 
   uint8_t   powerSource: 2
 
   uint8_t   powerType: 2
 
   uint16_t   powerValue
 
   uint16_t   ttl
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfInputs
 
   uint8_t   gwId
 
   uint16_t   duration
 
   uint8_t   identifier
 
   uint16_t   length
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint16_t   rejectedProtocol
 
   uint8_t   rejectedInfo []
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   version
 
   uint16_t   epoch
 
   DtlsSequenceNumber   seqNum
 
   uint8_t   hash
 
   uint8_t   signature
 
   uint8_t   value []
 
LcpQualityProtocolOption
 Quality-Protocol option. More...
 
struct {
   uint16_t   tci
 
   uint16_t   type
 
   uint8_t   msgType
 
   uint8_t   hopCount
 
   Ipv6Addr   linkAddress
 
   Ipv6Addr   peerAddress
 
   uint8_t   options []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata [16]
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bString []
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint8_t   pointer
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   payloadLen
 
   uint16_t   reserved
 
   uint32_t   securityParamIndex
 
   uint32_t   sequenceNumber
 
   uint8_t   authData []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   Ipv6Addr   destAddr
 
   uint8_t   measurements [20]
 
   uint16_t   psePowerPriceIndex
 
   uint16_t   supportedCap
 
   uint16_t   enabledCap
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   inputStatus []
 
   uint8_t   radius
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint32_t   magicNumber
 
   uint8_t   identifier
 
   uint16_t   length
 
   uint16_t   opcode
 
   uint16_t   errorCode
 
   char_t   errorMsg []
 
   uint16_t   msgSeq
 
   uint8_t   fragOffset [3]
 
   uint8_t   fragLength [3]
 
   TlsSignHashAlgo   value []
 
   uint8_t   value []
 
LcpMagicNumberOption
 Magic-Number option. More...
 
struct {
   uint16_t   code
 
   uint16_t   length
 
   uint8_t   value []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint16_t   priority
 
   uint16_t   weight
 
   uint16_t   port
 
   uint8_t   target []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint16_t   bcdCdc
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint16_t   identifier
 
   uint16_t   sequenceNumber
 
   uint8_t   data []
 
   uint32_t   pointer
 
   uint32_t   securityParamIndex
 
   uint32_t   sequenceNumber
 
   uint8_t   payloadData []
 
   uint8_t   length
 
   uint8_t   powerPriority: 2
 
   uint8_t   pd4pid: 1
 
   uint8_t   reserved: 1
 
   uint8_t   powerSource: 2
 
   uint8_t   powerType: 2
 
   uint16_t   pdRequestedPower
 
   uint16_t   pseAllocatedPower
 
   uint8_t   mgmtAddrLen
 
   uint8_t   mgmtAddrSubtype
 
   uint8_t   mgmtAddr []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfRegs
 
   uint8_t   gwId
 
   uint8_t   gwAdd []
 
   Ipv4Addr   ipAddr
 
   uint8_t   identifier
 
   uint32_t   magicNumber
 
   uint16_t   serverVersion
 
   uint8_t   cookieLength
 
   uint8_t   cookie []
 
LcpPfcOption
 Protocol-Field-Compression option. More...
 
struct {
   uint32_t   iaId
 
   uint32_t   t1
 
   uint32_t   t2
 
   uint8_t   options []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint8_t   bmCapabilities
 
   uint8_t   bDataInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint16_t   identifier
 
   uint16_t   sequenceNumber
 
   uint8_t   data []
 
   uint8_t   length
 
   MacAddr   linkLayerAddr
 
   uint16_t   pdRequestedPowerA
 
   uint16_t   pdRequestedPowerB
 
   uint16_t   pseAllocatedPowerA
 
   uint16_t   pseAllocatedPowerB
 
   uint16_t   powerStatus
 
   uint8_t   systemSetup
 
   uint16_t   pseMaxAvailablePower
 
   uint8_t   autoclass
 
   uint8_t   powerDown [3]
 
   uint8_t   ifNumSubtype
 
   uint32_t   ifNum
 
   uint8_t   oidLen
 
   uint8_t   oid []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint16_t   regValue []
 
   MqttSnFlags   flags
 
   uint8_t   protocolId
 
   uint16_t   duration
 
   char_t   clientId []
 
   Ipv4Addr   ipAddr
 
   uint16_t   length
 
   uint8_t   value []
 
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

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

Copyright (C) 2010-2022 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
2.2.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 48 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 103 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 988 of file lcp.c.

◆ lcpOpen()

error_t lcpOpen ( PppContext context)

LCP Open event.

Parameters
[in]contextPPP 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]contextPPP context
[in]optionOption to be checked
[out]outPacketPointer to the Configure-Nak or Configure-Reject packet
Returns
Error code

Definition at line 1458 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 1735 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 1502 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 1648 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 1392 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 1320 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 1692 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 635 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 345 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 371 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 492 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 249 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 788 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 770 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 747 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 155 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 682 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 612 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 590 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 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]contextPPP context
[in]protocolRejected protocol
[in]informationRejected information
[in]lengthLength 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]contextPPP context
[in]packetUn-interpretable packet received from the peer
Returns
Error code

Definition at line 1281 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 1159 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 1178 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 1197 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 1024 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 1301 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 1247 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 1215 of file lcp.c.

◆ lcpThisLayerDown()

void lcpThisLayerDown ( PppContext context)

This-Layer-Down callback function.

Parameters
[in]contextPPP context

Definition at line 921 of file lcp.c.

◆ lcpThisLayerFinished()

void lcpThisLayerFinished ( PppContext context)

This-Layer-Finished callback function.

Parameters
[in]contextPPP context

Definition at line 967 of file lcp.c.

◆ lcpThisLayerStarted()

void lcpThisLayerStarted ( PppContext context)

This-Layer-Started callback function.

Parameters
[in]contextPPP context

Definition at line 955 of file lcp.c.

◆ lcpThisLayerUp()

void lcpThisLayerUp ( PppContext context)

This-Layer-Up callback function.

Parameters
[in]contextPPP 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]contextPPP context

Definition at line 125 of file lcp.c.

◆ lcpZeroRestartCount()

void lcpZeroRestartCount ( PppContext context)

Zero-Restart-Count callback function.

Parameters
[in]contextPPP context

Definition at line 1003 of file lcp.c.

Variable Documentation

◆ accm

uint32_t accm

Definition at line 86 of file lcp.h.

◆ data

uint8_t data[]

Definition at line 99 of file lcp.h.

◆ length

uint8_t length

Definition at line 73 of file lcp.h.

◆ magicNumber

uint32_t magicNumber

Definition at line 124 of file lcp.h.

◆ mru

uint16_t mru

Definition at line 74 of file lcp.h.

◆ protocol

uint16_t protocol

Definition at line 98 of file lcp.h.

◆ type

uint8_t type

Definition at line 72 of file lcp.h.