1 ------------------------------------------------------------------------------- |
1 ------------------------------------------------------------------------------- |
|
2 |
|
3 This is the README file of the IgH EtherCAT Master. |
2 |
4 |
3 $Id$ |
5 $Id$ |
4 |
6 |
|
7 Contents: |
|
8 1) General Information |
|
9 2) Requirements |
|
10 3) Building and installing |
|
11 4) Realtime & Tuning |
|
12 5) License |
|
13 |
5 ------------------------------------------------------------------------------- |
14 ------------------------------------------------------------------------------- |
6 |
15 |
7 General Information |
16 1) General Information |
8 =================== |
17 ====================== |
9 |
18 |
10 This is an Open-Source EtherCAT master implementation for Linux 2.6. |
19 This is an Open-Source EtherCAT master implementation for Linux 2.6. |
11 |
20 |
12 For more information, see |
21 For more information, see |
13 |
22 |
37 run. Drivers for other widespread devices (i. e. Intel PRO/100) will be |
46 run. Drivers for other widespread devices (i. e. Intel PRO/100) will be |
38 implemented soon. |
47 implemented soon. |
39 |
48 |
40 ------------------------------------------------------------------------------- |
49 ------------------------------------------------------------------------------- |
41 |
50 |
42 Building and installing |
51 3) Building and installing |
43 ======================= |
52 ========================== |
44 |
53 |
45 1) Create a copy of the configuration template: |
54 See the INSTALL file. |
46 |
|
47 $ cp ethercat.conf.tmpl ethercat.conf |
|
48 |
|
49 2) Adjust the Variables in the configuration file to your needs. |
|
50 |
|
51 3) Build the EtherCAT master and network device driver modules: |
|
52 |
|
53 $ make |
|
54 |
|
55 4) Install the the EtherCAT master (as root): |
|
56 |
|
57 # make install |
|
58 |
|
59 This will create the following files and directories: |
|
60 - /etc/sysconfig/ethercat (configuration file) |
|
61 - /etc/init.d/ethercat (startup script) |
|
62 - /usr/sbin/rcethercat (link to startup script) |
|
63 |
|
64 The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net |
|
65 (where <KERNEL> is the Linux kernel version configured in ethercat.conf). |
|
66 |
55 |
67 ------------------------------------------------------------------------------- |
56 ------------------------------------------------------------------------------- |
68 |
57 |
69 Realtime & Tuning |
58 4) Realtime & Tuning |
70 ================= |
59 ==================== |
71 |
60 |
72 Realtime patches for the Linux kernel are supported, but not required. The |
61 Realtime patches for the Linux kernel are supported, but not required. The |
73 realtime processing has to be done by the calling module (see API |
62 realtime processing has to be done by the calling module (see API |
74 documentation). The EtherCAT master code itself is (except for the free-run |
63 documentation). The EtherCAT master code itself is (except for the free-run |
75 mode) completely passive. |
64 mode) completely passive. |
76 |
65 |
77 To avoid frame timeouts, deactivating DMA access for hard drives is |
66 To avoid frame timeouts, deactivating DMA access for hard drives is |
78 recommented (hdparm -d0 <DEV>). |
67 recommented (hdparm -d0 <DEV>). |
79 |
68 |
80 ------------------------------------------------------------------------------- |
69 ------------------------------------------------------------------------------- |
|
70 |
|
71 5) License |
|
72 ========== |
|
73 |
|
74 Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH |
|
75 |
|
76 This file is part of the IgH EtherCAT Master. |
|
77 |
|
78 The IgH EtherCAT Master is free software; you can redistribute it |
|
79 and/or modify it under the terms of the GNU General Public License |
|
80 as published by the Free Software Foundation; version 2 of the License. |
|
81 |
|
82 The IgH EtherCAT Master is distributed in the hope that it will be |
|
83 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
84 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
85 GNU General Public License for more details. |
|
86 |
|
87 You should have received a copy of the GNU General Public License |
|
88 along with the IgH EtherCAT Master; if not, write to the Free Software |
|
89 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|
90 |
|
91 ------------------------------------------------------------------------------- |