author | Florian Pose <fp@igh-essen.com> |
Wed, 19 Jul 2006 15:28:34 +0000 | |
changeset 308 | d50b139c8601 |
parent 307 | ffec9aae50a5 |
child 561 | 99557f0634b7 |
permissions | -rw-r--r-- |
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 | 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 | 21 |
See the FEATURES file for a list of features. For more information, see |
171
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 | 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 |
307
ffec9aae50a5
Removed Freerun out of FEATURES and README.
Florian Pose <fp@igh-essen.com>
parents:
270
diff
changeset
|
63 |
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
|
64 |
for the idle mode). |
193
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 |
246
0bf7c769de06
Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents:
198
diff
changeset
|
80 |
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
|
81 |
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
|
82 |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
83 |
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
|
84 |
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
|
85 |
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
|
86 |
GNU General Public License for more details. |
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
87 |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
88 |
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
|
89 |
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
|
90 |
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
|
91 |
|
246
0bf7c769de06
Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents:
198
diff
changeset
|
92 |
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
|
93 |
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
|
94 |
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
|
95 |
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
|
96 |
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
|
97 |
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
|
98 |
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
|
99 |
Technology, IP and trade marks. |
0bf7c769de06
Changed license headers and added EtherCAT license notice.
Florian Pose <fp@igh-essen.com>
parents:
198
diff
changeset
|
100 |
|
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
101 |
------------------------------------------------------------------------------- |