fp@171: -------------------------------------------------------------------------------
fp@171: 
fp@197: This is the README file of the IgH EtherCAT Master.
fp@197: 
fp@171: $Id$
fp@171: 
fp@197: Contents:
fp@197: 1) General Information
fp@197: 2) Requirements
fp@197: 3) Building and Installing
fp@197: 4) Realtime & Tuning
fp@197: 5) License
fp@197: 
fp@171: -------------------------------------------------------------------------------
fp@171: 
fp@197: 1) General Information
fp@197: ======================
fp@171: 
fp@171: This is an Open-Source EtherCAT master implementation for Linux 2.6.
fp@171: 
fp@171: For more information, see
fp@171: 
fp@171: http://etherlab.org
fp@171: 
fp@171: or contact
fp@171: 
fp@171: Florian Pose <fp@igh-essen.com>
fp@171: Ingenieurgemeinschaft IgH
fp@171: Heinz-Baecker-Str. 34
fp@171: D-45356 Essen
fp@171: http://igh-essen.com
fp@171: 
fp@171: -------------------------------------------------------------------------------
fp@171: 
fp@197: 2) Requirements
fp@197: ===============
fp@171: 
fp@193: 1) Software requirements
fp@193: 
fp@193: Configured sources for the Linux 2.6 kernel are required to build the EtherCAT
fp@193: master.
fp@193: 
fp@193: 2) Hardware requirements
fp@193: 
fp@193: The EtherCAT master needs a RTL8139 (or compatible) network interface card to
fp@193: run. Drivers for other widespread devices (i. e. Intel PRO/100) will be
fp@193: implemented soon.
fp@193: 
fp@193: -------------------------------------------------------------------------------
fp@193: 
fp@197: 3) Building and installing
fp@197: ==========================
fp@193: 
fp@171: 1) Create a copy of the configuration template:
fp@171: 
fp@171:   $ cp ethercat.conf.tmpl ethercat.conf
fp@171: 
fp@171: 2) Adjust the Variables in the configuration file to your needs.
fp@171: 
fp@171: 3) Build the EtherCAT master and network device driver modules:
fp@171: 
fp@171:   $ make
fp@171: 
fp@171: 4) Install the the EtherCAT master (as root):
fp@171: 
fp@171:   # make install
fp@171: 
fp@171:   This will create the following files and directories:
fp@171:     - /etc/sysconfig/ethercat (configuration file)
fp@171:     - /etc/init.d/ethercat    (startup script)
fp@171:     - /usr/sbin/rcethercat    (link to startup script)
fp@171: 
fp@193:   The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net
fp@193:   (where <KERNEL> is the Linux kernel version configured in ethercat.conf).
fp@171: 
fp@171: -------------------------------------------------------------------------------
fp@193: 
fp@197: 4) Realtime & Tuning
fp@197: ====================
fp@193: 
fp@193: Realtime patches for the Linux kernel are supported, but not required. The
fp@193: realtime processing has to be done by the calling module (see API
fp@193: documentation). The EtherCAT master code itself is (except for the free-run
fp@193: mode) completely passive.
fp@193: 
fp@193: To avoid frame timeouts, deactivating DMA access for hard drives is
fp@193: recommented (hdparm -d0 <DEV>).
fp@193: 
fp@193: -------------------------------------------------------------------------------
fp@197: 
fp@197: 5) License
fp@197: ==========
fp@197: 
fp@197: Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
fp@197: 
fp@197: This file is part of the IgH EtherCAT Master.
fp@197: 
fp@197: The IgH EtherCAT Master is free software; you can redistribute it
fp@197: and/or modify it under the terms of the GNU General Public License
fp@197: as published by the Free Software Foundation; version 2 of the License.
fp@197: 
fp@197: The IgH EtherCAT Master is distributed in the hope that it will be
fp@197: useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
fp@197: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fp@197: GNU General Public License for more details.
fp@197: 
fp@197: You should have received a copy of the GNU General Public License
fp@197: along with the IgH EtherCAT Master; if not, write to the Free Software
fp@197: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
fp@197: 
fp@197: -------------------------------------------------------------------------------