IPv4 (Internet Protocol Version 4) More...

#include "core/net.h"
#include "core/ethernet.h"
#include "ipv4/ipv4_frag.h"

Data Structures
struct	Ipv4AddrEntry
	IPv4 address entry. More...

struct	Ipv4FilterEntry
	IPv4 multicast filter entry. More...

struct	Ipv4Context
	IPv4 context. More...

Macros
#define	Ipv4Header struct _Ipv4Header

#define	Ipv4PseudoHeader struct _Ipv4PseudoHeader

#define	IPV4_SUPPORT ENABLED

#define	IPV4_IPSEC_SUPPORT DISABLED

#define	IPV4_DEFAULT_TTL 64

#define	IPV4_ADDR_LIST_SIZE 1

#define	IPV4_DNS_SERVER_LIST_SIZE 2

#define	IPV4_MULTICAST_FILTER_SIZE 4

#define	IPV4_VERSION 4

#define	IPV4_MINIMUM_MTU 68

#define	IPV4_DEFAULT_MTU 576

#define	IPV4_MIN_HEADER_LENGTH 20

#define	IPV4_MAX_HEADER_LENGTH 60

#define	IPV4_DATA(packet) PTR_OFFSET(packet, packet->headerLength * 4)

#define	IPV4_ADDR(a, b, c, d) ((a) \| ((b) << 8) \| ((c) << 16) \| ((uint32_t) (d) << 24))

#define	IPV4_UNSPECIFIED_ADDR IPV4_ADDR(0, 0, 0, 0)

#define	IPV4_BROADCAST_ADDR IPV4_ADDR(255, 255, 255, 255)

#define	IPV4_LOOPBACK_ADDR IPV4_ADDR(127, 0, 0, 1)

#define	IPV4_LOOPBACK_PREFIX IPV4_ADDR(127, 0, 0, 0)

#define	IPV4_LOOPBACK_MASK IPV4_ADDR(255, 0, 0, 0)

#define	IPV4_LINK_LOCAL_PREFIX IPV4_ADDR(169, 254, 0, 0)

#define	IPV4_LINK_LOCAL_MASK IPV4_ADDR(255, 255, 0, 0)

#define	IPV4_MULTICAST_PREFIX IPV4_ADDR(224, 0, 0, 0)

#define	IPV4_MULTICAST_MASK IPV4_ADDR(240, 0, 0, 0)

#define	IPV4_MULTICAST_LNCB_PREFIX IPV4_ADDR(224, 0, 0, 0)

#define	IPV4_MULTICAST_LNCB_MASK IPV4_ADDR(255, 255, 255, 0)

#define	IPV4_MULTICAST_INCB_PREFIX IPV4_ADDR(224, 0, 1, 0)

#define	IPV4_MULTICAST_INCB_MASK IPV4_ADDR(255, 255, 255, 0)

#define	IPV4_CLASS_A_ADDR IPV4_ADDR(0, 0, 0, 0)

#define	IPV4_CLASS_A_MASK IPV4_ADDR(128, 0, 0, 0)

#define	IPV4_CLASS_B_ADDR IPV4_ADDR(128, 0, 0, 0)

#define	IPV4_CLASS_B_MASK IPV4_ADDR(192, 0, 0, 0)

#define	IPV4_CLASS_C_ADDR IPV4_ADDR(192, 0, 0, 0)

#define	IPV4_CLASS_C_MASK IPV4_ADDR(224, 0, 0, 0)

#define	IPV4_CLASS_D_ADDR IPV4_ADDR(224, 0, 0, 0)

#define	IPV4_CLASS_D_MASK IPV4_ADDR(240, 0, 0, 0)

#define	IPV4_CLASS_E_ADDR IPV4_ADDR(240, 0, 0, 0)

#define	IPV4_CLASS_E_MASK IPV4_ADDR(240, 0, 0, 0)

#define	ipv4CopyAddr(destIpAddr, srcIpAddr) osMemcpy(destIpAddr, srcIpAddr, sizeof(Ipv4Addr))

#define	ipv4CompAddr(ipAddr1, ipAddr2) (!osMemcmp(ipAddr1, ipAddr2, sizeof(Ipv4Addr)))

#define	ipv4IsOnSubnet(entry, ipAddr) (((ipAddr) & (entry)->subnetMask) == ((entry)->addr & (entry)->subnetMask))

#define	ipv4IsLoopbackAddr(ipAddr) (((ipAddr) & IPV4_LOOPBACK_MASK) == IPV4_LOOPBACK_PREFIX)

#define	ipv4IsLinkLocalAddr(ipAddr) (((ipAddr) & IPV4_LINK_LOCAL_MASK) == IPV4_LINK_LOCAL_PREFIX)

