ipv4.h File Reference

IPv4 (Internet Protocol Version 4) More...

#include <string.h>
#include "core/net.h"
#include "core/ethernet.h"
#include "ipv4/ipv4_frag.h"

Go to the source code of this file.

Data Structures
struct	_Ipv4Header
	IPv4 header. More...
struct	_Ipv4PseudoHeader
	IPv4 pseudo header. More...
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_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...
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
}	Ipv4Option
	IPv4 option. 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_RTRALT = 148 }
	IPv4 option types. More...

Functions
error_t	ipv4Init (NetInterface *interface)
	IPv4 related initialization. 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, NetRxAncillary *ancillary)
	Incoming IPv4 datagram processing. More...
error_t	ipv4SendDatagram (NetInterface *interface, Ipv4PseudoHeader *pseudoHeader, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send an IPv4 datagram. More...
error_t	ipv4SendPacket (NetInterface *interface, 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
__start_packed struct _Ipv4Header	__end_packed

Detailed Description

IPv4 (Internet Protocol Version 4)

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

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 100 of file ipv4.h.

IPV4_ADDR_LIST_SIZE

#define IPV4_ADDR_LIST_SIZE   1

Definition at line 63 of file ipv4.h.

IPV4_BROADCAST_ADDR

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

Definition at line 106 of file ipv4.h.

IPV4_CLASS_A_ADDR

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

Definition at line 130 of file ipv4.h.

IPV4_CLASS_A_MASK

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

Definition at line 131 of file ipv4.h.

IPV4_CLASS_B_ADDR

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

Definition at line 132 of file ipv4.h.

IPV4_CLASS_B_MASK

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

Definition at line 133 of file ipv4.h.

IPV4_CLASS_C_ADDR

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

Definition at line 134 of file ipv4.h.

IPV4_CLASS_C_MASK

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

Definition at line 135 of file ipv4.h.

IPV4_CLASS_D_ADDR

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

Definition at line 136 of file ipv4.h.

IPV4_CLASS_D_MASK

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

Definition at line 137 of file ipv4.h.

IPV4_CLASS_E_ADDR

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

Definition at line 138 of file ipv4.h.

IPV4_CLASS_E_MASK

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

Definition at line 139 of file ipv4.h.

IPV4_DATA

#define IPV4_DATA

(

packet

)

PTR_OFFSET(packet, packet->headerLength * 4)

Definition at line 94 of file ipv4.h.

IPV4_DEFAULT_MTU

#define IPV4_DEFAULT_MTU   576

Definition at line 87 of file ipv4.h.

IPV4_DEFAULT_TTL

#define IPV4_DEFAULT_TTL   64

Definition at line 56 of file ipv4.h.

IPV4_DNS_SERVER_LIST_SIZE

#define IPV4_DNS_SERVER_LIST_SIZE   2

Definition at line 70 of file ipv4.h.

IPV4_LINK_LOCAL_MASK

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

Definition at line 115 of file ipv4.h.

IPV4_LINK_LOCAL_PREFIX

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

Definition at line 114 of file ipv4.h.

IPV4_LOOPBACK_ADDR

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

Definition at line 109 of file ipv4.h.

IPV4_LOOPBACK_MASK

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

Definition at line 111 of file ipv4.h.

IPV4_LOOPBACK_PREFIX

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

Definition at line 110 of file ipv4.h.

IPV4_MAX_HEADER_LENGTH

#define IPV4_MAX_HEADER_LENGTH   60

Definition at line 91 of file ipv4.h.

IPV4_MIN_HEADER_LENGTH

#define IPV4_MIN_HEADER_LENGTH   20

Definition at line 89 of file ipv4.h.

IPV4_MINIMUM_MTU

#define IPV4_MINIMUM_MTU   68

Definition at line 85 of file ipv4.h.

IPV4_MULTICAST_FILTER_SIZE

#define IPV4_MULTICAST_FILTER_SIZE   4

Definition at line 77 of file ipv4.h.

IPV4_MULTICAST_INCB_MASK

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

Definition at line 127 of file ipv4.h.

IPV4_MULTICAST_INCB_PREFIX

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

Definition at line 126 of file ipv4.h.

IPV4_MULTICAST_LNCB_MASK

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

Definition at line 123 of file ipv4.h.

IPV4_MULTICAST_LNCB_PREFIX

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

Definition at line 122 of file ipv4.h.

IPV4_MULTICAST_MASK

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

Definition at line 119 of file ipv4.h.

IPV4_MULTICAST_PREFIX

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

Definition at line 118 of file ipv4.h.

IPV4_SUPPORT

#define IPV4_SUPPORT   ENABLED

Definition at line 49 of file ipv4.h.

IPV4_UNSPECIFIED_ADDR

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

Definition at line 104 of file ipv4.h.

IPV4_VERSION

#define IPV4_VERSION   4

Definition at line 83 of file ipv4.h.

ipv4CompAddr

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

Definition at line 146 of file ipv4.h.

ipv4CopyAddr

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

Definition at line 142 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 158 of file ipv4.h.

ipv4IsLoopbackAddr

#define ipv4IsLoopbackAddr

(

ipAddr

)

(((ipAddr) & IPV4_LOOPBACK_MASK) == IPV4_LOOPBACK_PREFIX)

Definition at line 154 of file ipv4.h.

ipv4IsMulticastAddr

#define ipv4IsMulticastAddr

(

ipAddr

)

(((ipAddr) & IPV4_MULTICAST_MASK) == IPV4_MULTICAST_PREFIX)

Definition at line 162 of file ipv4.h.

ipv4IsOnSubnet

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

Definition at line 150 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 239 of file ipv4.h.

Ipv4Option

typedef { ... } Ipv4Option

IPv4 option.

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 175 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 187 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 199 of file ipv4.h.

Ipv4OptionType

enum Ipv4OptionType

IPv4 option types.

Enumerator
IPV4_OPTION_EEOL
IPV4_OPTION_NOP
IPV4_OPTION_RTRALT

Definition at line 227 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 212 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 1529 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 1553 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 399 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 414 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 484 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 192 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 207 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 301 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 316 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 71 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 1257 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 1366 of file ipv4.c.

ipv4LinkChangeEvent()

void ipv4LinkChangeEvent

(

NetInterface *

interface

)

Callback function for link change event.

Parameters

[in]

interface

Underlying network interface

Definition at line 516 of file ipv4.c.

ipv4ProcessDatagram()

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

Incoming IPv4 datagram processing.

Parameters

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

Definition at line 783 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 567 of file ipv4.c.

ipv4SendDatagram()

error_t ipv4SendDatagram	(	NetInterface *	interface,
		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 942 of file ipv4.c.

ipv4SendPacket()

error_t ipv4SendPacket	(	NetInterface *	interface,
		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 1004 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 350 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 365 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 450 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 118 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 133 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 257 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 272 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 1442 of file ipv4.c.

Variable Documentation

__end_packed

__start_packed struct _Ipv6PseudoHeader __end_packed

length

uint8_t length

Definition at line 295 of file ipv4.h.

type

uint8_t type

Definition at line 294 of file ipv4.h.

value

uint8_t value[]

Definition at line 296 of file ipv4.h.