fp@2293: ------------------------------------------------------------------------------
fp@171: 
fp@197: This is the README file of the IgH EtherCAT Master.
fp@197: 
fp@171: $Id$
fp@171: 
fp@1326: vim: spelllang=en spell tw=78
fp@1326: 
fp@2293: ------------------------------------------------------------------------------
fp@1326: 
fp@197: Contents:
fp@197: 1) General Information
fp@197: 2) Requirements
fp@198: 3) Building and installing
fp@197: 4) Realtime & Tuning
fp@197: 5) License
fp@2293: 6) Coding Style
fp@197: 
fp@2293: ------------------------------------------------------------------------------
fp@171: 
fp@197: 1) General Information
fp@197: ======================
fp@171: 
fp@785: This is an open-source EtherCAT master implementation for Linux 2.6.
fp@171: 
fp@270: See the FEATURES file for a list of features. For more information, see
fp@785: http://etherlab.org/en/ethercat.
fp@171: 
fp@171: or contact
fp@171: 
fp@561: Dipl.-Ing. (FH) 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@2293: ------------------------------------------------------------------------------
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@787: A table of supported hardware can be found at
fp@787: http://etherlab.org/en/ethercat/hardware.php.
fp@193: 
fp@2293: ------------------------------------------------------------------------------
fp@193: 
fp@197: 3) Building and installing
fp@197: ==========================
fp@193: 
fp@198: See the INSTALL file.
fp@171: 
fp@2293: ------------------------------------------------------------------------------
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@2293: documentation). The EtherCAT master code itself is passive (except for the
fp@2293: idle mode and EoE).
fp@193: 
fp@193: To avoid frame timeouts, deactivating DMA access for hard drives is
fp@1326: recommended (hdparm -d0 <DEV>).
fp@193: 
fp@2293: ------------------------------------------------------------------------------
fp@197: 
fp@197: 5) License
fp@197: ==========
fp@197: 
fp@1331: Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH
fp@197: 
fp@197: This file is part of the IgH EtherCAT Master.
fp@197: 
fp@1326: The IgH EtherCAT Master is free software; you can redistribute it and/or
fp@1326: modify it under the terms of the GNU General Public License version 2, as
fp@1326: published by the Free Software Foundation.
fp@197: 
fp@1326: The IgH EtherCAT Master is distributed in the hope that it will be useful, but
fp@1326: WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fp@1326: FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
fp@1326: details.
fp@197: 
fp@1326: You should have received a copy of the GNU General Public License along with
fp@1326: the IgH EtherCAT Master; if not, write to the Free Software Foundation, Inc.,
fp@1326: 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
fp@197: 
fp@1355: ---
fp@1355: 
fp@1363: The license mentioned above concerns the source code only. Using the EtherCAT
fp@1363: technology and brand is only permitted in compliance with the industrial
fp@1363: property and similar rights of Beckhoff Automation GmbH.
fp@246: 
fp@2293: ------------------------------------------------------------------------------
fp@2293: 
fp@2293: 6) Coding Style
fp@2293: ===============
fp@2293: 
fp@2293: Developers shall use the coding style rules in the CodingStyle.txt file.
fp@2293: 
fp@2293: ------------------------------------------------------------------------------