ARP (Address Resolution Protocol) More...

#include "core/net.h"

Go to the source code of this file.

Data Structures

struct  ArpQueueItem
 ARP queue item. More...
 
struct  ArpCacheEntry
 ARP cache entry. More...
 

Macros

#define ARP_TICK_INTERVAL   200
 
#define ARP_CACHE_SIZE   8
 
#define ARP_MAX_PENDING_PACKETS   2
 
#define ARP_MAX_REQUESTS   3
 
#define ARP_REQUEST_TIMEOUT   1000
 
#define ARP_MAX_PROBES   2
 
#define ARP_PROBE_TIMEOUT   60000
 
#define ARP_REACHABLE_TIME   60000
 
#define ARP_DELAY_FIRST_PROBE_TIME   5000
 
#define ARP_HARDWARE_TYPE_ETH   0x0001
 
#define ARP_PROTOCOL_TYPE_IPV4   0x0800
 

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
 
ArpPacket
 ARP packet. More...
 

Enumerations

enum  ArpOpcode { ARP_OPCODE_ARP_REQUEST = 1, ARP_OPCODE_ARP_REPLY = 2 }
 ARP opcodes. More...
 
enum  ArpState {
  ARP_STATE_NONE = 0, ARP_STATE_INCOMPLETE = 1, ARP_STATE_REACHABLE = 2, ARP_STATE_STALE = 3,
  ARP_STATE_DELAY = 4, ARP_STATE_PROBE = 5, ARP_STATE_PERMANENT = 6
}
 ARP cache entry states. More...
 

Functions

error_t arpInit (NetInterface *interface)
 ARP cache initialization. More...
 
void arpFlushCache (NetInterface *interface)
 Flush ARP cache. More...
 
ArpCacheEntryarpCreateEntry (NetInterface *interface)
 Create a new entry in the ARP cache. More...
 
ArpCacheEntryarpFindEntry (NetInterface *interface, Ipv4Addr ipAddr)
 Search the ARP cache for a given IPv4 address. More...
 
void arpSendQueuedPackets (NetInterface *interface, ArpCacheEntry *entry)
 Send packets that are waiting for address resolution. More...
 
void arpFlushQueuedPackets (NetInterface *interface, ArpCacheEntry *entry)
 Flush packet queue. More...
 
error_t arpResolve (NetInterface *interface, Ipv4Addr ipAddr, MacAddr *macAddr)
 Address resolution using ARP protocol. More...
 
