123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484 |
- /****************************************************************************
- * net/arp/arp.h
- *
- * Copyright (C) 2014-2016, 2018-2019 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- #ifndef __NET_ARP_ARP_H
- #define __NET_ARP_ARP_H
- /* The Address Resolution Protocol ARP is used for mapping between IP
- * addresses and link level addresses such as the Ethernet MAC
- * addresses. ARP uses broadcast queries to ask for the link level
- * address of a known IP address and the host which is configured with
- * the IP address for which the query was meant, will respond with its
- * link level address.
- *
- * Note: This ARP implementation only supports Ethernet.
- */
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <stdint.h>
- #include <queue.h>
- #include <errno.h>
- #include <netinet/in.h>
- #include <nuttx/net/netdev.h>
- #include <nuttx/semaphore.h>
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- /* Configuration ************************************************************/
- #ifndef CONFIG_DEBUG_FEATURES
- # undef CONFIG_NET_ARP_DUMP
- #endif
- #ifndef CONFIG_ARP_SEND_MAXTRIES
- # define CONFIG_ARP_SEND_MAXTRIES 5
- #endif
- #ifndef CONFIG_ARP_SEND_DELAYMSEC
- # define CONFIG_ARP_SEND_DELAYMSEC 20
- #endif
- /* ARP Definitions **********************************************************/
- #define ARP_REQUEST 1
- #define ARP_REPLY 2
- #define ARP_HWTYPE_ETH 1
- #define RASIZE 4 /* Size of ROUTER ALERT */
- /* Allocate a new ARP data callback */
- #define arp_callback_alloc(dev) devif_callback_alloc(dev, &(dev)->d_conncb)
- #define arp_callback_free(dev,cb) devif_dev_callback_free(dev, cb)
- /****************************************************************************
- * Public Types
- ****************************************************************************/
- /* ARP header -- Size 28 bytes */
- struct arp_hdr_s
- {
- uint16_t ah_hwtype; /* 16-bit Hardware type (Ethernet=0x001) */
- uint16_t ah_protocol; /* 16-bit Protocol type (IP=0x0800) */
- uint8_t ah_hwlen; /* 8-bit Hardware address size (6) */
- uint8_t ah_protolen; /* 8-bit Procotol address size (4) */
- uint16_t ah_opcode; /* 16-bit Operation */
- uint8_t ah_shwaddr[6]; /* 48-bit Sender hardware address */
- uint16_t ah_sipaddr[2]; /* 32-bit Sender IP address */
- uint8_t ah_dhwaddr[6]; /* 48-bit Target hardware address */
- uint16_t ah_dipaddr[2]; /* 32-bit Target IP address */
- };
- /* IP header -- Size 20 or 24 bytes */
- struct arp_iphdr_s
- {
- uint8_t eh_vhl; /* 8-bit Version (4) and header length (5 or 6) */
- uint8_t eh_tos; /* 8-bit Type of service (e.g., 6=TCP) */
- uint8_t eh_len[2]; /* 16-bit Total length */
- uint8_t eh_ipid[2]; /* 16-bit Identification */
- uint8_t eh_ipoffset[2]; /* 16-bit IP flags + fragment offset */
- uint8_t eh_ttl; /* 8-bit Time to Live */
- uint8_t eh_proto; /* 8-bit Protocol */
- uint16_t eh_ipchksum; /* 16-bit Header checksum */
- uint16_t eh_srcipaddr[2]; /* 32-bit Source IP address */
- uint16_t eh_destipaddr[2]; /* 32-bit Destination IP address */
- uint16_t eh_ipoption[2]; /* (optional) */
- };
- #ifdef CONFIG_NET_ARP_SEND
- /* This structure holds the state of the send operation until it can be
- * operated upon from the network driver poll.
- */
- struct arp_send_s
- {
- FAR struct devif_callback_s *snd_cb; /* Reference to callback instance */
- sem_t snd_sem; /* Used to wake up the waiting thread */
- uint8_t snd_retries; /* Retry count */
- volatile bool snd_sent; /* True: if request sent */
- uint8_t snd_ifname[IFNAMSIZ]; /* Interface name */
- int16_t snd_result; /* The result of the send operation */
- in_addr_t snd_ipaddr; /* The IP address to be queried */
- };
- #endif
- #ifdef CONFIG_NET_ARP_SEND
- /* Used to notify a thread waiting for a particular ARP response */
- struct arp_notify_s
- {
- FAR struct arp_notify_s *nt_flink; /* Supports singly linked list */
- in_addr_t nt_ipaddr; /* Waited for IP address in the mapping */
- sem_t nt_sem; /* Will wake up the waiter */
- int nt_result; /* The result of the wait */
- };
- #endif
- /****************************************************************************
- * Public Data
- ****************************************************************************/
- /****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP
- /****************************************************************************
- * Name: arp_format
- *
- * Description:
- * Format an ARP packet.
- *
- * Input Parameters:
- * dev - Device structure
- * ipaddr - Target IP address (32-bit)
- *
- * Returned Value:
- * None
- *
- ****************************************************************************/
- struct net_driver_s; /* Forward reference */
- void arp_format(FAR struct net_driver_s *dev, in_addr_t ipaddr);
- /****************************************************************************
- * Name: arp_send
- *
- * Description:
- * The arp_send() call may be to send an ARP request to resolve an IPv4
- * address. This function first checks if the IPv4 address is already in
- * the ARP table. If so, then it returns success immediately.
- *
- * If the requested IPv4 address in not in the ARP table, then this function
- * will send an ARP request, delay, then check if the IP address is now in
- * the ARP table. It will repeat this sequence until either (1) the IP
- * address mapping is now in the ARP table, or (2) a configurable number
- * of timeouts occur without receiving the ARP replay.
- *
- * Input Parameters:
- * ipaddr The IP address to be queried.
- *
- * Returned Value:
- * Zero (OK) is returned on success and the IP address mapping can now be
- * found in the ARP table. On error a negated errno value is returned:
- *
- * -ETIMEDOUT: The number or retry counts has been exceed.
- * -EHOSTUNREACH: Could not find a route to the host
- *
- * Assumptions:
- * This function is called from the normal tasking context.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_SEND
- int arp_send(in_addr_t ipaddr);
- #else
- # define arp_send(i) (0)
- #endif
- /****************************************************************************
- * Name: arp_poll
- *
- * Description:
- * Poll all pending transfer for ARP requests to send.
- *
- * Assumptions:
- * This function is called from the MAC device driver indirectly through
- * devif_poll() and devif_timer(). The network must be locked.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_SEND
- int arp_poll(FAR struct net_driver_s *dev, devif_poll_callback_t callback);
- #else
- # define arp_poll(d,c) (0)
- #endif
- /****************************************************************************
- * Name: arp_wait_setup
- *
- * Description:
- * Called BEFORE an ARP request is sent. This function sets up the ARP
- * response timeout before the ARP request is sent so that there is
- * no race condition when arp_wait() is called.
- *
- * Assumptions:
- * This function is called from ARP send and executes in the normal
- * tasking environment.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_SEND
- void arp_wait_setup(in_addr_t ipaddr, FAR struct arp_notify_s *notify);
- #else
- # define arp_wait_setup(i,n)
- #endif
- /****************************************************************************
- * Name: arp_wait_cancel
- *
- * Description:
- * Cancel any wait set after arp_wait_setup is called but before arm_wait()
- * is called (arp_wait() will automatically cancel the wait).
- *
- * Assumptions:
- * This function may execute in the interrupt context when called from
- * arp_wait().
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_SEND
- int arp_wait_cancel(FAR struct arp_notify_s *notify);
- #else
- # define arp_wait_cancel(n) (0)
- #endif
- /****************************************************************************
- * Name: arp_wait
- *
- * Description:
- * Called each time that a ARP request is sent. This function will sleep
- * until either: (1) the matching ARP response is received, or (2) a
- * timeout occurs.
- *
- * Assumptions:
- * This function is called from ARP send and must execute with the network
- * un-locked.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_SEND
- int arp_wait(FAR struct arp_notify_s *notify, unsigned int timeout);
- #else
- # define arp_wait(n,t) (0)
- #endif
- /****************************************************************************
- * Name: arp_notify
- *
- * Description:
- * Called each time that a ARP response is received in order to wake-up
- * any threads that may be waiting for this particular ARP response.
- *
- * Assumptions:
- * This function is called from the MAC device driver indirectly through
- * arp_arpin() and will execute with the network locked.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_SEND
- void arp_notify(in_addr_t ipaddr);
- #else
- # define arp_notify(i)
- #endif
- /****************************************************************************
- * Name: arp_lookup
- *
- * Description:
- * Find the ARP entry corresponding to this IP address in the ARP table.
- *
- * Input Parameters:
- * ipaddr - Refers to an IP address in network order
- *
- * Assumptions:
- * The network is locked to assure exclusive access to the ARP table.
- * The return value will become unstable when the network is unlocked.
- *
- ****************************************************************************/
- FAR struct arp_entry_s *arp_lookup(in_addr_t ipaddr);
- /****************************************************************************
- * Name: arp_find
- *
- * Description:
- * Find the ARP entry corresponding to this IP address which may or may
- * not be in the ARP table (it may, instead, be a local network device).
- *
- * Input Parameters:
- * ipaddr - Refers to an IP address in network order
- * ethaddr - Location to return the corresponding Ethernet MAN address.
- * This address may be NULL. In that case, this function may be
- * used simply to determine if the Ethernet MAC address is
- * available.
- *
- * Assumptions
- * The network is locked to assure exclusive access to the ARP table.
- *
- ****************************************************************************/
- struct ether_addr; /* Forward reference */
- int arp_find(in_addr_t ipaddr, FAR struct ether_addr *ethaddr);
- /****************************************************************************
- * Name: arp_delete
- *
- * Description:
- * Remove an IP association from the ARP table
- *
- * Input Parameters:
- * ipaddr - Refers to an IP address in network order
- *
- * Assumptions
- * The network is locked to assure exclusive access to the ARP table.
- *
- ****************************************************************************/
- void arp_delete(in_addr_t ipaddr);
- /****************************************************************************
- * Name: arp_update
- *
- * Description:
- * Add the IP/HW address mapping to the ARP table -OR- change the IP
- * address of an existing association.
- *
- * Input Parameters:
- * ipaddr - The IP address as an inaddr_t
- * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN]
- *
- * Returned Value:
- * Zero (OK) if the ARP table entry was successfully modified. A negated
- * errno value is returned on any error.
- *
- * Assumptions
- * The network is locked to assure exclusive access to the ARP table
- *
- ****************************************************************************/
- int arp_update(in_addr_t ipaddr, FAR uint8_t *ethaddr);
- /****************************************************************************
- * Name: arp_hdr_update
- *
- * Description:
- * Add the IP/HW address mapping to the ARP table -OR- change the IP
- * address of an existing association.
- *
- * Input Parameters:
- * pipaddr - Refers to an IP address uint16_t[2] in network order
- * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN]
- *
- * Returned Value:
- * Zero (OK) if the ARP table entry was successfully modified. A negated
- * errno value is returned on any error.
- *
- * Assumptions
- * The network is locked to assure exclusive access to the ARP table
- *
- ****************************************************************************/
- void arp_hdr_update(FAR uint16_t *pipaddr, FAR uint8_t *ethaddr);
- /****************************************************************************
- * Name: arp_snapshot
- *
- * Description:
- * Take a snapshot of the current state of the ARP table.
- *
- * Input Parameters:
- * snapshot - Location to return the ARP table copy
- * nentries - The size of the user provided 'dest' in entries, each of
- * size sizeof(struct arp_entry_s)
- *
- * Returned Value:
- * On success, the number of entries actually copied is returned. Unused
- * entries are not returned.
- *
- * Assumptions
- * The network is locked to assure exclusive access to the ARP table
- *
- ****************************************************************************/
- #ifdef CONFIG_NETLINK_ROUTE
- unsigned int arp_snapshot(FAR struct arp_entry_s *snapshot,
- unsigned int nentries);
- #else
- # define arp_snapshot(s,n) (0)
- #endif
- /****************************************************************************
- * Name: arp_dump
- *
- * Description:
- * Dump the contents of an ARP packet to the SYSLOG device
- *
- * Input Parameters:
- * arp - A reference to the ARP header to be dumped.
- *
- * Returned Value:
- * None
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_ARP_DUMP
- void arp_dump(FAR struct arp_hdr_s *arp);
- #else
- # define arp_dump(arp)
- #endif
- #else /* CONFIG_NET_ARP */
- /* If ARP is disabled, stub out all ARP interfaces */
- # define arp_format(d,i);
- # define arp_send(i) (0)
- # define arp_poll(d,c) (0)
- # define arp_wait_setup(i,n)
- # define arp_wait_cancel(n) (0)
- # define arp_wait(n,t) (0)
- # define arp_notify(i)
- # define arp_find(i,e) (-ENOSYS)
- # define arp_delete(i)
- # define arp_update(i,m);
- # define arp_hdr_update(i,m);
- # define arp_snapshot(s,n) (0)
- # define arp_dump(arp)
- #endif /* CONFIG_NET_ARP */
- #endif /* __NET_ARP_ARP_H */
|