#define	ipv4IsMulticastAddr(ipAddr) (((ipAddr) & IPV4_MULTICAST_MASK) == IPV4_MULTICAST_PREFIX)

Typedefs
typedef uint32_t	Ipv4Addr
	IPv4 network address. More...

Enumerations
enum	Ipv4AddrScope { IPV4_ADDR_SCOPE_INTERFACE_LOCAL = 1, IPV4_ADDR_SCOPE_LINK_LOCAL = 2, IPV4_ADDR_SCOPE_GLOBAL = 3 }
	IPv4 address scopes. More...

enum	Ipv4AddrState { IPV4_ADDR_STATE_INVALID = 0, IPV4_ADDR_STATE_TENTATIVE = 1, IPV4_ADDR_STATE_VALID = 2 }
	IPv4 address state. More...

enum	Ipv4FragmentOffset { IPV4_FLAG_RES = 0x8000, IPV4_FLAG_DF = 0x4000, IPV4_FLAG_MF = 0x2000, IPV4_OFFSET_MASK = 0x1FFF }
	IPv4 fragment offset field. More...

enum	Ipv4Protocol { IPV4_PROTOCOL_ICMP = 1, IPV4_PROTOCOL_IGMP = 2, IPV4_PROTOCOL_TCP = 6, IPV4_PROTOCOL_UDP = 17, IPV4_PROTOCOL_ESP = 50, IPV4_PROTOCOL_AH = 51 }
	IPv4 protocol field. More...

enum	Ipv4OptionType { IPV4_OPTION_EEOL = 0, IPV4_OPTION_NOP = 1, IPV4_OPTION_RR = 7, IPV4_OPTION_ZSU = 10, IPV4_OPTION_MTUP = 11, IPV4_OPTION_MTUR = 12, IPV4_OPTION_ENCODE = 15, IPV4_OPTION_QS = 25, IPV4_OPTION_TS = 68, IPV4_OPTION_TR = 82, IPV4_OPTION_SEC = 130, IPV4_OPTION_LSR = 131, IPV4_OPTION_ESEC = 133, IPV4_OPTION_CIPSO = 134, IPV4_OPTION_SID = 136, IPV4_OPTION_SSR = 137, IPV4_OPTION_VISA = 142, IPV4_OPTION_IMITD = 144, IPV4_OPTION_EIP = 145, IPV4_OPTION_ADDEXT = 147, IPV4_OPTION_RTRALT = 148, IPV4_OPTION_SDB = 149, IPV4_OPTION_DPS = 151, IPV4_OPTION_UMP = 152, IPV4_OPTION_FINN = 205 }
	IPv4 option types. More...

Functions
error_t	ipv4Init (NetInterface *interface)
	IPv4 related initialization. More...

error_t	ipv4SetDefaultTtl (NetInterface *interface, uint8_t ttl)
	Set default TTL value for outgoing IPv4 packets. More...

error_t	ipv4SetHostAddr (NetInterface *interface, Ipv4Addr addr)
	Assign host address. More...

error_t	ipv4SetHostAddrEx (NetInterface *interface, uint_t index, Ipv4Addr addr)
	Assign host address. More...

error_t	ipv4GetHostAddr (NetInterface interface, Ipv4Addr addr)
	Retrieve host address. More...

error_t	ipv4GetHostAddrEx (NetInterface interface, uint_t index, Ipv4Addr addr)
	Retrieve host address. More...

error_t	ipv4SetSubnetMask (NetInterface *interface, Ipv4Addr mask)
	Configure subnet mask. More...

error_t	ipv4SetSubnetMaskEx (NetInterface *interface, uint_t index, Ipv4Addr mask)
	Configure subnet mask. More...

error_t	ipv4GetSubnetMask (NetInterface interface, Ipv4Addr mask)
	Retrieve subnet mask. More...

error_t	ipv4GetSubnetMaskEx (NetInterface interface, uint_t index, Ipv4Addr mask)
	Retrieve subnet mask. More...

error_t	ipv4SetDefaultGateway (NetInterface *interface, Ipv4Addr addr)
	Configure default gateway. More...

error_t	ipv4SetDefaultGatewayEx (NetInterface *interface, uint_t index, Ipv4Addr addr)
	Configure default gateway. More...

error_t	ipv4GetDefaultGateway (NetInterface interface, Ipv4Addr addr)
	Retrieve default gateway. More...

error_t	ipv4GetDefaultGatewayEx (NetInterface interface, uint_t index, Ipv4Addr addr)
	Retrieve default gateway. More...

error_t	ipv4SetDnsServer (NetInterface *interface, uint_t index, Ipv4Addr addr)
	Configure DNS server. More...

