author | Florian Pose <fp@igh-essen.com> |
Wed, 05 Dec 2012 14:55:32 +0100 | |
branch | stable-1.5 |
changeset 2475 | 9c18c29b8942 |
parent 2125 | af3eda069078 |
permissions | -rw-r--r-- |
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
1 |
------------------------------------------------------------------------------ |
171
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 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
9 |
------------------------------------------------------------------------------ |
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
|
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 | 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 |
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
17 |
6) Coding Style |
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
18 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
19 |
------------------------------------------------------------------------------ |
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
20 |
|
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
21 |
1) General Information |
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
22 |
====================== |
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
23 |
|
785 | 24 |
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
|
25 |
|
270 | 26 |
See the FEATURES file for a list of features. For more information, see |
785 | 27 |
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
|
28 |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
29 |
or contact |
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
30 |
|
561 | 31 |
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
|
32 |
Ingenieurgemeinschaft IgH |
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
33 |
Heinz-Baecker-Str. 34 |
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
34 |
D-45356 Essen |
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
35 |
http://igh-essen.com |
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
36 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
37 |
------------------------------------------------------------------------------ |
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
38 |
|
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
39 |
2) Requirements |
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
40 |
=============== |
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
41 |
|
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
42 |
1) Software 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 |
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
|
45 |
master. |
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
46 |
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
47 |
2) Hardware requirements |
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
48 |
|
787
efa24cde53a7
Added link to hardware table.
Florian Pose <fp@igh-essen.com>
parents:
785
diff
changeset
|
49 |
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
|
50 |
http://etherlab.org/en/ethercat/hardware.php. |
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
51 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
52 |
------------------------------------------------------------------------------ |
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
53 |
|
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
54 |
3) Building and installing |
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
55 |
========================== |
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
56 |
|
198 | 57 |
See the INSTALL file. |
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
58 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
59 |
------------------------------------------------------------------------------ |
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
60 |
|
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
61 |
4) Realtime & Tuning |
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
62 |
==================== |
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
63 |
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
64 |
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
|
65 |
realtime processing has to be done by the calling module (see API |
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
66 |
documentation). The EtherCAT master code itself is passive (except for the |
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
67 |
idle mode and EoE). |
193
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 |
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
|
70 |
recommended (hdparm -d0 <DEV>). |
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
71 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
72 |
------------------------------------------------------------------------------ |
197
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 |
5) License |
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 |
|
1331
7cd33a77f926
merge -c1609 branches/stable-1.4: INSTALL, README.
Florian Pose <fp@igh-essen.com>
parents:
1326
diff
changeset
|
77 |
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
|
78 |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
79 |
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
|
80 |
|
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
|
81 |
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
|
82 |
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
|
83 |
published by the Free Software Foundation. |
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
84 |
|
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
|
85 |
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
|
86 |
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
|
87 |
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
|
88 |
details. |
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
89 |
|
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
|
90 |
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
|
91 |
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
|
92 |
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
|
93 |
|
1355
df9be2b80b9a
Improved master licensing paragraph. Should be included in every file...
Florian Pose <fp@igh-essen.com>
parents:
1331
diff
changeset
|
94 |
--- |
df9be2b80b9a
Improved master licensing paragraph. Should be included in every file...
Florian Pose <fp@igh-essen.com>
parents:
1331
diff
changeset
|
95 |
|
1363
11c0b2caa253
Improved and added license headers.
Florian Pose <fp@igh-essen.com>
parents:
1355
diff
changeset
|
96 |
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
|
97 |
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
|
98 |
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
|
99 |
|
2125
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
100 |
------------------------------------------------------------------------------ |
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
101 |
|
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
102 |
6) Coding Style |
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
103 |
=============== |
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
104 |
|
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
105 |
Developers shall use the coding style rules in the CodingStyle.txt file. |
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
106 |
|
af3eda069078
Added coding style document.
Florian Pose <fp@igh-essen.com>
parents:
1363
diff
changeset
|
107 |
------------------------------------------------------------------------------ |