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

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