orphan:

lib_xtcp: TCP/IP Library

vendor:	XMOS
version:	7.0.1
scope:	General Use
description:	TCP/IP Library
category:	Networking
keywords:	Ethernet
devices:	xcore.ai, xcore-200

Summary

lib_xtcp is a library providing implementations of the Ethernet transport layer, designed to support host-to-host network communication by handling data exchange typically using TCP or UDP protocols. It provides a software defined Ethernet transport stack implementation that connects to and runs on the XMOS Ethernet library lib_ethernet to support layer-4 traffic over Ethernet via MII or RGMII, at 10/100/1000 Mb/s Ethernet data rates.

The library provides two alternative TCP/UDP/IP protocol stacks for XMOS devices. See the following section for further details.

TCP/IP Stack

The TCP/IP stack used is the third-party lwIP (lightweight IP) stack ported to the xcore architecture. The lwIP stack is designed to provide good throughput and also has support for TCP windowing. Throughput in excess of 50 Mbps can be achieved using RMII with this stack on xcore.ai devices.

Repository Submodule

Please note: the TCP/IP stack is included as a submodule, if cloning the repository please ensure to clone with --recurse-submodules or run git submodule update --init --recursive after cloning.

Features

• TCP and UDP connection handling
• Common API to TCP/IP stack, LwIP
• TCP, UDP, DHCP, ICMP, IGMP
• Low level, event based interface for efficient memory usage
• Supports IPv4 only, not IPv6

Known issues

• Only one network interface supported at a time with an RMII/RGMII MAC. This needs support from the underlying lib_ethernet library (#51).
• Support for IP4LL have been disabled.
• Only supports real-time variants of lib_ethernet MACs, due to use of timestamps of sent and received packets.

Development repo

• lib_xtcp

Required tools

• XMOS XTC Tools: 15.3.1

Required libraries (dependencies)

• lib_ethernet
• lib_otpinfo
• lib_logging
• lib_random
• lib_xassert

Related application notes

• AN00120: 100Mbps RMII ethernet application note
• AN00199: XMOS Gigabit Ethernet application note (XK-EVK-XE216)

The following application notes use this library:

• AN00121: Using XMOS TCP/IP Library for UDP-based Networking on XCORE-200 application note
• AN02044: Using XMOS TCP/IP Library for UDP-based Networking application note

Support

This package is supported by XMOS Ltd. Issues can be raised against the software at http://www.xmos.com/support