| author | Florian Pose <fp@igh-essen.com> |
| Fri, 21 Apr 2006 12:35:17 +0000 | |
| changeset 197 | b9a6e2c22745 |
| parent 193 | 1053a25af575 |
| child 198 | f7dff1ed01ba |
| 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 |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
10 |
3) Building and Installing |
|
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 |
|
|
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
54 |
1) Create a copy of the configuration template: |
|
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 |
$ cp ethercat.conf.tmpl ethercat.conf |
|
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 |
2) Adjust the Variables in the configuration file to your needs. |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
59 |
|
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
60 |
3) Build the EtherCAT master and network device driver modules: |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
61 |
|
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
62 |
$ make |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
63 |
|
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
64 |
4) Install the the EtherCAT master (as root): |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
65 |
|
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
66 |
# make install |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
67 |
|
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
68 |
This will create the following files and directories: |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
69 |
- /etc/sysconfig/ethercat (configuration file) |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
70 |
- /etc/init.d/ethercat (startup script) |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
71 |
- /usr/sbin/rcethercat (link to startup script) |
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
72 |
|
|
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
73 |
The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net |
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
74 |
(where <KERNEL> is the Linux kernel version configured in ethercat.conf). |
|
171
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
75 |
|
|
faa7d433239c
Added README file and altered outputs of install.sh
Florian Pose <fp@igh-essen.com>
parents:
diff
changeset
|
76 |
------------------------------------------------------------------------------- |
|
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
77 |
|
|
197
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
78 |
4) Realtime & Tuning |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
79 |
==================== |
|
193
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
80 |
|
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
81 |
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
|
82 |
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
|
83 |
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
|
84 |
mode) completely passive. |
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
85 |
|
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
86 |
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
|
87 |
recommented (hdparm -d0 <DEV>). |
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
88 |
|
|
1053a25af575
README: Requirements and realtime.
Florian Pose <fp@igh-essen.com>
parents:
171
diff
changeset
|
89 |
------------------------------------------------------------------------------- |
|
197
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 |
5) License |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
92 |
========== |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
93 |
|
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
94 |
Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
95 |
|
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
96 |
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
|
97 |
|
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
98 |
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
|
99 |
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
|
100 |
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
|
101 |
|
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
102 |
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
|
103 |
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
|
104 |
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
|
105 |
GNU General Public License for more details. |
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
106 |
|
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
107 |
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
|
108 |
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
|
109 |
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
|
110 |
|
|
b9a6e2c22745
GPLv2 License and enhanced Doxygen output.
Florian Pose <fp@igh-essen.com>
parents:
193
diff
changeset
|
111 |
------------------------------------------------------------------------------- |