Building and Running Sample Application

This section describes all the steps required to build a IPerf-based application. The instructions provided in this section are not intended for any particular toolchain, but instead are described in a generic way that can be adapted to any toolchain.

The best way to start building a IPerf-based project is to start from an existing µC/TCP-IP project. 

Working project with µC/TCP-IP

The first step before including the µC/IPerf is to have a working project with the µC/TCP-IP. As previously mentioned, Micriµm may offer starting example with µC/OS-III kernels and µC/TCP-IP and even with µC/IPerf for many evaluation boards. 

If no project that include µC/TCP-IP is available, you should follow the µC/TCP-IP - Getting Started Guide to start with a working TCP/IP  project before starting integrating µC/IPerf. Then you can follow the following steps to build and run your first µC/IPerf sample application.

Including Additional Modules to the Project

Once you have a working project with your RTOS and µC/TCP-IP additional modules are needed by the Micriµm IPerf Module that are not necessarily already included in your project. Therefore, be sure to add µC/CPU and µC/LIB to your project.  

Refer to the following manuals for further information about Micriµm modules:

µC/TCP-IP Documentation

µC/OS-II Documentation

µC/OS-III Documentation

µC/LIB Documentation

µC/CPU Documentation

Optional module

µC/IPerf comes with a set of command that can be executed from a shell command line tool. If you want to use it you have to include µC/Shell to your project:

 µC/Shell Documentation

Including µC/IPerf Source Code

Include the following files in your project tree from the µC/IPerf source code distribution, as indicated in Figure - µC/IPerf Source Code.

As indicated in the Figure - µC/IPerf Source Code, all the files in the Source folder must be added to your project tree. 

Compiler settings

Finally, add the following include paths to your project’s C compiler settings:

\Micrium\Software\uC-IPerf

\Micrium\Software\uC-TCPIP

\Micrium\Software\uC-Shell (optional if uC/Shell is used)

Copying and Modifying Template Files

Copy the files from the µC/IPerf configuration folder into your application as illustrated in Figure - µC/IPerf Copying Template Files.

iperf_cfg.h define µC/IPerf module static parameters and run-time configuration structure. Refer to section Module Configuration for more details on all the configurations inside templates files.

Modifying the HEAP memory configuration

The µC/IPerf Module uses additional heap memory space. Therefore, it is possible that your sample application will require more allocation of heap memory. If it is the case, you can increase the HEAP memory size of your sample project, refer to section µC/LIB Memory Management Configuration for more details on the heap usage. 

Adding µC/IPerf application function

Before running the sample application, you will need to add the new function call, in your application file to initialize and setup the µC/IPerf module. Section Sample Application gives an example of how to initialize µC/IPerf and launch a network throughput test. 

This code example will need to be modified in accordance with your project. 

Adding Additional includes

When you initialize µC/IPerf and where call API you need to include the following files.

#include <Source/iperf.h>