1 ------------------------------------------------------------------------------- |
1 ------------------------------------------------------------------------------ |
2 |
2 |
3 This is the README file of the IgH EtherCAT Master. |
3 This is the README file of the IgH EtherCAT Master. |
4 |
4 |
5 $Id$ |
5 $Id$ |
6 |
6 |
7 vim: spelllang=en spell tw=78 |
7 vim: spelllang=en spell tw=78 |
8 |
8 |
9 ------------------------------------------------------------------------------- |
9 ------------------------------------------------------------------------------ |
10 |
10 |
11 Contents: |
11 Contents: |
12 1) General Information |
12 1) General Information |
13 2) Requirements |
13 2) Requirements |
14 3) Building and installing |
14 3) Building and installing |
15 4) Realtime & Tuning |
15 4) Realtime & Tuning |
16 5) License |
16 5) License |
|
17 6) Coding Style |
17 |
18 |
18 ------------------------------------------------------------------------------- |
19 ------------------------------------------------------------------------------ |
19 |
20 |
20 1) General Information |
21 1) General Information |
21 ====================== |
22 ====================== |
22 |
23 |
23 This is an open-source EtherCAT master implementation for Linux 2.6. |
24 This is an open-source EtherCAT master implementation for Linux 2.6. |
46 2) Hardware requirements |
47 2) Hardware requirements |
47 |
48 |
48 A table of supported hardware can be found at |
49 A table of supported hardware can be found at |
49 http://etherlab.org/en/ethercat/hardware.php. |
50 http://etherlab.org/en/ethercat/hardware.php. |
50 |
51 |
51 ------------------------------------------------------------------------------- |
52 ------------------------------------------------------------------------------ |
52 |
53 |
53 3) Building and installing |
54 3) Building and installing |
54 ========================== |
55 ========================== |
55 |
56 |
56 See the INSTALL file. |
57 See the INSTALL file. |
57 |
58 |
58 ------------------------------------------------------------------------------- |
59 ------------------------------------------------------------------------------ |
59 |
60 |
60 4) Realtime & Tuning |
61 4) Realtime & Tuning |
61 ==================== |
62 ==================== |
62 |
63 |
63 Realtime patches for the Linux kernel are supported, but not required. The |
64 Realtime patches for the Linux kernel are supported, but not required. The |
64 realtime processing has to be done by the calling module (see API |
65 realtime processing has to be done by the calling module (see API |
65 documentation). The EtherCAT master code itself is passive (except for the idle |
66 documentation). The EtherCAT master code itself is passive (except for the |
66 mode and EoE). |
67 idle mode and EoE). |
67 |
68 |
68 To avoid frame timeouts, deactivating DMA access for hard drives is |
69 To avoid frame timeouts, deactivating DMA access for hard drives is |
69 recommended (hdparm -d0 <DEV>). |
70 recommended (hdparm -d0 <DEV>). |
70 |
71 |
71 ------------------------------------------------------------------------------- |
72 ------------------------------------------------------------------------------ |
72 |
73 |
73 5) License |
74 5) License |
74 ========== |
75 ========== |
75 |
76 |
76 Copyright (C) 2006-2009 Florian Pose, Ingenieurgemeinschaft IgH |
77 Copyright (C) 2006-2009 Florian Pose, Ingenieurgemeinschaft IgH |
94 |
95 |
95 The license mentioned above concerns the source code only. Using the EtherCAT |
96 The license mentioned above concerns the source code only. Using the EtherCAT |
96 technology and brand is only permitted in compliance with the industrial |
97 technology and brand is only permitted in compliance with the industrial |
97 property and similar rights of Beckhoff Automation GmbH. |
98 property and similar rights of Beckhoff Automation GmbH. |
98 |
99 |
99 ------------------------------------------------------------------------------- |
100 ------------------------------------------------------------------------------ |
|
101 |
|
102 6) Coding Style |
|
103 =============== |
|
104 |
|
105 Developers shall use the coding style rules in the CodingStyle.txt file. |
|
106 |
|
107 ------------------------------------------------------------------------------ |