Expose more ARP APIs

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@1633 42af7a65-404d-4744-a932-0658087f49c3

5 files changed, 302 insertions, 51 deletions

diff --git a/nuttx/include/net/uip/uip-arp.h b/nuttx/include/net/uip/uip-arp.h
index 52f742508..134293ece 100644
--- a/nuttx/include/net/uip/uip-arp.h
+++ b/nuttx/include/net/uip/uip-arp.h
@@ -1,13 +1,20 @@
-/* uip-arp.h
+/****************************************************************************
+ * include/net/uip/uip-arch.h
  * Macros and definitions for the ARP module.
- * Author: Adam Dunkels <adam@dunkels.com>
  *
- * Copyright (c) 2001-2003, Adam Dunkels.
- * All rights reserved.
+ *   Copyright (C) 2007, 2009 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *
+ * Derived from uIP with has a similar BSD-styple license:
+ *
+ *   Author: Adam Dunkels <adam@dunkels.com>
+ *   Copyright (c) 2001-2003, Adam Dunkels.
+ *   All rights reserved.
  *
  * 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
@@ -29,16 +36,35 @@
  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- */
+ ****************************************************************************/
 
 #ifndef __UIP_ARP_H__
 #define __UIP_ARP_H__
 
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
 #include <sys/types.h>
 #include <nuttx/compiler.h>
 #include <net/ethernet.h>
 #include <net/uip/uip.h>
 
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+
+/* Recognized values of the type bytes in the Ethernet header */
+
+#define UIP_ETHTYPE_ARP 0x0806
+#define UIP_ETHTYPE_IP  0x0800
+#define UIP_ETHTYPE_IP6 0x86dd
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
 /* The Ethernet header -- 14 bytes. The first two fields are type 'struct
  * ether_addr but are represented as a simple byte array here because
  * some compilers refuse to pack 6 byte structures.
@@ -51,55 +77,164 @@ struct uip_eth_hdr
   uint16 type;    /* Type code (2 bytes) */
 };
 
-/* Recognized values of the type bytes in the Ethernet header */
+/* One entry in the ARP table (volatile!) */
 
-#define UIP_ETHTYPE_ARP 0x0806
-#define UIP_ETHTYPE_IP  0x0800
-#define UIP_ETHTYPE_IP6 0x86dd
+struct arp_entry
+{
+  in_addr_t         at_ipaddr;   /* IP address */
+  struct ether_addr at_ethaddr;  /* Hardware address */
+  uint8             at_time;
+};
 
-/* The uip_arp_init() function must be called before any of the other
- * ARP functions.
- */
+/****************************************************************************
+ * Public Data
+ ****************************************************************************/
 
-void uip_arp_init(void);
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
 
-/* The uip_arp_ipin() function should be called whenever an IP packet
- * arrives from the Ethernet. This function refreshes the ARP table or
- * inserts a new mapping if none exists. The function assumes that an
- * IP packet with an Ethernet header is present in the d_buf buffer
- * and that the length of the packet is in the d_len field.
- */
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: uip_arp_init
+ *
+ * Description:
+ *   Initialize the ARP module. This function must be called before any of
+ *   the other ARP functions.
+ *
+ ****************************************************************************/
+
+EXTERN void uip_arp_init(void);
+
+/****************************************************************************
+ * Name: uip_arp_init
+ *
+ * Description:
+ *   The uip_arp_ipin() function should be called whenever an IP packet
+ *   arrives from the Ethernet. This function refreshes the ARP table or
+ *   inserts a new mapping if none exists. The function assumes that an
+ *   IP packet with an Ethernet header is present in the d_buf buffer
+ *   and that the length of the packet is in the d_len field.
+ *
+ ****************************************************************************/
 
 #define uip_arp_ipin()
 
-/* The uip_arp_arpin() should be called when an ARP packet is received
- * by the Ethernet driver. This function also assumes that the
- * Ethernet frame is present in the d_buf buffer. When the
- * uip_arp_arpin() function returns, the contents of the d_buf
- * buffer should be sent out on the Ethernet if the d_len field
- * is > 0.
- */
+/****************************************************************************
+ * Name: uip_arp_arpin
+ *
+ * Description:
+ *   The uip_arp_arpin() should be called when an ARP packet is received
+ *   by the Ethernet driver. This function also assumes that the
+ *   Ethernet frame is present in the d_buf buffer. When the
+ *   uip_arp_arpin() function returns, the contents of the d_buf
+ *   buffer should be sent out on the Ethernet if the d_len field
+ *   is > 0.
+ *
+ ****************************************************************************/
 
