1

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

     2

     3

This is the README file of the IgH EtherCAT Master.

     4

     5

$Id$

     6

     7

Contents:

     8

1) General Information

     9

2) Requirements

    10

3) Building and installing

    11

4) Realtime & Tuning

    12

5) License

    13

    14

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

    15

    16

1) General Information

    17

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

    18

    19

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

    20

    21

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

    22

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

    23

    24

or contact

    25

    26

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

    27

Ingenieurgemeinschaft IgH

    28

Heinz-Baecker-Str. 34

    29

D-45356 Essen

    30

http://igh-essen.com

    31

    32

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

    33

    34

2) Requirements

    35

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

    36

    37

1) Software requirements

    38

    39

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

    40

master.

    41

    42

2) Hardware requirements

    43

    44

A table of supported hardware can be found at

    45

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

    46

    47

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

    48

    49

3) Building and installing

    50

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

    51

    52

See the INSTALL file.

    53

    54

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

    55

    56

4) Realtime & Tuning

    57

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

    58

    59

Realtime patches for the Linux kernel are supported, but not required. The

    60

realtime processing has to be done by the calling module (see API

    61

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

    62

mode and EoE).

    63

    64

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

    65

recommented (hdparm -d0 <DEV>).

    66

    67

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

    68

    69

5) License

    70

==========

    71

    72

Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

    73

    74

This file is part of the IgH EtherCAT Master.

    75

    76

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

    77

and/or modify it under the terms of the GNU General Public License

    78

as published by the Free Software Foundation; either version 2 of the

    79

License, or (at your option) any later version.

    80

    81

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

    82

useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    83

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    84

GNU General Public License for more details.

    85

    86

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

    87

along with the IgH EtherCAT Master; if not, write to the Free Software

    88

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

    89

    90

The right to use EtherCAT Technology is granted and comes free of

    91

charge under condition of compatibility of product made by

    92

Licensee. People intending to distribute/sell products based on the

    93

code, have to sign an agreement to guarantee that products using

    94

software based on IgH EtherCAT master stay compatible with the actual

    95

EtherCAT specification (which are released themselves as an open

    96

standard) as the (only) precondition to have the right to use EtherCAT

    97

Technology, IP and trade marks.

    98

    99

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