IPv4 (Internet Protocol Version 4) More...

#include "core/net.h"
#include "core/ethernet.h"
#include "core/ip.h"
#include "core/udp.h"
#include "core/tcp_fsm.h"
#include "core/raw_socket.h"
#include "ipv4/arp_cache.h"
#include "ipv4/ipv4.h"
#include "ipv4/ipv4_multicast.h"
#include "ipv4/ipv4_routing.h"
#include "ipv4/ipv4_misc.h"
#include "ipv4/icmp.h"
#include "ipv4/auto_ip_misc.h"
#include "igmp/igmp_host.h"
#include "dhcp/dhcp_client_misc.h"
#include "mdns/mdns_responder.h"
#include "mibs/mib2_module.h"
#include "mibs/ip_mib_module.h"
#include "debug.h"
#include "ipsec/ipsec.h"
#include "ipsec/ipsec_inbound.h"
#include "ipsec/ipsec_outbound.h"
#include "ah/ah.h"
#include "esp/esp.h"

Macros
#define	TRACE_LEVEL IPV4_TRACE_LEVEL

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

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.

Description

The Internet Protocol (IP) provides the functions necessary to deliver a datagram from a source to a destination over an interconnected system of networks. Refer to RFC 791 for complete details

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file ipv4.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL IPV4_TRACE_LEVEL

Definition at line 38 of file ipv4.c.

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 1457 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 1481 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 438 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 453 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 523 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 228 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 243 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 339 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 354 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 80 of file ipv4.c.

◆ ipv4LinkChangeEvent()

void ipv4LinkChangeEvent ( NetInterface * interface )

Callback function for link change event.

Parameters

[in] interface Underlying network interface

Definition at line 555 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 825 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 606 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 1010 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 1096 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 389 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 404 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 129 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 489 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 154 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 169 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 294 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 309 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 1368 of file ipv4.c.

Macros

Functions

Detailed Description

License

Description

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ipv4AddrToString()

◆ ipv4DumpHeader()

◆ ipv4GetDefaultGateway()

◆ ipv4GetDefaultGatewayEx()

◆ ipv4GetDnsServer()

◆ ipv4GetHostAddr()

◆ ipv4GetHostAddrEx()

◆ ipv4GetSubnetMask()

◆ ipv4GetSubnetMaskEx()

◆ ipv4Init()

◆ ipv4LinkChangeEvent()

◆ ipv4ProcessDatagram()

◆ ipv4ProcessPacket()

◆ ipv4SendDatagram()

◆ ipv4SendPacket()

◆ ipv4SetDefaultGateway()

◆ ipv4SetDefaultGatewayEx()

◆ ipv4SetDefaultTtl()

◆ ipv4SetDnsServer()

◆ ipv4SetHostAddr()

◆ ipv4SetHostAddrEx()

◆ ipv4SetSubnetMask()

◆ ipv4SetSubnetMaskEx()

◆ ipv4StringToAddr()