-void uip_arp_arpin(struct uip_driver_s *dev);
-
-/* The uip_arp_out() function should be called when an IP packet
- * should be sent out on the Ethernet. This function creates an
- * Ethernet header before the IP header in the d_buf buffer. The
- * Ethernet header will have the correct Ethernet MAC destination
- * address filled in if an ARP table entry for the destination IP
- * address (or the IP address of the default router) is present. If no
- * such table entry is found, the IP packet is overwritten with an ARP
- * request and we rely on TCP to retransmit the packet that was
- * overwritten. In any case, the d_len field holds the length of
- * the Ethernet frame that should be transmitted.
- */
+EXTERN void uip_arp_arpin(struct uip_driver_s *dev);
 
-void uip_arp_out(struct uip_driver_s *dev);
+/****************************************************************************
+ * Name: uip_arp_arpin
+ *
+ * Description:
+ *   The uip_arp_out() function should be called when an IP packet
+ *   should be sent out on the Ethernet. This function creates an
+ *   Ethernet header before the IP header in the d_buf buffer. The
+ *   Ethernet header will have the correct Ethernet MAC destination
+ *   address filled in if an ARP table entry for the destination IP
+ *   address (or the IP address of the default router) is present. If no
+ *   such table entry is found, the IP packet is overwritten with an ARP
+ *   request and we rely on TCP to retransmit the packet that was
+ *   overwritten. In any case, the d_len field holds the length of
+ *   the Ethernet frame that should be transmitted.
+ *
+ ****************************************************************************/
 
-/* The uip_arp_timer() function should be called every ten seconds. It
- * is responsible for flushing old entries in the ARP table.
- */
+EXTERN void uip_arp_out(struct uip_driver_s *dev);
+
+/****************************************************************************
+ * Name: uip_arp_timer
+ *
+ * Description:
+ *   This function performs periodic timer processing in the ARP module
+ *   and should be called at regular intervals. The recommended interval
+ *   is 10 seconds between the calls.  It is responsible for flushing old
+ *   entries in the ARP table.
+ *
+ ****************************************************************************/
+
+EXTERN void uip_arp_timer(void);
+
+/****************************************************************************
+ * Name: uip_arp_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[2] in network order
+ *   ethaddr - Refers to a HW address uint8[IFHWADDRLEN]
+ *
+ * Assumptions
+ *   Interrupts are disabled
+ *
+ ****************************************************************************/
+
+EXTERN void uip_arp_update(uint16 *pipaddr, uint8 *ethaddr);
+
+/****************************************************************************
+ * Name: uip_arp_find
+ *
+ * Description:
+ *   Find the ARP entry corresponding to this IP address.
+ *
+ * Input parameters:
+ *   ipaddr - Refers to an IP address in network order
+ *
+ * Assumptions
+ *   Interrupts are disabled; Returned value will become unstable when
+ *   interrupts are re-enabled or if any other uIP APIs are called.
+ *
+ ****************************************************************************/
+
+EXTERN struct arp_entry *uip_arp_find(in_addr_t ipaddr);
 