error_t	ipv4GetDnsServer (NetInterface interface, uint_t index, Ipv4Addr addr)
	Retrieve DNS server. More...

void	ipv4LinkChangeEvent (NetInterface *interface)
	Callback function for link change event. More...

void	ipv4ProcessPacket (NetInterface interface, Ipv4Header packet, size_t length, NetRxAncillary *ancillary)
	Incoming IPv4 packet processing. More...

void	ipv4ProcessDatagram (NetInterface interface, const NetBuffer buffer, size_t offset, NetRxAncillary *ancillary)
	Incoming IPv4 datagram processing. More...

error_t	ipv4SendDatagram (NetInterface interface, const Ipv4PseudoHeader pseudoHeader, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Send an IPv4 datagram. More...

error_t	ipv4SendPacket (NetInterface interface, const Ipv4PseudoHeader pseudoHeader, uint16_t fragId, size_t fragOffset, NetBuffer buffer, size_t offset, NetTxAncillary ancillary)
	Send an IPv4 packet. More...

error_t	ipv4JoinMulticastGroup (NetInterface *interface, Ipv4Addr groupAddr)
	Join the specified host group. More...

error_t	ipv4LeaveMulticastGroup (NetInterface *interface, Ipv4Addr groupAddr)
	Leave the specified host group. More...

error_t	ipv4StringToAddr (const char_t str, Ipv4Addr ipAddr)
	Convert a dot-decimal string to a binary IPv4 address. More...

char_t *	ipv4AddrToString (Ipv4Addr ipAddr, char_t *str)
	Convert a binary IPv4 address to dot-decimal notation. More...

void	ipv4DumpHeader (const Ipv4Header *ipHeader)
	Dump IPv4 header for debugging purpose. More...

Variables
__packed_struct	_Ipv4Header
	IPv4 header. More...

uint8_t	version

uint8_t	typeOfService

uint16_t	totalLength

uint16_t	identification

uint16_t	fragmentOffset

uint8_t	timeToLive

uint8_t	protocol

uint16_t	headerChecksum

Ipv4Addr	srcAddr

Ipv4Addr	destAddr

uint8_t	options []

__packed_struct	_Ipv4PseudoHeader
	IPv4 pseudo header. More...

uint8_t	reserved

uint16_t	length

typedef	__packed_struct
	IPv4 option. More...

uint8_t	value []

	Ipv4Option

Detailed Description

IPv4 (Internet Protocol Version 4)

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

Definition in file ipv4.h.

Macro Definition Documentation

◆ IPV4_ADDR

#define IPV4_ADDR	(	a,
		b,
		c,
		d
	)	((a) \| ((b) << 8) \| ((c) << 16) \| ((uint32_t) (d) << 24))

Definition at line 106 of file ipv4.h.

◆ IPV4_ADDR_LIST_SIZE

#define IPV4_ADDR_LIST_SIZE 1

Definition at line 69 of file ipv4.h.

◆ IPV4_BROADCAST_ADDR

#define IPV4_BROADCAST_ADDR IPV4_ADDR(255, 255, 255, 255)

Definition at line 112 of file ipv4.h.

◆ IPV4_CLASS_A_ADDR

#define IPV4_CLASS_A_ADDR IPV4_ADDR(0, 0, 0, 0)

Definition at line 136 of file ipv4.h.

◆ IPV4_CLASS_A_MASK

#define IPV4_CLASS_A_MASK IPV4_ADDR(128, 0, 0, 0)

Definition at line 137 of file ipv4.h.

◆ IPV4_CLASS_B_ADDR

#define IPV4_CLASS_B_ADDR IPV4_ADDR(128, 0, 0, 0)

Definition at line 138 of file ipv4.h.

◆ IPV4_CLASS_B_MASK

#define IPV4_CLASS_B_MASK IPV4_ADDR(192, 0, 0, 0)

Definition at line 139 of file ipv4.h.

◆ IPV4_CLASS_C_ADDR

#define IPV4_CLASS_C_ADDR IPV4_ADDR(192, 0, 0, 0)

Definition at line 140 of file ipv4.h.

◆ IPV4_CLASS_C_MASK

#define IPV4_CLASS_C_MASK IPV4_ADDR(224, 0, 0, 0)

Definition at line 141 of file ipv4.h.

◆ IPV4_CLASS_D_ADDR

#define IPV4_CLASS_D_ADDR IPV4_ADDR(224, 0, 0, 0)

Definition at line 142 of file ipv4.h.

◆ IPV4_CLASS_D_MASK

#define IPV4_CLASS_D_MASK IPV4_ADDR(240, 0, 0, 0)

Definition at line 143 of file ipv4.h.

