3678a69c38
alloc_tty_driver was deprecated by tty_alloc_driver in commit 7f0bc6a68ed9 (TTY: pass flags to alloc_tty_driver) in 2012 but first in kernel v5.15 it has been dropped (56ec5880a28e). Switch to tty_alloc_driver when using kernels >= v5.15 As of v5.15, the put_tty_driver alias has been dropped in favor of directly calling tty_driver_kref_put (9f90a4ddef4e). Switch to tty_driver_kref_put when using kernels >= v5.15 As from v5.14 the write_room (03b3b1a2405c) and chars_in_buffer (fff4ef17a940) methods' return type changed from int to unsigned int in struct tty_operations. This has impact on ec_tty_write_room() and ec_tty_chars_in_buffer(). |
||
|---|---|---|
| devices | ||
| documentation | ||
| doxygen-layout@fa4893ab56 | ||
| examples | ||
| include | ||
| lib | ||
| master | ||
| script | ||
| tool | ||
| tty | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .hgignore | ||
| AUTHORS | ||
| COPYING | ||
| COPYING.LESSER | ||
| CodingStyle.md | ||
| Doxyfile.in | ||
| FEATURES.md | ||
| INSTALL.md | ||
| Kbuild.in | ||
| Makefile.am | ||
| Makefile.kbuild | ||
| NEWS | ||
| README.EoE | ||
| README.md | ||
| TODO | ||
| bootstrap | ||
| configure.ac | ||
| ethercat.spec.in | ||
| globals.h | ||
README.md
This is the README file of the IgH EtherCAT Master.
vim: spelllang=en spell tw=78
Contents:
General Information
This is an open-source EtherCAT master implementation for Linux 2.6 or newer.
See the features file for a list of features. For more
information, see http://etherlab.org/en/ethercat.
or contact
Dipl.-Ing. (FH) Florian Pose fp@igh.de
Ingenieurgemeinschaft IgH
Nordsternstraße 66
D-45329 Essen
http://igh.de
Documentation
Handbook
The PDF documentation is generated via LaTeX and can be build with the
following steps:
cd documentation
make
The PDF is automatically held up-to-date and can be downloaded from
GitLab.
Doxygen
To generate the Doxygen documentation, the following commands can be used.
Therefore, the configure script must have run (see the install
file).
git submodule update --init
make doc
An up-to-date Doxygen output can be found on
docs.etherlab.org.
Requirements
Software requirements
Configured sources for the Linux 2.6 (or newer) kernel are required to build
the EtherCAT master.
Hardware requirements
A table of supported hardware can be found at
http://etherlab.org/en/ethercat/hardware.php.
Building and installing
See the install file.
Realtime and Tuning
Realtime patches for the Linux kernel are supported, but not required. The
realtime processing has to be done by the calling module (see API
documentation). The EtherCAT master code itself is passive (except for the
idle mode and EoE).
To avoid frame timeouts, deactivating DMA access for hard drives is
recommended (hdparm -d0 <DEV>).
License
Copyright (C) 2006-2023 Florian Pose, Ingenieurgemeinschaft IgH
This file is part of the IgH EtherCAT Master.
The IgH EtherCAT Master is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.
The IgH EtherCAT Master is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
the IgH EtherCAT Master; if not, write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
The license mentioned above concerns the source code only. Using the EtherCAT
technology and brand is only permitted in compliance with the industrial
property and similar rights of Beckhoff Automation GmbH.
Coding Style
Developers shall use the coding style rules in the coding style
file.