-void uip_arp_timer(void);
+
+/****************************************************************************
+ * Name: uip_arp_delete
+ *
+ * Description:
+ *   Remove an IP association from the ARP table
+ *
+ * Input parameters:
+ *   ipaddr - Refers to an IP address in network order
+ *
+ * Assumptions
+ *   Interrupts are disabled
+ *
+ ****************************************************************************/
+
+#define uip_arp_delete(ipaddr) \
+{ \
+  struct arp_entry *tabptr = uip_arp_find(ipaddr); \
+  if (tabptr) \
+    { \
+      tabptr->at_ipaddr = 0; \
+    } \
+}
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* __UIP_ARP_H__ */
diff --git a/nuttx/include/netinet/arp.h b/nuttx/include/netinet/arp.h
new file mode 100644
index 000000000..908f5790a
--- /dev/null
+++ b/nuttx/include/netinet/arp.h
@@ -0,0 +1,110 @@
+/****************************************************************************
+ * netinet/arp.h
+ *
+ *   Copyright (C) 2009 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *
+ * 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 __NETINET_ARP_H
+#define __NETINET_ARP_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <sys/types.h>
+#include <nuttx/ioctl.h>
+
+/****************************************************************************
+ * Public Definitions
+ ****************************************************************************/
+
+/* Three ioctls are available on all PF_INET sockets, but only if the NuttX
+ * configuration CONFIG_NET_ARPIOCTLS is defined. Each ioctl takes a pointer
+ * to a 'struct arpreq' as its parameter.
+ */
+
+#define SIOCSARP        _ARPIOC(1) /* Set a ARP mapping */
+#define SIOCDARP        _ARPIOC(2) /* Delete an ARP mapping */
+#define SIOCGARP        _ARPIOC(3) /* Get an ARP mapping */
+
+/* Values for the FLAGS field in struct arpreq */
+
+#define ATF_COM         0x01      /* Lookup complete */
+#define ATF_PERM	0x02      /* Permanent entry */
+#define ATF_PUBL	0x04      /* Publish entry */
+#define ATF_USETRAILERS	0x10      /* Trailers requested */
+#define ATF_NETMASK	0x20      /* Use a netmask */
+#define ATF_DONTPUB	0x40      /* Don't answer */
+
+/****************************************************************************
+ * Public Type Definitions
+ ****************************************************************************/
+
+/* All ARP ioctls take a pointer to a struct arpreq as their parameter: */
+
+struct arpreq
+{
+  struct sockaddr arp_pa;      /* Protocol address */
+  struct sockaddr arp_ha;      /* Hardware address */
+  struct sockaddr arp_netmask; /* Netmask of protocol address */
+  ubyte  arp_flags;            /* Flags */
+  ubyte  arp_dev[IFNAMSIZ+1];  /* Device name (zero terminated)*/
+};
+
+/****************************************************************************
+ * Public Data
+ ****************************************************************************/
+
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+/* If CONFIG_NET_ARPIOCTLS is defined then the semi-standard ioctl commands
+ * described above are supported.  If not, you can call the uIP ARP interfaces
+ * directly in a very non-standard way.  See include/net/uip/uip-arp.h for
+ * prototypes.
+ */
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
+
+#endif /*   __NETINET_ARP_H */
diff --git a/nuttx/include/netinet/ether.h b/nuttx/include/netinet/ether.h
index 335fd56bf..3cd2d3ad4 100644
--- a/nuttx/include/netinet/ether.h
+++ b/nuttx/include/netinet/ether.h
@@ -1,7 +1,7 @@
 /****************************************************************************
  * netinet/ether.h
  *
- *   Copyright (C) 2007 Gregory Nutt. All rights reserved.
+ *   Copyright (C) 2007, 2009 Gregory Nutt. All rights reserved.
  *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
  *
  * Redistribution and use in source and binary forms, with or without
@@ -14,7 +14,7 @@
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
- * 3. Neither the name Gregory Nutt nor the names of its contributors may be
+ * 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.
  *
@@ -33,8 +33,8 @@
  *
  ****************************************************************************/
 
-#ifndef   __NETINET_ETHER_H
-#define   __NETINET_ETHER_H
+#ifndef __NETINET_ETHER_H
+#define __NETINET_ETHER_H
 
 /****************************************************************************
  * Included Files
diff --git a/nuttx/include/netinet/ip6.h b/nuttx/include/netinet/ip6.h
index cc6a5295c..c8c0e22e3 100644
--- a/nuttx/include/netinet/ip6.h
+++ b/nuttx/include/netinet/ip6.h
@@ -1,7 +1,7 @@
 /****************************************************************************
  * netinet/ip6.h
  *
- *   Copyright (C) 2007 Gregory Nutt. All rights reserved.
+ *   Copyright (C) 2007, 2009 Gregory Nutt. All rights reserved.
  *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
  *
  * Redistribution and use in source and binary forms, with or without
@@ -14,7 +14,7 @@
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
- * 3. Neither the name Gregory Nutt nor the names of its contributors may be
+ * 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.
  *
diff --git a/nuttx/include/nuttx/ioctl.h b/nuttx/include/nuttx/ioctl.h
index 49d9ca48e..7d35548b2 100644
--- a/nuttx/include/nuttx/ioctl.h
+++ b/nuttx/include/nuttx/ioctl.h
@@ -1,7 +1,7 @@
 /****************************************************************************
  * include/nuttx/ioctl.h
  *
- *   Copyright (C) 2008 Gregory Nutt. All rights reserved.
+ *   Copyright (C) 2008, 2009 Gregory Nutt. All rights reserved.
  *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
  *
  * Redistribution and use in source and binary forms, with or without
@@ -56,6 +56,7 @@
 #define _DIOCBASE       (0x8800) /* Character driver ioctl commands */
 #define _BIOCBASE       (0x8900) /* Block driver ioctl commands */
 #define _SIOCBASE       (0x8a00) /* Socket ioctl commandss */
+#define _ARPBASE        (0x8b00) /* ARP ioctl commandss */
 
 /* Macros used to manage ioctl commands */
 
@@ -100,6 +101,11 @@
                                         *      return (void*) base address
                                         *      of device memory */
 
+/* NuttX ARP driver ioctl definitions (see netinet/arp.h) */
+
+#define _ARPIOCVALID(c)   (_IOC_TYPE(c)==_ARPBASE)
+#define _ARPIOC(nr)       _IOC(_ARPBASE,nr)
+
 /****************************************************************************
  * Public Type Definitions
  ****************************************************************************/