◆ IPV4_CLASS_E_ADDR

#define IPV4_CLASS_E_ADDR IPV4_ADDR(240, 0, 0, 0)

Definition at line 144 of file ipv4.h.

◆ IPV4_CLASS_E_MASK

#define IPV4_CLASS_E_MASK IPV4_ADDR(240, 0, 0, 0)

Definition at line 145 of file ipv4.h.

◆ IPV4_DATA

#define IPV4_DATA ( packet ) PTR_OFFSET(packet, packet->headerLength * 4)

Definition at line 100 of file ipv4.h.

◆ IPV4_DEFAULT_MTU

#define IPV4_DEFAULT_MTU 576

Definition at line 93 of file ipv4.h.

◆ IPV4_DEFAULT_TTL

#define IPV4_DEFAULT_TTL 64

Definition at line 62 of file ipv4.h.

◆ IPV4_DNS_SERVER_LIST_SIZE

#define IPV4_DNS_SERVER_LIST_SIZE 2

Definition at line 76 of file ipv4.h.

◆ IPV4_IPSEC_SUPPORT

#define IPV4_IPSEC_SUPPORT DISABLED

Definition at line 55 of file ipv4.h.

◆ IPV4_LINK_LOCAL_MASK

#define IPV4_LINK_LOCAL_MASK IPV4_ADDR(255, 255, 0, 0)

Definition at line 121 of file ipv4.h.

◆ IPV4_LINK_LOCAL_PREFIX

#define IPV4_LINK_LOCAL_PREFIX IPV4_ADDR(169, 254, 0, 0)

Definition at line 120 of file ipv4.h.

◆ IPV4_LOOPBACK_ADDR

#define IPV4_LOOPBACK_ADDR IPV4_ADDR(127, 0, 0, 1)

Definition at line 115 of file ipv4.h.

◆ IPV4_LOOPBACK_MASK

#define IPV4_LOOPBACK_MASK IPV4_ADDR(255, 0, 0, 0)

Definition at line 117 of file ipv4.h.

◆ IPV4_LOOPBACK_PREFIX

#define IPV4_LOOPBACK_PREFIX IPV4_ADDR(127, 0, 0, 0)

Definition at line 116 of file ipv4.h.

◆ IPV4_MAX_HEADER_LENGTH

#define IPV4_MAX_HEADER_LENGTH 60

Definition at line 97 of file ipv4.h.

◆ IPV4_MIN_HEADER_LENGTH

#define IPV4_MIN_HEADER_LENGTH 20

Definition at line 95 of file ipv4.h.

◆ IPV4_MINIMUM_MTU

#define IPV4_MINIMUM_MTU 68

Definition at line 91 of file ipv4.h.

◆ IPV4_MULTICAST_FILTER_SIZE

#define IPV4_MULTICAST_FILTER_SIZE 4

Definition at line 83 of file ipv4.h.

◆ IPV4_MULTICAST_INCB_MASK

#define IPV4_MULTICAST_INCB_MASK IPV4_ADDR(255, 255, 255, 0)

Definition at line 133 of file ipv4.h.

◆ IPV4_MULTICAST_INCB_PREFIX

#define IPV4_MULTICAST_INCB_PREFIX IPV4_ADDR(224, 0, 1, 0)

Definition at line 132 of file ipv4.h.

◆ IPV4_MULTICAST_LNCB_MASK

#define IPV4_MULTICAST_LNCB_MASK IPV4_ADDR(255, 255, 255, 0)

Definition at line 129 of file ipv4.h.

◆ IPV4_MULTICAST_LNCB_PREFIX

#define IPV4_MULTICAST_LNCB_PREFIX IPV4_ADDR(224, 0, 0, 0)

Definition at line 128 of file ipv4.h.

◆ IPV4_MULTICAST_MASK

#define IPV4_MULTICAST_MASK IPV4_ADDR(240, 0, 0, 0)

Definition at line 125 of file ipv4.h.

◆ IPV4_MULTICAST_PREFIX

#define IPV4_MULTICAST_PREFIX IPV4_ADDR(224, 0, 0, 0)

Definition at line 124 of file ipv4.h.

◆ IPV4_SUPPORT

#define IPV4_SUPPORT ENABLED

Definition at line 48 of file ipv4.h.

◆ IPV4_UNSPECIFIED_ADDR

#define IPV4_UNSPECIFIED_ADDR IPV4_ADDR(0, 0, 0, 0)

Definition at line 110 of file ipv4.h.

◆ IPV4_VERSION

#define IPV4_VERSION 4

Definition at line 89 of file ipv4.h.

◆ ipv4CompAddr

