README
author Florian Pose <fp@igh-essen.com>
Tue, 11 Aug 2009 12:15:20 +0000
changeset 1521 2180c608e250
parent 1363 11c0b2caa253
child 2125 af3eda069078
child 2126 0383b71b88e4
permissions -rw-r--r--
Check for NULL pointer in ecdev_receive().
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
1326
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
     7
vim: spelllang=en spell tw=78
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
     8
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
     9
-------------------------------------------------------------------------------
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    10
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    11
Contents:
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    12
1) General Information
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    13
2) Requirements
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 197
diff changeset
    14
3) Building and installing
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    15
4) Realtime & Tuning
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    16
5) License
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
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    20
1) General Information
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    21
======================
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    22
785
c7e600cd2812 Updated README etc.
Florian Pose <fp@igh-essen.com>
parents: 561
diff changeset
    23
This is an open-source EtherCAT master implementation for Linux 2.6.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
270
f6ba0b288657 Added FEATURES file.
Florian Pose <fp@igh-essen.com>
parents: 246
diff changeset
    25
See the FEATURES file for a list of features. For more information, see
785
c7e600cd2812 Updated README etc.
Florian Pose <fp@igh-essen.com>
parents: 561
diff changeset
    26
http://etherlab.org/en/ethercat.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
or contact
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
561
99557f0634b7 Updated README file.
Florian Pose <fp@igh-essen.com>
parents: 307
diff changeset
    30
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
    31
Ingenieurgemeinschaft IgH
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    32
Heinz-Baecker-Str. 34
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    33
D-45356 Essen
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    34
http://igh-essen.com
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    35
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    36
-------------------------------------------------------------------------------
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    37
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    38
2) Requirements
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    39
===============
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    40
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    41
1) Software requirements
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
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
    44
master.
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    45
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    46
2) Hardware requirements
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    47
787
efa24cde53a7 Added link to hardware table.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    48
A table of supported hardware can be found at
efa24cde53a7 Added link to hardware table.
Florian Pose <fp@igh-essen.com>
parents: 785
diff changeset
    49
http://etherlab.org/en/ethercat/hardware.php.
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    50
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    51
-------------------------------------------------------------------------------
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    52
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    53
3) Building and installing
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    54
==========================
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    55
198
f7dff1ed01ba Separate INSTALL file.
Florian Pose <fp@igh-essen.com>
parents: 197
diff changeset
    56
See the INSTALL file.
171
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    57
faa7d433239c Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    58
-------------------------------------------------------------------------------
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    59
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    60
4) Realtime & Tuning
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    61
====================
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    62
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    63
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
    64
realtime processing has to be done by the calling module (see API
785
c7e600cd2812 Updated README etc.
Florian Pose <fp@igh-essen.com>
parents: 561
diff changeset
    65
documentation). The EtherCAT master code itself is passive (except for the idle
c7e600cd2812 Updated README etc.
Florian Pose <fp@igh-essen.com>
parents: 561
diff changeset
    66
mode and EoE).
193
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
To avoid frame timeouts, deactivating DMA access for hard drives is
1326
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    69
recommended (hdparm -d0 <DEV>).
193
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    70
1053a25af575 README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents: 171
diff changeset
    71
-------------------------------------------------------------------------------
197
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
5) License
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
1331
7cd33a77f926 merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents: 1326
diff changeset
    76
Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH
197
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
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
    79
1326
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    80
The IgH EtherCAT Master is free software; you can redistribute it and/or
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    81
modify it under the terms of the GNU General Public License version 2, as
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    82
published by the Free Software Foundation.
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    83
1326
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    84
The IgH EtherCAT Master is distributed in the hope that it will be useful, but
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    85
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    86
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    87
details.
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    88
1326
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    89
You should have received a copy of the GNU General Public License along with
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    90
the IgH EtherCAT Master; if not, write to the Free Software Foundation, Inc.,
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only.
Florian Pose <fp@igh-essen.com>
parents: 787
diff changeset
    91
51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    92
1355
df9be2b80b9a Improved master licensing paragraph. Should be included in every file...
Florian Pose <fp@igh-essen.com>
parents: 1331
diff changeset
    93
---
df9be2b80b9a Improved master licensing paragraph. Should be included in every file...
Florian Pose <fp@igh-essen.com>
parents: 1331
diff changeset
    94
1363
11c0b2caa253 Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents: 1355
diff changeset
    95
The license mentioned above concerns the source code only. Using the EtherCAT
11c0b2caa253 Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents: 1355
diff changeset
    96
technology and brand is only permitted in compliance with the industrial
11c0b2caa253 Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents: 1355
diff changeset
    97
property and similar rights of Beckhoff Automation GmbH.
246
0bf7c769de06 Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents: 198
diff changeset
    98
197
b9a6e2c22745 GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents: 193
diff changeset
    99
-------------------------------------------------------------------------------