Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
printablefalse

Prerequisites 

Before running your first application, you must ensure that you have the minimal set of required tools and components:

  • Toolchain for your specific microcontroller.
  • Development board.
  • Source code for the µC/TCPI-IP stack.
  • Source code for all the other Micriµm modules required by the µC/TCPI-IP stack (see section Installing the µC/TCP-IP StackAdditional Modules)
  • Interface device driver compatible with your hardware for the µC/TCP-IP stack (Ethernet + PHY driver or WiFi driver).*
  • Board support package (BSP) for your development board.*
  • A running project for your selected RTOS.
Info
iconfalse
* If Micrium does not support your network device driver, you will have to write your own device driver. The same goes for your BSP. However, you can contact Micriµm (support@micrium.com) to see if a BSP example exists for your development board to help you get started. Refer to section µC/TCPIP Driver Manual for more information on writing your own Ethernet or WiFi device driver and section Network Board Support Package  for writing your own BSP.

Additional Modules

µC/TCP-IP depends on other modules to run. First, it needs the presence of a RTOS. Furthermore, µC/CPU, µC/LIB and µC/Common modules are required.

...

The µC/Common repository comprises multiple modules required by the µC/TCP-IP stack. Among others,  the KAL module is included. KAL stands for Kernel-Abstraction Layer. It is used by µC/TCP-IP stack and other Micriµm products to interacts with the RTOS by specifying a set of generic API functions. KAL comes with the µC/OS-II and µC/OS-III ports. The complete KAL documentation can be found here.

Downloading the source code

µC/TCP-IP stack can be downloaded from the Micrium customer portal as all the other required modules. The distribution package includes the full source code and documentation. 

...

You can log into the Micrium customer portal at the address below to begin your download (you must have a valid license to gain access to the file):

http://micrium.com/login

Installing the Files

Once all the distribution packages have been downloaded to your host machine, extract all the files at the root of your C:\ drive for instance. The package may be extracted to any location. After extracting all the files, the directory structure should look as illustrated in Installing the Figure - Directory Tree for µC/TCP-IP Stack. In the example, all Micriµm products sub-folders shown in  Installing the Figure - Directory Tree for µC/TCP-IP Stack will be located in C:\Micrium\Software\. The Micriµm µC/OS-III RTOS has been chosen for this example.

...