#define ipv4CompAddr	(	ipAddr1,
		ipAddr2
	)	(!osMemcmp(ipAddr1, ipAddr2, sizeof(Ipv4Addr)))

Definition at line 152 of file ipv4.h.

◆ ipv4CopyAddr

#define ipv4CopyAddr	(	destIpAddr,
		srcIpAddr
	)	osMemcpy(destIpAddr, srcIpAddr, sizeof(Ipv4Addr))

Definition at line 148 of file ipv4.h.

◆ Ipv4Header

#define Ipv4Header struct _Ipv4Header

Definition at line 36 of file ipv4.h.

◆ ipv4IsLinkLocalAddr

#define ipv4IsLinkLocalAddr ( ipAddr ) (((ipAddr) & IPV4_LINK_LOCAL_MASK) == IPV4_LINK_LOCAL_PREFIX)

Definition at line 164 of file ipv4.h.

◆ ipv4IsLoopbackAddr

#define ipv4IsLoopbackAddr ( ipAddr ) (((ipAddr) & IPV4_LOOPBACK_MASK) == IPV4_LOOPBACK_PREFIX)

Definition at line 160 of file ipv4.h.

◆ ipv4IsMulticastAddr

#define ipv4IsMulticastAddr ( ipAddr ) (((ipAddr) & IPV4_MULTICAST_MASK) == IPV4_MULTICAST_PREFIX)

Definition at line 168 of file ipv4.h.

◆ ipv4IsOnSubnet

#define ipv4IsOnSubnet	(	entry,
		ipAddr
	)	(((ipAddr) & (entry)->subnetMask) == ((entry)->addr & (entry)->subnetMask))

Definition at line 156 of file ipv4.h.

◆ Ipv4PseudoHeader

#define Ipv4PseudoHeader struct _Ipv4PseudoHeader

Definition at line 39 of file ipv4.h.

Typedef Documentation

◆ Ipv4Addr

typedef uint32_t Ipv4Addr

IPv4 network address.

Definition at line 267 of file ipv4.h.

Enumeration Type Documentation

◆ Ipv4AddrScope

enum Ipv4AddrScope

IPv4 address scopes.

Enumerator
IPV4_ADDR_SCOPE_INTERFACE_LOCAL
IPV4_ADDR_SCOPE_LINK_LOCAL
IPV4_ADDR_SCOPE_GLOBAL

Definition at line 181 of file ipv4.h.

◆ Ipv4AddrState

enum Ipv4AddrState

IPv4 address state.

Enumerator
IPV4_ADDR_STATE_INVALID	An address that is not assigned to any interface.
IPV4_ADDR_STATE_TENTATIVE	An address whose uniqueness on a link is being verified.
IPV4_ADDR_STATE_VALID	An address assigned to an interface whose use is unrestricted.

Definition at line 193 of file ipv4.h.

◆ Ipv4FragmentOffset

enum Ipv4FragmentOffset

IPv4 fragment offset field.

Enumerator
IPV4_FLAG_RES
IPV4_FLAG_DF
IPV4_FLAG_MF
IPV4_OFFSET_MASK

Definition at line 205 of file ipv4.h.

◆ Ipv4OptionType

enum Ipv4OptionType

IPv4 option types.

Enumerator
IPV4_OPTION_EEOL	End of Options List.
IPV4_OPTION_NOP	No Operation.
IPV4_OPTION_RR	Record Route.
IPV4_OPTION_ZSU	Experimental Measurement.
IPV4_OPTION_MTUP	MTU Probe.
IPV4_OPTION_MTUR	MTU Reply.
IPV4_OPTION_ENCODE	Experimental IP encryption.
IPV4_OPTION_QS	Quick-Start.
IPV4_OPTION_TS	Time Stamp.
IPV4_OPTION_TR	Traceroute.
IPV4_OPTION_SEC	Security.
IPV4_OPTION_LSR	Loose Source Route.
IPV4_OPTION_ESEC	Extended Security.
IPV4_OPTION_CIPSO	Commercial Security.
IPV4_OPTION_SID	Stream ID.
IPV4_OPTION_SSR	Strict Source Route.
IPV4_OPTION_VISA	Experimental Access Control.
IPV4_OPTION_IMITD	IMI Traffic Descriptor.
IPV4_OPTION_EIP	Extended Internet Protocol.
IPV4_OPTION_ADDEXT	Address Extension.
IPV4_OPTION_RTRALT	Router Alert.
IPV4_OPTION_SDB	Selective Directed Broadcast.
IPV4_OPTION_DPS	Dynamic Packet State.
IPV4_OPTION_UMP	Upstream Multicast Packet.
IPV4_OPTION_FINN	Experimental Flow Control.