error_t arpEnqueuePacket (NetInterface *interface, Ipv4Addr ipAddr, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Enqueue an IPv4 packet waiting for address resolution. More...
 
void arpTick (NetInterface *interface)
 ARP timer handler. More...
 
void arpProcessPacket (NetInterface *interface, ArpPacket *arpPacket, size_t length)
 Incoming ARP packet processing. More...
 
void arpProcessRequest (NetInterface *interface, ArpPacket *arpRequest)
 Incoming ARP request processing. More...
 
void arpProcessReply (NetInterface *interface, ArpPacket *arpResponse)
 Incoming ARP reply processing. More...
 
error_t arpSendProbe (NetInterface *interface, Ipv4Addr targetIpAddr)
 Send ARP probe. More...
 
error_t arpSendRequest (NetInterface *interface, Ipv4Addr targetIpAddr, const MacAddr *destMacAddr)
 Send ARP request. More...
 
error_t arpSendReply (NetInterface *interface, Ipv4Addr senderIpAddr, Ipv4Addr targetIpAddr, const MacAddr *targetMacAddr)
 Send ARP reply. More...
 
void arpDumpPacket (const ArpPacket *arpPacket)
 Dump ARP packet for debugging purpose. More...
 

Variables

systime_t arpTickCounter
 

Detailed Description

ARP (Address Resolution Protocol)

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

Definition in file arp.h.

Macro Definition Documentation

◆ ARP_CACHE_SIZE

#define ARP_CACHE_SIZE   8

Definition at line 46 of file arp.h.

◆ ARP_DELAY_FIRST_PROBE_TIME

#define ARP_DELAY_FIRST_PROBE_TIME   5000

Definition at line 95 of file arp.h.

◆ ARP_HARDWARE_TYPE_ETH

#define ARP_HARDWARE_TYPE_ETH   0x0001

Definition at line 101 of file arp.h.

◆ ARP_MAX_PENDING_PACKETS

#define ARP_MAX_PENDING_PACKETS   2

Definition at line 53 of file arp.h.

◆ ARP_MAX_PROBES

#define ARP_MAX_PROBES   2

Definition at line 74 of file arp.h.

◆ ARP_MAX_REQUESTS

#define ARP_MAX_REQUESTS   3

Definition at line 60 of file arp.h.

◆ ARP_PROBE_TIMEOUT

#define ARP_PROBE_TIMEOUT   60000

Definition at line 81 of file arp.h.

◆ ARP_PROTOCOL_TYPE_IPV4

#define ARP_PROTOCOL_TYPE_IPV4   0x0800

Definition at line 103 of file arp.h.

◆ ARP_REACHABLE_TIME

#define ARP_REACHABLE_TIME   60000

Definition at line 88 of file arp.h.

◆ ARP_REQUEST_TIMEOUT

#define ARP_REQUEST_TIMEOUT   1000

Definition at line 67 of file arp.h.

◆ ARP_TICK_INTERVAL

#define ARP_TICK_INTERVAL   200

Definition at line 39 of file arp.h.

Typedef Documentation

◆ ArpPacket

typedef { ... } ArpPacket

ARP packet.

Enumeration Type Documentation

◆ ArpOpcode

enum ArpOpcode

ARP opcodes.

Enumerator
ARP_OPCODE_ARP_REQUEST 
ARP_OPCODE_ARP_REPLY 

Definition at line 115 of file arp.h.

◆ ArpState

enum ArpState

ARP cache entry states.

Enumerator
ARP_STATE_NONE 
ARP_STATE_INCOMPLETE 
ARP_STATE_REACHABLE 
ARP_STATE_STALE 
ARP_STATE_DELAY 
ARP_STATE_PROBE 
ARP_STATE_PERMANENT 

Definition at line 126 of file arp.h.

Function Documentation

◆ arpCreateEntry()

ArpCacheEntry* arpCreateEntry ( NetInterface interface)

Create a new entry in the ARP cache.

Parameters
[in]interfaceUnderlying network interface
Returns
Pointer to the newly created entry

Definition at line 100 of file arp.c.

◆ arpDumpPacket()

void arpDumpPacket ( const ArpPacket arpPacket)

Dump ARP packet for debugging purpose.

Parameters
[in]arpPacketARP header

Definition at line 1001 of file arp.c.

◆ arpEnqueuePacket()

error_t arpEnqueuePacket ( NetInterface interface,
Ipv4Addr  ipAddr,
NetBuffer buffer,
size_t  offset,
NetTxAncillary ancillary 
)

Enqueue an IPv4 packet waiting for address resolution.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv4 address of the destination host
[in]bufferMulti-part buffer containing the packet to be enqueued
[in]offsetOffset to the first byte of the packet
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 344 of file arp.c.

◆ arpFindEntry()

ArpCacheEntry* arpFindEntry ( NetInterface interface,
Ipv4Addr  ipAddr 
)

Search the ARP cache for a given IPv4 address.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv4 address
Returns
A pointer to the matching ARP entry is returned. NULL is returned if the specified IPv4 address could not be found in ARP cache

Definition at line 152 of file arp.c.

◆ arpFlushCache()

void arpFlushCache ( NetInterface interface)

Flush ARP cache.

Parameters
[in]interfaceUnderlying network interface

Definition at line 75 of file arp.c.

◆ arpFlushQueuedPackets()

void arpFlushQueuedPackets ( NetInterface interface,
ArpCacheEntry entry 
)

Flush packet queue.

Parameters
[in]interfaceUnderlying network interface
[in]entryPointer to a ARP cache entry

Definition at line 223 of file arp.c.

◆ arpInit()

error_t arpInit ( NetInterface interface)

ARP cache initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 60 of file arp.c.

◆ arpProcessPacket()

void arpProcessPacket ( NetInterface interface,
ArpPacket arpPacket,
size_t  length 
)

Incoming ARP packet processing.

Parameters
[in]interfaceUnderlying network interface
[in]arpPacketIncoming ARP packet
[in]lengthPacket length

Definition at line 543 of file arp.c.

◆ arpProcessReply()

void arpProcessReply ( NetInterface interface,
ArpPacket arpReply 
)

Incoming ARP reply processing.

Parameters
[in]interfaceUnderlying network interface
[in]arpReplyIncoming ARP reply

Definition at line 732 of file arp.c.

◆ arpProcessRequest()

void arpProcessRequest ( NetInterface interface,
ArpPacket arpRequest 
)

Incoming ARP request processing.

Parameters
[in]interfaceUnderlying network interface
[in]arpRequestIncoming ARP request

Definition at line 662 of file arp.c.

◆ arpResolve()

error_t arpResolve ( NetInterface interface,
Ipv4Addr  ipAddr,
MacAddr macAddr 
)

Address resolution using ARP protocol.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv4 address
[in]macAddrPhysical address matching the specified IPv4 address
Returns
Error code

Definition at line 251 of file arp.c.

◆ arpSendProbe()

error_t arpSendProbe ( NetInterface interface,
Ipv4Addr  targetIpAddr 
)

Send ARP probe.

Parameters
[in]interfaceUnderlying network interface
[in]targetIpAddrTarget IPv4 address
Returns
Error code

Definition at line 814 of file arp.c.

◆ arpSendQueuedPackets()

void arpSendQueuedPackets ( NetInterface interface,
ArpCacheEntry entry 
)

Send packets that are waiting for address resolution.

Parameters
[in]interfaceUnderlying network interface
[in]entryPointer to a ARP cache entry

Definition at line 183 of file arp.c.

◆ arpSendReply()

error_t arpSendReply ( NetInterface interface,
Ipv4Addr  senderIpAddr,
Ipv4Addr  targetIpAddr,
const MacAddr targetMacAddr 
)

Send ARP reply.

Parameters
[in]interfaceUnderlying network interface
[in]senderIpAddrSender Ipv4 address
[in]targetIpAddrTarget IPv4 address
[in]targetMacAddrTarget MAC address
Returns
Error code

Definition at line 943 of file arp.c.

◆ arpSendRequest()

error_t arpSendRequest ( NetInterface interface,
Ipv4Addr  targetIpAddr,
const MacAddr destMacAddr 
)

Send ARP request.

Parameters
[in]interfaceUnderlying network interface
[in]targetIpAddrTarget IPv4 address
[in]destMacAddrDestination MAC address
Returns
Error code

Definition at line 874 of file arp.c.

◆ arpTick()

void arpTick ( NetInterface interface)

ARP timer handler.

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

Parameters
[in]interfaceUnderlying network interface

Definition at line 432 of file arp.c.

Variable Documentation

◆ arpTickCounter

systime_t arpTickCounter
extern

Definition at line 51 of file arp.c.

◆ hln

uint8_t hln

Definition at line 152 of file arp.h.

◆ hrd

uint16_t hrd

Definition at line 150 of file arp.h.

◆ op

uint16_t op

Definition at line 154 of file arp.h.

◆ pln

uint8_t pln

Definition at line 153 of file arp.h.

◆ pro

uint16_t pro

Definition at line 151 of file arp.h.

◆ sha

MacAddr sha

Definition at line 155 of file arp.h.

◆ spa

Ipv4Addr spa

Definition at line 156 of file arp.h.

◆ tha

MacAddr tha

Definition at line 157 of file arp.h.

◆ tpa

Ipv4Addr tpa

Definition at line 158 of file arp.h.