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

   1 /*\r
   2  * FreeRTOS+TCP V2.0.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. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 #ifndef FREERTOS_DHCP_H\r
  30 #define FREERTOS_DHCP_H\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif\r
  35 \r
  36 /* Application level configuration options. */\r
  37 #include "FreeRTOSIPConfig.h"\r
  38 #include "IPTraceMacroDefaults.h"\r
  39 \r
  40 /* Used in the DHCP callback if ipconfigUSE_DHCP_HOOK is set to 1. */\r
  41 typedef enum eDHCP_PHASE\r
  42 {\r
  43         eDHCPPhasePreDiscover,  /* Driver is about to send a DHCP discovery. */\r
  44         eDHCPPhasePreRequest,   /* Driver is about to request DHCP an IP address. */\r
  45 #if( ipconfigDHCP_SEND_DISCOVER_AFTER_AUTO_IP != 0 )\r
  46         eDHCPPhasePreLLA,               /* Driver is about to try get an LLA address */\r
  47 #endif /* ipconfigDHCP_SEND_DISCOVER_AFTER_AUTO_IP */\r
  48 } eDHCPCallbackPhase_t;\r
  49 \r
  50 /* Used in the DHCP callback if ipconfigUSE_DHCP_HOOK is set to 1. */\r
  51 typedef enum eDHCP_ANSWERS\r
  52 {\r
  53         eDHCPContinue,                  /* Continue the DHCP process */\r
  54         eDHCPUseDefaults,               /* Stop DHCP and use the static defaults. */\r
  55         eDHCPStopNoChanges,             /* Stop DHCP and continue with current settings. */\r
  56 } eDHCPCallbackAnswer_t;\r
  57 \r
  58 /*\r
  59  * NOT A PUBLIC API FUNCTION.\r
  60  */\r
  61 void vDHCPProcess( BaseType_t xReset );\r
  62 \r
  63 /* Internal call: returns true if socket is the current DHCP socket */\r
  64 BaseType_t xIsDHCPSocket( Socket_t xSocket );\r
  65 \r
  66 /* Prototype of the hook (or callback) function that must be provided by the\r
  67 application if ipconfigUSE_DHCP_HOOK is set to 1.  See the following URL for\r
  68 usage information:\r
  69 http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html#ipconfigUSE_DHCP_HOOK\r
  70 */\r
  71 eDHCPCallbackAnswer_t xApplicationDHCPHook( eDHCPCallbackPhase_t eDHCPPhase, uint32_t ulIPAddress );\r
  72 \r
  73 #ifdef __cplusplus\r
  74 }       /* extern "C" */\r
  75 #endif\r
  76 \r
  77 #endif /* FREERTOS_DHCP_H */\r
  78 \r
  79 \r
  80 \r
  81 \r
  82 \r
  83 \r
  84 \r
  85 \r
  86 \r
  87 \r
  88 \r
  89 \r
  90 \r