git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/FreeTCPIP/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.5 2008/02/07 01:35:00 adamdunkels Exp $\r
  58  *\r
  59  */\r
  60 #include "net/uip_arp.h"\r
  61 \r
  62 #include <string.h>\r
  63 \r
  64 #include "net/pack_struct_start.h"\r
  65 struct arp_hdr\r
  66 {\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         uip_ipaddr_t            sipaddr;\r
  75         struct uip_eth_addr dhwaddr;\r
  76         uip_ipaddr_t            dipaddr;\r
  77 }\r
  78 \r
  79 #include "net/pack_struct_end.h"\r
  80 \r
  81 #include "net/pack_struct_start.h"\r
  82 \r
  83 struct ethip_hdr\r
  84 {\r
  85         struct uip_eth_hdr      ethhdr;\r
  86 \r
  87         /* IP header. */\r
  88         u8_t                            vhl, tos, len[2], ipid[2], ipoffset[2], ttl, proto;\r
  89         u16_t                           ipchksum;\r
  90         uip_ipaddr_t            srcipaddr, destipaddr;\r
  91 }\r
  92 \r
  93 #include "net/pack_struct_end.h"\r
  94 \r
  95 #define ARP_REQUEST             1\r
  96 #define ARP_REPLY               2\r
  97 \r
  98 #define ARP_HWTYPE_ETH  1\r
  99 \r
 100 struct arp_entry\r
 101 {\r
 102         uip_ipaddr_t            ipaddr;\r
 103         struct uip_eth_addr ethaddr;\r
 104         u8_t                            time;\r
 105 };\r
 106 \r
 107 static const struct uip_eth_addr        broadcast_ethaddr = { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } };\r
 108 \r
 109 static struct arp_entry                         arp_table[UIP_ARPTAB_SIZE];\r
 110 static uip_ipaddr_t                                     ipaddr;\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 #define DEBUG   0\r
 119 #if DEBUG\r
 120 #include <stdio.h>\r
 121 #define PRINTF( ... )   printf( __VA_ARGS__ )\r
 122 #else\r
 123 \r
 124 //#define PRINTF( ... )\r
 125 #endif\r
 126 \r
 127 /*-----------------------------------------------------------------------------------*/\r
 128 \r
 129 /**\r
 130  * Initialize the ARP module.\r
 131  *\r
 132  */\r
 133 \r
 134 /*-----------------------------------------------------------------------------------*/\r
 135 void uip_arp_init( void )\r
 136 {\r
 137         for( i = 0; i < UIP_ARPTAB_SIZE; ++i )\r
 138         {\r
 139                 memset( &arp_table[i].ipaddr, 0, 4 );\r
 140         }\r
 141 }\r
 142 \r
 143 /*-----------------------------------------------------------------------------------*/\r
 144 \r
 145 /**\r
 146  * Periodic ARP processing function.\r
 147  *\r
 148  * This function performs periodic timer processing in the ARP module\r
 149  * and should be called at regular intervals. The recommended interval\r
 150  * is 10 seconds between the calls.\r
 151  *\r
 152  */\r
 153 \r
 154 /*-----------------------------------------------------------------------------------*/\r
 155 void uip_arp_timer( void )\r
 156 {\r
 157         struct arp_entry        *tabptr;\r
 158 \r
 159         ++arptime;\r
 160         for( i = 0; i < UIP_ARPTAB_SIZE; ++i )\r
 161         {\r
 162                 tabptr = &arp_table[i];\r
 163                 if( uip_ipaddr_cmp(&tabptr->ipaddr, &uip_all_zeroes_addr) && arptime - tabptr->time >= UIP_ARP_MAXAGE )\r
 164                 {\r
 165                         memset( &tabptr->ipaddr, 0, 4 );\r
 166                 }\r
 167         }\r
 168 }\r
 169 \r
 170 /*-----------------------------------------------------------------------------------*/\r
 171 static void uip_arp_update( uip_ipaddr_t *ipaddr, struct uip_eth_addr *ethaddr )\r
 172 {\r
 173         register struct arp_entry       *tabptr;\r
 174 \r
 175         /* Walk through the ARP mapping table and try to find an entry to\r
 176      update. If none is found, the IP -> MAC address mapping is\r
 177      inserted in the ARP table. */\r
 178         for( i = 0; i < UIP_ARPTAB_SIZE; ++i )\r
 179         {\r
 180                 tabptr = &arp_table[i];\r
 181 \r
 182                 /* Only check those entries that are actually in use. */\r
 183                 if( !uip_ipaddr_cmp(&tabptr->ipaddr, &uip_all_zeroes_addr) )\r
 184                 {\r
 185                         /* Check if the source IP address of the incoming packet matches\r
 186          the IP address in this ARP table entry. */\r
 187                         if( uip_ipaddr_cmp(ipaddr, &tabptr->ipaddr) )\r
 188                         {\r
 189                                 /* An old entry found, update this and return. */\r
 190                                 memcpy( tabptr->ethaddr.addr, ethaddr->addr, 6 );\r
 191                                 tabptr->time = arptime;\r
 192 \r
 193                                 return;\r
 194                         }\r
 195                 }\r
 196         }\r
 197 \r
 198         /* If we get here, no existing ARP table entry was found, so we\r
 199      create one. */\r
 200 \r
 201         /* First, we try to find an unused entry in the ARP table. */\r
 202         for( i = 0; i < UIP_ARPTAB_SIZE; ++i )\r
 203         {\r
 204                 tabptr = &arp_table[i];\r
 205                 if( uip_ipaddr_cmp(&tabptr->ipaddr, &uip_all_zeroes_addr) )\r
 206                 {\r
 207                         break;\r
 208                 }\r
 209         }\r
 210 \r
 211         /* If no unused entry is found, we try to find the oldest entry and\r
 212      throw it away. */\r
 213         if( i == UIP_ARPTAB_SIZE )\r
 214         {\r
 215                 tmpage = 0;\r
 216                 c = 0;\r
 217                 for( i = 0; i < UIP_ARPTAB_SIZE; ++i )\r
 218                 {\r
 219                         tabptr = &arp_table[i];\r
 220                         if( arptime - tabptr->time > tmpage )\r
 221                         {\r
 222                                 tmpage = arptime - tabptr->time;\r
 223                                 c = i;\r
 224                         }\r
 225                 }\r
 226 \r
 227                 i = c;\r
 228                 tabptr = &arp_table[i];\r
 229         }\r
 230 \r
 231         /* Now, i is the ARP table entry which we will fill with the new\r
 232      information. */\r
 233         uip_ipaddr_copy( &tabptr->ipaddr, ipaddr );\r
 234         memcpy( tabptr->ethaddr.addr, ethaddr->addr, 6 );\r
 235         tabptr->time = arptime;\r
 236 }\r
 237 \r
 238 /*-----------------------------------------------------------------------------------*/\r
 239 \r
 240 /**\r
 241  * ARP processing for incoming IP packets\r
 242  *\r
 243  * This function should be called by the device driver when an IP\r
 244  * packet has been received. The function will check if the address is\r
 245  * in the ARP cache, and if so the ARP cache entry will be\r
 246  * refreshed. If no ARP cache entry was found, a new one is created.\r
 247  *\r
 248  * This function expects an IP packet with a prepended Ethernet header\r
 249  * in the uip_buf[] buffer, and the length of the packet in the global\r
 250  * variable uip_len.\r
 251  */\r
 252 \r
 253 /*-----------------------------------------------------------------------------------*/\r
 254 #if 0\r
 255 void uip_arp_ipin( void )\r
 256 {\r
 257         uip_len -= sizeof( struct uip_eth_hdr );\r
 258 \r
 259         /* Only insert/update an entry if the source IP address of the\r
 260      incoming IP packet comes from a host on the local network. */\r
 261         if( (IPBUF->srcipaddr[0] & uip_netmask[0]) != (uip_hostaddr[0] & uip_netmask[0]) )\r
 262         {\r
 263                 return;\r
 264         }\r
 265 \r
 266         if( (IPBUF->srcipaddr[1] & uip_netmask[1]) != (uip_hostaddr[1] & uip_netmask[1]) )\r
 267         {\r
 268                 return;\r
 269         }\r
 270 \r
 271         uip_arp_update( IPBUF->srcipaddr, &(IPBUF->ethhdr.src) );\r
 272 \r
 273         return;\r
 274 }\r
 275 \r
 276 #endif /* 0 */\r
 277 \r
 278 /*-----------------------------------------------------------------------------------*/\r
 279 \r
 280 /**\r
 281  * ARP processing for incoming ARP packets.\r
 282  *\r
 283  * This function should be called by the device driver when an ARP\r
 284  * packet has been received. The function will act differently\r
 285  * depending on the ARP packet type: if it is a reply for a request\r
 286  * that we previously sent out, the ARP cache will be filled in with\r
 287  * the values from the ARP reply. If the incoming ARP packet is an ARP\r
 288  * request for our IP address, an ARP reply packet is created and put\r
 289  * into the uip_buf[] buffer.\r
 290  *\r
 291  * When the function returns, the value of the global variable uip_len\r
 292  * indicates whether the device driver should send out a packet or\r
 293  * not. If uip_len is zero, no packet should be sent. If uip_len is\r
 294  * non-zero, it contains the length of the outbound packet that is\r
 295  * present in the uip_buf[] buffer.\r
 296  *\r
 297  * This function expects an ARP packet with a prepended Ethernet\r
 298  * header in the uip_buf[] buffer, and the length of the packet in the\r
 299  * global variable uip_len.\r
 300  */\r
 301 \r
 302 /*-----------------------------------------------------------------------------------*/\r
 303 void uip_arp_arpin( void )\r
 304 {\r
 305         if( uip_len < sizeof(struct arp_hdr) )\r
 306         {\r
 307                 uip_len = 0;\r
 308                 return;\r
 309         }\r
 310 \r
 311         uip_len = 0;\r
 312 \r
 313         switch( BUF->opcode )\r
 314         {\r
 315                 case HTONS( ARP_REQUEST ):\r
 316                         /* ARP request. If it asked for our address, we send out a\r
 317                 reply. */\r
 318 \r
 319                         /*    if(BUF->dipaddr[0] == uip_hostaddr[0] &&\r
 320                         BUF->dipaddr[1] == uip_hostaddr[1]) {*/\r
 321 \r
 322                         //PRINTF( "uip_arp_arpin: request for %d.%d.%d.%d (we are %d.%d.%d.%d)\n", BUF->dipaddr.u8[0], BUF->dipaddr.u8[1], BUF->dipaddr.u8[2],                  \r
 323                         //BUF->dipaddr.u8[3], uip_hostaddr.u8[0], uip_hostaddr.u8[1], uip_hostaddr.u8[2], uip_hostaddr.u8[3] );\r
 324                         if( uip_ipaddr_cmp(&BUF->dipaddr, &uip_hostaddr) )\r
 325                         {\r
 326                                 /* First, we register the one who made the request in our ARP\r
 327                                 table, since it is likely that we will do more communication\r
 328                                 with this host in the future. */\r
 329                                 uip_arp_update( &BUF->sipaddr, &BUF->shwaddr );\r
 330 \r
 331                                 BUF->opcode = HTONS( ARP_REPLY );\r
 332 \r
 333                                 memcpy( BUF->dhwaddr.addr, BUF->shwaddr.addr, 6 );\r
 334                                 memcpy( BUF->shwaddr.addr, uip_ethaddr.addr, 6 );\r
 335                                 memcpy( BUF->ethhdr.src.addr, uip_ethaddr.addr, 6 );\r
 336                                 memcpy( BUF->ethhdr.dest.addr, BUF->dhwaddr.addr, 6 );\r
 337 \r
 338                                 uip_ipaddr_copy( &BUF->dipaddr, &BUF->sipaddr );\r
 339                                 uip_ipaddr_copy( &BUF->sipaddr, &uip_hostaddr );\r
 340 \r
 341                                 BUF->ethhdr.type = HTONS( UIP_ETHTYPE_ARP );\r
 342                                 uip_len = sizeof( struct arp_hdr );\r
 343                         }\r
 344 \r
 345                         break;\r
 346 \r
 347                 case HTONS( ARP_REPLY ):\r
 348                         /* ARP reply. We insert or update the ARP table if it was meant\r
 349                         for us. */\r
 350                         if( uip_ipaddr_cmp(&BUF->dipaddr, &uip_hostaddr) )\r
 351                         {\r
 352                                 uip_arp_update( &BUF->sipaddr, &BUF->shwaddr );\r
 353                         }\r
 354 \r
 355                         break;\r
 356         }\r
 357 \r
 358         return;\r
 359 }\r
 360 \r
 361 /*-----------------------------------------------------------------------------------*/\r
 362 \r
 363 /**\r
 364  * Prepend Ethernet header to an outbound IP packet and see if we need\r
 365  * to send out an ARP request.\r
 366  *\r
 367  * This function should be called before sending out an IP packet. The\r
 368  * function checks the destination IP address of the IP packet to see\r
 369  * what Ethernet MAC address that should be used as a destination MAC\r
 370  * address on the Ethernet.\r
 371  *\r
 372  * If the destination IP address is in the local network (determined\r
 373  * by logical ANDing of netmask and our IP address), the function\r
 374  * checks the ARP cache to see if an entry for the destination IP\r
 375  * address is found. If so, an Ethernet header is prepended and the\r
 376  * function returns. If no ARP cache entry is found for the\r
 377  * destination IP address, the packet in the uip_buf[] is replaced by\r
 378  * an ARP request packet for the IP address. The IP packet is dropped\r
 379  * and it is assumed that they higher level protocols (e.g., TCP)\r
 380  * eventually will retransmit the dropped packet.\r
 381  *\r
 382  * If the destination IP address is not on the local network, the IP\r
 383  * address of the default router is used instead.\r
 384  *\r
 385  * When the function returns, a packet is present in the uip_buf[]\r
 386  * buffer, and the length of the packet is in the global variable\r
 387  * uip_len.\r
 388  */\r
 389 \r
 390 /*-----------------------------------------------------------------------------------*/\r
 391 void uip_arp_out( void )\r
 392 {\r
 393         struct arp_entry        *tabptr;\r
 394 \r
 395         /* Find the destination IP address in the ARP table and construct\r
 396      the Ethernet header. If the destination IP addres isn't on the\r
 397      local network, we use the default router's IP address instead.\r
 398 \r
 399      If not ARP table entry is found, we overwrite the original IP\r
 400      packet with an ARP request for the IP address. */\r
 401 \r
 402         /* First check if destination is a local broadcast. */\r
 403         if( uip_ipaddr_cmp(&IPBUF->destipaddr, &uip_broadcast_addr) )\r
 404         {\r
 405                 memcpy( IPBUF->ethhdr.dest.addr, broadcast_ethaddr.addr, 6 );\r
 406         }\r
 407         else\r
 408         {\r
 409                 /* Check if the destination address is on the local network. */\r
 410                 if( !uip_ipaddr_maskcmp(&IPBUF->destipaddr, &uip_hostaddr, &uip_netmask) )\r
 411                 {\r
 412                         /* Destination address was not on the local network, so we need to\r
 413          use the default router's IP address instead of the destination\r
 414          address when determining the MAC address. */\r
 415                         uip_ipaddr_copy( &ipaddr, &uip_draddr );\r
 416                 }\r
 417                 else\r
 418                 {\r
 419                         /* Else, we use the destination IP address. */\r
 420                         uip_ipaddr_copy( &ipaddr, &IPBUF->destipaddr );\r
 421                 }\r
 422 \r
 423                 for( i = 0; i < UIP_ARPTAB_SIZE; ++i )\r
 424                 {\r
 425                         tabptr = &arp_table[i];\r
 426                         if( uip_ipaddr_cmp(&ipaddr, &tabptr->ipaddr) )\r
 427                         {\r
 428                                 break;\r
 429                         }\r
 430                 }\r
 431 \r
 432                 if( i == UIP_ARPTAB_SIZE )\r
 433                 {\r
 434                         /* The destination address was not in our ARP table, so we\r
 435          overwrite the IP packet with an ARP request. */\r
 436                         memset( BUF->ethhdr.dest.addr, 0xff, 6 );\r
 437                         memset( BUF->dhwaddr.addr, 0x00, 6 );\r
 438                         memcpy( BUF->ethhdr.src.addr, uip_ethaddr.addr, 6 );\r
 439                         memcpy( BUF->shwaddr.addr, uip_ethaddr.addr, 6 );\r
 440 \r
 441                         uip_ipaddr_copy( &BUF->dipaddr, &ipaddr );\r
 442                         uip_ipaddr_copy( &BUF->sipaddr, &uip_hostaddr );\r
 443                         BUF->opcode = HTONS( ARP_REQUEST ); /* ARP request. */\r
 444                         BUF->hwtype = HTONS( ARP_HWTYPE_ETH );\r
 445                         BUF->protocol = HTONS( UIP_ETHTYPE_IP );\r
 446                         BUF->hwlen = 6;\r
 447                         BUF->protolen = 4;\r
 448                         BUF->ethhdr.type = HTONS( UIP_ETHTYPE_ARP );\r
 449 \r
 450                         uip_appdata = &uip_buf[UIP_TCPIP_HLEN + UIP_LLH_LEN];\r
 451 \r
 452                         uip_len = sizeof( struct arp_hdr );\r
 453                         return;\r
 454                 }\r
 455 \r
 456                 /* Build an ethernet header. */\r
 457                 memcpy( IPBUF->ethhdr.dest.addr, tabptr->ethaddr.addr, 6 );\r
 458         }\r
 459 \r
 460         memcpy( IPBUF->ethhdr.src.addr, uip_ethaddr.addr, 6 );\r
 461 \r
 462         IPBUF->ethhdr.type = HTONS( UIP_ETHTYPE_IP );\r
 463 \r
 464         uip_len += sizeof( struct uip_eth_hdr );\r
 465 }\r
 466 \r
 467 /*-----------------------------------------------------------------------------------*/\r
 468 \r
 469 /** @} */\r
 470 \r
 471 /** @} */\r