examples/rtai/README
author Patrick Bruenn <p.bruenn@beckhoff.com>
Thu, 05 Nov 2015 16:54:49 +0100
branchstable-1.5
changeset 2638 5995331a55fe
parent 1080 088a61306930
permissions -rw-r--r--
update ccat driver to v0.14
- fix ccat startup stall and 64 bit address usage
- limit rx processing to one frame per poll
- print registered gpio base to kernel log
- fix constness for *_driver objects
- refactor dma fifo initialization
- refactor rx/tx fifo code and structures
1080
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     1
-------------------------------------------------------------------------------
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     2
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     3
$Id$
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     4
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     5
-------------------------------------------------------------------------------
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     6
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     7
This is a minimal example module for the use of the EtherCAT master realtime
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     8
interface with an RTAI thread.
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     9
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    10
The module expects an RTAI installation. Configure the master sources
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    11
specifying --with-rtai-dir to have the right include paths.
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    12
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    13
Most probably you'll have different EtherCAT slaves present. Try adjusting the
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    14
section "process data" in rtai_sample.c to your bus configuration.
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    15
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    16
There are some features that can be disabled by commenting out the respective
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    17
defines at the head of rtai_sample.c.
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    18
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    19
---
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    20
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    21
To build the example module, call:
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    22
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    23
make modules
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    25
To run it, load the appropriate RTAI modules and call:
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    26
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
insmod ec_rtai_sample.ko
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
...and watch the system logs for the outputs.
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    30
088a61306930 Removed MSR example; adapted RTAI example; README files for examples.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    31
-------------------------------------------------------------------------------