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

   1 /*\r
   2  * FreeRTOS+TCP V2.2.0\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_DNS_H\r
  27 #define FREERTOS_DNS_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 "IPTraceMacroDefaults.h"\r
  36 \r
  37 \r
  38 /* The Link-local Multicast Name Resolution (LLMNR)\r
  39  * is included.\r
  40  * Note that a special MAC address is required in addition to the NIC's actual\r
  41  * MAC address: 01:00:5E:00:00:FC\r
  42  *\r
  43  * The target IP address will be 224.0.0.252\r
  44  */\r
  45 #if( ipconfigBYTE_ORDER == pdFREERTOS_BIG_ENDIAN )\r
  46         #define ipLLMNR_IP_ADDR                 0xE00000FC\r
  47 #else\r
  48         #define ipLLMNR_IP_ADDR                 0xFC0000E0\r
  49 #endif /* ipconfigBYTE_ORDER == pdFREERTOS_BIG_ENDIAN */\r
  50 \r
  51 #define ipLLMNR_PORT    5355 /* Standard LLMNR port. */\r
  52 #define ipDNS_PORT              53      /* Standard DNS port. */\r
  53 #define ipDHCP_CLIENT   67\r
  54 #define ipDHCP_SERVER   68\r
  55 #define ipNBNS_PORT             137     /* NetBIOS Name Service. */\r
  56 #define ipNBDGM_PORT    138 /* Datagram Service, not included. */\r
  57 \r
  58 /*\r
  59  * The following function should be provided by the user and return true if it\r
  60  * matches the domain name.\r
  61  */\r
  62 extern BaseType_t xApplicationDNSQueryHook( const char *pcName );\r
  63 \r
  64 /*\r
  65  * LLMNR is very similar to DNS, so is handled by the DNS routines.\r
  66  */\r
  67 uint32_t ulDNSHandlePacket( NetworkBufferDescriptor_t *pxNetworkBuffer );\r
  68 \r
  69 #if( ipconfigUSE_LLMNR == 1 )\r
  70         extern const MACAddress_t xLLMNR_MacAdress;\r
  71 #endif /* ipconfigUSE_LLMNR */\r
  72 \r
  73 #if( ipconfigUSE_NBNS != 0 )\r
  74 \r
  75         /*\r
  76          * Inspect a NetBIOS Names-Service message.  If the name matches with ours\r
  77          * (xApplicationDNSQueryHook returns true) an answer will be sent back.\r
  78          * Note that LLMNR is a better protocol for name services on a LAN as it is\r
  79          * less polluted\r
  80          */\r
  81         uint32_t ulNBNSHandlePacket (NetworkBufferDescriptor_t *pxNetworkBuffer );\r
  82 \r
  83 #endif /* ipconfigUSE_NBNS */\r
  84 \r
  85 #if( ipconfigUSE_DNS_CACHE != 0 )\r
  86 \r
  87     /* Look for the indicated host name in the DNS cache. Returns the IPv4 \r
  88     address if present, or 0x0 otherwise. */\r
  89         uint32_t FreeRTOS_dnslookup( const char *pcHostName );\r
  90 \r
  91     /* Remove all entries from the DNS cache. */\r
  92     void FreeRTOS_dnsclear();\r
  93 #endif /* ipconfigUSE_DNS_CACHE != 0 */\r
  94 \r
  95 #if( ipconfigDNS_USE_CALLBACKS != 0 )\r
  96 \r
  97         /*\r
  98          * Users may define this type of function as a callback.\r
  99          * It will be called when a DNS reply is received or when a timeout has been reached.\r
 100          */\r
 101         typedef void (* FOnDNSEvent ) ( const char * /* pcName */, void * /* pvSearchID */, uint32_t /* ulIPAddress */ );\r
 102 \r
 103         /*\r
 104          * Asynchronous version of gethostbyname()\r
 105          * xTimeout is in units of ms.\r
 106          */\r
 107         uint32_t FreeRTOS_gethostbyname_a( const char *pcHostName, FOnDNSEvent pCallback, void *pvSearchID, TickType_t xTimeout );\r
 108         void FreeRTOS_gethostbyname_cancel( void *pvSearchID );\r
 109 \r
 110 #endif\r
 111 \r
 112 /*\r
 113  * FULL, UP-TO-DATE AND MAINTAINED REFERENCE DOCUMENTATION FOR ALL THESE\r
 114  * FUNCTIONS IS AVAILABLE ON THE FOLLOWING URL:\r
 115  * _TBD_ Add URL\r
 116  */\r
 117 uint32_t FreeRTOS_gethostbyname( const char *pcHostName );\r
 118 \r
 119 \r
 120 #ifdef __cplusplus\r
 121 }       /* extern "C" */\r
 122 #endif\r
 123 \r
 124 #endif /* FREERTOS_DNS_H */\r
 125 \r
 126 \r
 127 \r
 128 \r
 129 \r
 130 \r
 131 \r
 132 \r
 133 \r
 134 \r
 135 \r
 136 \r
 137 \r