Homepage  

FreeRTOS.org Stellaris WEB Server Demo
Using Eclipse, OpenOCD and GCC for a completely
open source development environment

[Embedded Ethernet Examples]


The demo described by this page uses...

...to create a simple WEB server example for the range of ARM Cortex-M3 Stellaris evaluation kits available from Luminary Micro.

Click to see live WEB pages served from an LM3S6965 Cortex-M3 microcontroller.
[A non standard port number is used which may be blocked by some proxy servers and fire walls.]

Tested on the the following evaluation kits (ethernet is only available on the LM3S6965 and LM3S8962):

The Europa version of Eclipse includes enhancements that facilitate cross development.

The FreeRTOS.org zip file contains everything required to setup the development environment, other than the Eclipse and GCC tools themselves. Please follow these instructions carefully to install and configure Eclipse correctly for use with this demo application.

The Luminary Micro evaluation kits connect directly to the host PC via a micro USB cable, removing the requirement for a separate JTAG interface device. This USB connection is used to power, program and debug the microcontroller.

uIP and OpenOCD are licensed separately from FreeRTOS.org. Users must familiarise themselves with their respective licenses. (OpenOCD is licensed under the GNU GPL).

Although all the tools used are cross platform - I have only tested the Cortex-M3/Eclipse build on a windows host.

Upgrading to FreeRTOS.org V4.8.0: Prior to V4.8.0 the FreeRTOS.org kernel did not make use of the SVCall interrupt. From V4.8.0 onwards it does. Therefore, to upgrade an older project to the V4.8.0 standard, a small edit to the startup code is required. To do this, simply install vPortSVCHandler() in the SVCall position within the interrupt vector table (contained in the startup source file). The demo projects included in the FreeRTOS.org download have already been updated so these can be used as an example.

Note for LM3S2965 and LM3S6965 users: The display part number changed on REV C evaluation kit boards. If you are using a REV C board then:

  1. In the project or makefile, delete the reference to osram128x64x4.c and replace it with rit128x96x4.c. rit128x96x4.c and rit128x96x4.h can be located within the FreeRTOS.org download as they are already used for other projects.
  2. In main.c, within the case statement at the top of the vOLEDTask() function, ensure the LM3S2965 and LM3S6965 use the rit128x96x4 driver, as per the other devices initialised within the same case statement.


IMPORTANT! Notes on using the Stellaris WEB Server Demo

Please read all the following points before using this RTOS port.

  1. Source Code Organisation
  2. The Demo Application
  3. RTOS Configuration and Usage Details
See also the FAQ My application does not run, what could be wrong?

Source Code Organisation

The Eclipse workspace for the Eclipse Stellaris demo is located in the FreeRTOS/Demo/CORTEX_LM3Sxxxx_Eclipse directory. This is the directory to select when prompted for a workspace location during the Eclipse startup process. Be sure to read the Eclipse installation and configuration instructions prior to building the project.

The FreeRTOS.org zip file download contains the files for all the ports and demo application projects. It therefore contains many more files than used by this demo. See the Source Code Organization section for a description of the downloaded files and information on creating a new project.


The Demo Application

Demo application setup

Note the comments at the head of this page regarding the selection of the correct display driver.

Connect the Stellaris evaluation board to a computer running a WEB browser either directly using a point to point (crossover) cable, or via a hub/router using a standard Ethernet cable. The prototyping board may also allow the use of a standard Ethernet cable when connecting point to point, but I have not tried this configuration.

The IP address used by the demo is set by the constants uipIP_ADDR0 to uipIP_ADDR3 within the file FreeRTOS/Demo/CORTEX_LM3Sxxxx_Eclipse/RTOSDemo/webserver/uIP_Task.c. The IP addresses used by the WEB browser computer and the prototyping board must be compatible. This can be ensured by making the first three octets of both IP addresses identical. For example, if the WEB browser computer uses IP address 192.168.100.1, then the prototyping board can be given any address in the range 192.168.100.2 to 192.168.100.254 (barring any addresses already present on the network).

Each evaluation kit is pre-programmed with a unique MAC address, removing the requirement for this to be manually configured.

The demo application uses the LED and OLED display built onto the evaluation board so no other hardware setup is required.


Building the demo application

