Minor edits prior to tagging V8.1.0.

[freertos] / FreeRTOS / Demo / CORTEX_A9_Zynq_ZC702 / RTOSDemo / src / lwIP_Demo / main_lwIP.c

diff --git a/FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo/src/lwIP_Demo/main_lwIP.c b/FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo/src/lwIP_Demo/main_lwIP.c
index 05942205bbe81163ba093106ded4f79527e75b5c..507e5bd0239e35d543c5475c9acd5b94d9b3f780 100644 (file)
--- a/FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo/src/lwIP_Demo/main_lwIP.c
+++ b/FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo/src/lwIP_Demo/main_lwIP.c
@@ -1,5 +1,5 @@
 /*\r
-       FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
+       FreeRTOS V8.1.0 - Copyright (C) 2014 Real Time Engineers Ltd.\r
        All rights reserved\r
 \r
        VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
@@ -74,8 +74,33 @@
  * basic demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  * required to configure the hardware are defined in main.c.\r
  ******************************************************************************\r
+ *\r
+ * The lwIP example can be configured to use either a static or dynamic IP\r
+ * address:\r
+ *    + To use a dynamically allocated IP address set LWIP_DHCP to 1 in\r
+ *      lwipopts.h and connect the target to a network that includes a DHCP\r
+ *      server.  The obtained IP address is printed to the UART console.\r
+ *    + To use a static IP address set LWIP_DHCP to 0 in lwipopts.h and set\r
+ *      the static IP address using the configIP_ADDR0 to configIP_ADDR3\r
+ *      constants at the bottom of FreeRTOSConfig.h.  Constants used to define\r
+ *      a netmask are also located at the bottom of FreeRTOSConfig.h.\r
+ *\r
+ * When connected correctly the demo uses the lwIP sockets API to create\r
+ * a FreeRTOS+CLI command console, and the lwIP raw API to create a basic HTTP\r
+ * web server with server side includes that generate dynamic run time web\r
+ * pages.  See http://www.freertos.org/RTOS-Xilinx-Zynq.html for more\r
+ * information.\r
+ *\r
+ * To connect to FreeRTOS+CLI, open a command prompt and enter "telnet <ipaddr>"\r
+ * where <ipaddr> is the IP address of the target.  Once connected type "help"\r
+ * to see a list of registered commands.  Note this example does not implement\r
+ * a real telnet server, it just uses the telnet port number to allow easy\r
+ * connection using telnet tools.\r
+ *\r
+ * To connect to the http server simply type the IP address of the target into\r
+ * the address bar of a web browser.\r
+ *\r
  */\r
-#warning Need to update the comment above.\r
 \r
 /* Kernel includes. */\r
 #include "FreeRTOS.h"\r
@@ -156,4 +181,4 @@ static void prvLEDToggleTimer( TimerHandle_t pxTimer )
        vParTestToggleLED( mainTIMER_LED );\r
 }\r
 \r
-\r
+/*-----------------------------------------------------------*/\r