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/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

The EtherCAT master needs a RTL8139 (or compatible) network interface card to

    45

run. Drivers for other widespread devices (i. e. Intel PRO/100) will be

    46

implemented soon.

    47

    48

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

    49

    50

3) Building and installing

    51

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

    52

    53

See the INSTALL file.

    54

    55

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

    56

    57

4) Realtime & Tuning

    58

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

    59

    60

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

    61

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

    62

documentation). The EtherCAT master code itself is completely passive (except

    63

for the idle mode).

    64

    65

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

    66

recommented (hdparm -d0 <DEV>).

    67

    68

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

    69

    70

5) License

    71

==========

    72

    73

Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

    74

    75

This file is part of the IgH EtherCAT Master.

    76

    77

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

    78

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

    79

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

    80

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

    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

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

    92

charge under condition of compatibility of product made by

    93

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

    94

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

    95

software based on IgH EtherCAT master stay compatible with the actual

    96

EtherCAT specification (which are released themselves as an open

    97

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

    98

Technology, IP and trade marks.

    99

   100

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