fp@171: -------------------------------------------------------------------------------
fp@171: 
fp@1618: This is the README file of the IgH EtherCAT Master.
fp@1618: 
fp@171: $Id$
fp@171: 
fp@1618: Contents:
fp@1618: 1) General Information
fp@1618: 2) Requirements
fp@1618: 3) Building and installing
fp@1618: 4) Realtime & Tuning
fp@1618: 5) License
fp@1618: 
fp@171: -------------------------------------------------------------------------------
fp@171: 
fp@1618: 1) General Information
fp@1618: ======================
fp@171: 
fp@171: This is an Open-Source EtherCAT master implementation for Linux 2.6.
fp@171: 
fp@1621: See the FEATURES file for a list of features. 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@1618: 2) Requirements
fp@1618: ===============
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@1618: 3) Building and installing
fp@1618: ==========================
fp@193: 
fp@1618: See the INSTALL file.
fp@171: 
fp@171: -------------------------------------------------------------------------------
fp@193: 
fp@1618: 4) Realtime & Tuning
fp@1618: ====================
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@1624: documentation). The EtherCAT master code itself is completely passive (except
fp@1624: for the idle mode).
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@1618: 
fp@1618: 5) License
fp@1618: ==========
fp@1618: 
fp@1618: Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
fp@1618: 
fp@1618: This file is part of the IgH EtherCAT Master.
fp@1618: 
fp@1618: The IgH EtherCAT Master is free software; you can redistribute it
fp@1618: and/or modify it under the terms of the GNU General Public License
fp@1619: as published by the Free Software Foundation; either version 2 of the
fp@1619: License, or (at your option) any later version.
fp@1618: 
fp@1618: The IgH EtherCAT Master is distributed in the hope that it will be
fp@1618: useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
fp@1618: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fp@1618: GNU General Public License for more details.
fp@1618: 
fp@1618: You should have received a copy of the GNU General Public License
fp@1618: along with the IgH EtherCAT Master; if not, write to the Free Software
fp@1618: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
fp@1618: 
fp@1619: The right to use EtherCAT Technology is granted and comes free of
fp@1619: charge under condition of compatibility of product made by
fp@1619: Licensee. People intending to distribute/sell products based on the
fp@1619: code, have to sign an agreement to guarantee that products using
fp@1619: software based on IgH EtherCAT master stay compatible with the actual
fp@1619: EtherCAT specification (which are released themselves as an open
fp@1619: standard) as the (only) precondition to have the right to use EtherCAT
fp@1619: Technology, IP and trade marks.
fp@1619: 
fp@1618: -------------------------------------------------------------------------------