README
author Florian Pose <fp@igh-essen.com>
Tue, 25 Apr 2006 12:15:54 +0000
changeset 205 7fa6de7e3823
parent 198 f7dff1ed01ba
child 246 0bf7c769de06
permissions -rw-r--r--
documentation update.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     1
-------------------------------------------------------------------------------
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     2
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
     3
This is the README file of the IgH EtherCAT Master.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
     4
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     5
$Id$
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     6
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
     7
Contents:
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
     8
1) General Information
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
     9
2) Requirements
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 197
diff changeset
    10
3) Building and installing
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    11
4) Realtime & Tuning
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    12
5) License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    13
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    14
-------------------------------------------------------------------------------
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    15
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    16
1) General Information
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    17
======================
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    18
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    19
This is an Open-Source EtherCAT master implementation for Linux 2.6.
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    20
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    21
For more information, see
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    22
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    23
http://etherlab.org
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    25
or contact
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    26
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
Florian Pose <fp@igh-essen.com>
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
Ingenieurgemeinschaft IgH
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
Heinz-Baecker-Str. 34
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    30
D-45356 Essen
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    31
http://igh-essen.com
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    32
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    33
-------------------------------------------------------------------------------
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    34
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    35
2) Requirements
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    36
===============
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    37
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    38
1) Software requirements
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    39
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    40
Configured sources for the Linux 2.6 kernel are required to build the EtherCAT
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    41
master.
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    42
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    43
2) Hardware requirements
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    44
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    45
The EtherCAT master needs a RTL8139 (or compatible) network interface card to
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    46
run. Drivers for other widespread devices (i. e. Intel PRO/100) will be
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    47
implemented soon.
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    48
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    49
-------------------------------------------------------------------------------
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    50
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    51
3) Building and installing
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    52
==========================
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    53
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 197
diff changeset
    54
See the INSTALL file.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    55
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    56
-------------------------------------------------------------------------------
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    57
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    58
4) Realtime & Tuning
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    59
====================
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    60
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    61
Realtime patches for the Linux kernel are supported, but not required. The
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    62
realtime processing has to be done by the calling module (see API
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    63
documentation). The EtherCAT master code itself is (except for the free-run
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    64
mode) completely passive.
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    65
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    66
To avoid frame timeouts, deactivating DMA access for hard drives is
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    67
recommented (hdparm -d0 <DEV>).
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    68
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    69
-------------------------------------------------------------------------------
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    70
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    71
5) License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    72
==========
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    73
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    74
Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    75
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    76
This file is part of the IgH EtherCAT Master.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    77
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    78
The IgH EtherCAT Master is free software; you can redistribute it
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    79
and/or modify it under the terms of the GNU General Public License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    80
as published by the Free Software Foundation; version 2 of the License.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    81
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    82
The IgH EtherCAT Master is distributed in the hope that it will be
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    83
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    84
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    85
GNU General Public License for more details.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    86
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    87
You should have received a copy of the GNU General Public License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    88
along with the IgH EtherCAT Master; if not, write to the Free Software
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    89
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    90
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    91
-------------------------------------------------------------------------------