1

-------------------------------------------------------------------------------

     2

     3

This is the README file of the IgH EtherCAT Master.

     4

     5

$Id$

     6

     7

vim: spelllang=en spell tw=78

     8

     9

-------------------------------------------------------------------------------

    10

    11

Contents:

    12

1) General Information

    13

2) Requirements

    14

3) Building and installing

    15

4) Realtime & Tuning

    16

5) License

    17

    18

-------------------------------------------------------------------------------

    19

    20

1) General Information

    21

======================

    22

    23

This is an open-source EtherCAT master implementation for Linux 2.6.

    24

    25

See the FEATURES file for a list of features. For more information, see

    26

http://etherlab.org/en/ethercat.

    27

    28

or contact

    29

    30

Dipl.-Ing. (FH) Florian Pose <fp@igh-essen.com>

    31

Ingenieurgemeinschaft IgH

    32

Heinz-Baecker-Str. 34

    33

D-45356 Essen

    34

http://igh-essen.com

    35

    36

-------------------------------------------------------------------------------

    37

    38

2) Requirements

    39

===============

    40

    41

1) Software requirements

    42

    43

Configured sources for the Linux 2.6 kernel are required to build the EtherCAT

    44

master.

    45

    46

2) Hardware requirements

    47

    48

A table of supported hardware can be found at

    49

http://etherlab.org/en/ethercat/hardware.php.

    50

    51

-------------------------------------------------------------------------------

    52

    53

3) Building and installing

    54

==========================

    55

    56

See the INSTALL file.

    57

    58

-------------------------------------------------------------------------------

    59

    60

4) Realtime & Tuning

    61

====================

    62

    63

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

documentation). The EtherCAT master code itself is passive (except for the idle

    66

mode and EoE).

    67

    68

To avoid frame timeouts, deactivating DMA access for hard drives is

    69

recommended (hdparm -d0 <DEV>).

    70

    71

-------------------------------------------------------------------------------

    72

    73

5) License

    74

==========

    75

    76

Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH

    77

    78

This file is part of the IgH EtherCAT Master.

    79

    80

The IgH EtherCAT Master is free software; you can redistribute it and/or

    81

modify it under the terms of the GNU General Public License version 2, as

    82

published by the Free Software Foundation.

    83

    84

The IgH EtherCAT Master is distributed in the hope that it will be useful, but

    85

WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    86

FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more

    87

details.

    88

    89

You should have received a copy of the GNU General Public License along with

    90

the IgH EtherCAT Master; if not, write to the Free Software Foundation, Inc.,

    91

51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    92

    93

---

    94

    95

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

property and similar rights of Beckhoff Automation GmbH.

    98

    99

-------------------------------------------------------------------------------