This FreeRTOS Labs
project is adding multiple interfaces and multiple endpoint support to the currently single interface only FreeRTOS+TCP TCP/IP stack. While the resultant multiple interface version is fully functional, it is still undergoing optimisation, test coverage and documentation improvements, and memory safety checks. Until that work is complete the code is available as a branch of the FreeRTOS+TCP GitHub repo
FreeRTOS+TCP Multiple Interfaces
Introduction: Multiple interfaces, multiple end-points
We are introducing two new concepts in FreeRTOS+TCP: interfaces
An interface corresponds to a Network Interface Card (NIC), and has the following properties: it has a set
of function addresses that perform the actual work i.e. initialise the NIC, send a
packet, get the Link Status, and as usual, each interface will start-up its own task
to do the reading of packets, and forward them to the IP-task. A message buffer will
contain pointers to both the Interface, and to the end-point on which it was received.
The concept of an end-point makes it possible to obtain multiple IP-addresses. Each
end-point has the following properties:
- IP-address ( either IPv4 or IPv6 )
- Default IP-address
- A prefix ( IPv6 ) or a net-mask ( IPv4 )
- Gateway address
- DNS addresses
Up until now, each FreeRTOS+TCP project had one physical interface, either a Local Area Network (LAN) or Wi-Fi.
The driver for this interface is linked into the code and offers the possibility to send and
receive packets. An application can only link with a single network interface, this is a
static (compile-time) choice.
The library expects a network interface that exchanges raw IEEE 802.3
packets. Here is an example
of an application with a single interface:
An application can communicate with other nodes on the same LAN. The physical (MAC-) addresses are
looked up by using ARP. The bindings can be stored in a cache.
When an application wants to connect to the Internet, it must first find the remote IP-address. A DNS
client takes care of this. Once the IP-address is known, the application must know a gateway
address. This is normally a network router. If there is no gateway defined, a packet will be dropped.
The routing logic in the single driver is very simple. If the peer's IP-address is within the
network mask, packets will be sent directly. For instance, the laptop here above ( 192.168.2.5 )
can be reached directly.
More and more applications want to make use of more than one network interface. With multiple
interfaces this is possible.
Here below a configuration with 2 network interfaces:
Now the FreeRTOS application is connected to a LAN and also to a Wi-Fi station.
It uses the addresses 192.168.2.100 and 10.2.0.45. These addresses can be configured either
statically or automatically by the use of DHCP, or Router Advertisement ( “RA” ) in case of IPv6.
IP-routing becomes a little more complex now. Suppose the application wants to send a UDP packet
to the IoT-thing. The library will try to find a matching network address:
The solution is easy: 10.2.0.12 matches with the network address 10.2.0.0, which is the Wi-Fi network.
No gateway is needed.
Now it wants to load a page from Google.com. DNS returns the address 22.214.171.124. This address does
not match with either the LAN or the Wi-Fi network address.
The library will iterate through the list of interfaces again and look for a Gateway. The first gateway
found will be used.
Two networks, same network address
Some users on the FreeRTOS forum have asked if two networks may have the same network address.
The algorithm says that the first interface with a matching
network address shall be used. The same for an incoming TCP connection: the very first SYN
packet will set the MAC-address and the interface used. As for UDP packets: incoming packets
will be replied to through the interface that received the packet.
Porting existing applications to FreeRTOS+TCP /multi:
Any existing application can easily be ported by defining `ipconfigCOMPATIBLE_WITH_SINGLE` in the
FreeRTOSIPConfig.h file. In that case, only one interface shall be linked to the project, and IPv6
shall be disabled.
When not using the compatible mode, each end-point must be initialised by the application: set the
default values, and indicate whether DHCP or Router Advertisement is desired.
In the earlier /single version, the device ( as a whole ) was said to be up or down. In the new
version, an end-point can become up or down. So earlier functions like FreeRTOS_GetAddressConfiguration()
can not be used as is. A new parameter will be added: the end-point.
Lean and mean: while adding these new features, we have tried to keep both the code and the usage of
RAM as small as possible. It has no sophisticated indexed tables or complex routing rules.
For instance, it is assumed that there is only one gateway and one DNS address. If there is more than
one gateway or DNS address, the first one will be chosen.
The actual logic for TCP has not been changed. The windowing mechanism, the retransmissions, time-out,
all remain the same.
The how to setup and run a demo for multiple interfaces page provides instructions on setting up multiple interfaces
Multiple Interface functions
The IPv6 and multiple interface functions page provides information on new functions required to use both IPv6 and multiple interfaces.
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.