xmos · samchesney · Jan 31, 2017 · Aug 17, 2015 · Sep 1, 2015 · Sep 1, 2015
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
 **/.build*/*
 bin/
 _build/
+__gen/
+_README/
 *.o
 *.xe
 *.vcd
@@ -22,6 +24,7 @@ Doxyfile-e
 .DS_Store
 *.pyc
 *.xmt
+**/test_results.csv
 examples/AN01032_100Mbit_avb_i2s_demo/.settings/
 *.pptx
 examples/AN01032_100Mbit_avb_i2s_demo/doc/pdf/
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,30 +1,72 @@
-TCP/IP Library Change Log
+TCP/IP library change log
 =========================
 
+6.0.0
+-----
+
+  * CHANGE: Unified the branches of uIP and lwIP as the backend of the XTCP
+    stack. The default is uIP. To change the stack, define XTCP_STACK in your
+    makefile to be either UIP or LWIP. Then, instead of calling xtcp(...), call
+    either xtcp_uip(...) or xtcp_lwip(...) respectively.
+  * CHANGE: The interface between the client and server is now event-driven
+    rather than polling.
+  * CHANGE: Channels have been replaced by interfaces as communication medium
+    between client and server.
+  * REMOVED: The following xtcp_event_types: XTCP_PUSH_DATA, XTCP_REQUEST_DATA,
+    XTCP_POLL, XTCP_ALREADY_HANDLED
+  * CHANGE: The fields of packet_length and client_num have been added to the
+    xtcp_connection_t structure.
+  * REMOVED: xtcp_connection_t no longer has a xtcp_connection_type_t field.
+  * REMOVED: The ability to pause a connection
+  * REMOVED: The ability to partially acknowledge a packet
+  * REMOVED: Support for IPv6
+  * REMOVED: the ability to send with an index. This functionality is easily
+    replicated with a call to send() with the pointer of the array index
+    location, i.e. &(data[index]).
+  * REMOVED: Support for XTCP_EXCLUDE_* macros which reduced functionality in
+    order to save code size
+  * FIXED: Problem where ethernet packets smaller than 64 bytes would be incorrectly padded with uIP.
+  * REMOVED: Dependancy on lib_crypto.
+
+5.1.0
+-----
+
+  * ADDED: Support for using lib_wifi to provide the physical transport
+
+5.0.0
+-----
+
+  * ADDED: Port of LwIP TCP/IP stack
+
+  * Changes to dependencies:
+
+    - lib_crypto: Added dependency 1.0.0
+
 4.0.3
 -----
 
-  * Update to support enabling link status notifications
+  * ADDED: Support to enable link status notifications
 
 4.0.2
 -----
 
-  * Change uIP timer.h to uip_timer.h to avoid conflict with xcore timer.h
-  * Update to source code license and copyright
+  * CHANGE: uIP timer.h renamed to uip_timer.h to avoid conflict with xcore
+    timer.h
+  * CHANGE: Update to source code license and copyright
 
 4.0.1
 -----
 
-  * Fixed issue with link up/down events being ignored when SMI is not polled
-    within XTCP
-  * MAC address parameter to xtcp() is now qualified as const to allow parallel
-    usage
+  * CHANGE: MAC address parameter to xtcp() is now qualified as const to allow
+    parallel usage
+  * RESOLVED: Fixed issue with link up/down events being ignored when SMI is not
+    polled within XTCP
 
 4.0.0
 -----
 
-  * Moved over to new file structure
-  * Updated to use new lib_ethernet
+  * CHANGE: Moved over to new file structure
+  * CHANGE: Updated to use new lib_ethernet
 
   * Changes to dependencies:
 

diff --git a/README.rst b/README.rst
@@ -4,39 +4,70 @@ TCP/IP Library
 Overview
 --------
 
-A TCP/UDP/IP protocol stack for XMOS devices. This library connects to
-the XMOS Ethernet library to provide layer-3 traffic over Ethernet via
-MII or RGMII.
+A library providing two alternative TCP/UDP/IP protocol stacks for XMOS devices.
+This library connects to the XMOS Ethernet library to provide layer-3 traffic
+over Ethernet via MII or RGMII.
 
 Features
 ........
 
-   * TCP + UDP connection handling
+   * TCP and UDP connection handling
    * DHCP, IP4LL, ICMP, IGMP support
    * Low level, event based interface for efficient memory usage
-   * Based on the open-source uIP stack
-   * Currently, the library does not officially support IPv6. However,
-     experimental code for IPv6 support is contained in the
-     library. Contact XMOS for more details if you require IPv6.
+   * Supports IPv4 only, not IPv6
+
+Stacks
+......
+
+This library provides two different TCP/IP stack implementations ported to the
+xCORE architecture.
+
+uIP stack
++++++++++
+
+The first stack ported is the uIP (micro IP) stack. The uIP stack has been
+designed to have a minimal resource footprint. As a result, it has limited
+performance and does not provide support for TCP windowing.
+
+lwIP stack
+++++++++++
+
+The second stack ported is the lwIP (lightweight IP) stack. The lwIP stack
+requires more resources than uIP, but is designed to provide
+better throughput and also has support for TCP windowing.
 
 Typical Resource Usage
 ......................
 
 .. resusage::
 
