Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 59 Next »

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 Stack)
  • 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.
* 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.

If you are using one of the two Micriµm OS, complete documentation can be found here for µC/OS-II and here for µ/COS-III. Refer to those guides for more information on the requirements, installation, configuration and running of those RTOS.

The µC/CPU module regroups the processor's hardware-dependent code. µC/CPU includes many ports for all the different CPU architectures Micriµm supports. You must therefore used the port corresponding to your specific CPU. The complete µC/CPU documentation can be found here. 

The µC/LIB module is the Micriµm run-time library, implementing the most common standard library functions, macros, and constants. The complete µC/LIB documentation can be found here.

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. 

The customer portal also includes all the network interface device driver supported by Micriµm. Wired Ethernet devices and WiFi devices are supported by Micriµm. Download the device driver adequate for your project. If your device is not support by Micriµm, you will need to develop your own device driver. Refer to section µC/TCPIP Driver Manual for all the details.

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 µC/TCP-IP Stack. In the example, all Micriµm products sub-folders shown in  Installing the µC/TCP-IP Stack will be located in C:\Micrium\Software\. The Micriµm µC/OS-III RTOS has been chosen for this example.

 

  • No labels