README
author Florian Pose <fp@igh-essen.com>
Mon, 30 Jul 2007 11:41:37 +0000
changeset 672 271d6033314f
parent 561 99557f0634b7
child 785 c7e600cd2812
permissions -rw-r--r--
Made e1000_hw.h and e1000_osdep.h kernel-dependent.
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
270
f6ba0b288657 Added FEATURES file.
Florian Pose <fp@igh-essen.com>
parents: 246
diff changeset
    21
See the FEATURES file for a list of features. For more information, see
561
99557f0634b7 Updated README file.
Florian Pose <fp@igh-essen.com>
parents: 307
diff changeset
    22
http://etherlab.org/ethercat.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    23
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
or contact
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    25
561
99557f0634b7 Updated README file.
Florian Pose <fp@igh-essen.com>
parents: 307
diff changeset
    26
Dipl.-Ing. (FH) Florian Pose <fp@igh-essen.com>
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
Ingenieurgemeinschaft IgH
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
Heinz-Baecker-Str. 34
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
D-45356 Essen
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    30
http://igh-essen.com
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    31
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
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    34
2) Requirements
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    35
===============
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    36
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    37
1) Software requirements
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    38
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    39
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
    40
master.
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    41
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    42
2) Hardware requirements
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    43
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    44
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
    45
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
    46
implemented soon.
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    47
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
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    50
3) Building and installing
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    51
==========================
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    52
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 197
diff changeset
    53
See the INSTALL file.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    54
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    55
-------------------------------------------------------------------------------
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    56
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    57
4) Realtime & Tuning
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    58
====================
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    59
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    60
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
    61
realtime processing has to be done by the calling module (see API
307
ffec9aae50a5 Removed Freerun out of FEATURES and README.
Florian Pose <fp@igh-essen.com>
parents: 270
diff changeset
    62
documentation). The EtherCAT master code itself is completely passive (except
ffec9aae50a5 Removed Freerun out of FEATURES and README.
Florian Pose <fp@igh-essen.com>
parents: 270
diff changeset
    63
for the idle mode).
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    64
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    65
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
    66
recommented (hdparm -d0 <DEV>).
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    67
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    68
-------------------------------------------------------------------------------
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    69
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    70
5) License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    71
==========
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
Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    74
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    75
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
    76
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    77
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
    78
and/or modify it under the terms of the GNU General Public License
246
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    79
as published by the Free Software Foundation; either version 2 of the
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    80
License, or (at your option) any later version.
197
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
246
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    91
The right to use EtherCAT Technology is granted and comes free of
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    92
charge under condition of compatibility of product made by
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    93
Licensee. People intending to distribute/sell products based on the
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    94
code, have to sign an agreement to guarantee that products using
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    95
software based on IgH EtherCAT master stay compatible with the actual
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    96
EtherCAT specification (which are released themselves as an open
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    97
standard) as the (only) precondition to have the right to use EtherCAT
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    98
Technology, IP and trade marks.
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    99
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
   100
-------------------------------------------------------------------------------