-  * - configuration: Standard
+  * - configuration: UIP
+    - globals: xtcp_ipconfig_t ipconfig = {
+               { 0, 0, 0, 0 },
+               { 0, 0, 0, 0 },
+               { 0, 0, 0, 0 }
+               };
+               char mac_addr[6] = {0};
+    - locals: interface mii_if i_mii; xtcp_if i_xtcp[1];
+    - fn: xtcp_uip(i_xtcp, 1, i_mii,
+                   null, null, null,
+                   null, 0, mac_addr, null, ipconfig);
+    - pins: 0
+    - ports: 0
+  * - configuration: LWIP
     - globals: xtcp_ipconfig_t ipconfig = {
                { 0, 0, 0, 0 },
                { 0, 0, 0, 0 },
                { 0, 0, 0, 0 }
                };
                char mac_addr[6] = {0};
-    - locals: interface mii_if i_mii; chan c_xtcp[1];
-    - fn: xtcp(c_xtcp, 1, i_mii,
-               null, null, null,
-               null, 0, mac_addr, null, ipconfig);
+    - locals: interface mii_if i_mii; xtcp_if i_xtcp[1];
+    - fn: xtcp_lwip(i_xtcp, 1, i_mii,
+                   null, null, null,
+                   null, 0, mac_addr, null, ipconfig);
     - pins: 0
     - ports: 0
+    - target: XCORE-200-EXPLORER
 
 
 Software version and dependencies

diff --git a/examples/AN00121_udp_demo/Makefile b/examples/AN00121_udp_demo/Makefile
@@ -9,14 +9,20 @@ TARGET = SLICEKIT-L16
 APP_NAME = 
 
 # The USED_MODULES variable lists other module used by the application.
-USED_MODULES = lib_xtcp
+USED_MODULES = lib_xtcp(>=6.0.0)
 
 # The flags passed to xcc when building the application
 # You can also set the following to override flags for a particular language:
 # XCC_XC_FLAGS, XCC_C_FLAGS, XCC_ASM_FLAGS, XCC_CPP_FLAGS
 # If the variable XCC_MAP_FLAGS is set it overrides the flags passed to
 # xcc for the final link (mapping) stage.
-XCC_FLAGS = -g -O2 -save-temps -DXTCP_VERBOSE_DEBUG
+GEN_XCC_FLAGS = -g -O2 -save-temps -fxscope
+
+XCC_FLAGS =
+
+XCC_C_FLAGS = $(GEN_XCC_FLAGS)
+XCC_XC_FLAGS = $(GEN_XCC_FLAGS)
+XCC_MAP_FLAGS = -report
 
 # The VERBOSE variable, if set to 1, enables verbose output from the make
 # system.

diff --git a/examples/AN00121_udp_demo/README.rst b/examples/AN00121_udp_demo/README.rst
@@ -1,12 +1,12 @@
 Using XMOS TCP/IP Library for UDP-based Networking
 ==================================================
 
-.. version:: 2.0.1
+.. version:: 6.0.0
 
 Summary
 -------
 
-This application note demonstrates the use of  XMOS TCP/IP stack on
+This application note demonstrates the use of XMOS TCP/IP stack on
 an XMOS multicore micro controller to communicate on an ethernet-based network.
 
 The code associated with this application note provides an example of
@@ -28,19 +28,17 @@ networks.
 Note: This application note requires an application to be run on the
 host machine to test the communication with the XMOS device.
 
-
 Required tools and libraries
 ............................
 
-* xTIMEcomposer Tools - Version 14.0.0
-* XMOS TCP/IP library - Version 4.0.0
+.. appdeps::
 
 Required hardware
 .................
 
 This application note is designed to run on an XMOS xCORE
-General-Purpose 
-device. 
+General-Purpose
+device.
 
 The example code provided with the application has been implemented and tested
 on the xCORE General-Purpose sliceKIT (XP-SKC-L2) with an ethernet sliceCARD (XA-SK-E100) but there is no dependancy on this board and it can be
@@ -51,9 +49,9 @@ Prerequisites
 
   - This document assumes familiarity with the XMOS xCORE architecture, the XMOS tool chain and the xC language. Documentation related to these aspects which are not specific to this application note are lin
9FA8
ked to in the references appendix.
 
-  - For descriptions of XMOS related terms found in this document please see the *XMOS glossary* [#]_. 
+  - For descriptions of XMOS related terms found in this document please see the *XMOS glossary* [#]_.
 
-  - For an overview of XTCP TCP/IP stack please see the *XMOS TCP/IP stack design guide* [#]_ for reference. 
+  - For an overview of XTCP TCP/IP stack please see the *XMOS TCP/IP stack design guide* [#]_ for reference.
 
 .. [#] http://www.xmos.com/published/glossary
 

diff --git a/examples/AN00121_udp_demo/bin/AN00121_udp_demo.xe b/examples/AN00121_udp_demo/bin/AN00121_udp_demo.xe
diff --git a/examples/AN00121_udp_demo/doc/pdf/AN00121.pdf b/examples/AN00121_udp_demo/doc/pdf/AN00121.pdf