Definition at line 233 of file ipv4.h.

◆ Ipv4Protocol

enum Ipv4Protocol

IPv4 protocol field.

Enumerator
IPV4_PROTOCOL_ICMP
IPV4_PROTOCOL_IGMP
IPV4_PROTOCOL_TCP
IPV4_PROTOCOL_UDP
IPV4_PROTOCOL_ESP
IPV4_PROTOCOL_AH

Definition at line 218 of file ipv4.h.

Function Documentation

◆ ipv4AddrToString()

char_t* ipv4AddrToString	(	Ipv4Addr	ipAddr,
		char_t *	str
	)

Convert a binary IPv4 address to dot-decimal notation.

Parameters

[in]	ipAddr	Binary representation of the IPv4 address
[out]	str	NULL-terminated string representing the IPv4 address

Returns: Pointer to the formatted string

Definition at line 1617 of file ipv4.c.

◆ ipv4DumpHeader()

void ipv4DumpHeader ( const Ipv4Header * ipHeader )

Dump IPv4 header for debugging purpose.

Parameters

[in] ipHeader Pointer to the IPv4 header

Definition at line 1641 of file ipv4.c.

◆ ipv4GetDefaultGateway()

error_t ipv4GetDefaultGateway	(	NetInterface *	interface,
		Ipv4Addr *	addr
	)

Retrieve default gateway.

Parameters

[in]	interface	Pointer to the desired network interface
[out]	addr	Default gateway address

Returns: Error code

Definition at line 434 of file ipv4.c.

◆ ipv4GetDefaultGatewayEx()

error_t ipv4GetDefaultGatewayEx	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr *	addr
	)

Retrieve default gateway.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	Zero-based index
[out]	addr	Default gateway address

Returns: Error code

Definition at line 449 of file ipv4.c.

◆ ipv4GetDnsServer()

error_t ipv4GetDnsServer	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr *	addr
	)

Retrieve DNS server.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	This parameter selects between the primary and secondary DNS server
[out]	addr	DNS server address

Returns: Error code

Definition at line 519 of file ipv4.c.

◆ ipv4GetHostAddr()

error_t ipv4GetHostAddr	(	NetInterface *	interface,
		Ipv4Addr *	addr
	)

Retrieve host address.

Parameters

[in]	interface	Pointer to the desired network interface
[out]	addr	IPv4 host address

Returns: Error code

Definition at line 227 of file ipv4.c.

◆ ipv4GetHostAddrEx()

error_t ipv4GetHostAddrEx	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr *	addr
	)

Retrieve host address.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	Zero-based index
[out]	addr	IPv4 host address

Returns: Error code

Definition at line 242 of file ipv4.c.

◆ ipv4GetSubnetMask()

error_t ipv4GetSubnetMask	(	NetInterface *	interface,
		Ipv4Addr *	mask
	)

Retrieve subnet mask.

Parameters

[in]	interface	Pointer to the desired network interface
[out]	mask	Subnet mask

Returns: Error code

Definition at line 336 of file ipv4.c.

◆ ipv4GetSubnetMaskEx()

error_t ipv4GetSubnetMaskEx	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr *	mask
	)

Retrieve subnet mask.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	Zero-based index
[out]	mask	Subnet mask

Returns: Error code

Definition at line 351 of file ipv4.c.

◆ ipv4Init()

error_t ipv4Init ( NetInterface * interface )

IPv4 related initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 79 of file ipv4.c.

◆ ipv4JoinMulticastGroup()

error_t ipv4JoinMulticastGroup	(	NetInterface *	interface,
		Ipv4Addr	groupAddr
	)

Join the specified host group.

Parameters

[in]	interface	Underlying network interface
[in]	groupAddr	IPv4 address identifying the host group to join

Returns: Error code

Definition at line 1345 of file ipv4.c.

◆ ipv4LeaveMulticastGroup()

error_t ipv4LeaveMulticastGroup	(	NetInterface *	interface,
		Ipv4Addr	groupAddr
	)

Leave the specified host group.

Parameters

[in]	interface	Underlying network interface
[in]	groupAddr	IPv4 address identifying the host group to leave

Returns: Error code

Definition at line 1454 of file ipv4.c.

◆ ipv4LinkChangeEvent()

void ipv4LinkChangeEvent ( NetInterface * interface )

Callback function for link change event.

Parameters

[in] interface Underlying network interface

Definition at line 551 of file ipv4.c.

◆ ipv4ProcessDatagram()

void ipv4ProcessDatagram	(	NetInterface *	interface,
		const NetBuffer *	buffer,
		size_t	offset,
		NetRxAncillary *	ancillary
	)

