git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/uIP/uip-1.0/uip/uip_arp.c

   1 /**\r
   2  * \addtogroup uip\r
   3  * @{\r
   4  */\r
   5 \r
   6 /**\r
   7  * \defgroup uiparp uIP Address Resolution Protocol\r
   8  * @{\r
   9  *\r
  10  * The Address Resolution Protocol ARP is used for mapping between IP\r
  11  * addresses and link level addresses such as the Ethernet MAC\r
  12  * addresses. ARP uses broadcast queries to ask for the link level\r
  13  * address of a known IP address and the host which is configured with\r
  14  * the IP address for which the query was meant, will respond with its\r
  15  * link level address.\r
  16  *\r
  17  * \note This ARP implementation only supports Ethernet.\r
  18  */\r
  19  \r
  20 /**\r
  21  * \file\r
  22  * Implementation of the ARP Address Resolution Protocol.\r
  23  * \author Adam Dunkels <adam@dunkels.com>\r
  24  *\r
  25  */\r
  26 \r
  27 /*\r
  28  * Copyright (c) 2001-2003, Adam Dunkels.\r
  29  * All rights reserved.\r
  30  *\r
  31  * Redistribution and use in source and binary forms, with or without\r
  32  * modification, are permitted provided that the following conditions\r
  33  * are met:\r
  34  * 1. Redistributions of source code must retain the above copyright\r
  35  *    notice, this list of conditions and the following disclaimer.\r
  36  * 2. Redistributions in binary form must reproduce the above copyright\r
  37  *    notice, this list of conditions and the following disclaimer in the\r
  38  *    documentation and/or other materials provided with the distribution.\r
  39  * 3. The name of the author may not be used to endorse or promote\r
  40  *    products derived from this software without specific prior\r
  41  *    written permission.\r
  42  *\r
  43  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS\r
  44  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
  45  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY\r
  47  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE\r
  49  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  50  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
  51  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  52  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
  53  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  54  *\r
  55  * This file is part of the uIP TCP/IP stack.\r
  56  *\r
  57  * $Id: uip_arp.c,v 1.8 2006/06/02 23:36:21 adam Exp $\r
  58  *\r
  59  */\r
  60 \r
  61 \r
  62 #include "uip_arp.h"\r
  63 \r
  64 #include <string.h>\r
  65 \r
  66 struct arp_hdr {\r
  67   struct uip_eth_hdr ethhdr;\r
  68   u16_t hwtype;\r
  69   u16_t protocol;\r
  70   u8_t hwlen;\r
  71   u8_t protolen;\r
  72   u16_t opcode;\r
  73   struct uip_eth_addr shwaddr;\r
  74   u16_t sipaddr[2];\r
  75   struct uip_eth_addr dhwaddr;\r
  76   u16_t dipaddr[2];\r
  77 } PACK_STRUCT_END;\r
  78 \r
  79 struct ethip_hdr {\r
  80   struct uip_eth_hdr ethhdr;\r
  81   /* IP header. */\r
  82   u8_t vhl,\r
  83     tos,\r
  84     len[2],\r
  85     ipid[2],\r
  86     ipoffset[2],\r
  87     ttl,\r
  88     proto;\r
  89   u16_t ipchksum;\r
  90   u16_t srcipaddr[2],\r
  91     destipaddr[2];\r
  92 } PACK_STRUCT_END;\r
  93 \r
  94 #define ARP_REQUEST 1\r
  95 #define ARP_REPLY   2\r
  96 \r
  97 #define ARP_HWTYPE_ETH 1\r
  98 \r
  99 struct arp_entry {\r
 100   u16_t ipaddr[2];\r
 101   struct uip_eth_addr ethaddr;\r
 102   u8_t time;\r
 103 };\r
 104 \r
 105 static const struct uip_eth_addr broadcast_ethaddr =\r
 106   {{0xff,0xff,0xff,0xff,0xff,0xff}};\r
 107 static const u16_t broadcast_ipaddr[2] = {0xffff,0xffff};\r
 108 \r
 109 static struct arp_entry arp_table[UIP_ARPTAB_SIZE];\r
 110 static u16_t ipaddr[2];\r
 111 static u8_t i, c;\r
 112 \r
 113 static u8_t arptime;\r
 114 static u8_t tmpage;\r
 115 \r
 116 #define BUF   ((struct arp_hdr *)&uip_buf[0])\r
 117 #define IPBUF ((struct ethip_hdr *)&uip_buf[0])\r
 118 /*-----------------------------------------------------------------------------------*/\r
 119 /**\r
 120  * Initialize the ARP module.\r
 121  *\r
 122  */\r
 123 /*-----------------------------------------------------------------------------------*/\r
 124 void\r
 125 uip_arp_init(void)\r
 126 {\r
 127   for(i = 0; i < UIP_ARPTAB_SIZE; ++i) {\r
 128     memset(arp_table[i].ipaddr, 0, 4);\r
 129   }\r
 130 }\r
 131 /*-----------------------------------------------------------------------------------*/\r
 132 /**\r
 133  * Periodic ARP processing function.\r
 134  *\r
 135  * This function performs periodic timer processing in the ARP module\r
 136  * and should be called at regular intervals. The recommended interval\r
 137  * is 10 seconds between the calls.\r
 138  *\r
 139  */\r
 140 /*-----------------------------------------------------------------------------------*/\r
 141 void\r
 142 uip_arp_timer(void)\r
 143 {\r
 144   struct arp_entry *tabptr;\r
 145   \r
 146   ++arptime;\r
 147   for(i = 0; i < UIP_ARPTAB_SIZE; ++i) {\r
 148     tabptr = &arp_table[i];\r
 149     if((tabptr->ipaddr[0] | tabptr->ipaddr[1]) != 0 &&\r
 150        arptime - tabptr->time >= UIP_ARP_MAXAGE) {\r
 151       memset(tabptr->ipaddr, 0, 4);\r
 152     }\r
 153   }\r
 154 \r
 155 }\r
 156 /*-----------------------------------------------------------------------------------*/\r
 157 static void\r
 158 uip_arp_update(u16_t *ipaddr, struct uip_eth_addr *ethaddr)\r
 159 {\r
 160   register struct arp_entry *tabptr;\r
 161   /* Walk through the ARP mapping table and try to find an entry to\r
 162      update. If none is found, the IP -> MAC address mapping is\r
 163      inserted in the ARP table. */\r
 164   for(i = 0; i < UIP_ARPTAB_SIZE; ++i) {\r
 165 \r
 166     tabptr = &arp_table[i];\r
 167     /* Only check those entries that are actually in use. */\r
 168     if(tabptr->ipaddr[0] != 0 &&\r
 169        tabptr->ipaddr[1] != 0) {\r
 170 \r
 171       /* Check if the source IP address of the incoming packet matches\r
 172          the IP address in this ARP table entry. */\r
 173       if(ipaddr[0] == tabptr->ipaddr[0] &&\r
 174          ipaddr[1] == tabptr->ipaddr[1]) {\r
 175          \r
 176         /* An old entry found, update this and return. */\r
 177         memcpy(tabptr->ethaddr.addr, ethaddr->addr, 6);\r
 178         tabptr->time = arptime;\r
 179 \r
 180         return;\r
 181       }\r
 182     }\r
 183   }\r
 184 \r
 185   /* If we get here, no existing ARP table entry was found, so we\r
 186      create one. */\r
 187 \r
 188   /* First, we try to find an unused entry in the ARP table. */\r
 189   for(i = 0; i < UIP_ARPTAB_SIZE; ++i) {\r
 190     tabptr = &arp_table[i];\r
 191     if(tabptr->ipaddr[0] == 0 &&\r
 192        tabptr->ipaddr[1] == 0) {\r
 193       break;\r
 194     }\r
 195   }\r
 196 \r
 197   /* If no unused entry is found, we try to find the oldest entry and\r
 198      throw it away. */\r
 199   if(i == UIP_ARPTAB_SIZE) {\r
 200     tmpage = 0;\r
 201     c = 0;\r
 202     for(i = 0; i < UIP_ARPTAB_SIZE; ++i) {\r
 203       tabptr = &arp_table[i];\r
 204       if(arptime - tabptr->time > tmpage) {\r
 205         tmpage = arptime - tabptr->time;\r
 206         c = i;\r
 207       }\r
 208     }\r
 209     i = c;\r
 210     tabptr = &arp_table[i];\r
 211   }\r
 212 \r
 213   /* Now, i is the ARP table entry which we will fill with the new\r
 214      information. */\r
 215   memcpy(tabptr->ipaddr, ipaddr, 4);\r
 216   memcpy(tabptr->ethaddr.addr, ethaddr->addr, 6);\r
 217   tabptr->time = arptime;\r
 218 }\r
 219 /*-----------------------------------------------------------------------------------*/\r
 220 /**\r
 221  * ARP processing for incoming IP packets\r
 222  *\r
 223  * This function should be called by the device driver when an IP\r
 224  * packet has been received. The function will check if the address is\r
 225  * in the ARP cache, and if so the ARP cache entry will be\r
 226  * refreshed. If no ARP cache entry was found, a new one is created.\r
 227  *\r
 228  * This function expects an IP packet with a prepended Ethernet header\r
 229  * in the uip_buf[] buffer, and the length of the packet in the global\r
 230  * variable uip_len.\r
 231  */\r
 232 /*-----------------------------------------------------------------------------------*/\r
 233 #if 1\r
 234 void\r
 235 uip_arp_ipin(void)\r
 236 {\r
 237   uip_len -= sizeof(struct uip_eth_hdr);\r
 238         \r
 239   /* Only insert/update an entry if the source IP address of the\r
 240      incoming IP packet comes from a host on the local network. */\r
 241   if((IPBUF->srcipaddr[0] & uip_netmask[0]) !=\r
 242      (uip_hostaddr[0] & uip_netmask[0])) {\r
 243     return;\r
 244   }\r
 245   if((IPBUF->srcipaddr[1] & uip_netmask[1]) !=\r
 246      (uip_hostaddr[1] & uip_netmask[1])) {\r
 247     return;\r
 248   }\r
 249   uip_arp_update(IPBUF->srcipaddr, &(IPBUF->ethhdr.src));\r
 250   \r
 251   return;\r
 252 }\r
 253 #endif /* 0 */\r
 254 /*-----------------------------------------------------------------------------------*/\r
 255 /**\r
 256  * ARP processing for incoming ARP packets.\r
 257  *\r
 258  * This function should be called by the device driver when an ARP\r
 259  * packet has been received. The function will act differently\r
 260  * depending on the ARP packet type: if it is a reply for a request\r
 261  * that we previously sent out, the ARP cache will be filled in with\r
 262  * the values from the ARP reply. If the incoming ARP packet is an ARP\r
 263  * request for our IP address, an ARP reply packet is created and put\r
 264  * into the uip_buf[] buffer.\r
 265  *\r
 266  * When the function returns, the value of the global variable uip_len\r
 267  * indicates whether the device driver should send out a packet or\r
 268  * not. If uip_len is zero, no packet should be sent. If uip_len is\r
 269  * non-zero, it contains the length of the outbound packet that is\r
 270  * present in the uip_buf[] buffer.\r
 271  *\r
 272  * This function expects an ARP packet with a prepended Ethernet\r
 273  * header in the uip_buf[] buffer, and the length of the packet in the\r
 274  * global variable uip_len.\r
 275  */\r
 276 /*-----------------------------------------------------------------------------------*/\r
 277 void\r
 278 uip_arp_arpin(void)\r
 279 {\r
 280   \r
 281   if(uip_len < sizeof(struct arp_hdr)) {\r
 282     uip_len = 0;\r
 283     return;\r
 284   }\r
 285   uip_len = 0;\r
 286   \r
 287   switch(BUF->opcode) {\r
 288   case HTONS(ARP_REQUEST):\r
 289     /* ARP request. If it asked for our address, we send out a\r
 290        reply. */\r
 291     if(uip_ipaddr_cmp(BUF->dipaddr, uip_hostaddr)) {\r
 292       /* First, we register the one who made the request in our ARP\r
 293          table, since it is likely that we will do more communication\r
 294          with this host in the future. */\r
 295       uip_arp_update(BUF->sipaddr, &BUF->shwaddr);\r
 296       \r
 297       /* The reply opcode is 2. */\r
 298       BUF->opcode = HTONS(2);\r
 299 \r
 300       memcpy(BUF->dhwaddr.addr, BUF->shwaddr.addr, 6);\r
 301       memcpy(BUF->shwaddr.addr, uip_ethaddr.addr, 6);\r
 302       memcpy(BUF->ethhdr.src.addr, uip_ethaddr.addr, 6);\r
 303       memcpy(BUF->ethhdr.dest.addr, BUF->dhwaddr.addr, 6);\r
 304       \r
 305       BUF->dipaddr[0] = BUF->sipaddr[0];\r
 306       BUF->dipaddr[1] = BUF->sipaddr[1];\r
 307       BUF->sipaddr[0] = uip_hostaddr[0];\r
 308       BUF->sipaddr[1] = uip_hostaddr[1];\r
 309 \r
 310       BUF->ethhdr.type = HTONS(UIP_ETHTYPE_ARP);\r
 311       uip_len = sizeof(struct arp_hdr);\r
 312     }\r
 313     break;\r
 314   case HTONS(ARP_REPLY):\r
 315     /* ARP reply. We insert or update the ARP table if it was meant\r
 316        for us. */\r
 317     if(uip_ipaddr_cmp(BUF->dipaddr, uip_hostaddr)) {\r
 318       uip_arp_update(BUF->sipaddr, &BUF->shwaddr);\r
 319     }\r
 320     break;\r
 321   }\r
 322 \r
 323   return;\r
 324 }\r
 325 /*-----------------------------------------------------------------------------------*/\r
 326 /**\r
 327  * Prepend Ethernet header to an outbound IP packet and see if we need\r
 328  * to send out an ARP request.\r
 329  *\r
 330  * This function should be called before sending out an IP packet. The\r
 331  * function checks the destination IP address of the IP packet to see\r
 332  * what Ethernet MAC address that should be used as a destination MAC\r
 333  * address on the Ethernet.\r
 334  *\r
 335  * If the destination IP address is in the local network (determined\r
 336  * by logical ANDing of netmask and our IP address), the function\r
 337  * checks the ARP cache to see if an entry for the destination IP\r
 338  * address is found. If so, an Ethernet header is prepended and the\r
 339  * function returns. If no ARP cache entry is found for the\r
 340  * destination IP address, the packet in the uip_buf[] is replaced by\r
 341  * an ARP request packet for the IP address. The IP packet is dropped\r
 342  * and it is assumed that they higher level protocols (e.g., TCP)\r
 343  * eventually will retransmit the dropped packet.\r
 344  *\r
 345  * If the destination IP address is not on the local network, the IP\r
 346  * address of the default router is used instead.\r
 347  *\r
 348  * When the function returns, a packet is present in the uip_buf[]\r
 349  * buffer, and the length of the packet is in the global variable\r
 350  * uip_len.\r
 351  */\r
 352 /*-----------------------------------------------------------------------------------*/\r
 353 void\r
 354 uip_arp_out(void)\r
 355 {\r
 356   struct arp_entry *tabptr;\r
 357   \r
 358   /* Find the destination IP address in the ARP table and construct\r
 359      the Ethernet header. If the destination IP addres isn't on the\r
 360      local network, we use the default router's IP address instead.\r
 361 \r
 362      If not ARP table entry is found, we overwrite the original IP\r
 363      packet with an ARP request for the IP address. */\r
 364 \r
 365   /* First check if destination is a local broadcast. */\r
 366   if(uip_ipaddr_cmp(IPBUF->destipaddr, broadcast_ipaddr)) {\r
 367     memcpy(IPBUF->ethhdr.dest.addr, broadcast_ethaddr.addr, 6);\r
 368   } else {\r
 369     /* Check if the destination address is on the local network. */\r
 370     if(!uip_ipaddr_maskcmp(IPBUF->destipaddr, uip_hostaddr, uip_netmask)) {\r
 371       /* Destination address was not on the local network, so we need to\r
 372          use the default router's IP address instead of the destination\r
 373          address when determining the MAC address. */\r
 374       uip_ipaddr_copy(ipaddr, uip_draddr);\r
 375     } else {\r
 376       /* Else, we use the destination IP address. */\r
 377       uip_ipaddr_copy(ipaddr, IPBUF->destipaddr);\r
 378     }\r
 379       \r
 380     for(i = 0; i < UIP_ARPTAB_SIZE; ++i) {\r
 381       tabptr = &arp_table[i];\r
 382       if(uip_ipaddr_cmp(ipaddr, tabptr->ipaddr)) {\r
 383         break;\r
 384       }\r
 385     }\r
 386 \r
 387     if(i == UIP_ARPTAB_SIZE) {\r
 388       /* The destination address was not in our ARP table, so we\r
 389          overwrite the IP packet with an ARP request. */\r
 390 \r
 391       memset(BUF->ethhdr.dest.addr, 0xff, 6);\r
 392       memset(BUF->dhwaddr.addr, 0x00, 6);\r
 393       memcpy(BUF->ethhdr.src.addr, uip_ethaddr.addr, 6);\r
 394       memcpy(BUF->shwaddr.addr, uip_ethaddr.addr, 6);\r
 395     \r
 396       uip_ipaddr_copy(BUF->dipaddr, ipaddr);\r
 397       uip_ipaddr_copy(BUF->sipaddr, uip_hostaddr);\r
 398       BUF->opcode = HTONS(ARP_REQUEST); /* ARP request. */\r
 399       BUF->hwtype = HTONS(ARP_HWTYPE_ETH);\r
 400       BUF->protocol = HTONS(UIP_ETHTYPE_IP);\r
 401       BUF->hwlen = 6;\r
 402       BUF->protolen = 4;\r
 403       BUF->ethhdr.type = HTONS(UIP_ETHTYPE_ARP);\r
 404 \r
 405       uip_appdata = &uip_buf[UIP_TCPIP_HLEN + UIP_LLH_LEN];\r
 406     \r
 407       uip_len = sizeof(struct arp_hdr);\r
 408       return;\r
 409     }\r
 410 \r
 411     /* Build an ethernet header. */\r
 412     memcpy(IPBUF->ethhdr.dest.addr, tabptr->ethaddr.addr, 6);\r
 413   }\r
 414   memcpy(IPBUF->ethhdr.src.addr, uip_ethaddr.addr, 6);\r
 415   \r
 416   IPBUF->ethhdr.type = HTONS(UIP_ETHTYPE_IP);\r
 417 \r
 418   uip_len += sizeof(struct uip_eth_hdr);\r
 419 }\r
 420 /*-----------------------------------------------------------------------------------*/\r
 421 \r
 422 /** @} */\r
 423 /** @} */\r