arp.c File Reference

ARP (Address Resolution Protocol) More...

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

Go to the source code of this file.

Macros

#define TRACE_LEVEL   ARP_TRACE_LEVEL
 

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)
 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 *arpReply)
 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 targetIpAddr, const MacAddr *targetMacAddr, const MacAddr *destMacAddr)
 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

Copyright (C) 2010-2018 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.

Description

Address Resolution Protocol is used to determine the hardware address of a specific host when only its IPv4 address is known. Refer to RFC 826

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

Definition in file arp.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   ARP_TRACE_LEVEL

Definition at line 35 of file arp.c.

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 97 of file arp.c.

◆ arpDumpPacket()

void arpDumpPacket ( const ArpPacket arpPacket)

Dump ARP packet for debugging purpose.

Parameters
[in]arpPacketARP header

Definition at line 927 of file arp.c.

◆ arpEnqueuePacket()

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

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
Returns
Error code

Definition at line 339 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 149 of file arp.c.

◆ arpFlushCache()

void arpFlushCache ( NetInterface interface)

Flush ARP cache.

Parameters
[in]interfaceUnderlying network interface

Definition at line 72 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 220 of file arp.c.

◆ arpInit()

error_t arpInit ( NetInterface interface)

ARP cache initialization.

Parameters
[in]interfaceUnderlying network interface
Returns
Error code

Definition at line 57 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 534 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 675 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 628 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 248 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 757 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 180 of file arp.c.

◆ arpSendReply()

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

Send ARP reply.

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

Definition at line 875 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 812 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 423 of file arp.c.

Variable Documentation

◆ arpTickCounter

systime_t arpTickCounter

Definition at line 48 of file arp.c.