IgH EtherCAT Master for Linux
Go to file
Florian Pose d48d9ebac2 Do not output CoE retries. 2010-01-26 10:17:44 +01:00
devices Removed tabulators. 2010-01-08 11:40:27 +01:00
documentation Improved installation chapter. 2010-01-13 16:39:56 +01:00
examples Fixed segfault if creation of TTY devices fails. 2010-01-25 18:31:27 +01:00
include Callback set via own structure. 2010-01-25 17:42:07 +01:00
lib Merged Komax changes. 2010-01-08 11:26:07 +01:00
m4 Added deummy Makefile.am for m4 directory. 2009-05-04 13:53:41 +00:00
master Do not output CoE retries. 2010-01-26 10:17:44 +01:00
script Added variable vor master module arguments. 2010-01-26 10:15:59 +01:00
tool Allow BITx types in XML output. 2009-11-17 11:05:20 +01:00
tty Pass initial cflag to device-specific implementation in constructor. 2010-01-25 18:32:45 +01:00
.hgignore Ignore documentation files. 2010-01-05 12:36:29 +01:00
AUTHORS Updated AUTHORS file. 2007-02-13 13:00:19 +00:00
COPYING Removed --foreign switch for autotools. 2006-11-06 09:43:36 +00:00
COPYING.LESSER Added LGPL licence headers to userspace library. 2008-10-14 14:01:09 +00:00
Doxyfile.in Maintained code docs. 2008-10-15 10:01:54 +00:00
FEATURES Updated FEATURES. 2010-01-05 12:36:07 +01:00
INSTALL merge -c1609 branches/stable-1.4: INSTALL, README. 2009-01-26 11:51:53 +00:00
Kbuild.in Base files for new TTY driver. 2009-11-30 18:02:29 +01:00
Makefile.am Install ec_tty module. 2009-11-30 18:10:36 +01:00
NEWS Added e100 driver for 2.6.27. 2009-09-30 21:14:40 +02:00
README Improved and added license headers. 2009-02-24 12:51:39 +00:00
README.EoE merge -c1609 branches/stable-1.4: INSTALL, README. 2009-01-26 11:51:53 +00:00
TODO TODO for 1.5.0. 2010-01-13 08:48:37 +01:00
bootstrap Do not create m4 directory in bootstrap file. 2009-05-07 08:12:13 +00:00
configure.ac Disable use of hrtimer for scheduling by default. Does not work on some PPC targets. 2010-01-19 15:15:57 +01:00
globals.h Switched from Subversion to Mercurial. 2009-08-13 15:18:53 +02:00

README

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

This is the README file of the IgH EtherCAT Master.

$Id$

vim: spelllang=en spell tw=78

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

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.

See the FEATURES file for a list of features. For more information, see
http://etherlab.org/en/ethercat.

or contact

Dipl.-Ing. (FH) 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

A table of supported hardware can be found at
http://etherlab.org/en/ethercat/hardware.php.

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

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

See the INSTALL file.

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

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 passive (except for the idle
mode and EoE).

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

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

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

Copyright (C) 2006-2009  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 version 2, as
published by the Free Software Foundation.

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

---

The license mentioned above concerns the source code only. Using the EtherCAT
technology and brand is only permitted in compliance with the industrial
property and similar rights of Beckhoff Automation GmbH.

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