git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_ARP.h

   1 /*\r
   2  * FreeRTOS+TCP V2.0.11\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://aws.amazon.com/freertos\r
  23  * http://www.FreeRTOS.org\r
  24  */\r
  25 \r
  26 #ifndef FREERTOS_ARP_H\r
  27 #define FREERTOS_ARP_H\r
  28 \r
  29 #ifdef __cplusplus\r
  30 extern "C" {\r
  31 #endif\r
  32 \r
  33 /* Application level configuration options. */\r
  34 #include "FreeRTOSIPConfig.h"\r
  35 #include "FreeRTOSIPConfigDefaults.h"\r
  36 #include "IPTraceMacroDefaults.h"\r
  37 \r
  38 /*-----------------------------------------------------------*/\r
  39 /* Miscellaneous structure and definitions. */\r
  40 /*-----------------------------------------------------------*/\r
  41 \r
  42 typedef struct xARP_CACHE_TABLE_ROW\r
  43 {\r
  44         uint32_t ulIPAddress;           /* The IP address of an ARP cache entry. */\r
  45         MACAddress_t xMACAddress;       /* The MAC address of an ARP cache entry. */\r
  46         uint8_t ucAge;                          /* A value that is periodically decremented but can also be refreshed by active communication.  The ARP cache entry is removed if the value reaches zero. */\r
  47         uint8_t ucValid;                        /* pdTRUE: xMACAddress is valid, pdFALSE: waiting for ARP reply */\r
  48 } ARPCacheRow_t;\r
  49 \r
  50 typedef enum\r
  51 {\r
  52         eARPCacheMiss = 0,                      /* 0 An ARP table lookup did not find a valid entry. */\r
  53         eARPCacheHit,                           /* 1 An ARP table lookup found a valid entry. */\r
  54         eCantSendPacket                         /* 2 There is no IP address, or an ARP is still in progress, so the packet cannot be sent. */\r
  55 } eARPLookupResult_t;\r
  56 \r
  57 typedef enum\r
  58 {\r
  59         eNotFragment = 0,                       /* The IP packet being sent is not part of a fragment. */\r
  60         eFirstFragment,                         /* The IP packet being sent is the first in a set of fragmented packets. */\r
  61         eFollowingFragment                      /* The IP packet being sent is part of a set of fragmented packets. */\r
  62 } eIPFragmentStatus_t;\r
  63 \r
  64 /*\r
  65  * If ulIPAddress is already in the ARP cache table then reset the age of the\r
  66  * entry back to its maximum value.  If ulIPAddress is not already in the ARP\r
  67  * cache table then add it - replacing the oldest current entry if there is not\r
  68  * a free space available.\r
  69  */\r
  70 void vARPRefreshCacheEntry( const MACAddress_t * pxMACAddress, const uint32_t ulIPAddress );\r
  71 \r
  72 #if( ipconfigARP_USE_CLASH_DETECTION != 0 )\r
  73         /* Becomes non-zero if another device responded to a gratuitos ARP message. */\r
  74         extern BaseType_t xARPHadIPClash;\r
  75         /* MAC-address of the other device containing the same IP-address. */\r
  76         extern MACAddress_t xARPClashMacAddress;\r
  77 #endif /* ipconfigARP_USE_CLASH_DETECTION */\r
  78 \r
  79 #if( ipconfigUSE_ARP_REMOVE_ENTRY != 0 )\r
  80 \r
  81         /*\r
  82          * In some rare cases, it might be useful to remove a ARP cache entry of a\r
  83          * known MAC address to make sure it gets refreshed.\r
  84          */\r
  85         uint32_t ulARPRemoveCacheEntryByMac( const MACAddress_t * pxMACAddress );\r
  86 \r
  87 #endif /* ipconfigUSE_ARP_REMOVE_ENTRY != 0 */\r
  88 \r
  89 /*\r
  90  * Look for ulIPAddress in the ARP cache.  If the IP address exists, copy the\r
  91  * associated MAC address into pxMACAddress, refresh the ARP cache entry's\r
  92  * age, and return eARPCacheHit.  If the IP address does not exist in the ARP\r
  93  * cache return eARPCacheMiss.  If the packet cannot be sent for any reason\r
  94  * (maybe DHCP is still in process, or the addressing needs a gateway but there\r
  95  * isn't a gateway defined) then return eCantSendPacket.\r
  96  */\r
  97 eARPLookupResult_t eARPGetCacheEntry( uint32_t *pulIPAddress, MACAddress_t * const pxMACAddress );\r
  98 \r
  99 #if( ipconfigUSE_ARP_REVERSED_LOOKUP != 0 )\r
 100 \r
 101         /* Lookup an IP-address if only the MAC-address is known */\r
 102         eARPLookupResult_t eARPGetCacheEntryByMac( MACAddress_t * const pxMACAddress, uint32_t *pulIPAddress );\r
 103 \r
 104 #endif\r
 105 /*\r
 106  * Reduce the age count in each entry within the ARP cache.  An entry is no\r
 107  * longer considered valid and is deleted if its age reaches zero.\r
 108  */\r
 109 void vARPAgeCache( void );\r
 110 \r
 111 /*\r
 112  * Send out an ARP request for the IP address contained in pxNetworkBuffer, and\r
 113  * add an entry into the ARP table that indicates that an ARP reply is\r
 114  * outstanding so re-transmissions can be generated.\r
 115  */\r
 116 void vARPGenerateRequestPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer );\r
 117 \r
 118 /*\r
 119  * After DHCP is ready and when changing IP address, force a quick send of our new IP\r
 120  * address\r
 121  */\r
 122 void vARPSendGratuitous( void );\r
 123 \r
 124 #ifdef __cplusplus\r
 125 } // extern "C"\r
 126 #endif\r
 127 \r
 128 #endif /* FREERTOS_ARP_H */\r
 129 \r
 130 \r
 131 \r
 132 \r
 133 \r
 134 \r
 135 \r
 136 \r
 137 \r
 138 \r
 139 \r
 140 \r
 141 \r