Incoming IPv4 datagram processing.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer that holds the incoming IPv4 datagram
[in]	offset	Offset from the beginning of the buffer
[in]	ancillary	Additional options passed to the stack along with the packet

Definition at line 819 of file ipv4.c.

◆ ipv4ProcessPacket()

void ipv4ProcessPacket	(	NetInterface *	interface,
		Ipv4Header *	packet,
		size_t	length,
		NetRxAncillary *	ancillary
	)

Incoming IPv4 packet processing.

Parameters

[in]	interface	Underlying network interface
[in]	packet	Incoming IPv4 packet
[in]	length	Packet length including header and payload
[in]	ancillary	Additional options passed to the stack along with the packet

Definition at line 602 of file ipv4.c.

◆ ipv4SendDatagram()

error_t ipv4SendDatagram	(	NetInterface *	interface,
		const Ipv4PseudoHeader *	pseudoHeader,
		NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send an IPv4 datagram.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	IPv4 pseudo header
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first byte of the payload
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 1004 of file ipv4.c.

◆ ipv4SendPacket()

error_t ipv4SendPacket	(	NetInterface *	interface,
		const Ipv4PseudoHeader *	pseudoHeader,
		uint16_t	fragId,
		size_t	fragOffset,
		NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send an IPv4 packet.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	IPv4 pseudo header
[in]	fragId	Fragment identification field
[in]	fragOffset	Fragment offset field
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first byte of the payload
[in]	ancillary	Additional options passed to the stack along with the packet

Returns: Error code

Definition at line 1081 of file ipv4.c.

◆ ipv4SetDefaultGateway()

error_t ipv4SetDefaultGateway	(	NetInterface *	interface,
		Ipv4Addr	addr
	)

Configure default gateway.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	addr	Default gateway address

Returns: Error code

Definition at line 385 of file ipv4.c.

◆ ipv4SetDefaultGatewayEx()

error_t ipv4SetDefaultGatewayEx	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr	addr
	)

Configure default gateway.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	Zero-based index
[in]	addr	Default gateway address

Returns: Error code

Definition at line 400 of file ipv4.c.

◆ ipv4SetDefaultTtl()

error_t ipv4SetDefaultTtl	(	NetInterface *	interface,
		uint8_t	ttl
	)

Set default TTL value for outgoing IPv4 packets.

Parameters

[in]	interface	Underlying network interface
[in]	ttl	Default time-to-live value

Returns: Error code

Definition at line 128 of file ipv4.c.

◆ ipv4SetDnsServer()

error_t ipv4SetDnsServer	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr	addr
	)

Configure DNS server.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	This parameter selects between the primary and secondary DNS server
[in]	addr	DNS server address

Returns: Error code

Definition at line 485 of file ipv4.c.

◆ ipv4SetHostAddr()

error_t ipv4SetHostAddr	(	NetInterface *	interface,
		Ipv4Addr	addr
	)

Assign host address.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	addr	IPv4 host address

Returns: Error code

Definition at line 153 of file ipv4.c.

◆ ipv4SetHostAddrEx()

error_t ipv4SetHostAddrEx	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr	addr
	)

Assign host address.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	Zero-based index
[in]	addr	IPv4 host address

Returns: Error code

Definition at line 168 of file ipv4.c.

◆ ipv4SetSubnetMask()

error_t ipv4SetSubnetMask	(	NetInterface *	interface,
		Ipv4Addr	mask
	)

Configure subnet mask.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	mask	Subnet mask

Returns: Error code

Definition at line 292 of file ipv4.c.

◆ ipv4SetSubnetMaskEx()

error_t ipv4SetSubnetMaskEx	(	NetInterface *	interface,
		uint_t	index,
		Ipv4Addr	mask
	)

Configure subnet mask.

Parameters

[in]	interface	Pointer to the desired network interface
[in]	index	Zero-based index
[in]	mask	Subnet mask

Returns: Error code

Definition at line 307 of file ipv4.c.

◆ ipv4StringToAddr()

error_t ipv4StringToAddr	(	const char_t *	str,
		Ipv4Addr *	ipAddr
	)

Convert a dot-decimal string to a binary IPv4 address.

Parameters

[in]	str	NULL-terminated string representing the IPv4 address
[out]	ipAddr	Binary representation of the IPv4 address

Returns: Error code

Definition at line 1530 of file ipv4.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct

Initial value:

