IPV6CP (PPP IPv6 Control Protocol) More...

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

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

}	Ipv6cpInterfaceIdOption
	Interface-Identifier 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

}	Ipv6cpIpCompProtocolOption
	IPv6-Compression-Protocol option. More...

Enumerations
enum	Ipv6cpOptionType { IPV6CP_OPTION_INTERFACE_ID = 1, IPV6CP_OPTION_IPV6_COMP_PROTOCOL = 2 }
	IPV6CP option types. More...

Functions
error_t	ipv6cpOpen (PppContext *context)
	IPV6CP Open event. More...

error_t	ipv6cpClose (PppContext *context)
	IPV6CP Close event. More...

void	ipv6cpTick (PppContext *context)
	IPV6CP timer handler. More...

void	ipv6cpProcessPacket (PppContext context, const PppPacket packet, size_t length)
	Process an incoming IPV6CP packet. More...

error_t	ipv6cpProcessConfigureReq (PppContext context, const PppConfigurePacket configureReqPacket)
	Process Configure-Request packet. More...

error_t	ipv6cpProcessConfigureAck (PppContext context, const PppConfigurePacket configureAckPacket)
	Process Configure-Ack packet. More...

error_t	ipv6cpProcessConfigureNak (PppContext context, const PppConfigurePacket configureNakPacket)
	Process Configure-Nak packet. More...

error_t	ipv6cpProcessConfigureReject (PppContext context, const PppConfigurePacket configureRejPacket)
	Process Configure-Reject packet. More...

error_t	ipv6cpProcessTerminateReq (PppContext context, const PppTerminatePacket terminateReqPacket)
	Process Terminate-Request packet. More...

error_t	ipv6cpProcessTerminateAck (PppContext context, const PppTerminatePacket terminateAckPacket)
	Process Terminate-Ack packet. More...

error_t	ipv6cpProcessCodeRej (PppContext context, const PppCodeRejPacket codeRejPacket)
	Process Code-Reject packet. More...

error_t	ipv6cpProcessUnknownCode (PppContext context, const PppPacket packet)
	Process packet with unknown code. More...

void	ipv6cpThisLayerUp (PppContext *context)
	This-Layer-Up callback function. More...

void	ipv6cpThisLayerDown (PppContext *context)
	This-Layer-Down callback function. More...

void	ipv6cpThisLayerStarted (PppContext *context)
	This-Layer-Started callback function. More...

void	ipv6cpThisLayerFinished (PppContext *context)
	This-Layer-Finished callback function. More...

void	ipv6cpInitRestartCount (PppContext *context, uint_t value)
	Initialize-Restart-Count callback function. More...

void	ipv6cpZeroRestartCount (PppContext *context)
	Zero-Restart-Count callback function. More...

error_t	ipv6cpSendConfigureReq (PppContext *context)
	Send-Configure-Request callback function. More...

error_t	ipv6cpSendConfigureAck (PppContext context, const PppConfigurePacket configureReqPacket)
	Send-Configure-Ack callback function. More...

error_t	ipv6cpSendConfigureNak (PppContext context, const PppConfigurePacket configureReqPacket)
	Send-Configure-Nak callback function. More...

error_t	ipv6cpSendConfigureRej (PppContext context, const PppConfigurePacket configureReqPacket)
	Send-Configure-Reject callback function. More...

error_t	ipv6cpSendTerminateReq (PppContext *context)
	Send-Terminate-Request callback function. More...

error_t	ipv6cpSendTerminateAck (PppContext context, const PppTerminatePacket terminateReqPacket)
	Send-Terminate-Ack callback function. More...

error_t	ipv6cpSendCodeRej (PppContext context, const PppPacket packet)
	Send-Code-Reject callback function. More...

error_t	ipv6cpParseOption (PppContext context, PppOption option, size_t inPacketLen, PppConfigurePacket *outPacket)
	Parse IPV6CP configuration option. More...