Again - please refer to the Eclipse installation and configuration instructions for more detailed information.
  1. Ensure the ARM EABI Lite version of the Code Sourcery G++ development tools is installed, and that the [install path]/CodeSourcery/Sourcery G++ Lite/bin directory is included within your PATH environment variable.
  2. Open the FreeRTOS/Demo/CORTEX_LM3Sxxxx_Eclipse Eclipse workspace from within the Eclipse Workbench.
  3. Ensure the FreeRTOS_ROOT variable has been configured.
  4. Press F7 (or select "Build All" from the "Project" menu) to build the demo application.


Running the demo application

Once again - please refer to the Eclipse installation and configuration instructions for more detailed information.
  1. Connect the Stellaris evaluation kit to your host PC using a USB cable. If this is the first time the kit has been connected then you will be prompted to install 3 USB drivers. The correct drivers are included on the Luminary Micro CD that came with the kit, alternatively they can be downloaded from the Luminary Micro WEB site.
  2. Ensure an Ethernet cable is connected as described above.
  3. Select "OpenOCD Programmer" from the "Run | External Tools" menu - then wait for the programming to complete.
If you then wish to commence a debugging session:
  1. Select "OpenOCD Server" from the "Run | External Tools" menu.
  2. Switch to the debugging perspective.
  3. Select the OpenOCD server executable within the Debug pane.
  4. Click the "Debug RTOSDemo" speed button (the one with the little green bug icon).


Functionality

The demo application creates 20 persistent tasks, and periodically dynamically creates and destroys another 2. These tasks consist predominantly of the standard demo application tasks (see the demo application section for details of the individual tasks).

The following tasks and tests are created in addition to the standard demo tasks:

When executing correctly the demo application will behave as follows:


Served WEB Pages (LM3S6965 and LM3S8962 kits only)

The top of each served page includes a menu containing a link to every other page.


The served RTOS stats page

The RTOS stats page provides run time information on the state of each task within the system - including the stack high water mark (the minimum amount of stack there has been available at any time since the task started executing). The page will reload approximately every two seconds - depending on network load.

This page is transmitted in three sections - the HTML header and menu, the dynamically generated content, then finally the HTML footer. This makes the page relatively fast to load. It could be optimised further by transmitting the entire page in one go.

The continuous reloading can sometimes make navigating away from the RTOS stats page a little tricky.


The served IO page

The IO page provides a simple interface that permits data to be sent to the LED and OLED display on the development board.

The check box permits the state of the user LED to be set and queried. The text box can be used to write a message to the OLED display, but does not query the text currently being display. Changes are sent to the target hardware by clicking the "Update IO" button.

The TCP Stats and Connections pages display run time networking information. Note that these pages transmit each line individually so will not load quickly. This demonstrates how memory usage can be optimised through the use of a small transmit buffer by sacrificing the achieved data throughput.



RTOS Configuration and Usage Details


RTOS Port specific configuration

Configuration items specific to these demos are contained in FreeRTOS/Demo/CORTEX_LM3Sxxxx_Eclipse/RTOSDemo/FreeRTOSConfig.h. The constants defined in this file can be edited to suit your application. In particular -

Each port #defines 'portBASE_TYPE' to equal the most efficient data type for that processor. This port defines portBASE_TYPE to be of type long.

Note that vPortEndScheduler() has not been implemented.


Interrupt service routines

In the demo application the vector table remains in flash.

Unlike most ports, interrupt service routines that cause a context switch have no special requirements and can be written as per the compiler documentation. The macro portEND_SWITCHING_ISR() can be used to request a context switch from within an ISR.

Note that portEND_SWITCHING_ISR() will leave interrupts enabled.


Switching between the pre-emptive and co-operative real time kernels

Set the definition configUSE_PREEMPTION within FreeRTOS/Demo/CORTEX_LM3Sxxxx_Eclipse/RTOSDemo/FreeRTOSConfig.h to 1 to use pre-emption or 0 to use co-operative.


Compiler options

As with all the ports, it is essential that the correct compiler options are used. The best way to ensure this is to base your application on the provided demo application files.


Memory allocation

Source/Portable/MemMang/heap_2.c is included in the ARM Cortex-M3 demo application project to provide the memory allocation required by the real time kernel. Please refer to the Memory Management section of the API documentation for full information.




Copyright (C) 2003 - 2008 Richard Barry
Any and all data, files, source code, html content and documentation included in the FreeRTOS.org distribution or available on this site are the exclusive property of Richard Barry. See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Richard Barry.