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 1) Create a copy of the configuration template: |
46 |
55 |
47 $ cp ethercat.conf.tmpl ethercat.conf |
56 $ cp ethercat.conf.tmpl ethercat.conf |
48 |
57 |
64 The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net |
73 The modules will be placed in /lib/modules/<KERNEL>/kernel/drivers/net |
65 (where <KERNEL> is the Linux kernel version configured in ethercat.conf). |
74 (where <KERNEL> is the Linux kernel version configured in ethercat.conf). |
66 |
75 |
67 ------------------------------------------------------------------------------- |
76 ------------------------------------------------------------------------------- |
68 |
77 |
69 Realtime & Tuning |
78 4) Realtime & Tuning |
70 ================= |
79 ==================== |
71 |
80 |
72 Realtime patches for the Linux kernel are supported, but not required. The |
81 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 |
82 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 |
83 documentation). The EtherCAT master code itself is (except for the free-run |
75 mode) completely passive. |
84 mode) completely passive. |
76 |
85 |
77 To avoid frame timeouts, deactivating DMA access for hard drives is |
86 To avoid frame timeouts, deactivating DMA access for hard drives is |
78 recommented (hdparm -d0 <DEV>). |
87 recommented (hdparm -d0 <DEV>). |
79 |
88 |
80 ------------------------------------------------------------------------------- |
89 ------------------------------------------------------------------------------- |
|
90 |
|
91 5) License |
|
92 ========== |
|
93 |
|
94 Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH |
|
95 |
|
96 This file is part of the IgH EtherCAT Master. |
|
97 |
|
98 The IgH EtherCAT Master is free software; you can redistribute it |
|
99 and/or modify it under the terms of the GNU General Public License |
|
100 as published by the Free Software Foundation; version 2 of the License. |
|
101 |
|
102 The IgH EtherCAT Master is distributed in the hope that it will be |
|
103 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
104 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
105 GNU General Public License for more details. |
|
106 |
|
107 You should have received a copy of the GNU General Public License |
|
108 along with the IgH EtherCAT Master; if not, write to the Free Software |
|
109 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|
110 |
|
111 ------------------------------------------------------------------------------- |