error_t	ipv6cpParseInterfaceIdOption (PppContext context, Ipv6cpInterfaceIdOption option, PppConfigurePacket *outPacket)
	Parse Interface-Identifier option. More...

Detailed Description

IPV6CP (PPP IPv6 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.2.4

Definition in file ipv6cp.h.

Typedef Documentation

◆ Ipv6cpInterfaceIdOption

typedef { ... } Ipv6cpInterfaceIdOption

Interface-Identifier option.

◆ Ipv6cpIpCompProtocolOption

typedef { ... } Ipv6cpIpCompProtocolOption

IPv6-Compression-Protocol option.

Enumeration Type Documentation

◆ Ipv6cpOptionType

enum Ipv6cpOptionType

IPV6CP option types.

Enumerator
IPV6CP_OPTION_INTERFACE_ID	Interface-Identifier.
IPV6CP_OPTION_IPV6_COMP_PROTOCOL	IPv6-Compression-Protocol.

Definition at line 48 of file ipv6cp.h.

Function Documentation

◆ ipv6cpClose()

error_t ipv6cpClose ( PppContext * context )

IPV6CP Close event.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 98 of file ipv6cp.c.

◆ ipv6cpInitRestartCount()

void ipv6cpInitRestartCount	(	PppContext *	context,
		uint_t	value
	)

Initialize-Restart-Count callback function.

Parameters

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

Definition at line 667 of file ipv6cp.c.

◆ ipv6cpOpen()

error_t ipv6cpOpen ( PppContext * context )

IPV6CP Open event.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 77 of file ipv6cp.c.

◆ ipv6cpParseInterfaceIdOption()

error_t ipv6cpParseInterfaceIdOption	(	PppContext *	context,
		Ipv6cpInterfaceIdOption *	option,
		PppConfigurePacket *	outPacket
	)

Parse Interface-Identifier 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 969 of file ipv6cp.c.

◆ ipv6cpParseOption()

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

Parse IPV6CP 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 917 of file ipv6cp.c.

◆ ipv6cpProcessCodeRej()

error_t ipv6cpProcessCodeRej	(	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 512 of file ipv6cp.c.

◆ ipv6cpProcessConfigureAck()

error_t ipv6cpProcessConfigureAck	(	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 322 of file ipv6cp.c.

◆ ipv6cpProcessConfigureNak()

error_t ipv6cpProcessConfigureNak	(	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 348 of file ipv6cp.c.

◆ ipv6cpProcessConfigureReject()

error_t ipv6cpProcessConfigureReject	(	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 411 of file ipv6cp.c.

◆ ipv6cpProcessConfigureReq()

error_t ipv6cpProcessConfigureReq	(	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 226 of file ipv6cp.c.

◆ ipv6cpProcessPacket()

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

Process an incoming IPV6CP packet.

Parameters

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

Definition at line 152 of file ipv6cp.c.

◆ ipv6cpProcessTerminateAck()

error_t ipv6cpProcessTerminateAck	(	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 489 of file ipv6cp.c.

◆ ipv6cpProcessTerminateReq()

error_t ipv6cpProcessTerminateReq	(	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 467 of file ipv6cp.c.

◆ ipv6cpProcessUnknownCode()

error_t ipv6cpProcessUnknownCode	(	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 559 of file ipv6cp.c.

◆ ipv6cpSendCodeRej()

error_t ipv6cpSendCodeRej	(	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 895 of file ipv6cp.c.

◆ ipv6cpSendConfigureAck()

error_t ipv6cpSendConfigureAck	(	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 773 of file ipv6cp.c.

◆ ipv6cpSendConfigureNak()

error_t ipv6cpSendConfigureNak	(	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 792 of file ipv6cp.c.

◆ ipv6cpSendConfigureRej()

error_t ipv6cpSendConfigureRej	(	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 811 of file ipv6cp.c.

◆ ipv6cpSendConfigureReq()

error_t ipv6cpSendConfigureReq ( PppContext * context )

Send-Configure-Request callback function.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 703 of file ipv6cp.c.

◆ ipv6cpSendTerminateAck()

error_t ipv6cpSendTerminateAck	(	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 861 of file ipv6cp.c.

◆ ipv6cpSendTerminateReq()

error_t ipv6cpSendTerminateReq ( PppContext * context )

Send-Terminate-Request callback function.

Parameters

[in] context PPP context

Returns: Error code

Definition at line 829 of file ipv6cp.c.

◆ ipv6cpThisLayerDown()

void ipv6cpThisLayerDown ( PppContext * context )

This-Layer-Down callback function.

Parameters

[in] context PPP context

Definition at line 615 of file ipv6cp.c.

◆ ipv6cpThisLayerFinished()

void ipv6cpThisLayerFinished ( PppContext * context )

This-Layer-Finished callback function.

Parameters

[in] context PPP context

Definition at line 654 of file ipv6cp.c.

◆ ipv6cpThisLayerStarted()

void ipv6cpThisLayerStarted ( PppContext * context )

This-Layer-Started callback function.

Parameters

[in] context PPP context

Definition at line 642 of file ipv6cp.c.

◆ ipv6cpThisLayerUp()

void ipv6cpThisLayerUp ( PppContext * context )

This-Layer-Up callback function.

Parameters

[in] context PPP context

Definition at line 579 of file ipv6cp.c.

◆ ipv6cpTick()

void ipv6cpTick ( PppContext * context )

IPV6CP timer handler.

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

Parameters

[in] context PPP context

Definition at line 122 of file ipv6cp.c.

◆ ipv6cpZeroRestartCount()

void ipv6cpZeroRestartCount ( PppContext * context )

Zero-Restart-Count callback function.

Parameters

[in] context PPP context

Definition at line 682 of file ipv6cp.c.

Variable Documentation

◆ data

uint8_t data[]

Definition at line 82 of file ipv6cp.h.

◆ interfaceId

Eui64 interfaceId

Definition at line 69 of file ipv6cp.h.

◆ length

uint8_t length

Definition at line 68 of file ipv6cp.h.

◆ protocol

uint16_t protocol

Definition at line 81 of file ipv6cp.h.

◆ type

uint8_t type

Definition at line 67 of file ipv6cp.h.

Typedefs

Enumerations

Functions

Detailed Description

License

Typedef Documentation

◆ Ipv6cpInterfaceIdOption

◆ Ipv6cpIpCompProtocolOption

Enumeration Type Documentation

◆ Ipv6cpOptionType

Function Documentation

◆ ipv6cpClose()

◆ ipv6cpInitRestartCount()

◆ ipv6cpOpen()

◆ ipv6cpParseInterfaceIdOption()

◆ ipv6cpParseOption()

◆ ipv6cpProcessCodeRej()

◆ ipv6cpProcessConfigureAck()

◆ ipv6cpProcessConfigureNak()

◆ ipv6cpProcessConfigureReject()

◆ ipv6cpProcessConfigureReq()

◆ ipv6cpProcessPacket()

◆ ipv6cpProcessTerminateAck()

◆ ipv6cpProcessTerminateReq()

◆ ipv6cpProcessUnknownCode()

◆ ipv6cpSendCodeRej()

◆ ipv6cpSendConfigureAck()

◆ ipv6cpSendConfigureNak()

◆ ipv6cpSendConfigureRej()

◆ ipv6cpSendConfigureReq()

◆ ipv6cpSendTerminateAck()

◆ ipv6cpSendTerminateReq()

◆ ipv6cpThisLayerDown()

◆ ipv6cpThisLayerFinished()

◆ ipv6cpThisLayerStarted()

◆ ipv6cpThisLayerUp()

◆ ipv6cpTick()

◆ ipv6cpZeroRestartCount()

Variable Documentation

◆ data

◆ interfaceId

◆ length

◆ protocol

◆ type