1.10 TCP/IP TCP Server

This application demonstrates usage of MPLAB Harmony TCP API to implement a TCP echo server on port 9760.

Description

The TCP/IP TCP Server application is based on MPLAB® Harmony 3 TCP/IP Stack.

The Harmony TCP/IP stack is a collection of different network protocols.

The source files of Harmony 3 TCP/IP stack is available here.

The demo is created with MPLAB X IDE and MCC plugin.

MCC Project Graph - TCP/IP TCP Server

The following Project Graph shows the Harmony components included in the TCP/IP TCP Server demo application.

Figure 1-46. Project Graph

FreeRTOS component is required for RTOS application. For bare-metal (non-RTOS) FreeRTOS component should not be selected.

TCP/IP Configuration - TCP/IP TCP Server

The TCP/IP modules enabled for the demo is shown in the TCP/IP Configuration Overview

More details of TCP/IP Configuration plugin is available here

Figure 1-47. SAM9X75-Curiosity

The Ethernet interface in this demo-configuration use GMAC peripheral and Gigabit Ethernet PHY Transceiver LAN8840.

Figure 1-48. SAM9X75-DDR3-EB

The Ethernet interface in this demo-configuration use GMAC peripheral and Gigabit Ethernet PHY Transceiver KSZ9131.

The Application Layer modules enabled in the demo are as follows:

  • Application Layer Modules
    • DHCP Client to discover the IPv4 address from the nearest DHCP Server.
    • DNS Client provides DNS resolution capabilities to the stack.

Downloading and Building the application

To clone or download this application from Github, go to the main page of this repository and then click Clone button to clone this repository or download as zip file.

This content can also be downloaded using content manager by following these instructions.

Path of the application within the repository is apps\tcpip_tcp_server\firmware .

To build the application, refer to the following list of demo configurations and open the project using MPLAB X IDE.

Table 1-11. Demo Configurations
Project NameTarget DeviceDevelopment BoardDescription
sam_9x75_curiosity.XSAM9X75D2GSAM9X75-Curiosity + LAN8840 EDS2 Daughter Card

TCP/IP TCP Server - Gigabit Ethernet PHY LAN8840 - Bare Metal

sam_9x75_curiosity_freertos.XSAM9X75D2GSAM9X75-Curiosity + LAN8840 EDS2 Daughter Card

TCP/IP TCP Server - Gigabit Ethernet PHY LAN8840 - FreeRTOS

sam_9x75_ddr3_eb.XSAM9X75SAM9X75-DDR3-EB

TCP/IP TCP Server - Gigabit Ethernet PHY KSZ9131 - Bare Metal

sam_9x75_ddr3_eb_freertos.XSAM9X75SAM9X75-DDR3-EB

TCP/IP TCP Server - Gigabit Ethernet PHY KSZ9131 - FreeRTOS

Hardware Setup - SAM9X75-Curiosity

The target board for running the application is SAM9X75-CURIOSITY.

This section provides essential hardware configuration of this target board to run TCP/IP applications.

Figure 1-49. SAM9X75-CURIOSITY

Board Setup

  • Default jumper setting of the board is a shown above.
  • Connect the Micro-USB cable between USB-A port on the board and host PC. This will supply power to the board.
  • Connect a USB-UART converter for console output between the UART DEBUG port on the board and host PC.
  • Connect the debugger/programmer between JTAG connector on the board and host PC.
  • Connect Ethernet cable between RJ45 connector and router/switch/computer.

Hardware Setup - SAM9X75-DDR3-EB

The target board for running the application is SAM9X75-DDR3-EB.

This section provides essential hardware configuration of this target board to run TCP/IP applications.

Figure 1-50. SAM9X75-DDR3-EB

Board Setup

  • Default jumper setting of the board is a shown above.
  • Connect USB cable between USB-A port (J28) and host PC. This will supply 5V power to board.
  • Connect serial cable (FTDI) for debug console output on DBGU1(J36) port.
  • Connect Ethernet cable between RJ45 socket (J18) and router/switch/computer.

Setting up at91bootstrap loader

To load the application binary onto the target device, we need to use at91bootstrap loader.

Refer to the at91bootstrap loader documentation for details on how to configure and run/debug the application using MPLABX and booting application using an SD Card.

Running the Application

  1. Open a terminal application on the host computer (like Hyper-terminal or Tera Term).
  2. Configure the terminal application for serial port connected to UART DEBUG port.
  3. Set baud rate as 115200 in the terminal application.
  4. Build and download the application project on the target board.
  5. Ensure connection from Gigabit(1000Mbps) capable network socket of a router/switch/computer to the board.
  6. Verify the TCP/IP Stack initialization console messages.

If DHCP client is enabled in the demonstration, wait for the DHCP server to assign an IP address for the development board.

This will be printed on the console. Otherwise, the default static IP address will be assigned to the board.

TCP Server Test

For TCP Server test, a TCP Client application is required to run on the host computer (SocketTest, PacketSender etc).

In this demonstration, we use PacketSender utility.

  • Send a TCP packet to the IP address of the hardware board, port 9760, from TCP Client application (PacketSender) running on the computer. See the following screenshot.
  • The TCP Server running on the hardware board will echo back the message it receives. See the following console screenshot.