ipcp.h File Reference

IPCP (PPP Internet Protocol Control Protocol) More...

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

Go to the source code of this file.

Macros

#define IPCP_DEFAULT_SUBNET_MASK   IPV4_ADDR(255, 255, 255, 255)
 

Typedefs

struct {
   uint8_t   type
 
   uint8_t   length
 
   Ipv4Addr   srcIpAddr
 
   Ipv4Addr   destIpAddr
 
IpcpIpAddressesOption
 IP-Addresses option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   uint16_t   protocol
 
   uint8_t   data []
 
IpcpIpCompProtocolOption
 IP-Compression-Protocol option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
IpcpIpAddressOption
 IP-Address option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
IpcpPrimaryDnsOption
 Primary-DNS-Server-Address option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
IpcpPrimaryNbnsOption
 Primary-NBNS-Server-Address option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
IpcpSecondaryDnsOption
 Secondary-DNS-Server-Address option. More...
 
struct {
   uint8_t   type
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
IpcpSecondaryNbnsOption
 Secondary-NBNS-Server-Address option. More...
 

Enumerations

enum  IpcpOptionType {
  IPCP_OPTION_IP_ADDRESSES = 1, IPCP_OPTION_IP_COMP_PROTOCOL = 2, IPCP_OPTION_IP_ADDRESS = 3, IPCP_OPTION_PRIMARY_DNS = 129,
  IPCP_OPTION_PRIMARY_NBNS = 130, IPCP_OPTION_SECONDARY_DNS = 131, IPCP_OPTION_SECONDARY_NBNS = 132
}
 IPCP option types. More...
 

Functions

error_t ipcpOpen (PppContext *context)
 IPCP Open event. More...
 
error_t ipcpClose (PppContext *context)
 IPCP Close event. More...
 
void ipcpTick (PppContext *context)
 IPCP timer handler. More...
 
void ipcpProcessPacket (PppContext *context, const PppPacket *packet, size_t length)
 Process an incoming IPCP packet. More...
 
error_t ipcpProcessConfigureReq (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Process Configure-Request packet. More...
 
error_t ipcpProcessConfigureAck (PppContext *context, const PppConfigurePacket *configureAckPacket)
 Process Configure-Ack packet. More...
 
error_t ipcpProcessConfigureNak (PppContext *context, const PppConfigurePacket *configureNakPacket)
 Process Configure-Nak packet. More...
 
error_t ipcpProcessConfigureReject (PppContext *context, const PppConfigurePacket *configureRejPacket)
 Process Configure-Reject packet. More...
 
error_t ipcpProcessTerminateReq (PppContext *context, const PppTerminatePacket *terminateReqPacket)
 Process Terminate-Request packet. More...
 
error_t ipcpProcessTerminateAck (PppContext *context, const PppTerminatePacket *terminateAckPacket)
 Process Terminate-Ack packet. More...
 
error_t ipcpProcessCodeRej (PppContext *context, const PppCodeRejPacket *codeRejPacket)
 Process Code-Reject packet. More...
 
error_t ipcpProcessUnknownCode (PppContext *context, const PppPacket *packet)
 Process packet with unknown code. More...
 
void ipcpThisLayerUp (PppContext *context)
 This-Layer-Up callback function. More...
 
void ipcpThisLayerDown (PppContext *context)
 This-Layer-Down callback function. More...
 
void ipcpThisLayerStarted (PppContext *context)
 This-Layer-Started callback function. More...
 
void ipcpThisLayerFinished (PppContext *context)
 This-Layer-Finished callback function. More...
 
void ipcpInitRestartCount (PppContext *context, uint_t value)
 Initialize-Restart-Count callback function. More...
 
void ipcpZeroRestartCount (PppContext *context)
 Zero-Restart-Count callback function. More...
 
error_t ipcpSendConfigureReq (PppContext *context)
 Send-Configure-Request callback function. More...
 
error_t ipcpSendConfigureAck (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Ack callback function. More...
 
error_t ipcpSendConfigureNak (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Nak callback function. More...
 
error_t ipcpSendConfigureRej (PppContext *context, const PppConfigurePacket *configureReqPacket)
 Send-Configure-Reject callback function. More...
 
error_t ipcpSendTerminateReq (PppContext *context)
 Send-Terminate-Request callback function. More...
 
error_t ipcpSendTerminateAck (PppContext *context, const PppTerminatePacket *terminateReqPacket)
 Send-Terminate-Ack callback function. More...
 
error_t ipcpSendCodeRej (PppContext *context, const PppPacket *packet)
 Send-Code-Reject callback function. More...
 
error_t ipcpParseOption (PppContext *context, PppOption *option, size_t inPacketLen, PppConfigurePacket *outPacket)
 Parse IPCP configuration option. More...
 
error_t ipcpParseIpAddressOption (PppContext *context, IpcpIpAddressOption *option, PppConfigurePacket *outPacket)
 Parse IP-Address option. More...
 

Detailed Description

IPCP (PPP Internet Protocol 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 ipcp.h.

Macro Definition Documentation

◆ IPCP_DEFAULT_SUBNET_MASK

#define IPCP_DEFAULT_SUBNET_MASK   IPV4_ADDR(255, 255, 255, 255)

Definition at line 37 of file ipcp.h.

Typedef Documentation

◆ IpcpIpAddressesOption

typedef { ... } IpcpIpAddressesOption

IP-Addresses option.

◆ IpcpIpAddressOption

typedef { ... } IpcpIpAddressOption

IP-Address option.

◆ IpcpIpCompProtocolOption

typedef { ... } IpcpIpCompProtocolOption

IP-Compression-Protocol option.

◆ IpcpPrimaryDnsOption

typedef { ... } IpcpPrimaryDnsOption

Primary-DNS-Server-Address option.

◆ IpcpPrimaryNbnsOption

typedef { ... } IpcpPrimaryNbnsOption

Primary-NBNS-Server-Address option.

◆ IpcpSecondaryDnsOption

typedef { ... } IpcpSecondaryDnsOption

Secondary-DNS-Server-Address option.

◆ IpcpSecondaryNbnsOption

typedef { ... } IpcpSecondaryNbnsOption

Secondary-NBNS-Server-Address option.

Enumeration Type Documentation

◆ IpcpOptionType

IPCP option types.

Enumerator
IPCP_OPTION_IP_ADDRESSES 

IP-Addresses.

IPCP_OPTION_IP_COMP_PROTOCOL 

IP-Compression-Protocol.

IPCP_OPTION_IP_ADDRESS 

IP-Address.

IPCP_OPTION_PRIMARY_DNS 

Primary-DNS-Server-Address.

IPCP_OPTION_PRIMARY_NBNS 

Primary-NBNS-Server-Address.

IPCP_OPTION_SECONDARY_DNS 

Secondary-DNS-Server-Address.

IPCP_OPTION_SECONDARY_NBNS 

Secondary-NBNS-Server-Address.

Definition at line 49 of file ipcp.h.

Function Documentation

◆ ipcpClose()

error_t ipcpClose ( PppContext context)

IPCP Close event.

Parameters
[in]contextPPP context
Returns
Error code

Definition at line 95 of file ipcp.c.

◆ ipcpInitRestartCount()

void ipcpInitRestartCount ( PppContext context,
uint_t  value 
)

Initialize-Restart-Count callback function.

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

Definition at line 713 of file ipcp.c.

◆ ipcpOpen()

error_t ipcpOpen ( PppContext context)

IPCP Open event.

Parameters
[in]contextPPP context
Returns
Error code

Definition at line 74 of file ipcp.c.

◆ ipcpParseIpAddressOption()

error_t ipcpParseIpAddressOption ( PppContext context,
IpcpIpAddressOption option,
PppConfigurePacket outPacket 
)

Parse IP-Address 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 1033 of file ipcp.c.

◆ ipcpParseOption()

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

Parse IPCP 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 981 of file ipcp.c.

◆ ipcpProcessCodeRej()

error_t ipcpProcessCodeRej ( 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 547 of file ipcp.c.

◆ ipcpProcessConfigureAck()

error_t ipcpProcessConfigureAck ( 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 319 of file ipcp.c.

◆ ipcpProcessConfigureNak()

error_t ipcpProcessConfigureNak ( 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 345 of file ipcp.c.

◆ ipcpProcessConfigureReject()

error_t ipcpProcessConfigureReject ( 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 434 of file ipcp.c.

◆ ipcpProcessConfigureReq()

error_t ipcpProcessConfigureReq ( 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 223 of file ipcp.c.

◆ ipcpProcessPacket()

void ipcpProcessPacket ( PppContext context,
const PppPacket packet,
size_t  length 
)

Process an incoming IPCP packet.

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

Definition at line 149 of file ipcp.c.

◆ ipcpProcessTerminateAck()

error_t ipcpProcessTerminateAck ( 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 524 of file ipcp.c.

◆ ipcpProcessTerminateReq()

error_t ipcpProcessTerminateReq ( 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 502 of file ipcp.c.

◆ ipcpProcessUnknownCode()

error_t ipcpProcessUnknownCode ( 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 594 of file ipcp.c.

◆ ipcpSendCodeRej()

error_t ipcpSendCodeRej ( 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 959 of file ipcp.c.

◆ ipcpSendConfigureAck()

error_t ipcpSendConfigureAck ( 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 837 of file ipcp.c.

◆ ipcpSendConfigureNak()

error_t ipcpSendConfigureNak ( 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 856 of file ipcp.c.

◆ ipcpSendConfigureRej()

error_t ipcpSendConfigureRej ( 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 875 of file ipcp.c.

◆ ipcpSendConfigureReq()

error_t ipcpSendConfigureReq ( PppContext context)

Send-Configure-Request callback function.

Parameters
[in]contextPPP context
Returns
Error code

Definition at line 749 of file ipcp.c.

◆ ipcpSendTerminateAck()

error_t ipcpSendTerminateAck ( 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 925 of file ipcp.c.

◆ ipcpSendTerminateReq()

error_t ipcpSendTerminateReq ( PppContext context)

Send-Terminate-Request callback function.

Parameters
[in]contextPPP context
Returns
Error code

Definition at line 893 of file ipcp.c.

◆ ipcpThisLayerDown()

void ipcpThisLayerDown ( PppContext context)

This-Layer-Down callback function.

Parameters
[in]contextPPP context

Definition at line 661 of file ipcp.c.

◆ ipcpThisLayerFinished()

void ipcpThisLayerFinished ( PppContext context)

This-Layer-Finished callback function.

Parameters
[in]contextPPP context

Definition at line 700 of file ipcp.c.

◆ ipcpThisLayerStarted()

void ipcpThisLayerStarted ( PppContext context)

This-Layer-Started callback function.

Parameters
[in]contextPPP context

Definition at line 688 of file ipcp.c.

◆ ipcpThisLayerUp()

void ipcpThisLayerUp ( PppContext context)

This-Layer-Up callback function.

Parameters
[in]contextPPP context

Definition at line 614 of file ipcp.c.

◆ ipcpTick()

void ipcpTick ( PppContext context)

IPCP timer handler.

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

Parameters
[in]contextPPP context

Definition at line 119 of file ipcp.c.

◆ ipcpZeroRestartCount()

void ipcpZeroRestartCount ( PppContext context)

Zero-Restart-Count callback function.

Parameters
[in]contextPPP context

Definition at line 728 of file ipcp.c.

Variable Documentation

◆ data

uint8_t data[]

Definition at line 89 of file ipcp.h.

◆ destIpAddr

Ipv4Addr destIpAddr

Definition at line 76 of file ipcp.h.

◆ ipAddr

Ipv4Addr ipAddr

Definition at line 101 of file ipcp.h.

◆ length

uint8_t length

Definition at line 74 of file ipcp.h.

◆ protocol

uint16_t protocol

Definition at line 88 of file ipcp.h.

◆ srcIpAddr

Ipv4Addr srcIpAddr

Definition at line 75 of file ipcp.h.

◆ type

uint8_t type

Definition at line 73 of file ipcp.h.