PACKAGE: xmos_ethernet.1v3

VERSION: 1v3 (build a486d22673b8c02f15aa7ad661516317b991abde)

DESCRIPTION:

This package provides modules and sample applications that use tcp/ip
protocols over ethernet.

REQUIRED TOOLS:

Xmos Desktop Development Tools 9.9.2 or above.

INCLUDED MODULES AND APPLICATIONS:

The following modules are provided in this package, these can be
used in your applications:

   module_ethernet:
      A module providing an ethernet MAC and hardware interfacing over MII.

   module_xmos_common:
      Common build framework for applications using xmos modules.

In addition the follow example applications are provided:

   app_ethernet_demo1:
      Receive-transmit loopback test.

   app_ethernet_demo2:
      Transmit-receive loopback test.

   app_ethernet_demo3:
      ARP/ICMP demo.

INSTALLATION (XDE):

To install, open the XDE Eclipse IDE and perform the following steps:

   * Select the "Import" item from the "File" menu
   * Select "General" -> "Existing Projects into Workspace" and click "Next"
   * Click on "Browse" next to "Select archive file" and select the
     xmos_ethernet.1v3.zip file.
   * Make sure the projects you want to import are ticked in the
     "Projects:" list. Import all the components and whichever
     applications you are interested in. 
   * Click on "Finish"

To build, select the application you wish to build in the Project
Explorer window and click on build icon. To run an application: select
the .xe file in the bin/ directory of that application project, right
click and select "Run As..."

INSTALLATION (COMMAND LINE):

To install, unzip the package zip. To build an application change into
that application directory and execute the command:

   xmake all

The generated executable will be placed in the bin/ sub-directory. To
run execture the command:

   xrun bin/[binary file].xe


REQUIRED HARDWARE:

Demonstration programs run on either an XMOS XS-1 G development kit 
,an XC-2 development card or an XC-2G development card.

Code can be adapted to run on any board with an XS-1 device with an
100Mbit ethernet phy attached

DEMOS:

A demo/test program is provided. This implements a very simple
webserver (serving only one page). To use the demo, edit the
src/demo/main.xc file and alter the ipconfig variable to configure a
usable ip address for your network. 

In addition, a more complicated web server demo is provided that
implements the pre-loaded XC-2 firmware demo. The source for this demo
is located in src/xc2_firmware and it can be built by adding 
FIRMWARE=1 to the build.

INSTALLATION AND RUNNING THE DEMO (XDE):

 To build for a different target right-click on the
project and edit the list of environment variables found be following
the menus "C/XC Build"->"Environment" - add the TARGET variable and
set it to one of XDK, XC-2 or XC-2G.

To run, click on the run icon. To configure the project to run on a
particular device or in the simulator click on the drop down arrow
next to the run icon and select "Run Configurations"

INSTALLATION AND RUNNING THE DEMO (COMMAND LINE):

From an enviroment that can access the XMOS Desktop Development tools.
Unzip the zipfile and from the top level directory run:

       xmake all

will build the XC-2 simple demo. Running:

       xmake TARGET=[target] [FIRMWARE=1] all

where target is one of XDK, XC-2 or XC-2G will build for a specific
target. Adding the FIRMWARE=1 option will build the firmware demo
rather than the simple demo.

The executable can be found in the bin/[target] directory and can be
run with xrun e.g.

       xrun --io bin/XC-2/xtcp_demo.xe

NOTES

OTHER DOCUMENTATION:

  CHANGELOG            - release change log
  src/README           - simple documentation of source code