{

uint8_t type

IPv4 option.

Definition at line 320 of file ipv4.h.

◆ _Ipv4Header

__packed_struct _Ipv4Header

Initial value:

{
 
   uint8_t headerLength : 4

IPv4 header.

Definition at line 280 of file ipv4.h.

◆ _Ipv4PseudoHeader

__packed_struct _Ipv4PseudoHeader

Initial value:

{

Ipv4Addr srcAddr

IPv4 pseudo header.

Definition at line 306 of file ipv4.h.

◆ destAddr

Ipv6Addr destAddr

Definition at line 297 of file ipv4.h.

◆ fragmentOffset

uint16_t fragmentOffset

Definition at line 292 of file ipv4.h.

◆ headerChecksum

uint16_t headerChecksum

Definition at line 295 of file ipv4.h.

◆ identification

uint16_t identification

Definition at line 291 of file ipv4.h.

◆ Ipv4Option

Ipv4Option

Definition at line 325 of file ipv4.h.

◆ length

uint8_t length

Definition at line 312 of file ipv4.h.

◆ options

uint8_t options[]

Definition at line 298 of file ipv4.h.

◆ protocol

uint16_t protocol

Definition at line 294 of file ipv4.h.

◆ reserved

uint8_t reserved

Definition at line 310 of file ipv4.h.

◆ srcAddr

Ipv4Addr srcAddr

Definition at line 296 of file ipv4.h.

◆ timeToLive

uint8_t timeToLive

Definition at line 293 of file ipv4.h.

◆ totalLength

uint16_t totalLength

Definition at line 290 of file ipv4.h.

◆ typeOfService

uint8_t typeOfService

Definition at line 289 of file ipv4.h.

◆ value

uint8_t value[]

Definition at line 324 of file ipv4.h.

◆ version

uint8_t version

Definition at line 287 of file ipv4.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ IPV4_ADDR

◆ IPV4_ADDR_LIST_SIZE

◆ IPV4_BROADCAST_ADDR

◆ IPV4_CLASS_A_ADDR

◆ IPV4_CLASS_A_MASK

◆ IPV4_CLASS_B_ADDR

◆ IPV4_CLASS_B_MASK

◆ IPV4_CLASS_C_ADDR

◆ IPV4_CLASS_C_MASK

◆ IPV4_CLASS_D_ADDR

◆ IPV4_CLASS_D_MASK

◆ IPV4_CLASS_E_ADDR

◆ IPV4_CLASS_E_MASK

◆ IPV4_DATA

◆ IPV4_DEFAULT_MTU

◆ IPV4_DEFAULT_TTL

◆ IPV4_DNS_SERVER_LIST_SIZE

◆ IPV4_IPSEC_SUPPORT

◆ IPV4_LINK_LOCAL_MASK

◆ IPV4_LINK_LOCAL_PREFIX

◆ IPV4_LOOPBACK_ADDR

◆ IPV4_LOOPBACK_MASK

◆ IPV4_LOOPBACK_PREFIX

◆ IPV4_MAX_HEADER_LENGTH

◆ IPV4_MIN_HEADER_LENGTH

◆ IPV4_MINIMUM_MTU

◆ IPV4_MULTICAST_FILTER_SIZE

◆ IPV4_MULTICAST_INCB_MASK

◆ IPV4_MULTICAST_INCB_PREFIX

◆ IPV4_MULTICAST_LNCB_MASK

◆ IPV4_MULTICAST_LNCB_PREFIX

◆ IPV4_MULTICAST_MASK

◆ IPV4_MULTICAST_PREFIX

◆ IPV4_SUPPORT

◆ IPV4_UNSPECIFIED_ADDR

◆ IPV4_VERSION

◆ ipv4CompAddr

◆ ipv4CopyAddr

◆ Ipv4Header

◆ ipv4IsLinkLocalAddr

◆ ipv4IsLoopbackAddr

◆ ipv4IsMulticastAddr

◆ ipv4IsOnSubnet

◆ Ipv4PseudoHeader

Typedef Documentation

◆ Ipv4Addr

Enumeration Type Documentation

◆ Ipv4AddrScope

◆ Ipv4AddrState

◆ Ipv4FragmentOffset

◆ Ipv4OptionType

◆ Ipv4Protocol

Function Documentation

◆ ipv4AddrToString()

◆ ipv4DumpHeader()

◆ ipv4GetDefaultGateway()

◆ ipv4GetDefaultGatewayEx()

◆ ipv4GetDnsServer()

◆ ipv4GetHostAddr()

◆ ipv4GetHostAddrEx()

◆ ipv4GetSubnetMask()

◆ ipv4GetSubnetMaskEx()

◆ ipv4Init()

◆ ipv4JoinMulticastGroup()

◆ ipv4LeaveMulticastGroup()

◆ ipv4LinkChangeEvent()

◆ ipv4ProcessDatagram()

◆ ipv4ProcessPacket()

◆ ipv4SendDatagram()

◆ ipv4SendPacket()

◆ ipv4SetDefaultGateway()