-------------------------------------------------------------------------------

This is the README file of the IgH EtherCAT Master.

$Id$

Contents:
1) General Information
2) Requirements
3) Building and Installing
4) Realtime & Tuning
5) License

-------------------------------------------------------------------------------

1) General Information
======================

This is an Open-Source EtherCAT master implementation for Linux 2.6.

For more information, see

http://etherlab.org

or contact

Florian Pose <fp@igh-essen.com>
Ingenieurgemeinschaft IgH
Heinz-Baecker-Str. 34
D-45356 Essen
http://igh-essen.com

-------------------------------------------------------------------------------

2) Requirements
===============

1) Software requirements

Configured sources for the Linux 2.6 kernel are required to build the EtherCAT
master.

2) Hardware requirements

The EtherCAT master needs a RTL8139 (or compatible) network interface card to
run. Drivers for other widespread devices (i. e. Intel PRO/100) will be
implemented soon.

-------------------------------------------------------------------------------

3) Building and installing
==========================

1) Create a copy of the configuration template:

  $ cp ethercat.conf.tmpl ethercat.conf

2) Adjust the Variables in the configuration file to your needs.

3) Build the EtherCAT master and network device driver modules:

  $ make

4) Install the the EtherCAT master (as root):

  # make install

  This will create the following files and directories:
    - /etc/sysconfig/ethercat (configuration file)
    - /etc/init.d/ethercat    (startup script)
    - /usr/sbin/rcethercat    (link to startup script)

  The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net
  (where <KERNEL> is the Linux kernel version configured in ethercat.conf).

-------------------------------------------------------------------------------

4) Realtime & Tuning
====================

Realtime patches for the Linux kernel are supported, but not required. The
realtime processing has to be done by the calling module (see API
documentation). The EtherCAT master code itself is (except for the free-run
mode) completely passive.

To avoid frame timeouts, deactivating DMA access for hard drives is
recommented (hdparm -d0 <DEV>).

-------------------------------------------------------------------------------

5) License
==========

Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

This file is part of the IgH EtherCAT Master.

The IgH EtherCAT Master is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; version 2 of the License.

The IgH EtherCAT Master is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with the IgH EtherCAT Master; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

-------------------------------------------------------------------------------