| author | Florian Pose <fp@igh-essen.com> |
| Mon, 20 Apr 2009 11:53:17 +0000 | |
| changeset 1406 | 8686c5b3d14b |
| parent 1399 | f79d4bb5b23a |
| child 1423 | 41e3baa2da23 |
| permissions | -rw-r--r-- |
| 369 | 1 |
%------------------------------------------------------------------------------ |
2 |
% |
|
3 |
% IgH EtherCAT Master Documentation |
|
4 |
% |
|
5 |
% $Id$ |
|
6 |
% |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
7 |
% vi: spell spelllang=en tw=78 |
| 1095 | 8 |
% |
| 369 | 9 |
%------------------------------------------------------------------------------ |
10 |
||
11 |
\documentclass[a4paper,12pt,BCOR6mm,bibtotoc,idxtotoc]{scrbook}
|
|
12 |
||
13 |
\usepackage[latin1]{inputenc}
|
|
14 |
\usepackage[automark,headsepline]{scrpage2}
|
|
15 |
\usepackage{graphicx}
|
|
16 |
\usepackage{makeidx}
|
|
17 |
\usepackage[refpage]{nomencl}
|
|
18 |
\usepackage{listings}
|
|
19 |
\usepackage{svn}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
20 |
\usepackage{SIunits}
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
21 |
\usepackage{hyperref}
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
22 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
23 |
\hypersetup{pdfpagelabels,plainpages=false}
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
24 |
\hypersetup{linkcolor=blue,colorlinks=true,urlcolor=blue}
|
| 369 | 25 |
|
26 |
\setlength{\parskip}{0.8ex plus 0.8ex minus 0.5ex}
|
|
27 |
\setlength{\parindent}{0mm}
|
|
28 |
||
29 |
\setcounter{secnumdepth}{\subsubsectionlevel}
|
|
30 |
||
31 |
\DeclareFontShape{OT1}{cmtt}{bx}{n}
|
|
32 |
{
|
|
33 |
<5><6><7><8><9><10><10.95><12><14.4><17.28><20.74><24.88>cmttb10 |
|
34 |
}{}
|
|
35 |
||
36 |
\lstset{basicstyle=\ttfamily\small,numberstyle=\tiny,aboveskip=4mm,
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
37 |
belowskip=2mm,escapechar=`} |
| 369 | 38 |
\renewcommand\lstlistlistingname{List of Listings}
|
39 |
||
|
917
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
40 |
% Workaround for lstlistoflistings bug |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
41 |
\makeatletter% --> De-TeX-FAQ |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
42 |
\renewcommand*{\lstlistoflistings}{%
|
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
43 |
\begingroup |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
44 |
\if@twocolumn |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
45 |
\@restonecoltrue\onecolumn |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
46 |
\else |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
47 |
\@restonecolfalse |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
48 |
\fi |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
49 |
\lol@heading |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
50 |
\setlength{\parskip}{\z@}%
|
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
51 |
\setlength{\parindent}{\z@}%
|
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
52 |
\setlength{\parfillskip}{\z@ \@plus 1fil}%
|
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
53 |
\@starttoc{lol}%
|
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
54 |
\if@restonecol\twocolumn\fi |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
55 |
\endgroup |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
56 |
} |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
57 |
\makeatother% --> \makeatletter |
|
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
58 |
|
| 369 | 59 |
\renewcommand\nomname{Glossary}
|
60 |
||
61 |
\newcommand{\IgH}{\raisebox{-0.7667ex}
|
|
62 |
{\includegraphics[height=2.2ex]{images/ighsign}}}
|
|
63 |
||
64 |
\SVN $Date$ |
|
65 |
\SVN $Revision$ |
|
66 |
||
|
1270
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
67 |
\newcommand{\masterversion}{1.5.0}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
68 |
\newcommand{\linenum}[1]{\normalfont\textcircled{\tiny #1}}
|
| 487 | 69 |
|
| 369 | 70 |
\makeindex |
|
917
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
71 |
\makenomenclature |
| 369 | 72 |
|
73 |
%------------------------------------------------------------------------------ |
|
74 |
||
75 |
\begin{document}
|
|
76 |
||
77 |
\pagenumbering{roman}
|
|
78 |
\pagestyle{empty}
|
|
79 |
||
80 |
\begin{titlepage}
|
|
81 |
\begin{center}
|
|
82 |
\rule{\textwidth}{1.5mm}
|
|
83 |
||
84 |
{\Huge\bf IgH \includegraphics[height=2.4ex]{images/ethercat}
|
|
| 487 | 85 |
Master \masterversion\\[1ex] |
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
86 |
Preliminary Documentation} |
| 369 | 87 |
|
88 |
\vspace{1ex}
|
|
89 |
\rule{\textwidth}{1.5mm}
|
|
90 |
||
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
91 |
\vspace{\fill} {\Large Dipl.-Ing. (FH) Florian Pose,
|
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
92 |
\url{fp@igh-essen.com}\\[1ex] Ingenieurgemeinschaft \IgH}
|
| 369 | 93 |
|
94 |
\vspace{\fill}
|
|
95 |
{\Large Essen, \SVNDate\\[1ex]
|
|
96 |
Revision \SVNRevision} |
|
97 |
\end{center}
|
|
98 |
\end{titlepage}
|
|
99 |
||
100 |
%------------------------------------------------------------------------------ |
|
101 |
||
102 |
\tableofcontents |
|
103 |
\listoftables |
|
104 |
\listoffigures |
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
105 |
%\lstlistoflistings |
| 369 | 106 |
|
107 |
%------------------------------------------------------------------------------ |
|
108 |
||
109 |
\newpage |
|
110 |
\pagestyle{scrheadings}
|
|
111 |
||
112 |
\section*{Conventions}
|
|
113 |
\addcontentsline{toc}{section}{Conventions}
|
|
114 |
\markleft{Conventions}
|
|
115 |
||
116 |
The following typographic conventions are used: |
|
117 |
||
118 |
\begin{itemize}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
119 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
120 |
\item \textit{Italic face} is used for newly introduced terms and file names.
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
121 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
122 |
\item \texttt{Typewriter face} is used for code examples and command line
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
123 |
output. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
124 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
125 |
\item \texttt{\textbf{Bold typewriter face}} is used for user input in command
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
126 |
lines. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
127 |
|
| 369 | 128 |
\end{itemize}
|
129 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
130 |
Data values and addresses are usually specified as hexadecimal values. These |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
131 |
are marked in the \textit{C} programming language style with the prefix
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
132 |
\lstinline+0x+ (example: \lstinline+0x88A4+). Unless otherwise noted, address |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
133 |
values are specified as byte addresses. |
| 369 | 134 |
|
135 |
Function names are always printed with parentheses, but without |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
136 |
parameters. So, if a function \lstinline+ecrt_request_master()+ has |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
137 |
empty parentheses, this shall not imply that it has no parameters. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
138 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
139 |
If shell commands have to be entered, this is marked by a dollar prompt: |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
140 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
141 |
\begin{lstlisting}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
142 |
$ |
| 369 | 143 |
\end{lstlisting}
|
144 |
||
145 |
Further, if a shell command has to be entered as the superuser, the |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
146 |
prompt is a mesh: |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
147 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
148 |
\begin{lstlisting}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
149 |
# |
| 369 | 150 |
\end{lstlisting}
|
151 |
||
152 |
%------------------------------------------------------------------------------ |
|
153 |
||
154 |
\chapter{The IgH EtherCAT Master}
|
|
155 |
\label{chapter:master}
|
|
156 |
\pagenumbering{arabic}
|
|
157 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
158 |
This chapter covers some general information about the EtherCAT master. |
| 369 | 159 |
|
160 |
%------------------------------------------------------------------------------ |
|
161 |
||
162 |
\section{Feature Summary}
|
|
163 |
\label{sec:summary}
|
|
164 |
\index{Master!Features}
|
|
165 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
166 |
The list below gives a short summary of the master features. |
| 369 | 167 |
|
168 |
\begin{itemize}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
169 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
170 |
\item Designed as a kernel module for Linux 2.6. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
171 |
|
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
172 |
\item Implemented according to IEC 61158-12 \cite{dlspec} \cite{alspec}.
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
173 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
174 |
\item Comes with EtherCAT-capable drivers for several common Ethernet devices. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
175 |
|
| 369 | 176 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
177 |
|
| 369 | 178 |
\item The Ethernet hardware is operated without interrupts. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
179 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
180 |
\item Drivers for additional Ethernet hardware can easily be implemented |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
181 |
using the common device interface (see sec.~\ref{sec:ecdev}) provided by the
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
182 |
master module. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
183 |
|
| 369 | 184 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
185 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
186 |
\item The master module supports multiple EtherCAT masters running in |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
187 |
parallel. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
188 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
189 |
\item The master code supports any Linux realtime extension through its |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
190 |
independent architecture. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
191 |
|
| 369 | 192 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
193 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
194 |
\item RTAI\nomenclature{RTAI}{Realtime Application Interface},
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
195 |
ADEOS\nomenclature{ADEOS}{Adaptive Domain Environment for Operating
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
196 |
Systems}, etc. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
197 |
|
| 369 | 198 |
\item It runs well even without realtime extensions. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
199 |
|
| 369 | 200 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
201 |
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
202 |
\item Common ``Application Interface'' for applications, that want to use |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
203 |
EtherCAT functionality (see chap.~\ref{chap:api}).
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
204 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
205 |
\item \textit{Domains} are introduced, to allow grouping of process
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
206 |
data transfers with different slave groups and task periods. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
207 |
|
| 369 | 208 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
209 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
210 |
\item Handling of multiple domains with different task periods. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
211 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
212 |
\item Automatic calculation of process data mapping, FMMU and sync manager |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
213 |
configuration within each domain. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
214 |
|
| 369 | 215 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
216 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
217 |
\item Communication through several finite state machines. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
218 |
|
| 369 | 219 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
220 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
221 |
\item Automatic bus scanning after topology changes. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
222 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
223 |
\item Bus monitoring during operation. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
224 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
225 |
\item Automatic reconfiguration of slaves (for example after power failure) |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
226 |
during operation. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
227 |
|
| 369 | 228 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
229 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
230 |
\item CANopen over EtherCAT (CoE) |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
231 |
|
| 369 | 232 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
233 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
234 |
\item SDO upload, download and information service. |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
235 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
236 |
\item Slave configuration via SDOs. |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
237 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
238 |
\item SDO access from userspace and from the application. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
239 |
|
| 369 | 240 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
241 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
242 |
\item Ethernet over EtherCAT (EoE) |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
243 |
|
| 369 | 244 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
245 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
246 |
\item Transparent use of EoE slaves via virtual network interfaces. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
247 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
248 |
\item Natively supports either a switched or a routed EoE network |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
249 |
architecture. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
250 |
|
| 369 | 251 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
252 |
|
| 1364 | 253 |
\item Vendor-specific over EtherCAT (VoE) |
254 |
||
255 |
\begin{itemize}
|
|
256 |
||
257 |
\item Communication with vendor-specific mailbox protocols via the API. |
|
258 |
||
259 |
\end{itemize}
|
|
260 |
||
261 |
\item File Access over EtherCAT (FoE) |
|
262 |
||
263 |
\begin{itemize}
|
|
264 |
||
265 |
\item Loading and storing files via the command-line tool. |
|
266 |
||
267 |
\item Updating a slave's firmware can be done easily. |
|
268 |
||
269 |
\end{itemize}
|
|
270 |
||
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
271 |
\item Userspace command-line-tool ``ethercat`` (see sec.~\ref{sec:tool})
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
272 |
|
| 369 | 273 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
274 |
|
| 1364 | 275 |
\item Detailed information about master, slaves, domains and bus |
276 |
configuration. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
277 |
\item Setting the master's debug level. |
| 1364 | 278 |
\item Reading/Writing alias addresses. |
279 |
\item Listing slave configurations. |
|
280 |
\item Viewing process data. |
|
281 |
\item SDO download/upload; listing SDO dictionaries. |
|
282 |
\item Loading and storing files via FoE. |
|
283 |
\item Access to slave registers. |
|
284 |
\item Slave SII (EEPROM) access. |
|
285 |
\item Controlling application-layer states. |
|
286 |
\item Generation of slave description XML from existing slaves. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
287 |
|
| 369 | 288 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
289 |
|
| 369 | 290 |
\item Seamless system integration though LSB\nomenclature{LSB}{Linux
|
291 |
Standard Base} compliance. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
292 |
|
| 369 | 293 |
\begin{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
294 |
|
| 1095 | 295 |
\item Master and network device configuration via sysconfig files. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
296 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
297 |
\item Init script for master control. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
298 |
|
| 369 | 299 |
\end{itemize}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
300 |
|
| 369 | 301 |
\item Virtual read-only network interface for monitoring and debugging |
302 |
purposes. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
303 |
|
| 369 | 304 |
\end{itemize}
|
305 |
||
306 |
%------------------------------------------------------------------------------ |
|
307 |
||
308 |
\section{License}
|
|
309 |
\label{sec:license}
|
|
310 |
||
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
311 |
The master code is released under the terms and conditions of the GNU General |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
312 |
Public License (GPL \cite{gpl})\index{GPL}, version 2. Other developers, that
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
313 |
want to use EtherCAT with Linux systems, are invited to use the master code or |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
314 |
even participate on development. |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
315 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
316 |
To allow static linking of userspace application against the master's |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
317 |
application interface (see chap.~\ref{chap:api}), the userspace library (see
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
318 |
sec.~\ref{sec:userlib}) is licensed under the terms and conditions of the GNU
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
319 |
Lesser General Public License (LGPL \cite{lgpl})\index{LGPL}, version 2.1.
|
| 369 | 320 |
|
321 |
%------------------------------------------------------------------------------ |
|
322 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
323 |
\chapter{Architecture}
|
| 1299 | 324 |
\label{chap:arch}
|
| 369 | 325 |
\index{Master!Architecture}
|
326 |
||
327 |
The EtherCAT master is integrated into the Linux 2.6 kernel. This was |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
328 |
an early design decision, which has been made for several reasons: |
| 369 | 329 |
|
330 |
\begin{itemize}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
331 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
332 |
\item Kernel code has significantly better realtime characteristics, i.\,e.\ |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
333 |
less latency than userspace code. It was foreseeable, that a fieldbus master |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
334 |
has a lot of cyclic work to do. Cyclic work is usually triggered by timer |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
335 |
interrupts inside the kernel. The execution delay of a function that processes |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
336 |
timer interrupts is less, when it resides in kernelspace, because there is no |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
337 |
need of time-consuming context switches to a userspace process. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
338 |
|
| 369 | 339 |
\item It was also foreseeable, that the master code has to directly |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
340 |
communicate with the Ethernet hardware. This has to be done in the kernel |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
341 |
anyway (through network device drivers), which is one more reason for the |
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
342 |
master code being in kernelspace. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
343 |
|
| 369 | 344 |
\end{itemize}
|
345 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
346 |
Figure~\ref{fig:arch} gives a general overview of the master architecture.
|
| 369 | 347 |
|
348 |
\begin{figure}[htbp]
|
|
349 |
\centering |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
350 |
\includegraphics[width=.9\textwidth]{images/architecture}
|
| 1291 | 351 |
\caption{Master Architecture}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
352 |
\label{fig:arch}
|
| 369 | 353 |
\end{figure}
|
354 |
||
| 1291 | 355 |
The components of the master environment are described below: |
356 |
||
357 |
\begin{description}
|
|
358 |
||
359 |
\item[Master Module]\index{Master Module} Kernel module containing one or more
|
|
360 |
EtherCAT master instances (see sec.~\ref{sec:mastermod}), the ``Device
|
|
361 |
Interface'' (see sec.~\ref{sec:ecdev}) and the ``Application Interface'' (see
|
|
362 |
chap.~\ref{chap:api}).
|
|
363 |
||
364 |
\item[Device Modules]\index{Device modules} EtherCAT-capable Ethernet device
|
|
365 |
driver modules\index{Device modules}, that offer their devices to the EtherCAT
|
|
366 |
master via the device interface (see sec.~\ref{sec:ecdev}). These modified
|
|
367 |
network drivers can handle network devices used for EtherCAT operation and |
|
368 |
``normal'' Ethernet devices in parallel. A master can accept a certain device |
|
369 |
and then is able to send and receive EtherCAT frames. Ethernet devices |
|
370 |
declined by the master module are connected to the kernel's network stack as |
|
371 |
usual. |
|
372 |
||
373 |
\item[Application]\index{Application} A program that uses the EtherCAT master
|
|
374 |
(usually for cyclic exchange of process data with EtherCAT slaves). These |
|
375 |
programs are not part of the EtherCAT master code\footnote{Although there are
|
|
376 |
some examples provided in the \textit{examples/} directory.}, but have to be
|
|
377 |
generated or written by the user. An application can ``request'' a master |
|
378 |
through the application interface (see chap.~\ref{chap:api}). If this
|
|
379 |
succeeds, it has the control over the master: It can provide a bus |
|
380 |
configuration and exchange process data. Applications can be kernel modules |
|
381 |
(that use the kernel application interface directly) or userspace programs, |
|
382 |
that use the application interface via the EtherCAT library (see |
|
383 |
sec.~\ref{sec:userlib}).
|
|
384 |
||
385 |
\end{description}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
386 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
387 |
%------------------------------------------------------------------------------ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
388 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
389 |
\section{Master Module}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
390 |
\label{sec:mastermod}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
391 |
\index{Master module}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
392 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
393 |
The EtherCAT master kernel module \textit{ec\_master} can contain multiple
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
394 |
master instances. Each master waits for a certain Ethernet device identified |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
395 |
by its MAC address\index{MAC address}. These addresses have to be specified on
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
396 |
module loading via the \textit{main\_devices} module parameter. The number of
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
397 |
master instances to initialize is taken from the number of MAC addresses |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
398 |
given. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
399 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
400 |
The below command loads the master module with a single master instance that |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
401 |
waits for the Ethernet device with the MAC address |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
402 |
\lstinline+00:0E:0C:DA:A2:20+. The master will be accessible via index $0$. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
403 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
404 |
\begin{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
405 |
# `\textbf{modprobe ec\_master main\_devices=00:0E:0C:DA:A2:20}`
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
406 |
\end{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
407 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
408 |
MAC addresses for multiple masters have to be separated by commas: |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
409 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
410 |
\begin{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
411 |
# `\textbf{modprobe ec\_master main\_devices=00:0E:0C:DA:A2:20,00:e0:81:71:d5:1c}`
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
412 |
\end{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
413 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
414 |
The two masters can be addressed by their indices 0 and 1 respectively (see |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
415 |
figure~\ref{fig:masters}). The master index is needed for the
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
416 |
\lstinline+ecrt_master_request()+ function of the application interface (see |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
417 |
chap.~\ref{chap:api}) and the \lstinline+--master+ option of the
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
418 |
\textit{ethercat} command-line tool (see sec.~\ref{sec:tool}), which defaults
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
419 |
to $0$. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
420 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
421 |
\begin{figure}[htbp]
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
422 |
\centering |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
423 |
\includegraphics[width=.5\textwidth]{images/masters}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
424 |
\caption{Multiple masters in one module}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
425 |
\label{fig:masters}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
426 |
\end{figure}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
427 |
|
|
1399
f79d4bb5b23a
Added debug_level module parameter. debug_level is now unsigned int.
Florian Pose <fp@igh-essen.com>
parents:
1364
diff
changeset
|
428 |
\paragraph{Debug Level} The master module also has a parameter
|
|
f79d4bb5b23a
Added debug_level module parameter. debug_level is now unsigned int.
Florian Pose <fp@igh-essen.com>
parents:
1364
diff
changeset
|
429 |
\textit{debug\_level} to set the initial debug level for all masters (see
|
|
f79d4bb5b23a
Added debug_level module parameter. debug_level is now unsigned int.
Florian Pose <fp@igh-essen.com>
parents:
1364
diff
changeset
|
430 |
also~\ref{sec:ethercat-debug}).
|
|
f79d4bb5b23a
Added debug_level module parameter. debug_level is now unsigned int.
Florian Pose <fp@igh-essen.com>
parents:
1364
diff
changeset
|
431 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
432 |
\paragraph{Init Script}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
433 |
\index{Init script}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
434 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
435 |
In most cases it is not necessary to load the master module and the Ethernet |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
436 |
driver modules manually. There is an init script available, so the master can |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
437 |
be started as a service (see sec.~\ref{sec:system}).
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
438 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
439 |
\paragraph{Syslog}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
440 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
441 |
The master module outputs information about its state and events to the kernel |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
442 |
ring buffer. These also end up in the system logs. The above module loading |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
443 |
command should result in the messages below: |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
444 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
445 |
\begin{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
446 |
# `\textbf{dmesg | tail -2}`
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
447 |
EtherCAT: Master driver `\masterversion` |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
448 |
EtherCAT: 2 masters waiting for devices. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
449 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
450 |
# `\textbf{tail -2 /var/log/messages}`
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
451 |
Jul 4 10:22:45 ethercat kernel: EtherCAT: Master driver `\masterversion` |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
452 |
Jul 4 10:22:45 ethercat kernel: EtherCAT: 2 masters waiting |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
453 |
for devices. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
454 |
\end{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
455 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
456 |
All EtherCAT master output is prefixed with \lstinline+EtherCAT+ which makes |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
457 |
searching the logs easier. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
458 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
459 |
%------------------------------------------------------------------------------ |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
460 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
461 |
\section{Master Phases}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
462 |
\index{Master phases}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
463 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
464 |
Every EtherCAT master provided by the master module (see |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
465 |
sec.~\ref{sec:mastermod}) runs through several phases (see
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
466 |
fig.~\ref{fig:phases}):
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
467 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
468 |
\begin{figure}[htbp]
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
469 |
\centering |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
470 |
\includegraphics[width=.9\textwidth]{images/phases}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
471 |
\caption{Master phases and transitions}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
472 |
\label{fig:phases}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
473 |
\end{figure}
|
| 1291 | 474 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
475 |
\begin{description}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
476 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
477 |
\item[Orphaned phase]\index{Orphaned phase} This mode takes effect, when the
|
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
478 |
master still waits for its Ethernet device to connect. No bus communication is |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
479 |
possible until then. |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
480 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
481 |
\item[Idle phase]\index{Idle phase} takes effect when the master has accepted
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
482 |
an Ethernet device, but is not requested by any application yet. The master |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
483 |
runs its state machine (see sec.~\ref{sec:fsm-master}), that automatically
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
484 |
scans the bus for slaves and executes pending operations from the userspace |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
485 |
interface (for example SDO access). The command-line tool can be used to |
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
486 |
access the bus, but there is no process data exchange because of the missing |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
487 |
bus configuration. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
488 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
489 |
\item[Operation phase]\index{Operation phase} The master is requested by an
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
490 |
application that can provide a bus configuration and exchange process data. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
491 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
492 |
\end{description}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
493 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
494 |
%------------------------------------------------------------------------------ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
495 |
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
496 |
\section{Process Data}
|
| 369 | 497 |
\label{sec:processdata}
|
498 |
||
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
499 |
This section shall introduce a few terms and ideas how the master handles |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
500 |
process data. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
501 |
|
| 369 | 502 |
\paragraph{Process Data Image}
|
503 |
\index{Process data}
|
|
504 |
||
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
505 |
Slaves offer their inputs and outputs by presenting the master so-called |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
506 |
``Process Data Objects'' (PDOs\index{PDO}). The available PDOs can be either
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
507 |
determined by reading out the slave's TXPDO and RXPDO SII categories from the |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
508 |
E$^2$PROM (in case of fixed PDOs) or by reading out the appropriate CoE |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
509 |
objects (see sec.~\ref{sec:coe}), if available. The application can register
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
510 |
the PDOs' entries for exchange during cyclic operation. The sum of all |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
511 |
registered PDO entries defines the ``process data image'', which is exchanged |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
512 |
via datagrams with ``logical'' memory access (like LWR, LRD or LRW) introduced |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
513 |
in~\cite[sec.~5.4]{dlspec}.
|
| 369 | 514 |
|
515 |
\paragraph{Process Data Domains}
|
|
516 |
\index{Domain}
|
|
517 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
518 |
The process data image can be easily managed by creating so-called |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
519 |
``domains'', which allow grouped PDO exchange. They also take care of managing |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
520 |
the datagram structures needed to exchange the PDOs. Domains are mandatory for |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
521 |
process data exchange, so there has to be at least one. They were introduced |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
522 |
for the following reasons: |
| 369 | 523 |
|
524 |
\begin{itemize}
|
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
525 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
526 |
\item The maximum size of a datagram is limited due to the limited size of an |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
527 |
Ethernet frame: The maximum data size is the Ethernet data field size minus |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
528 |
the EtherCAT frame header, EtherCAT datagram header and EtherCAT datagram |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
529 |
footer: $1500 - 2 - 12 - 2 = 1484$ octets. If the size of the process data |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
530 |
image exceeds this limit, multiple frames have to be sent, and the image has |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
531 |
to be partitioned for the use of multiple datagrams. A domain manages this |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
532 |
automatically. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
533 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
534 |
\item Not every PDO has to be exchanged with the same frequency: The values of |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
535 |
PDOs can vary slowly over time (for example temperature values), so exchanging |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
536 |
them with a high frequency would just waste bus bandwidth. For this reason, |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
537 |
multiple domains can be created, to group different PDOs and so allow separate |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
538 |
exchange. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
539 |
|
| 369 | 540 |
\end{itemize}
|
541 |
||
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
542 |
There is no upper limit for the number of domains, but each domain occupies |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
543 |
one FMMU in each slave involved, so the maximum number of domains is de facto |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
544 |
limited by the slaves. |
| 369 | 545 |
|
546 |
\paragraph{FMMU Configuration}
|
|
547 |
\index{FMMU!Configuration}
|
|
548 |
||
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
549 |
An application can register PDO entries for exchange. Every PDO entry and its |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
550 |
parent PDO is part of a memory area in the slave's physical memory, that is |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
551 |
protected by a sync manager \cite[sec.~6.7]{dlspec} for synchronized access.
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
552 |
In order to make a sync manager react on a datagram accessing its memory, it |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
553 |
is necessary to access the last byte covered by the sync manager. Otherwise |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
554 |
the sync manager will not react on the datagram and no data will be exchanged. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
555 |
That is why the whole synchronized memory area has to be included into the |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
556 |
process data image: For example, if a certain PDO entry of a slave is |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
557 |
registered for exchange with a certain domain, one FMMU will be configured to |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
558 |
map the complete sync-manager-protected memory, the PDO entry resides in. If a |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
559 |
second PDO entry of the same slave is registered for process data exchange |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
560 |
within the same domain, and it resides in the same sync-manager-protected |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
561 |
memory as the first one, the FMMU configuration is not altered, because the |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
562 |
desired memory is already part of the domain's process data image. If the |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
563 |
second PDO entry would belong to another sync-manager-protected area, this |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
564 |
complete area would also be included into the domains process data image. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
565 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
566 |
Figure~\ref{fig:fmmus} gives an overview, how FMMUs are configured to map
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
567 |
physical memory to logical process data images. |
| 369 | 568 |
|
569 |
\begin{figure}[htbp]
|
|
570 |
\centering |
|
571 |
\includegraphics[width=\textwidth]{images/fmmus}
|
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
572 |
\caption{FMMU Configuration}
|
| 369 | 573 |
\label{fig:fmmus}
|
574 |
\end{figure}
|
|
575 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
576 |
%------------------------------------------------------------------------------ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
577 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
578 |
\chapter{Application Interface}
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
579 |
\label{chap:api}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
580 |
\index{Application interface}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
581 |
|
| 1297 | 582 |
% TODO |
583 |
% |
|
584 |
% Interface version |
|
585 |
% Master Requesting and Releasing |
|
586 |
% Master Locking |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
587 |
% Configuring PDO assignment and mapping |
| 1297 | 588 |
% Domains (memory) |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
589 |
% PDO entry registration |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
590 |
% SDO configuration |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
591 |
% SDO access |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
592 |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
593 |
The application interface provides functions and data structures for |
| 1292 | 594 |
applications to access an EtherCAT master. The complete documentation of the |
595 |
interface is included as Doxygen~\cite{doxygen} comments in the header file
|
|
596 |
\textit{include/ecrt.h}. It can either be read directly from the file
|
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
597 |
comments, or as a more comfortable HTML documentation. The HTML generation is |
| 1292 | 598 |
described in sec.~\ref{sec:gendoc}.
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
599 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
600 |
The following sections cover a general description of the application |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
601 |
interface. |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
602 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
603 |
Every application should use the master in two steps: |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
604 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
605 |
\begin{description}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
606 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
607 |
\item[Configuration] The master is requested and the configuration is applied. |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
608 |
For example, domains are created, slaves are configured and PDO entries are |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
609 |
registered (see sec.~\ref{sec:masterconfig}).
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
610 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
611 |
\item[Operation] Cyclic code is run and process data are exchanged (see |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
612 |
sec.~\ref{sec:cyclic}).
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
613 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
614 |
\end{description}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
615 |
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
616 |
\paragraph{Example Applications}\index{Example Applications} There are a few
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
617 |
example applications in the \textit{examples/} subdirectory of the master
|
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
618 |
code. They are documented in the source code. |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
619 |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
620 |
%------------------------------------------------------------------------------ |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
621 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
622 |
\section{Master Configuration}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
623 |
\label{sec:masterconfig}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
624 |
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
625 |
The bus configuration is supplied via the application interface. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
626 |
Figure~\ref{fig:app-config} gives an overview of the objects, that can be
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
627 |
configured by the application. |
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
628 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
629 |
\begin{figure}[htbp]
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
630 |
\centering |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
631 |
\includegraphics[width=.8\textwidth]{images/app-config}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
632 |
\caption{Master Configuration}
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
633 |
\label{fig:app-config}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
634 |
\end{figure}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
635 |
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
636 |
\subsection{Slave Configuration}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
637 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
638 |
The application has to tell the master about the expected bus topology. This |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
639 |
can be done by creating ``slave configurations''. A slave configuration can be |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
640 |
seen as an expected slave. When a slave configuration is created, the |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
641 |
application provides the bus position (see below), vendor id and product code. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
642 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
643 |
When the bus configuration is applied, the master checks, if there is a slave |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
644 |
with the given vendor id and product code at the given position. If this is |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
645 |
the case, the slave configuration is ``attached'' to the real slave on the bus |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
646 |
and the slave is configured according to the settings provided by the |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
647 |
application. The state of a slave configuration can either be queried via the |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
648 |
application interface or via the command-line tool (see |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
649 |
sec.~\ref{sec:ethercat-config}).
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
650 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
651 |
\paragraph{Slave Position} The slave position has to be specified as a tuple
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
652 |
of ``alias'' and ``position''. This allows addressing slaves either via an |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
653 |
absolute bus position, or a stored identifier called ``alias'', or a mixture |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
654 |
of both. The alias is a 16-bit value stored in the slave's E$^2$PROM. It can |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
655 |
be modified via the command-line tool (see sec.~\ref{sec:ethercat-alias}).
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
656 |
Table~\ref{tab:slaveposition} shows, how the values are interpreted.
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
657 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
658 |
\begin{table}[htbp]
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
659 |
\centering |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
660 |
\caption{Specifying a Slave Position}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
661 |
\label{tab:slaveposition}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
662 |
\vspace{2mm}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
663 |
\begin{tabular}{c|c|p{70mm}}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
664 |
Alias & Position & Interpretation\\ |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
665 |
\hline |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
666 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
667 |
\lstinline+0+ & \lstinline+0+ -- \lstinline+65535+ & |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
668 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
669 |
Position addressing. The position parameter is interpreted as the absolute |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
670 |
ring position in the bus.\\ \hline |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
671 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
672 |
\lstinline+1+ -- \lstinline+65535+ & \lstinline+0+ -- \lstinline+65535+ & |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
673 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
674 |
Alias addressing. The position parameter is interpreted as relative |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
675 |
position after the first slave with the given alias address. \\ \hline |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
676 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
677 |
\end{tabular}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
678 |
\end{table}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
679 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
680 |
Figure~\ref{fig:attach} shows an example of how slave configurations are
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
681 |
attached. Some of the configurations were attached, while others remain |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
682 |
detached. The below lists gives the reasons beginning with the top slave |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
683 |
configuration. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
684 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
685 |
\begin{figure}[htbp]
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
686 |
\centering |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
687 |
\includegraphics[width=.7\textwidth]{images/attach}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
688 |
\caption{Slave Configuration Attachment}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
689 |
\label{fig:attach}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
690 |
\end{figure}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
691 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
692 |
\begin{enumerate}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
693 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
694 |
\item A zero alias means to use simple position addressing. Slave 1 exists and |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
695 |
vendor id and product code match the expected values. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
696 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
697 |
\item Although the slave with position 0 is found, the product code does not |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
698 |
match, so the configuration is not attached. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
699 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
700 |
\item The alias is non-zero, so alias addressing is used. Slave 2 is the first |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
701 |
slave with alias \lstinline+0x2000+. Because the position value is zero, the |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
702 |
same slave is used. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
703 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
704 |
\item There is no slave with the given alias, so the configuration can not be |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
705 |
attached. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
706 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
707 |
\item Slave 2 is again the first slave with the alias \lstinline+0x2000+, but |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
708 |
position is now 1, so slave 3 is attached. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
709 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
710 |
\end{enumerate}
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
711 |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
712 |
%------------------------------------------------------------------------------ |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
713 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
714 |
\section{Cyclic Operation}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
715 |
\label{sec:cyclic}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
716 |
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
717 |
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
718 |
To enter cyclic operation mode, the master has to be ``activated'' to |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
719 |
calculate the process data image and apply the bus configuration for the first |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
720 |
time. After activation, the application is in charge to send and receive |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
721 |
frames. |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
722 |
|
| 1297 | 723 |
% TODO |
724 |
% |
|
725 |
% PDO endianess |
|
726 |
% Datagram injection |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
727 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
728 |
%------------------------------------------------------------------------------ |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
729 |
|
| 1298 | 730 |
\section{VoE Handlers}
|
731 |
\label{sec:api-voe}
|
|
732 |
||
733 |
During the configuration phase, the application can create handlers for the |
|
734 |
VoE mailbox protocol described in sec.~\ref{sec:voe}. One VoE handler always
|
|
735 |
belongs to a certain slave configuration, so the creation function is a method |
|
736 |
of the slave configuration. |
|
737 |
||
738 |
A VoE handler manages the VoE data and the datagram used to transmit and |
|
739 |
receive VoE messages. Is contains the state machine necessary to transfer VoE |
|
740 |
messages. |
|
741 |
||
742 |
The VoE state machine can only process one operation at a time. As a result, |
|
743 |
either a read or write operation may be issued at a time\footnote{If
|
|
744 |
simultaneous sending and receiving is desired, two VoE handlers can be created |
|
745 |
for the slave configuration.}. After the operation is initiated, the handler |
|
746 |
must be executed cyclically until it is finished. After that, the results of |
|
747 |
the operation can be retrieved. |
|
748 |
||
749 |
A VoE handler has an own datagram structure, that is marked for exchange after |
|
750 |
each execution step. So the application can decide, how many handlers to |
|
751 |
execute before sending the corresponding EtherCAT frame(s). |
|
752 |
||
753 |
For more information about the use of VoE handlers see the documentation of |
|
754 |
the application interface functions and the example applications provided in |
|
755 |
the \textit{examples/} directory.
|
|
756 |
||
757 |
%------------------------------------------------------------------------------ |
|
758 |
||
| 1294 | 759 |
\section{Concurrent Master Access}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
760 |
\label{sec:concurr}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
761 |
\index{Concurrency}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
762 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
763 |
In some cases, one master is used by several instances, for example when an |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
764 |
application does cyclic process data exchange, and there are EoE-capable |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
765 |
slaves that require to exchange Ethernet data with the kernel (see |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
766 |
sec.~\ref{sec:eoe}). For this reason, the master is a shared resource, and
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
767 |
access to it has to be sequentialized. This is usually done by locking with |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
768 |
semaphores, or other methods to protect critical sections. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
769 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
770 |
The master itself can not provide locking mechanisms, because it has no chance |
| 1291 | 771 |
to know the appropriate kind of lock. For example if the application is in |
772 |
kernelspace and uses RTAI functionality, ordinary kernel semaphores would not |
|
773 |
be sufficient. For that, an important design decision was made: The |
|
774 |
application that reserved a master must have the total control, therefore it |
|
775 |
has to take responsibility for providing the appropriate locking mechanisms. |
|
776 |
If another instance wants to access the master, it has to request the master |
|
777 |
lock by callbacks, that have to be set by the application. Moreover the |
|
778 |
application can deny access to the master if it considers it to be awkward at |
|
779 |
the moment. |
|
| 369 | 780 |
|
781 |
\begin{figure}[htbp]
|
|
782 |
\centering |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
783 |
\includegraphics[width=.6\textwidth]{images/master-locks}
|
| 1295 | 784 |
\caption{Concurrent Master Access}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
785 |
\label{fig:locks}
|
| 369 | 786 |
\end{figure}
|
787 |
||
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
788 |
Figure~\ref{fig:locks} exemplary shows, how two processes share one master:
|
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
789 |
The application's cyclic task uses the master for process data exchange, while |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
790 |
the master-internal EoE process uses it to communicate with EoE-capable |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
791 |
slaves. Both have to acquire the master lock before access: The application |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
792 |
task can access the lock natively, while the EoE process has to use the |
| 1294 | 793 |
callbacks. See the application interface documentation (chap.~\ref{chap:api})
|
794 |
for how to use the locking callbacks. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
795 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
796 |
%------------------------------------------------------------------------------ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
797 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
798 |
\chapter{Ethernet Devices}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
799 |
\label{sec:devices}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
800 |
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
801 |
The EtherCAT protocol is based on the Ethernet standard, so a master relies on |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
802 |
standard Ethernet hardware to communicate with the bus. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
803 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
804 |
The term \textit{device} is used as a synonym for Ethernet network interface
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
805 |
hardware. There are device driver modules that handle Ethernet hardware, which |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
806 |
a master can use to connect to an EtherCAT bus. |
| 369 | 807 |
|
808 |
%------------------------------------------------------------------------------ |
|
809 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
810 |
\section{Network Driver Basics}
|
| 369 | 811 |
\label{sec:networkdrivers}
|
812 |
\index{Network drivers}
|
|
813 |
||
814 |
EtherCAT relies on Ethernet hardware and the master needs a physical |
|
815 |
Ethernet device to communicate with the bus. Therefore it is necessary |
|
816 |
to understand how Linux handles network devices and their drivers, |
|
817 |
respectively. |
|
818 |
||
819 |
\paragraph{Tasks of a Network Driver}
|
|
820 |
||
| 1095 | 821 |
Network device drivers usually handle the lower two layers of the OSI model, |
822 |
that is the physical layer and the data-link layer. A network device itself |
|
823 |
natively handles the physical layer issues: It represents the hardware to |
|
824 |
connect to the medium and to send and receive data in the way, the physical |
|
825 |
layer protocol describes. The network device driver is responsible for getting |
|
826 |
data from the kernel's networking stack and forwarding it to the hardware, |
|
827 |
that does the physical transmission. If data is received by the hardware |
|
828 |
respectively, the driver is notified (usually by means of an interrupt) and |
|
829 |
has to read the data from the hardware memory and forward it to the network |
|
830 |
stack. There are a few more tasks, a network device driver has to handle, |
|
831 |
including queue control, statistics and device dependent features. |
|
| 369 | 832 |
|
833 |
\paragraph{Driver Startup}
|
|
834 |
||
835 |
Usually, a driver searches for compatible devices on module loading. |
|
836 |
For PCI drivers, this is done by scanning the PCI bus and checking for |
|
837 |
known device IDs. If a device is found, data structures are allocated |
|
838 |
and the device is taken into operation. |
|
839 |
||
840 |
\paragraph{Interrupt Operation}
|
|
841 |
\index{Interrupt}
|
|
842 |
||
843 |
A network device usually provides a hardware interrupt that is used to |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
844 |
notify the driver of received frames and success of transmission, or |
| 369 | 845 |
errors, respectively. The driver has to register an interrupt service |
846 |
routine (ISR\index{ISR}\nomenclature{ISR}{Interrupt Service Routine}),
|
|
847 |
that is executed each time, the hardware signals such an event. If the |
|
848 |
interrupt was thrown by the own device (multiple devices can share one |
|
849 |
hardware interrupt), the reason for the interrupt has to be determined |
|
850 |
by reading the device's interrupt register. For example, if the flag |
|
851 |
for received frames is set, frame data has to be copied from hardware |
|
852 |
to kernel memory and passed to the network stack. |
|
853 |
||
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
854 |
\paragraph{The \lstinline+net_device+ Structure}
|
| 369 | 855 |
\index{net\_device}
|
856 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
857 |
The driver registers a \lstinline+net_device+ structure for each device to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
858 |
communicate with the network stack and to create a ``network interface''. In |
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
859 |
case of an Ethernet driver, this interface appears as \textit{ethX}, where X
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
860 |
is a number assigned by the kernel on registration. The \lstinline+net_device+ |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
861 |
structure receives events (either from userspace or from the network stack) |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
862 |
via several callbacks, which have to be set before registration. Not every |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
863 |
callback is mandatory, but for reasonable operation the ones below are needed |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
864 |
in any case: |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
865 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
866 |
\newsavebox\boxopen |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
867 |
\sbox\boxopen{\lstinline+open()+}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
868 |
\newsavebox\boxstop |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
869 |
\sbox\boxstop{\lstinline+stop()+}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
870 |
\newsavebox\boxxmit |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
871 |
\sbox\boxxmit{\lstinline+hard_start_xmit()+}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
872 |
\newsavebox\boxstats |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
873 |
\sbox\boxstats{\lstinline+get_stats()+}
|
| 369 | 874 |
|
875 |
\begin{description}
|
|
| 1095 | 876 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
877 |
\item[\usebox\boxopen] This function is called when network communication has |
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
878 |
to be started, for example after a command \lstinline+ip link set ethX up+ |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
879 |
from userspace. Frame reception has to be enabled by the driver. |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
880 |
|
| 1297 | 881 |
\item[\usebox\boxstop] The purpose of this callback is to ``close'' the |
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
882 |
device, i.\,e.\ make the hardware stop receiving frames. |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
883 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
884 |
\item[\usebox\boxxmit] This function is called for each frame that has to be |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
885 |
transmitted. The network stack passes the frame as a pointer to an |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
886 |
\lstinline+sk_buff+ structure (``socket buffer''\index{Socket buffer}, see
|
| 1095 | 887 |
below), which has to be freed after sending. |
888 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
889 |
\item[\usebox\boxstats] This call has to return a pointer to the device's |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
890 |
\lstinline+net_device_stats+ structure, which permanently has to be filled with |
| 1095 | 891 |
frame statistics. This means, that every time a frame is received, sent, or an |
892 |
error happened, the appropriate counter in this structure has to be increased. |
|
893 |
||
894 |
\end{description}
|
|
895 |
||
896 |
The actual registration is done with the \lstinline+register_netdev()+ call, |
|
897 |
unregistering is done with \lstinline+unregister_netdev()+. |
|
| 369 | 898 |
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
899 |
\paragraph{The \lstinline+netif+ Interface}
|
| 369 | 900 |
\index{netif}
|
901 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
902 |
All other communication in the direction interface $\to$ network stack is done |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
903 |
via the \lstinline+netif_*()+ calls. For example, on successful device opening, |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
904 |
the network stack has to be notified, that it can now pass frames to the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
905 |
interface. This is done by calling \lstinline+netif_start_queue()+. After this |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
906 |
call, the \lstinline+hard_start_xmit()+ callback can be called by the network |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
907 |
stack. Furthermore a network driver usually manages a frame transmission queue. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
908 |
If this gets filled up, the network stack has to be told to stop passing |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
909 |
further frames for a while. This happens with a call to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
910 |
\lstinline+netif_stop_queue()+. If some frames have been sent, and there is |
| 1095 | 911 |
enough space again to queue new frames, this can be notified with |
912 |
\lstinline+netif_wake_queue()+. Another important call is |
|
913 |
\lstinline+netif_receive_skb()+\footnote{This function is part of the NAPI
|
|
914 |
(``New API''), that replaces the kernel 2.4 technique for interfacing to the |
|
915 |
network stack (with \lstinline+netif_rx()+). NAPI is a technique to improve |
|
916 |
network performance on Linux. Read more in |
|
917 |
\url{http://www.cyberus.ca/~hadi/usenix-paper.tgz}.}: It passes a frame to the
|
|
918 |
network stack, that was just received by the device. Frame data has to be |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
919 |
included in a so-called ``socket buffer'' for that (see below). |
| 369 | 920 |
|
921 |
\paragraph{Socket Buffers}
|
|
922 |
\index{Socket buffer}
|
|
923 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
924 |
Socket buffers are the basic data type for the whole network stack. They serve |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
925 |
as containers for network data and are able to quickly add data headers and |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
926 |
footers, or strip them off again. Therefore a socket buffer consists of an |
| 1095 | 927 |
allocated buffer and several pointers that mark beginning of the buffer |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
928 |
(\lstinline+head+), beginning of data (\lstinline+data+), end of data |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
929 |
(\lstinline+tail+) and end of buffer (\lstinline+end+). In addition, a socket |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
930 |
buffer holds network header information and (in case of received data) a |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
931 |
pointer to the \lstinline+net_device+, it was received on. There exist |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
932 |
functions that create a socket buffer (\lstinline+dev_alloc_skb()+), add data |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
933 |
either from front (\lstinline+skb_push()+) or back (\lstinline+skb_put()+), |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
934 |
remove data from front (\lstinline+skb_pull()+) or back |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
935 |
(\lstinline+skb_trim()+), or delete the buffer (\lstinline+kfree_skb()+). A |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
936 |
socket buffer is passed from layer to layer, and is freed by the layer that |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
937 |
uses it the last time. In case of sending, freeing has to be done by the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
938 |
network driver. |
| 369 | 939 |
|
940 |
%------------------------------------------------------------------------------ |
|
941 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
942 |
\section{EtherCAT Device Drivers}
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
943 |
\label{sec:drivers}
|
| 369 | 944 |
|
| 1095 | 945 |
There are a few requirements for Ethernet network devices to function as |
946 |
EtherCAT devices, when connected to an EtherCAT bus. |
|
| 369 | 947 |
|
948 |
\paragraph{Dedicated Interfaces}
|
|
949 |
||
| 1095 | 950 |
For performance and realtime purposes, the EtherCAT master needs direct and |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
951 |
exclusive access to the Ethernet hardware. This implies that the network device |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
952 |
must not be connected to the kernel's network stack as usual, because the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
953 |
kernel would try to use it as an ordinary Ethernet device. |
| 369 | 954 |
|
955 |
\paragraph{Interrupt-less Operation}
|
|
956 |
\index{Interrupt}
|
|
957 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
958 |
EtherCAT frames travel through the logical EtherCAT ring and are then sent back |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
959 |
to the master. Communication is highly deterministic: A frame is sent and will |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
960 |
be received again after a constant time, so there is no need to notify the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
961 |
driver about frame reception: The master can instead query the hardware for |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
962 |
received frames, if it expects them to be already received. |
| 1095 | 963 |
|
964 |
Figure~\ref{fig:interrupt} shows two workflows for cyclic frame transmission
|
|
965 |
and reception with and without interrupts. |
|
| 369 | 966 |
|
967 |
\begin{figure}[htbp]
|
|
968 |
\centering |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
969 |
\includegraphics[width=.9\textwidth]{images/interrupt}
|
| 369 | 970 |
\caption{Interrupt Operation versus Interrupt-less Operation}
|
971 |
\label{fig:interrupt}
|
|
972 |
\end{figure}
|
|
973 |
||
| 1095 | 974 |
In the left workflow ``Interrupt Operation'', the data from the last cycle is |
975 |
first processed and a new frame is assembled with new datagrams, which is then |
|
976 |
sent. The cyclic work is done for now. Later, when the frame is received |
|
977 |
again by the hardware, an interrupt is triggered and the ISR is executed. The |
|
978 |
ISR will fetch the frame data from the hardware and initiate the frame |
|
979 |
dissection: The datagrams will be processed, so that the data is ready for |
|
980 |
processing in the next cycle. |
|
981 |
||
982 |
In the right workflow ``Interrupt-less Operation'', there is no hardware |
|
983 |
interrupt enabled. Instead, the hardware will be polled by the master by |
|
984 |
executing the ISR. If the frame has been received in the meantime, it will be |
|
985 |
dissected. The situation is now the same as at the beginning of the left |
|
986 |
workflow: The received data is processed and a new frame is assembled and |
|
987 |
sent. There is nothing to do for the rest of the cycle. |
|
988 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
989 |
The interrupt-less operation is desirable, because hardware interrupts are not |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
990 |
conducive in improving the driver's realtime behaviour: Their indeterministic |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
991 |
incidences contribute to increasing the jitter. Besides, if a realtime |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
992 |
extension (like RTAI) is used, some additional effort would have to be made to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
993 |
prioritize interrupts. |
| 369 | 994 |
|
995 |
\paragraph{Ethernet and EtherCAT Devices}
|
|
996 |
||
| 1095 | 997 |
Another issue lies in the way Linux handles devices of the same type. For |
998 |
example, a PCI\nomenclature{PCI}{Peripheral Component Interconnect, Computer
|
|
999 |
Bus} driver scans the PCI bus for devices it can handle. Then it registers |
|
1000 |
itself as the responsible driver for all of the devices found. The problem is, |
|
1001 |
that an unmodified driver can not be told to ignore a device because it will |
|
1002 |
be used for EtherCAT later. There must be a way to handle multiple devices of |
|
1003 |
the same type, where one is reserved for EtherCAT, while the other is treated |
|
| 369 | 1004 |
as an ordinary Ethernet device. |
1005 |
||
| 1095 | 1006 |
For all this reasons, the author decided that the only acceptable solution is |
1007 |
to modify standard Ethernet drivers in a way that they keep their normal |
|
1008 |
functionality, but gain the ability to treat one or more of the devices as |
|
1009 |
EtherCAT-capable. |
|
| 369 | 1010 |
|
1011 |
Below are the advantages of this solution: |
|
1012 |
||
1013 |
\begin{itemize}
|
|
1014 |
\item No need to tell the standard drivers to ignore certain devices. |
|
1015 |
\item One networking driver for EtherCAT and non-EtherCAT devices. |
|
1016 |
\item No need to implement a network driver from scratch and running |
|
1017 |
into issues, the former developers already solved. |
|
1018 |
\end{itemize}
|
|
1019 |
||
1020 |
The chosen approach has the following disadvantages: |
|
1021 |
||
1022 |
\begin{itemize}
|
|
1023 |
\item The modified driver gets more complicated, as it must handle |
|
1024 |
EtherCAT and non-EtherCAT devices. |
|
1025 |
\item Many additional case differentiations in the driver code. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1026 |
\item Changes and bug fixes on the standard drivers have to be ported |
| 369 | 1027 |
to the Ether\-CAT-capable versions from time to time. |
1028 |
\end{itemize}
|
|
1029 |
||
1030 |
%------------------------------------------------------------------------------ |
|
1031 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1032 |
\section{Device Selection}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1033 |
\label{sec:deviceselection}
|
| 369 | 1034 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1035 |
After loading the master module, at least one EtherCAT-capable network driver |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1036 |
module has to be loaded, that offers its devices to the master (see |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1037 |
sec.~\ref{sec:ecdev}. The master module knows the devices to choose from the
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1038 |
module parameters (see sec.~\ref{sec:mastermod}). If the init script is used
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1039 |
to start the master, the drivers and devices to use can be specified in the |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1040 |
sysconfig file (see sec.~\ref{sec:sysconfig}).
|
| 369 | 1041 |
|
1042 |
%------------------------------------------------------------------------------ |
|
1043 |
||
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1044 |
\section{EtherCAT Device Interface}
|
| 369 | 1045 |
\label{sec:ecdev}
|
1046 |
\index{Device interface}
|
|
1047 |
||
1048 |
An anticipation to the section about the master module |
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1049 |
(sec.~\ref{sec:mastermod}) has to be made in order to understand the way, a
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1050 |
network device driver module can connect a device to a specific EtherCAT |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1051 |
master. |
| 369 | 1052 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1053 |
The master module provides a ``device interface'' for network device drivers. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1054 |
To use this interface, a network device driver module must include the header |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1055 |
\textit{devices/ecdev.h}\nomenclature{ecdev}{EtherCAT Device}, coming with the
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1056 |
EtherCAT master code. This header offers a function interface for EtherCAT |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1057 |
devices. All functions of the device interface are named with the prefix |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1058 |
\lstinline+ecdev+. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1059 |
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1060 |
The documentation of the device interface can be found in the header file or |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1061 |
in the appropriate module of the interface documentation (see |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1062 |
sec.~\ref{sec:gendoc} for generation instructions).
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1063 |
|
| 1296 | 1064 |
% TODO general description of the device interface |
| 369 | 1065 |
|
1066 |
%------------------------------------------------------------------------------ |
|
1067 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1068 |
\section{Patching Network Drivers}
|
| 369 | 1069 |
\label{sec:patching}
|
1070 |
\index{Network drivers}
|
|
1071 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1072 |
This section will describe, how to make a standard Ethernet driver |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1073 |
EtherCAT-capable. Unfortunately, there is no standard procedure to enable an |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1074 |
Ethernet driver for use with the EtherCAT master, but there are a few common |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1075 |
techniques. |
| 369 | 1076 |
|
1077 |
\begin{enumerate}
|
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1078 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1079 |
\item A first simple rule is, that \lstinline+netif_*()+ calls must be avoided |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1080 |
for all EtherCAT devices. As mentioned before, EtherCAT devices have no |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1081 |
connection to the network stack, and therefore must not call its interface |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1082 |
functions. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1083 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1084 |
\item Another important thing is, that EtherCAT devices should be operated |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1085 |
without interrupts. So any calls of registering interrupt handlers and enabling |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1086 |
interrupts at hardware level must be avoided, too. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1087 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1088 |
\item The master does not use a new socket buffer for each send operation: |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1089 |
Instead there is a fix one allocated on master initialization. This socket |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1090 |
buffer is filled with an EtherCAT frame with every send operation and passed to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1091 |
the \lstinline+hard_start_xmit()+ callback. For that it is necessary, that the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1092 |
socket buffer is not be freed by the network driver as usual. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1093 |
|
| 369 | 1094 |
\end{enumerate}
|
1095 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1096 |
An Ethernet driver usually handles several Ethernet devices, each described by |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1097 |
a \lstinline+net_device+ structure with a \lstinline+priv_data+ field to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1098 |
attach driver-dependent data to the structure. To distinguish between normal |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1099 |
Ethernet devices and the ones used by EtherCAT masters, the private data |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1100 |
structure used by the driver could be extended by a pointer, that points to an |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1101 |
\lstinline+ec_device_t+ object returned by \lstinline+ecdev_offer()+ (see |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1102 |
sec.~\ref{sec:ecdev}) if the device is used by a master and otherwise is zero.
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1103 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1104 |
The RealTek RTL-8139 Fast Ethernet driver is a ``simple'' Ethernet driver and |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1105 |
can be taken as an example to patch new drivers. The interesting sections can |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1106 |
be found by searching the string ``ecdev" in the file |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1107 |
\textit{devices/8139too-2.6.24-ethercat.c}.
|
| 369 | 1108 |
|
1109 |
%------------------------------------------------------------------------------ |
|
1110 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1111 |
\chapter{State Machines}
|
| 369 | 1112 |
\label{sec:fsm}
|
1113 |
\index{FSM}
|
|
1114 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1115 |
Many parts of the EtherCAT master are implemented as \textit{finite state
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1116 |
machines} (FSMs\nomenclature{FSM}{Finite State Machine}). Though this leads
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1117 |
to a higher grade of complexity in some aspects, is opens many new |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1118 |
possibilities. |
| 369 | 1119 |
|
1120 |
The below short code example exemplary shows how to read all slave |
|
1121 |
states and moreover illustrates the restrictions of ``sequential'' |
|
1122 |
coding: |
|
1123 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1124 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1125 |
ec_datagram_brd(datagram, 0x0130, 2); // prepare datagram |
1126 |
if (ec_master_simple_io(master, datagram)) return -1; |
|
1127 |
slave_states = EC_READ_U8(datagram->data); // process datagram |
|
1128 |
\end{lstlisting}
|
|
1129 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1130 |
The \textit{ec\_master\_simple\_io()} function provides a simple interface for
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1131 |
synchronously sending a single datagram and receiving the result\footnote{For
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1132 |
all communication issues have been meanwhile sourced out into state machines, |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1133 |
the function is deprecated and stopped existing. Nevertheless it is adequate |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1134 |
for showing it's own restrictions.}. Internally, it queues the specified |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1135 |
datagram, invokes the \textit{ec\_master\_send\_datagrams()} function to send
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1136 |
a frame with the queued datagram and then waits actively for its reception. |
| 369 | 1137 |
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1138 |
This sequential approach is very simple, reflecting in only three lines of |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1139 |
code. The disadvantage is, that the master is blocked for the time it waits |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1140 |
for datagram reception. There is no difficulty when only one instance is using |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1141 |
the master, but if more instances want to (synchronously\footnote{At this
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1142 |
time, synchronous master access will be adequate to show the advantages of an |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1143 |
FSM. The asynchronous approach will be discussed in sec.~\ref{sec:eoe}}) use
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1144 |
the master, it is inevitable to think about an alternative to the sequential |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1145 |
model. |
| 369 | 1146 |
|
1147 |
Master access has to be sequentialized for more than one instance |
|
1148 |
wanting to send and receive datagrams synchronously. With the present |
|
1149 |
approach, this would result in having one phase of active waiting for |
|
1150 |
each instance, which would be non-acceptable especially in realtime |
|
1151 |
circumstances, because of the huge time overhead. |
|
1152 |
||
1153 |
A possible solution is, that all instances would be executed |
|
1154 |
sequentially to queue their datagrams, then give the control to the |
|
1155 |
next instance instead of waiting for the datagram reception. Finally, |
|
1156 |
bus IO is done by a higher instance, which means that all queued |
|
1157 |
datagrams are sent and received. The next step is to execute all |
|
1158 |
instances again, which then process their received datagrams and issue |
|
1159 |
new ones. |
|
1160 |
||
1161 |
This approach results in all instances having to retain their state, |
|
1162 |
when giving the control back to the higher instance. It is quite |
|
1163 |
obvious to use a \textit{finite state machine} model in this case.
|
|
1164 |
Section~\ref{sec:fsmtheory} will introduce some of the theory used,
|
|
1165 |
while the listings below show the basic approach by coding the example |
|
1166 |
from above as a state machine: |
|
1167 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1168 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1169 |
// state 1 |
1170 |
ec_datagram_brd(datagram, 0x0130, 2); // prepare datagram |
|
1171 |
ec_master_queue(master, datagram); // queue datagram |
|
1172 |
next_state = state_2; |
|
1173 |
// state processing finished |
|
1174 |
\end{lstlisting}
|
|
1175 |
||
1176 |
After all instances executed their current state and queued their |
|
1177 |
datagrams, these are sent and received. Then the respective next |
|
1178 |
states are executed: |
|
1179 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1180 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1181 |
// state 2 |
1182 |
if (datagram->state != EC_DGRAM_STATE_RECEIVED) {
|
|
1183 |
next_state = state_error; |
|
1184 |
return; // state processing finished |
|
1185 |
} |
|
1186 |
slave_states = EC_READ_U8(datagram->data); // process datagram |
|
1187 |
// state processing finished. |
|
1188 |
\end{lstlisting}
|
|
1189 |
||
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1190 |
See sec.~\ref{sec:statemodel} for an introduction to the state machine
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1191 |
programming concept used in the master code. |
| 369 | 1192 |
|
1193 |
%------------------------------------------------------------------------------ |
|
1194 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1195 |
\section{State Machine Theory}
|
| 369 | 1196 |
\label{sec:fsmtheory}
|
1197 |
\index{FSM!Theory}
|
|
1198 |
||
1199 |
A finite state machine \cite{automata} is a model of behavior with
|
|
1200 |
inputs and outputs, where the outputs not only depend on the inputs, |
|
1201 |
but the history of inputs. The mathematical definition of a finite |
|
1202 |
state machine (or finite automaton) is a six-tuple $(\Sigma, \Gamma, |
|
1203 |
S, s_0, \delta, \omega)$, with |
|
1204 |
||
1205 |
\begin{itemize}
|
|
1206 |
\item the input alphabet $\Sigma$, with $\Sigma \neq |
|
1207 |
\emptyset$, containing all input symbols, |
|
1208 |
\item the output alphabet $\Gamma$, with $\Gamma \neq |
|
1209 |
\emptyset$, containing all output symbols, |
|
1210 |
\item the set of states $S$, with $S \neq \emptyset$, |
|
1211 |
\item the set of initial states $s_0$ with $s_0 \subseteq S, s_0 \neq |
|
1212 |
\emptyset$ |
|
1213 |
\item the transition function $\delta: S \times \Sigma \rightarrow S |
|
1214 |
\times \Gamma$ |
|
1215 |
\item the output function $\omega$. |
|
1216 |
\end{itemize}
|
|
1217 |
||
1218 |
The state transition function $\delta$ is often specified by a |
|
1219 |
\textit{state transition table}, or by a \textit{state transition
|
|
1220 |
diagram}. The transition table offers a matrix view of the state |
|
1221 |
machine behavior (see table~\ref{tab:statetrans}). The matrix rows
|
|
1222 |
correspond to the states ($S = \{s_0, s_1, s_2\}$) and the columns
|
|
1223 |
correspond to the input symbols ($\Gamma = \{a, b, \varepsilon\}$).
|
|
1224 |
The table contents in a certain row $i$ and column $j$ then represent |
|
1225 |
the next state (and possibly the output) for the case, that a certain |
|
1226 |
input symbol $\sigma_j$ is read in the state $s_i$. |
|
1227 |
||
1228 |
\begin{table}[htbp]
|
|
1229 |
\caption{A typical state transition table}
|
|
1230 |
\label{tab:statetrans}
|
|
1231 |
\vspace{2mm}
|
|
1232 |
\centering |
|
1233 |
\begin{tabular}{l|ccc}
|
|
1234 |
& $a$ & $b$ & $\varepsilon$\\ \hline |
|
1235 |
$s_0$ & $s_1$ & $s_1$ & $s_2$\\ |
|
1236 |
$s_1$ & $s_2$ & $s_1$ & $s_0$\\ |
|
1237 |
$s_2$ & $s_0$ & $s_0$ & $s_0$\\ \hline |
|
1238 |
\end{tabular}
|
|
1239 |
\end{table}
|
|
1240 |
||
1241 |
The state diagram for the same example looks like the one in |
|
1242 |
figure~\ref{fig:statetrans}. The states are represented as circles or
|
|
1243 |
ellipses and the transitions are drawn as arrows between them. Close |
|
1244 |
to a transition arrow can be the condition that must be fulfilled to |
|
1245 |
allow the transition. The initial state is marked by a filled black |
|
1246 |
circle with an arrow pointing to the respective state. |
|
1247 |
||
1248 |
\begin{figure}[htbp]
|
|
1249 |
\centering |
|
1250 |
\includegraphics[width=.5\textwidth]{images/statetrans}
|
|
1251 |
\caption{A typical state transition diagram}
|
|
1252 |
\label{fig:statetrans}
|
|
1253 |
\end{figure}
|
|
1254 |
||
1255 |
\paragraph{Deterministic and non-deterministic state machines}
|
|
1256 |
||
1257 |
A state machine can be deterministic, meaning that for one state and |
|
1258 |
input, there is one (and only one) following state. In this case, the |
|
1259 |
state machine has exactly one starting state. Non-deterministic state |
|
1260 |
machines can have more than one transitions for a single state-input |
|
1261 |
combination. There is a set of starting states in the latter case. |
|
1262 |
||
1263 |
\paragraph{Moore and Mealy machines}
|
|
1264 |
||
1265 |
There is a distinction between so-called \textit{Moore machines}, and
|
|
1266 |
\textit{Mealy machines}. Mathematically spoken, the distinction lies
|
|
1267 |
in the output function $\omega$: If it only depends on the current |
|
1268 |
state ($\omega: S \rightarrow \Gamma$), the machine corresponds to the |
|
1269 |
``Moore Model''. Otherwise, if $\omega$ is a function of a state and |
|
1270 |
the input alphabet ($\omega: S \times \Sigma \rightarrow \Gamma$) the |
|
1271 |
state machine corresponds to the ``Mealy model''. Mealy machines are |
|
1272 |
the more practical solution in most cases, because their design allows |
|
1273 |
machines with a minimum number of states. In practice, a mixture of |
|
1274 |
both models is often used. |
|
1275 |
||
1276 |
\paragraph{Misunderstandings about state machines}
|
|
1277 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1278 |
There is a phenomenon called ``state explosion'', that is often taken as a |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1279 |
counter-argument against general use of state machines in complex environments. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1280 |
It has to be mentioned, that this point is misleading~\cite{fsmmis}. State
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1281 |
explosions happen usually as a result of a bad state machine design: Common |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1282 |
mistakes are storing the present values of all inputs in a state, or not |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1283 |
dividing a complex state machine into simpler sub state machines. The EtherCAT |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1284 |
master uses several state machines, that are executed hierarchically and so |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1285 |
serve as sub state machines. These are also described below. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1286 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1287 |
%------------------------------------------------------------------------------ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1288 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1289 |
\section{The Master's State Model}
|
| 369 | 1290 |
\label{sec:statemodel}
|
1291 |
||
1292 |
This section will introduce the techniques used in the master to |
|
1293 |
implement state machines. |
|
1294 |
||
1295 |
\paragraph{State Machine Programming}
|
|
1296 |
||
1297 |
There are certain ways to implement a state machine in \textit{C}
|
|
1298 |
code. An obvious way is to implement the different states and actions |
|
1299 |
by one big case differentiation: |
|
1300 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1301 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1302 |
enum {STATE_1, STATE_2, STATE_3};
|
1303 |
int state = STATE_1; |
|
1304 |
||
1305 |
void state_machine_run(void *priv_data) {
|
|
1306 |
switch (state) {
|
|
1307 |
case STATE_1: |
|
1308 |
action_1(); |
|
1309 |
state = STATE_2; |
|
1310 |
break; |
|
1311 |
case STATE_2: |
|
1312 |
action_2() |
|
1313 |
if (some_condition) state = STATE_1; |
|
1314 |
else state = STATE_3; |
|
1315 |
break; |
|
1316 |
case STATE_3: |
|
1317 |
action_3(); |
|
1318 |
state = STATE_1; |
|
1319 |
break; |
|
1320 |
} |
|
1321 |
} |
|
1322 |
\end{lstlisting}
|
|
1323 |
||
1324 |
For small state machines, this is an option. The disadvantage is, that |
|
1325 |
with an increasing number of states the code soon gets complex and an |
|
1326 |
additional case differentiation is executed each run. Besides, lots of |
|
1327 |
indentation is wasted. |
|
1328 |
||
1329 |
The method used in the master is to implement every state in an own |
|
1330 |
function and to store the current state function with a function |
|
1331 |
pointer: |
|
1332 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1333 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1334 |
void (*state)(void *) = state1; |
1335 |
||
1336 |
void state_machine_run(void *priv_data) {
|
|
1337 |
state(priv_data); |
|
1338 |
} |
|
1339 |
||
1340 |
void state1(void *priv_data) {
|
|
1341 |
action_1(); |
|
1342 |
state = state2; |
|
1343 |
} |
|
1344 |
||
1345 |
void state2(void *priv_data) {
|
|
1346 |
action_2(); |
|
1347 |
if (some_condition) state = state1; |
|
1348 |
else state = state2; |
|
1349 |
} |
|
1350 |
||
1351 |
void state3(void *priv_data) {
|
|
1352 |
action_3(); |
|
1353 |
state = state1; |
|
1354 |
} |
|
1355 |
\end{lstlisting}
|
|
1356 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1357 |
In the master code, state pointers of all state machines\footnote{All except
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1358 |
for the EoE state machine, because multiple EoE slaves have to be handled in |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1359 |
parallel. For this reason each EoE handler object has its own state pointer.} |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1360 |
are gathered in a single object of the \lstinline+ec_fsm_master_t+ class. This |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1361 |
is advantageous, because there is always one instance of every state machine |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1362 |
available and can be started on demand. |
| 369 | 1363 |
|
1364 |
\paragraph{Mealy and Moore}
|
|
1365 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1366 |
If a closer look is taken to the above listing, it can be seen that the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1367 |
actions executed (the ``outputs'' of the state machine) only depend on the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1368 |
current state. This accords to the ``Moore'' model introduced in |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1369 |
sec.~\ref{sec:fsmtheory}. As mentioned, the ``Mealy'' model offers a higher
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1370 |
flexibility, which can be seen in the listing below: |
| 369 | 1371 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1372 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1373 |
void state7(void *priv_data) {
|
1374 |
if (some_condition) {
|
|
1375 |
action_7a(); |
|
1376 |
state = state1; |
|
1377 |
} |
|
1378 |
else {
|
|
1379 |
action_7b(); |
|
1380 |
state = state8; |
|
1381 |
} |
|
1382 |
} |
|
1383 |
\end{lstlisting}
|
|
1384 |
||
1385 |
\begin{description}
|
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1386 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1387 |
\item[\linenum{3} + \linenum{7}] The state function executes the actions
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1388 |
depending on the state transition, that is about to be done. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1389 |
|
| 369 | 1390 |
\end{description}
|
1391 |
||
1392 |
The most flexible alternative is to execute certain actions depending |
|
1393 |
on the state, followed by some actions dependent on the state |
|
1394 |
transition: |
|
1395 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1396 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
| 369 | 1397 |
void state9(void *priv_data) {
|
1398 |
action_9(); |
|
1399 |
if (some_condition) {
|
|
1400 |
action_9a(); |
|
1401 |
state = state7; |
|
1402 |
} |
|
1403 |
else {
|
|
1404 |
action_9b(); |
|
1405 |
state = state10; |
|
1406 |
} |
|
1407 |
} |
|
1408 |
\end{lstlisting}
|
|
1409 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1410 |
This model is often used in the master. It combines the best aspects of both |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1411 |
approaches. |
| 369 | 1412 |
|
1413 |
\paragraph{Using Sub State Machines}
|
|
1414 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1415 |
To avoid having too much states, certain functions of the EtherCAT master |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1416 |
state machine have been sourced out into sub state machines. This helps to |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1417 |
encapsulate the related workflows and moreover avoids the ``state explosion'' |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1418 |
phenomenon described in sec.~\ref{sec:fsmtheory}. If the master would instead
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1419 |
use one big state machine, the number of states would be a multiple of the |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1420 |
actual number. This would increase the level of complexity to a non-manageable |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1421 |
grade. |
| 369 | 1422 |
|
1423 |
\paragraph{Executing Sub State Machines}
|
|
1424 |
||
1425 |
If a state machine starts to execute a sub state machine, it usually |
|
1426 |
remains in one state until the sub state machine terminates. This is |
|
1427 |
usually done like in the listing below, which is taken out of the |
|
1428 |
slave configuration state machine code: |
|
1429 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1430 |
\begin{lstlisting}[gobble=2,language=C,numbers=left]
|
|
813
bfc3f1ab52de
Fixed typo SAVEOP -> SAFEOP.
Florian Pose <fp@igh-essen.com>
parents:
487
diff
changeset
|
1431 |
void ec_fsm_slaveconf_safeop(ec_fsm_t *fsm) |
| 369 | 1432 |
{
|
1433 |
fsm->change_state(fsm); // execute state change |
|
1434 |
// sub state machine |
|
1435 |
||
1436 |
if (fsm->change_state == ec_fsm_error) {
|
|
1437 |
fsm->slave_state = ec_fsm_end; |
|
1438 |
return; |
|
1439 |
} |
|
1440 |
||
1441 |
if (fsm->change_state != ec_fsm_end) return; |
|
1442 |
||
1443 |
// continue state processing |
|
1444 |
... |
|
1445 |
\end{lstlisting}
|
|
1446 |
||
1447 |
\begin{description}
|
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1448 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1449 |
\item[\linenum{3}] \lstinline+change_state+ is the state pointer of the state
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1450 |
change state machine. The state function, the pointer points on, is |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1451 |
executed\ldots |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1452 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1453 |
\item[\linenum{6}] \ldots either until the state machine terminates with the
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1454 |
error state \ldots |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1455 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1456 |
\item[\linenum{11}] \ldots or until the state machine terminates in the end
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1457 |
state. Until then, the ``higher'' state machine remains in the current state |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1458 |
and executes the sub state machine again in the next cycle. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1459 |
|
| 369 | 1460 |
\end{description}
|
1461 |
||
1462 |
\paragraph{State Machine Descriptions}
|
|
1463 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1464 |
The below sections describe every state machine used in the EtherCAT master. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1465 |
The textual descriptions of the state machines contain references to the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1466 |
transitions in the corresponding state transition diagrams, that are marked |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1467 |
with an arrow followed by the name of the successive state. Transitions caused |
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1468 |
by trivial error cases (i.\,e.\ no response from slave) are not described |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1469 |
explicitly. These transitions are drawn as dashed arrows in the diagrams. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1470 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1471 |
%------------------------------------------------------------------------------ |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1472 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1473 |
\section{The Master State Machine}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1474 |
\label{sec:fsm-master}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1475 |
\index{FSM!Master}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1476 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1477 |
The master state machine is executed in the context of the master thread. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1478 |
Figure~\ref{fig:fsm-master} shows its transition diagram. Its purposes are:
|
| 369 | 1479 |
|
1480 |
\begin{figure}[htbp]
|
|
1481 |
\centering |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1482 |
\includegraphics[width=\textwidth]{graphs/fsm_master}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1483 |
\caption{Transition diagram of the master state machine}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1484 |
\label{fig:fsm-master}
|
| 369 | 1485 |
\end{figure}
|
1486 |
||
1487 |
\begin{description}
|
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1488 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1489 |
\item[Bus monitoring] The bus topology is monitored. If it changes, the bus is |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1490 |
(re-)scanned. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1491 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1492 |
\item[Slave configuration] The application-layer states of the slaves are |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1493 |
monitored. If a slave is not in the state it supposed to be, the slave is |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1494 |
(re-)configured. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1495 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1496 |
\item[Request handling] Requests (either originating from the application or |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1497 |
from external sources) are handled. A request is a job that the master shall |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1498 |
process asynchronously, for example an SII access, SDO access, or similar. |
| 369 | 1499 |
|
1500 |
\end{description}
|
|
1501 |
||
1502 |
%------------------------------------------------------------------------------ |
|
1503 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1504 |
\section{The Slave Scan State Machine}
|
| 369 | 1505 |
\label{sec:fsm-scan}
|
1506 |
\index{FSM!Slave Scan}
|
|
1507 |
||
1508 |
The slave scan state machine, which can be seen in |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1509 |
figure~\ref{fig:fsm-slavescan}, leads through the process of reading desired
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1510 |
slave information. |
| 369 | 1511 |
|
1512 |
\begin{figure}[htbp]
|
|
1513 |
\centering |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1514 |
\includegraphics[height=.8\textheight]{graphs/fsm_slave_scan}
|
| 369 | 1515 |
\caption{Transition diagram of the slave scan state machine}
|
1516 |
\label{fig:fsm-slavescan}
|
|
1517 |
\end{figure}
|
|
1518 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1519 |
The scan process includes the following steps: |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1520 |
|
| 369 | 1521 |
\begin{description}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1522 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1523 |
\item[Node Address] The node address is set for the slave, so that it can be |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1524 |
node-addressed for all following operations. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1525 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1526 |
\item[AL State] The initial application-layer state is read. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1527 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1528 |
\item[Base Information] Base information (like the number of supported FMMUs) |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1529 |
is read from the lower physical memory. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1530 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1531 |
\item[Data Link] Information about the physical ports is read. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1532 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1533 |
\item[SII Size] The size of the SII contents is determined to allocate SII |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1534 |
image memory. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1535 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1536 |
\item[SII Data] The SII contents are read into the master's image. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1537 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1538 |
\item[PREOP] If the slave supports CoE, it is set to PREOP state using the |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1539 |
State change FSM (see sec.~\ref{sec:fsm-change}) to enable mailbox
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1540 |
communication and read the PDO configuration via CoE. |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1541 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1542 |
\item[PDOs] The PDOs are read via CoE (if supported) using the PDO Reading FSM |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1543 |
(see sec.~\ref{sec:fsm-pdo}). If this is successful, the PDO information from
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1544 |
the SII (if any) is overwritten. |
| 369 | 1545 |
|
1546 |
\end{description}
|
|
1547 |
||
1548 |
%------------------------------------------------------------------------------ |
|
1549 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1550 |
\section{The Slave Configuration State Machine}
|
| 369 | 1551 |
\label{sec:fsm-conf}
|
1552 |
\index{FSM!Slave Configuration}
|
|
1553 |
||
1554 |
The slave configuration state machine, which can be seen in |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1555 |
figure~\ref{fig:fsm-slaveconf}, leads through the process of configuring a
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1556 |
slave and bringing it to a certain application-layer state. |
| 369 | 1557 |
|
1558 |
\begin{figure}[htbp]
|
|
1559 |
\centering |
|
|
1406
8686c5b3d14b
Clear DC assignment after going to INIT.
Florian Pose <fp@igh-essen.com>
parents:
1399
diff
changeset
|
1560 |
\includegraphics[height=\textheight]{graphs/fsm_slave_conf}
|
| 369 | 1561 |
\caption{Transition diagram of the slave configuration state
|
1562 |
machine} |
|
1563 |
\label{fig:fsm-slaveconf}
|
|
1564 |
\end{figure}
|
|
1565 |
||
1566 |
\begin{description}
|
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1567 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1568 |
\item[INIT] The state change FSM is used to bring the slave to the INIT state. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1569 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1570 |
\item[FMMU Clearing] To avoid that the slave reacts on any process data, the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1571 |
FMMU configuration are cleared. If the slave does not support FMMUs, this |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1572 |
state is skipped. If INIT is the requested state, the state machine is |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1573 |
finished. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1574 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1575 |
\item[Mailbox Sync Manager Configuration] If the slaves support mailbox |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1576 |
communication, the mailbox sync managers are configured. Otherwise this state |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1577 |
is skipped. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1578 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1579 |
\item[PREOP] The state change FSM is used to bring the slave to PREOP state. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1580 |
If this is the requested state, the state machine is finished. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1581 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1582 |
\item[SDO Configuration] If there is a slave configuration attached (see |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1583 |
sec.~\ref{sec:masterconfig}), and there are any SDO configurations are
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1584 |
provided by the application, these are sent to the slave. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1585 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1586 |
\item[PDO Configuration] The PDO configuration state machine is executed to |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1587 |
apply all necessary PDO configurations. |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1588 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1589 |
\item[PDO Sync Manager Configuration] If any PDO sync managers exist, they are |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1590 |
configured. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1591 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1592 |
\item[FMMU Configuration] If there are FMMUs configurations supplied by the |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1593 |
application (i.\,e.\ if the application registered PDO entries), they are |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1594 |
applied. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1595 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1596 |
\item[SAFEOP] The state change FSM is used to bring the slave to SAFEOP state. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1597 |
If this is the requested state, the state machine is finished. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1598 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1599 |
\item[OP] The state change FSM is used to bring the slave to OP state. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1600 |
If this is the requested state, the state machine is finished. |
| 369 | 1601 |
|
1602 |
\end{description}
|
|
1603 |
||
1604 |
%------------------------------------------------------------------------------ |
|
1605 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1606 |
\section{The State Change State Machine}
|
| 369 | 1607 |
\label{sec:fsm-change}
|
1608 |
\index{FSM!State Change}
|
|
1609 |
||
1610 |
The state change state machine, which can be seen in |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1611 |
figure~\ref{fig:fsm-change}, leads through the process of changing a slave's
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1612 |
application-layer state. This implements the states and transitions described |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1613 |
in \cite[sec.~6.4.1]{alspec}.
|
| 369 | 1614 |
|
1615 |
\begin{figure}[htbp]
|
|
1616 |
\centering |
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1617 |
\includegraphics[width=.6\textwidth]{graphs/fsm_change}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1618 |
\caption{Transition Diagram of the State Change State Machine}
|
| 369 | 1619 |
\label{fig:fsm-change}
|
1620 |
\end{figure}
|
|
1621 |
||
1622 |
\begin{description}
|
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1623 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1624 |
\item[Start] The new application-layer state is requested via the ``AL Control |
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1625 |
Request'' register (see~\cite[sec. 5.3.1]{alspec}).
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1626 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1627 |
\item[Check for Response] Some slave need some time to respond to an AL state |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1628 |
change command, and do not respond for some time. For this case, the command |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1629 |
is issued again, until it is acknowledged. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1630 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1631 |
\item[Check AL Status] If the AL State change datagram was acknowledged, the |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1632 |
``AL Control Response'' register (see~\cite[sec. 5.3.2]{alspec}) must be read
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1633 |
out until the slave changes the AL state. |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1634 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1635 |
\item[AL Status Code] If the slave refused the state change command, the |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1636 |
reason can be read from the ``AL Status Code'' field in the ``AL State |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1637 |
Changed'' registers (see~\cite[sec. 5.3.3]{alspec}).
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1638 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1639 |
\item[Acknowledge State] If the state change was not successful, the master |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1640 |
has to acknowledge the old state by writing to the ``AL Control request'' |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1641 |
register again. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1642 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1643 |
\item[Check Acknowledge] After sending the acknowledge command, it has to read |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1644 |
out the ``AL Control Response'' register again. |
| 369 | 1645 |
|
1646 |
\end{description}
|
|
1647 |
||
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1648 |
The ``start\_ack'' state is a shortcut in the state machine for the case, that |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1649 |
the master wants to acknowledge a spontaneous AL state change, that was not |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1650 |
requested. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1651 |
|
| 369 | 1652 |
%------------------------------------------------------------------------------ |
1653 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1654 |
\section{The SII State Machine}
|
| 369 | 1655 |
\label{sec:fsm-sii}
|
1656 |
\index{FSM!SII}
|
|
1657 |
||
1658 |
The SII\index{SII} state machine (shown in figure~\ref{fig:fsm-sii})
|
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1659 |
implements the process of reading or writing SII data via the Slave |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1660 |
Information Interface described in \cite[sec.~6.4]{dlspec}.
|
| 369 | 1661 |
|
1662 |
\begin{figure}[htbp]
|
|
1663 |
\centering |
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1664 |
\includegraphics[width=.5\textwidth]{graphs/fsm_sii}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1665 |
\caption{Transition Diagram of the SII State Machine}
|
| 369 | 1666 |
\label{fig:fsm-sii}
|
1667 |
\end{figure}
|
|
1668 |
||
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1669 |
This is how the reading part of the state machine works: |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1670 |
|
| 369 | 1671 |
\begin{description}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1672 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1673 |
\item[Start Reading] The read request and the requested word address are |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1674 |
written to the SII attribute. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1675 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1676 |
\item[Check Read Command] If the SII read request command has been |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1677 |
acknowledged, a timer is started. A datagram is issued, that reads out the SII |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1678 |
attribute for state and data. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1679 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1680 |
\item[Fetch Data] If the read operation is still busy (the SII is usually |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1681 |
implemented as an E$^2$PROM), the state is read again. Otherwise the data are |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1682 |
copied from the datagram. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1683 |
|
| 369 | 1684 |
\end{description}
|
1685 |
||
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1686 |
The writing part works nearly similar: |
| 369 | 1687 |
|
1688 |
\begin{description}
|
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1689 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1690 |
\item[Start Writing] A write request, the target address and the data word are |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1691 |
written to the SII attribute. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1692 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1693 |
\item[Check Write Command] If the SII write request command has been |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1694 |
acknowledged, a timer is started. A datagram is issued, that reads out the SII |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1695 |
attribute for the state of the write operation. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1696 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1697 |
\item[Wait while Busy] If the write operation is still busy (determined by a |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1698 |
minimum wait time and the state of the busy flag), the state machine remains in |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1699 |
this state to avoid that another write operation is issued too early. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1700 |
|
| 369 | 1701 |
\end{description}
|
1702 |
||
1703 |
%------------------------------------------------------------------------------ |
|
1704 |
||
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1705 |
\section{The PDO State Machines}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1706 |
\label{sec:fsm-pdo}
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1707 |
\index{FSM!PDO}
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1708 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1709 |
The PDO state machines are a set of state machines that read or write the PDO |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1710 |
assignment and the PDO mapping via the ``CoE Communication Area'' described in |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1711 |
\cite[sec. 5.6.7.4]{alspec}. For the object access, the CANopen over EtherCAT
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1712 |
access primitives are used (see sec.~\ref{sec:coe}), so the slave must support
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1713 |
the CoE mailbox protocol. |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1714 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1715 |
\paragraph{PDO Reading FSM} This state machine (fig.~\ref{fig:fsm-pdo-read})
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1716 |
has the purpose to read the complete PDO configuration of a slave. It reads |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1717 |
the PDO assignment for each Sync Manager and uses the PDO Entry Reading FSM |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1718 |
(fig.~\ref{fig:fsm-pdo-entry-read}) to read the mapping for each assigned PDO.
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1719 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1720 |
\begin{figure}[htbp]
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1721 |
\centering |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1722 |
\includegraphics[width=.4\textwidth]{graphs/fsm_pdo_read}
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1723 |
\caption{Transition Diagram of the PDO Reading State Machine}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1724 |
\label{fig:fsm-pdo-read}
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1725 |
\end{figure}
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1726 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1727 |
Basically it reads the every Sync manager's PDO assignment SDO's |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1728 |
(\lstinline+0x1C1x+) number of elements to determine the number of assigned |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1729 |
PDOs for this sync manager and then reads out the subindices of the SDO to get |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1730 |
the assigned PDO's indices. When a PDO index is read, the PDO Entry Reading |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1731 |
FSM is executed to read the PDO's mapped PDO entries. |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1732 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1733 |
\paragraph{PDO Entry Reading FSM} This state machine
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1734 |
(fig.~\ref{fig:fsm-pdo-entry-read}) reads the PDO mapping (the PDO entries) of
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1735 |
a PDO. It reads the respective mapping SDO (\lstinline+0x1600+ -- |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
1736 |
\lstinline+0x17ff+, or \lstinline+0x1a00+ -- \lstinline+0x1bff+) for the given |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1737 |
PDO by reading first the subindex zero (number of elements) to determine the |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1738 |
number of mapped PDO entries. After that, each subindex is read to get the |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1739 |
mapped PDO entry index, subindex and bit size. |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1740 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1741 |
\begin{figure}[htbp]
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1742 |
\centering |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1743 |
\includegraphics[width=.4\textwidth]{graphs/fsm_pdo_entry_read}
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1744 |
\caption{Transition Diagram of the PDO Entry Reading State Machine}
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
1745 |
\label{fig:fsm-pdo-entry-read}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1746 |
\end{figure}
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1747 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1748 |
\begin{figure}[htbp]
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1749 |
\centering |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1750 |
\includegraphics[width=.9\textwidth]{graphs/fsm_pdo_conf}
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1751 |
\caption{Transition Diagram of the PDO Configuration State Machine}
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
1752 |
\label{fig:fsm-pdo-conf}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1753 |
\end{figure}
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1754 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1755 |
\begin{figure}[htbp]
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1756 |
\centering |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1757 |
\includegraphics[width=.4\textwidth]{graphs/fsm_pdo_entry_conf}
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1758 |
\caption{Transition Diagram of the PDO Entry Configuration State Machine}
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
1759 |
\label{fig:fsm-pdo-entry-conf}
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1760 |
\end{figure}
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1761 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1762 |
%------------------------------------------------------------------------------ |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1763 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1764 |
\chapter{Mailbox Protocol Implementations}
|
| 369 | 1765 |
\index{Mailbox}
|
1766 |
||
1767 |
The EtherCAT master implements the EoE and the CoE mailbox |
|
1768 |
protocols. See the below section for details. |
|
1769 |
||
1770 |
%------------------------------------------------------------------------------ |
|
1771 |
||
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1772 |
\section{Ethernet over EtherCAT (EoE)}
|
|
1269
fe4688f2c9e7
sec:ecrt is a chapter; sec:eoeimp -> sec:eoe, ...
Florian Pose <fp@igh-essen.com>
parents:
1235
diff
changeset
|
1773 |
\label{sec:eoe}
|
| 369 | 1774 |
\index{EoE}
|
1775 |
||
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1776 |
The EtherCAT master implements the |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1777 |
Ethernet over EtherCAT\nomenclature{EoE}{Ethernet over EtherCAT, Mailbox
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1778 |
Protocol} mailbox protocol~\cite[sec.~5.7]{alspec} to enable the tunneling of
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1779 |
Ethernet frames to special slaves, that can either have physical Ethernet |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1780 |
ports to forward the frames to, or have an own IP stack to receive the frames. |
| 369 | 1781 |
|
1782 |
\paragraph{Virtual Network Interfaces}
|
|
1783 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1784 |
The master creates a virtual EoE network interface for every EoE-capable |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1785 |
slave. These interfaces are called either |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1786 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1787 |
\begin{description}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1788 |
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
1789 |
\item[eoeXsY] for a slave without an alias address (see |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
1790 |
sec.~\ref{sec:ethercat-alias}), where X is the master index and Y is the
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
1791 |
slave's ring position, or |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1792 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1793 |
\item[eoeXaY] for a slave with a non-zero alias address, where X is the master |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1794 |
index and Y is the decimal alias address. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1795 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1796 |
\end{description}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1797 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1798 |
Frames sent to these interfaces are forwarded to the associated slaves by the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1799 |
master. Frames, that are received by the slaves, are fetched by the master and |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1800 |
forwarded to the virtual interfaces. |
| 369 | 1801 |
|
1802 |
This bears the following advantages: |
|
1803 |
||
1804 |
\begin{itemize}
|
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1805 |
|
| 369 | 1806 |
\item Flexibility: The user can decide, how the EoE-capable slaves are |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1807 |
interconnected with the rest of the world. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1808 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1809 |
\item Standard tools can be used to monitor the EoE activity and to configure |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1810 |
the EoE interfaces. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1811 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1812 |
\item The Linux kernel's layer-2-bridging implementation (according to the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1813 |
IEEE 802.1D MAC Bridging standard) can be used natively to bridge Ethernet |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1814 |
traffic between EoE-capable slaves. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1815 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1816 |
\item The Linux kernel's network stack can be used to route packets between |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1817 |
EoE-capable slaves and to track security issues, just like having physical |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1818 |
network interfaces. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1819 |
|
| 369 | 1820 |
\end{itemize}
|
1821 |
||
1822 |
\paragraph{EoE Handlers}
|
|
1823 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1824 |
The virtual EoE interfaces and the related functionality is encapsulated in |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1825 |
the \lstinline+ec_eoe_t+ class. An object of this class is called ``EoE |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1826 |
handler''. For example the master does not create the network interfaces |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1827 |
directly: This is done inside the constructor of an EoE handler. An EoE |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1828 |
handler additionally contains a frame queue. Each time, the kernel passes a |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1829 |
new socket buffer for sending via the interface's |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1830 |
\lstinline+hard_start_xmit()+ callback, the socket buffer is queued for |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1831 |
transmission by the EoE state machine (see below). If the queue gets filled |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1832 |
up, the passing of new socket buffers is suspended with a call to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1833 |
\lstinline+netif_stop_queue()+. |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1834 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1835 |
\paragraph{Creation of EoE Handlers}
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1836 |
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1837 |
During bus scanning (see sec.~\ref{sec:fsm-scan}), the master determines the
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1838 |
supported mailbox protocols foe each slave. This is done by examining the |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1839 |
``Supported Mailbox Protocols'' mask field at word address 0x001C of the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1840 |
SII\index{SII}. If bit 1 is set, the slave supports the EoE protocol. In this
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1841 |
case, an EoE handler is created for that slave. |
| 369 | 1842 |
|
1843 |
\paragraph{EoE State Machine}
|
|
1844 |
\index{FSM!EoE}
|
|
1845 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1846 |
Every EoE handler owns an EoE state machine, that is used to send frames to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1847 |
the corresponding slave and receive frames from the it via the EoE |
| 369 | 1848 |
communication primitives. This state machine is showed in |
1849 |
figure~\ref{fig:fsm-eoe}.
|
|
1850 |
||
1851 |
\begin{figure}[htbp]
|
|
1852 |
\centering |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1853 |
\includegraphics[width=.7\textwidth]{images/fsm-eoe} % FIXME
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1854 |
\caption{Transition Diagram of the EoE State Machine}
|
| 369 | 1855 |
\label{fig:fsm-eoe}
|
1856 |
\end{figure}
|
|
1857 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1858 |
% FIXME |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1859 |
|
| 369 | 1860 |
\begin{description}
|
1861 |
\item[RX\_START] The beginning state of the EoE state machine. A |
|
1862 |
mailbox check datagram is sent, to query the slave's mailbox for new |
|
| 379 | 1863 |
frames. $\rightarrow$~RX\_CHECK |
| 369 | 1864 |
|
1865 |
\item[RX\_CHECK] The mailbox check datagram is received. If the |
|
1866 |
slave's mailbox did not contain data, a transmit cycle is started. |
|
| 379 | 1867 |
$\rightarrow$~TX\_START |
| 369 | 1868 |
|
1869 |
If there are new data in the mailbox, a datagram is sent to fetch |
|
| 379 | 1870 |
the new data. $\rightarrow$~RX\_FETCH |
| 369 | 1871 |
|
1872 |
\item[RX\_FETCH] The fetch datagram is received. If the mailbox data |
|
1873 |
do not contain a ``EoE Fragment request'' command, the data are |
|
1874 |
dropped and a transmit sequence is started. |
|
| 379 | 1875 |
$\rightarrow$~TX\_START |
| 369 | 1876 |
|
1877 |
If the received Ethernet frame fragment is the first fragment, a new |
|
1878 |
socket buffer is allocated. In either case, the data are copied into |
|
1879 |
the correct position of the socket buffer. |
|
1880 |
||
1881 |
If the fragment is the last fragment, the socket buffer is forwarded |
|
1882 |
to the network stack and a transmit sequence is started. |
|
| 379 | 1883 |
$\rightarrow$~TX\_START |
| 369 | 1884 |
|
1885 |
Otherwise, a new receive sequence is started to fetch the next |
|
| 379 | 1886 |
fragment. $\rightarrow$~RX\_\-START |
| 369 | 1887 |
|
1888 |
\item[TX\_START] The beginning state of a transmit sequence. It is |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1889 |
checked, if the transmission queue contains a frame to send. If not, |
| 379 | 1890 |
a receive sequence is started. $\rightarrow$~RX\_START |
| 369 | 1891 |
|
1892 |
If there is a frame to send, it is dequeued. If the queue was |
|
1893 |
inactive before (because it was full), the queue is woken up with a |
|
1894 |
call to \textit{netif\_wake\_queue()}. The first fragment of the
|
|
| 379 | 1895 |
frame is sent. $\rightarrow$~TX\_SENT |
| 369 | 1896 |
|
1897 |
\item[TX\_SENT] It is checked, if the first fragment was sent |
|
1898 |
successfully. If the current frame consists of further fragments, |
|
| 379 | 1899 |
the next one is sent. $\rightarrow$~TX\_SENT |
| 369 | 1900 |
|
1901 |
If the last fragment was sent, a new receive sequence is started. |
|
| 379 | 1902 |
$\rightarrow$~RX\_START |
| 369 | 1903 |
\end{description}
|
1904 |
||
1905 |
\paragraph{EoE Processing}
|
|
1906 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1907 |
To execute the EoE state machine of every active EoE handler, there must be a |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1908 |
cyclic process. The easiest solution would be to execute the EoE state |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1909 |
machines synchronously with the master state machine (see |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1910 |
sec.~\ref{sec:fsm-master}). This approach has the following disadvantage:
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1911 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1912 |
Only one EoE fragment could be sent or received every few cycles. This |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1913 |
causes the data rate to be very low, because the EoE state machines are not |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1914 |
executed in the time between the application cycles. Moreover, the data rate |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1915 |
would be dependent on the period of the application task. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
1916 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1917 |
To overcome this problem, an own cyclic process is needed to asynchronously |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1918 |
execute the EoE state machines. For that, the master owns a kernel timer, that |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1919 |
is executed each timer interrupt. This guarantees a constant bandwidth, but |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1920 |
poses the new problem of concurrent access to the master. The locking |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1921 |
mechanisms needed for this are introduced in sec.~\ref{sec:concurr}.
|
| 369 | 1922 |
|
1923 |
\paragraph{Automatic Configuration}
|
|
1924 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1925 |
By default, slaves are left in PREOP state, if no configuration is applied. If |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1926 |
an EoE interface link is set to ``up'', the requested slave's |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1927 |
application-layer state is automatically set to OP. |
| 369 | 1928 |
|
1929 |
%------------------------------------------------------------------------------ |
|
1930 |
||
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1931 |
\section{CANopen over EtherCAT (CoE)}
|
|
1269
fe4688f2c9e7
sec:ecrt is a chapter; sec:eoeimp -> sec:eoe, ...
Florian Pose <fp@igh-essen.com>
parents:
1235
diff
changeset
|
1932 |
\label{sec:coe}
|
| 369 | 1933 |
\index{CoE}
|
1934 |
||
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1935 |
The CANopen over EtherCAT\nomenclature{CoE}{CANopen over EtherCAT, Mailbox
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1936 |
Protocol} protocol~\cite[sec.~5.6]{alspec} is used to configure slaves and
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
1937 |
exchange data objects on application level. |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1938 |
|
| 1297 | 1939 |
% TODO |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1940 |
% |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1941 |
% Download / Upload |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1942 |
% Expedited / Normal |
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
1943 |
% Segmenting |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1944 |
% SDO Info Services |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1945 |
% |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1946 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
1947 |
\ldots |
| 369 | 1948 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1949 |
\paragraph{SDO Download State Machine}
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1950 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1951 |
The best time to apply SDO configurations is during the slave's PREOP state, |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1952 |
because mailbox communication is already possible and slave's application will |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1953 |
start with updating input data in the succeeding SAFEOP state. Therefore the |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1954 |
SDO configuration has to be part of the slave configuration state machine (see |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1955 |
sec.~\ref{sec:fsm-conf}): It is implemented via an SDO download state machine,
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1956 |
that is executed just before entering the slave's SAFEOP state. In this way, |
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1957 |
it is guaranteed that the SDO configurations are applied each time, the slave |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
1958 |
is reconfigured. |
| 369 | 1959 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1960 |
The transition diagram of the SDO Download state machine can be seen |
| 369 | 1961 |
in figure~\ref{fig:fsm-coedown}.
|
1962 |
||
1963 |
\begin{figure}[htbp]
|
|
1964 |
\centering |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1965 |
\includegraphics[width=.9\textwidth]{images/fsm-coedown} % FIXME
|
| 369 | 1966 |
\caption{Transition diagram of the CoE download state machine}
|
1967 |
\label{fig:fsm-coedown}
|
|
1968 |
\end{figure}
|
|
1969 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1970 |
% FIXME |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
1971 |
|
| 369 | 1972 |
\begin{description}
|
1973 |
\item[START] The beginning state of the CoE download state |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1974 |
machine. The ``SDO Download Normal Request'' mailbox command is |
| 379 | 1975 |
sent. $\rightarrow$~REQUEST |
| 369 | 1976 |
|
1977 |
\item[REQUEST] It is checked, if the CoE download request has been |
|
1978 |
received by the slave. After that, a mailbox check command is issued |
|
| 379 | 1979 |
and a timer is started. $\rightarrow$~CHECK |
| 369 | 1980 |
|
1981 |
\item[CHECK] If no mailbox data is available, the timer is checked. |
|
1982 |
\begin{itemize}
|
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1983 |
\item If it timed out, the SDO download is aborted. |
| 379 | 1984 |
$\rightarrow$~ERROR |
| 369 | 1985 |
\item Otherwise, the mailbox is queried again. |
| 379 | 1986 |
$\rightarrow$~CHECK |
| 369 | 1987 |
\end{itemize}
|
1988 |
||
1989 |
If the mailbox contains new data, the response is fetched. |
|
| 379 | 1990 |
$\rightarrow$~RESPONSE |
| 369 | 1991 |
|
1992 |
\item[RESPONSE] If the mailbox response could not be fetched, the data |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1993 |
is invalid, the wrong protocol was received, or a ``Abort SDO |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1994 |
Transfer Request'' was received, the SDO download is aborted. |
| 379 | 1995 |
$\rightarrow$~ERROR |
| 369 | 1996 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1997 |
If a ``SDO Download Normal Response'' acknowledgement was received, |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1998 |
the SDO download was successful. $\rightarrow$~END |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
1999 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2000 |
\item[END] The SDO download was successful. |
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2001 |
|
|
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2002 |
\item[ERROR] The SDO download was aborted due to an error. |
| 369 | 2003 |
|
2004 |
\end{description}
|
|
2005 |
||
2006 |
%------------------------------------------------------------------------------ |
|
2007 |
||
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2008 |
\section{Vendor specific over EtherCAT (VoE)}
|
|
1270
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2009 |
\label{sec:voe}
|
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2010 |
\index{VoE}
|
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2011 |
|
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2012 |
The VoE protocol opens the possibility to implement a vendor-specific mailbox |
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2013 |
communication protocol. VoE mailbox messages are prepended by a VoE header |
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2014 |
containing a 32-bit vendor ID and a 16-bit vendor-type. There are no more |
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2015 |
constraints regarding this protocol. |
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2016 |
|
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2017 |
The EtherCAT master allows to create multiple VoE handlers per slave |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2018 |
configuration via the application interface (see chap.~\ref{chap:api}). These
|
|
1270
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2019 |
handlers contain the state machine necessary for the communication via VoE. |
| 1298 | 2020 |
|
2021 |
For more information about using VoE handlers, see sec.~\ref{sec:api-voe} or
|
|
2022 |
the example applications provided in the \textit{examples/} subdirectory.
|
|
|
1270
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2023 |
|
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2024 |
%------------------------------------------------------------------------------ |
|
11f4b6e10d74
Version 1.5.0; VoE documentation.
Florian Pose <fp@igh-essen.com>
parents:
1269
diff
changeset
|
2025 |
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2026 |
\chapter{Userspace Interfaces}
|
| 369 | 2027 |
\label{sec:user}
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2028 |
\index{Userspace}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2029 |
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2030 |
For the master runs as a kernel module, accessing it is natively limited to |
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2031 |
analyzing Syslog messages and controlling using \textit{modutils}.
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2032 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2033 |
It was necessary to implement further interfaces, that make it easier to access |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2034 |
the master from userspace and allow a finer influence. It should be possible |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2035 |
to view and to change special parameters at runtime. |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2036 |
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2037 |
Bus visualization is another point: For development and debugging purposes it |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2038 |
is necessary to show the connected slaves with a single command, for instance |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2039 |
(see sec.~\ref{sec:tool}).
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2040 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2041 |
The application interface has to be available in userspace, to allow userspace |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2042 |
programs to use EtherCAT master functionality. This was implemented via a |
| 1282 | 2043 |
character device and a userspace library (see sec.~\ref{sec:userlib}).
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2044 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2045 |
Another aspect is automatic startup and configuration. The master must be able |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2046 |
to automatically start up with a persistent configuration (see |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2047 |
sec.~\ref{sec:system}).
|
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2048 |
|
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2049 |
A last thing is monitoring EtherCAT communication. For debugging purposes, |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2050 |
there had to be a way to analyze EtherCAT datagrams. The best way would be |
|
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2051 |
with a popular network analyzer, like Wireshark \cite{wireshark} (the former
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2052 |
Ethereal) or others (see sec.~\ref{sec:debug}).
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2053 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2054 |
This chapter covers all these points and introduces the interfaces and tools |
|
1203
acb649738601
Some more documentation...
Florian Pose <fp@igh-essen.com>
parents:
1202
diff
changeset
|
2055 |
to make all that possible. |
| 369 | 2056 |
|
2057 |
%------------------------------------------------------------------------------ |
|
2058 |
||
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2059 |
\section{Command-line Tool}
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2060 |
\label{sec:tool}
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2061 |
|
| 1297 | 2062 |
% TODO --master |
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2063 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2064 |
\subsection{Character Devices}
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2065 |
\label{sec:cdev}
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2066 |
|
| 1214 | 2067 |
Each master instance will get a character device as a userspace interface. |
2068 |
The devices are named \textit{/dev/EtherCATx}, where $x \in \{0 \ldots n\}$ is
|
|
2069 |
the index of the master. |
|
2070 |
||
2071 |
\paragraph{Device Node Creation} The character device nodes are automatically
|
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2072 |
created, if the \lstinline+udev+ Package is installed. See |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2073 |
sec.~\ref{sec:autonode} for how to install and configure it.
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2074 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2075 |
%------------------------------------------------------------------------------ |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2076 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2077 |
\subsection{Setting Alias Addresses}
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
2078 |
\label{sec:ethercat-alias}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2079 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2080 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_alias}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2081 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2082 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2083 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2084 |
\subsection{Displaying the Bus Configuration}
|
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
2085 |
\label{sec:ethercat-config}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2086 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2087 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_config}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2088 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2089 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2090 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2091 |
\subsection{Displaying Process Data}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2092 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2093 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_data}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2094 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2095 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2096 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2097 |
\subsection{Setting a Master's Debug Level}
|
|
1399
f79d4bb5b23a
Added debug_level module parameter. debug_level is now unsigned int.
Florian Pose <fp@igh-essen.com>
parents:
1364
diff
changeset
|
2098 |
\label{sec:ethercat-debug}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2099 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2100 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_debug}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2101 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2102 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2103 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2104 |
\subsection{Configured Domains}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2105 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2106 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_domains}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2107 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2108 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2109 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2110 |
\subsection{Master and Ethernet Devices}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2111 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2112 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_master}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2113 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2114 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2115 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2116 |
\subsection{Sync Managers, PDOs and PDO Entries}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2117 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2118 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_pdos}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2119 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2120 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2121 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2122 |
\subsection{SDO Dictionary}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2123 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2124 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_sdos}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2125 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2126 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2127 |
|
|
1327
4d179b06dd3c
merge -c1604 branches/stable-1.4: Fixed spelling of EtherCAT terms.
Florian Pose <fp@igh-essen.com>
parents:
1309
diff
changeset
|
2128 |
\subsection{SDO Access}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2129 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2130 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_download}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2131 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2132 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_upload}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2133 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2134 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2135 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2136 |
\subsection{Slaves on the Bus}
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2137 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2138 |
Slave information can be gathered with the subcommand \lstinline+slaves+: |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2139 |
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2140 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_slaves}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2141 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2142 |
Below is a typical output: |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2143 |
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2144 |
\begin{lstlisting}
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2145 |
$ `\textbf{ethercat slaves}`
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2146 |
0 0:0 PREOP + EK1100 Ethernet Kopplerklemme (2A E-Bus) |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2147 |
1 5555:0 PREOP + EL3162 2K. Ana. Eingang 0-10V |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2148 |
2 5555:1 PREOP + EL4102 2K. Ana. Ausgang 0-10V |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2149 |
3 5555:2 PREOP + EL2004 4K. Dig. Ausgang 24V, 0,5A |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2150 |
\end{lstlisting}
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2151 |
|
| 369 | 2152 |
%------------------------------------------------------------------------------ |
2153 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2154 |
\subsection{SII Access}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2155 |
\label{sec:siiaccess}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2156 |
\index{SII!Access}
|
| 369 | 2157 |
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2158 |
It is possible to directly read or write the complete SII contents of the |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2159 |
slaves. This was introduced for the reasons below: |
| 369 | 2160 |
|
2161 |
\begin{itemize}
|
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2162 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2163 |
\item The format of the SII data is still in development and categories can be |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2164 |
added in the future. With read and write access, the complete memory contents |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2165 |
can be easily backed up and restored. |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2166 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2167 |
\item Some SII data fields have to be altered (like the alias address). A quick |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2168 |
writing must be possible for that. |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2169 |
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2170 |
\item Through reading access, analyzing category data is possible from |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2171 |
userspace. |
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2172 |
|
| 369 | 2173 |
\end{itemize}
|
2174 |
||
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2175 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_sii_read}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2176 |
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2177 |
Reading out SII data is as easy as other commands. Though the data are in |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2178 |
binary format, analysis is easier with a tool like \textit{hexdump}:
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2179 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2180 |
\begin{lstlisting}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2181 |
$ `\textbf{ethercat sii\_read --position 3 | hexdump}`
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2182 |
0000000 0103 0000 0000 0000 0000 0000 0000 008c |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2183 |
0000010 0002 0000 3052 07f0 0000 0000 0000 0000 |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2184 |
0000020 0000 0000 0000 0000 0000 0000 0000 0000 |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2185 |
... |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2186 |
\end{lstlisting}
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2187 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2188 |
Backing up SII contents can easily done with a redirection: |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2189 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2190 |
\begin{lstlisting}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2191 |
$ `\textbf{ethercat sii\_read --position 3 > sii-of-slave3.bin}`
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2192 |
\end{lstlisting}
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2193 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2194 |
To download SII contents to a slave, writing access to the master's character |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2195 |
device is necessary (see sec.~\ref{sec:cdev}).
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2196 |
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2197 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_sii_write}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2198 |
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2199 |
\begin{lstlisting}
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2200 |
# `\textbf{ethercat sii\_write --position 3 sii-of-slave3.bin}`
|
|
1087
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2201 |
\end{lstlisting}
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2202 |
|
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2203 |
The SII contents will be checked for validity and then sent to the slave. The |
|
f1417824cee5
prepared command-line tool.
Florian Pose <fp@igh-essen.com>
parents:
1086
diff
changeset
|
2204 |
write operation may take a few seconds. |
| 369 | 2205 |
|
2206 |
%------------------------------------------------------------------------------ |
|
2207 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2208 |
\subsection{Requesting Application-Layer States}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2209 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2210 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_states}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2211 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2212 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2213 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2214 |
\subsection{Generating Slave Description XML}
|
|
1140
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2215 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2216 |
\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_xml}
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2217 |
|
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2218 |
%------------------------------------------------------------------------------ |
|
cc779f7d2496
Command-line help in the docs.
Florian Pose <fp@igh-essen.com>
parents:
1107
diff
changeset
|
2219 |
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2220 |
\section{Userspace Library}
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2221 |
\label{sec:userlib}
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2222 |
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2223 |
The native application interface (see chap.~\ref{chap:api}) resides in
|
| 1282 | 2224 |
kernelspace and hence is only accessible from inside the kernel. To make the |
2225 |
application interface available from userspace programs, a userspace library |
|
2226 |
has been created, that can be linked to programs under the terms and |
|
2227 |
conditions of the LGPL, version 2 \cite{lgpl}.
|
|
2228 |
||
2229 |
The library is named \textit{libethercat}. Its sources reside in the
|
|
2230 |
\textit{lib/} subdirectory and are build by default when using
|
|
2231 |
\lstinline+make+. It is installed in the \textit{lib/} path below the
|
|
2232 |
installation prefix as \textit{libethercat.a} (for static linking),
|
|
2233 |
\textit{libethercat.la} (for the use with \textit{libtool}) and
|
|
2234 |
\textit{libethercat.so} (for dynamic linking).
|
|
2235 |
||
| 1299 | 2236 |
\subsection{Using the Library}
|
| 1282 | 2237 |
|
2238 |
The application interface header \textit{ecrt.h} can be used both in kernel
|
|
2239 |
and in user context. |
|
2240 |
||
2241 |
The following minimal example shows how to build a program with EtherCAT |
|
2242 |
functionality. An entire example can be found in the \textit{examples/user/}
|
|
2243 |
path of the master sources. |
|
2244 |
||
2245 |
\begin{lstlisting}[language=C]
|
|
2246 |
#include <ecrt.h> |
|
2247 |
||
2248 |
int main(void) |
|
2249 |
{
|
|
2250 |
ec_master_t *master = ecrt_request_master(0); |
|
2251 |
||
2252 |
if (!master) |
|
2253 |
return 1; // error |
|
2254 |
||
2255 |
pause(); // wait for signal |
|
2256 |
return 0; |
|
2257 |
} |
|
2258 |
\end{lstlisting}
|
|
2259 |
||
2260 |
The program can be compiled and dynamically linked to the library with the |
|
2261 |
below command: |
|
2262 |
||
2263 |
\begin{lstlisting}
|
|
2264 |
gcc ethercat.c -o ectest -I/opt/etherlab/include \ |
|
2265 |
-L/opt/etherlab/lib -lethercat \ |
|
2266 |
-Wl,--rpath -Wl,/opt/etherlab/lib |
|
2267 |
\end{lstlisting}
|
|
2268 |
||
2269 |
The library can also be linked statically to the program: |
|
2270 |
||
2271 |
\begin{lstlisting}
|
|
2272 |
gcc -static ectest.c -o ectest -I/opt/etherlab/include \ |
|
2273 |
/opt/etherlab/lib/libethercat.a |
|
2274 |
\end{lstlisting}
|
|
2275 |
||
2276 |
\subsection{Implementation}
|
|
2277 |
\label{sec:userimp}
|
|
2278 |
||
2279 |
Basically the kernel API was transferred into userspace via the master |
|
| 1299 | 2280 |
character device (see chap.~\ref{chap:arch}, fig.~\ref{fig:arch} and
|
2281 |
sec.~\ref{sec:cdev}).
|
|
| 1282 | 2282 |
|
2283 |
The function calls of the kernel API are mapped to the userspace via an |
|
2284 |
\lstinline+ioctl()+ interface. Each function has its own \lstinline+ioctl()+ |
|
2285 |
call. The kernel part of the interface calls the according API functions |
|
2286 |
directly, what results in a minimum additional delay (see |
|
2287 |
sec.~\ref{sec:usertiming}).
|
|
2288 |
||
| 1299 | 2289 |
For performance reasons, the actual domain process data (see |
2290 |
sec.~\ref{sec:processdata}) are not copied between kernel and user memory on
|
|
2291 |
every access: Instead, the data are memory-mapped to the userspace |
|
2292 |
application. Once the master is configured and activated, the master module |
|
2293 |
creates one process data memory area spanning all domains and maps it to |
|
2294 |
userspace, so that the application can directly access the process data. As a |
|
2295 |
result, there is no additional delay when accessing process data from |
|
2296 |
userspace. |
|
2297 |
||
2298 |
\paragraph{Kernel/User API Differences} Because of the memory-mapping of the
|
|
2299 |
process data, the memory is managed internally by the library functions. As a |
|
2300 |
result, it is not possible to provide external memory for domains, like in the |
|
2301 |
kernel API. The corresponding functions are only available in kernelspace. |
|
2302 |
This is the only difference when using the application interface in userspace. |
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2303 |
|
| 1281 | 2304 |
\subsection{Timing}
|
2305 |
\label{sec:usertiming}
|
|
2306 |
||
2307 |
An interesting aspect is the timing of the userspace library calls compared to |
|
2308 |
those of the kernel API. Table~\ref{tab:usertiming} shows the call times and
|
|
2309 |
standard deviancies of typical (and time-critical) API functions measured on |
|
2310 |
an Intel Pentium 4 M CPU with \unit{2.2}{\giga\hertz} and a standard 2.6.26
|
|
2311 |
kernel. |
|
2312 |
||
2313 |
\begin{table}[htbp]
|
|
2314 |
\centering |
|
2315 |
\caption{Application Interface Timing Comparison}
|
|
2316 |
\label{tab:usertiming}
|
|
2317 |
\vspace{2mm}
|
|
2318 |
\begin{tabular}{l|c|c|c|c}
|
|
2319 |
||
2320 |
& |
|
2321 |
\multicolumn{2}{|c}{\textbf{Kernelspace}} &
|
|
2322 |
\multicolumn{2}{|c}{\textbf{Userspace}} \\
|
|
2323 |
||
2324 |
\textbf{Function} &
|
|
2325 |
$\mu(t)$ & |
|
2326 |
$\sigma(t)$ & |
|
2327 |
$\mu(t)$ & |
|
2328 |
$\sigma(t)$ \\ |
|
2329 |
\hline |
|
2330 |
||
2331 |
\lstinline+ecrt_master_receive()+ & |
|
2332 |
\unit{1.1}{\micro\second} &
|
|
2333 |
\unit{0.3}{\micro\second} &
|
|
2334 |
\unit{2.2}{\micro\second} &
|
|
2335 |
\unit{0.5}{\micro\second} \\
|
|
2336 |
||
2337 |
\lstinline+ecrt_domain_process()+ & |
|
2338 |
\unit{<0.1}{\micro\second} &
|
|
2339 |
\unit{<0.1}{\micro\second} &
|
|
2340 |
\unit{1.0}{\micro\second} &
|
|
2341 |
\unit{0.2}{\micro\second} \\
|
|
2342 |
||
2343 |
\lstinline+ecrt_domain_queue()+ & |
|
2344 |
\unit{<0.1}{\micro\second} &
|
|
2345 |
\unit{<0.1}{\micro\second} &
|
|
2346 |
\unit{1.0}{\micro\second} &
|
|
2347 |
\unit{0.1}{\micro\second} \\
|
|
2348 |
||
2349 |
\lstinline+ecrt_master_send()+ & |
|
2350 |
\unit{1.8}{\micro\second} &
|
|
2351 |
\unit{0.2}{\micro\second} &
|
|
2352 |
\unit{2.5}{\micro\second} &
|
|
2353 |
\unit{0.5}{\micro\second} \\
|
|
2354 |
||
2355 |
\end{tabular}
|
|
2356 |
\end{table}
|
|
2357 |
||
| 1282 | 2358 |
The test results show, that for this configuration, the userspace API causes |
2359 |
about \unit{1}{\micro\second} additional delay for each function, compared to
|
|
2360 |
the kernel API. |
|
| 1281 | 2361 |
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2362 |
%------------------------------------------------------------------------------ |
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2363 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2364 |
\section{System Integration}
|
| 369 | 2365 |
\label{sec:system}
|
2366 |
||
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2367 |
To integrate the EtherCAT master as a service into a running system, it comes |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2368 |
with an init script and a sysconfig file, that are described below. |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2369 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2370 |
\subsection{Init Script}
|
| 369 | 2371 |
\label{sec:init}
|
2372 |
\index{Init script}
|
|
2373 |
||
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2374 |
The EtherCAT master init script conforms to the requirements of the ``Linux |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2375 |
Standard Base'' (LSB\index{LSB}, \cite{lsb}). The script is installed to
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2376 |
\textit{etc/init.d/ethercat} below the installation prefix and has to be
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2377 |
copied (or better: linked) to the appropriate location (see |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2378 |
sec.~\ref{sec:installation}), before the master can be inserted as a service.
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2379 |
Please note, that the init script depends on the sysconfig file described |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2380 |
below. |
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2381 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2382 |
To provide service dependencies (i.\,e.\ which services have to be started |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2383 |
before others) inside the init script code, LSB defines a special comment |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2384 |
block. System tools can extract this information to insert the EtherCAT init |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2385 |
script at the correct place in the startup sequence: |
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2386 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2387 |
\lstinputlisting[firstline=38,lastline=48] |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2388 |
{../script/init.d/ethercat}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2389 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2390 |
\subsection{Sysconfig File}
|
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2391 |
\label{sec:sysconfig}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2392 |
\index{Sysconfig file}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2393 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2394 |
For persistent configuration, the init script uses a sysconfig file installed |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2395 |
to \textit{etc/sysconfig/ethercat} (below the installation prefix), that is
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2396 |
mandatory for the init script. The sysconfig file contains all configuration |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2397 |
variables needed to operate one or more masters. The documentation is inside |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2398 |
the file and included below: |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2399 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2400 |
\lstinputlisting[numbers=left,firstline=9,basicstyle=\ttfamily\scriptsize] |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2401 |
{../script/sysconfig/ethercat}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2402 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2403 |
\subsection{Starting the Master as a Service}
|
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2404 |
\label{sec:service}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2405 |
\index{Service}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2406 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2407 |
After the init script and the sysconfig file are placed into the right |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2408 |
location, the EtherCAT master can be inserted as a service. The different Linux |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2409 |
distributions offer different ways to mark a service for starting and stopping |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2410 |
in certain runlevels. For example, SUSE Linux provides the \textit{insserv}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2411 |
command: |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2412 |
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2413 |
\begin{lstlisting}
|
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2414 |
# `\textbf{insserv ethercat}`
|
| 369 | 2415 |
\end{lstlisting}
|
2416 |
||
2417 |
The init script can also be used for manually starting and stopping |
|
2418 |
the EtherCAT master. It has to be executed with one of the parameters |
|
| 379 | 2419 |
\texttt{start}, \texttt{stop}, \texttt{restart} or \texttt{status}.
|
| 369 | 2420 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2421 |
\begin{lstlisting}[gobble=2]
|
| 379 | 2422 |
# `\textbf{/etc/init.d/ethercat restart}`
|
| 369 | 2423 |
Shutting down EtherCAT master done |
2424 |
Starting EtherCAT master done |
|
2425 |
\end{lstlisting}
|
|
2426 |
||
2427 |
%------------------------------------------------------------------------------ |
|
2428 |
||
|
1307
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2429 |
\section{Debug Interfaces}
|
| 369 | 2430 |
\label{sec:debug}
|
|
1307
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2431 |
\index{Debug Interfaces}
|
| 369 | 2432 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2433 |
EtherCAT buses can always be monitored by inserting a switch between master |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2434 |
and slaves. This allows to connect another PC with a network monitor like |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2435 |
Wireshark~\cite{wireshark}, for example.
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2436 |
|
|
1307
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2437 |
For convenience, so-called ``debug interfaces'' are supported. Debug |
|
1308
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2438 |
interfaces are virtual network interfaces allowing to capture EtherCAT traffic |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2439 |
with a network monitor (like Wireshark or tcpdump) running on the master |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2440 |
machine without using external hardware. To use this functionality, the master |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2441 |
sources have to be configured with the \lstinline+--enable-debug-if+ switch |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2442 |
(see sec.~\ref{sec:installation}).
|
|
1307
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2443 |
|
|
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2444 |
Every EtherCAT master registers a read-only network interface per attached |
|
1308
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2445 |
physical Ethernet device. The network interfaces are named \textit{ecdbgmX}
|
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2446 |
for the main device, and \textit{ecdbgbX} for the backup device (for future
|
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2447 |
use), where X is the master index. The below listing shows a debug interface |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2448 |
among some standard network interfaces: |
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2449 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2450 |
\begin{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2451 |
# `\textbf{ip link}`
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2452 |
1: lo: <LOOPBACK,UP> mtu 16436 qdisc noqueue |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2453 |
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2454 |
4: eth0: <BROADCAST,MULTICAST> mtu 1500 qdisc noop qlen 1000 |
|
1307
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2455 |
link/ether 00:13:46:3b:ad:d7 brd ff:ff:ff:ff:ff:ff |
|
1308
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2456 |
8: ecdbgm0: <BROADCAST,MULTICAST> mtu 1500 qdisc pfifo_fast |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2457 |
qlen 1000 |
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2458 |
link/ether 00:04:61:03:d1:01 brd ff:ff:ff:ff:ff:ff |
|
1307
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2459 |
\end{lstlisting}
|
|
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2460 |
|
|
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2461 |
While a debug interface is enabled, all frames sent or received to or from the |
|
45a82ad140f8
New debug interfaces docs.
Florian Pose <fp@igh-essen.com>
parents:
1306
diff
changeset
|
2462 |
physical device are additionally forwarded to the debug interface by the |
|
1308
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2463 |
corresponding master. Network interfaces can be enabled with the below |
|
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2464 |
command: |
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2465 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2466 |
\begin{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2467 |
# `\textbf{ip link set dev ecdbgm0 up}`
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2468 |
\end{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2469 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2470 |
Please note, that the frame rate can be very high. With an application |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2471 |
connected, the debug interface can produce thousands of frames per second. |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2472 |
|
| 1309 | 2473 |
\paragraph{Attention} The socket buffers needed for the operation of debug
|
2474 |
interfaces have to be allocated dynamically. Some Linux realtime extensions do |
|
|
1308
c8b82c27b6df
Improved new debug interfaces again.
Florian Pose <fp@igh-essen.com>
parents:
1307
diff
changeset
|
2475 |
not allow this in realtime context! |
| 369 | 2476 |
|
2477 |
%------------------------------------------------------------------------------ |
|
2478 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2479 |
\chapter{Timing Aspects}
|
| 369 | 2480 |
\label{sec:timing}
|
2481 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2482 |
Although EtherCAT's timing is highly deterministic and therefore timing issues |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2483 |
are rare, there are a few aspects that can (and should be) dealt with. |
| 369 | 2484 |
|
2485 |
%------------------------------------------------------------------------------ |
|
2486 |
||
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2487 |
\subsection{Application Interface Profiling}
|
| 369 | 2488 |
\label{sec:timing-profile}
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2489 |
\index{Profiling}
|
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2490 |
% FIXME |
| 369 | 2491 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2492 |
One of the most important timing aspects are the execution times of the |
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2493 |
application interface functions, that are called in cyclic context. These |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2494 |
functions make up an important part of the overall timing of the application. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2495 |
To measure the timing of the functions, the following code was used: |
| 369 | 2496 |
|
2497 |
\begin{lstlisting}[gobble=2,language=C]
|
|
2498 |
c0 = get_cycles(); |
|
2499 |
ecrt_master_receive(master); |
|
2500 |
c1 = get_cycles(); |
|
2501 |
ecrt_domain_process(domain1); |
|
2502 |
c2 = get_cycles(); |
|
2503 |
ecrt_master_run(master); |
|
2504 |
c3 = get_cycles(); |
|
2505 |
ecrt_master_send(master); |
|
2506 |
c4 = get_cycles(); |
|
2507 |
\end{lstlisting}
|
|
2508 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2509 |
Between each call of an interface function, the CPU timestamp counter is read. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2510 |
The counter differences are converted to \micro\second\ with help of the |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2511 |
\lstinline+cpu_khz+ variable, that contains the number of increments per |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2512 |
\milli\second. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2513 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2514 |
For the actual measuring, a system with a \unit{2.0}{\giga\hertz} CPU was used,
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2515 |
that ran the above code in an RTAI thread with a period of |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2516 |
\unit{100}{\micro\second}. The measuring was repeated $n = 100$ times and the
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2517 |
results were averaged. These can be seen in table~\ref{tab:profile}.
|
| 369 | 2518 |
|
2519 |
\begin{table}[htpb]
|
|
2520 |
\centering |
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2521 |
\caption{Profiling of an Application Cycle on a \unit{2.0}{\giga\hertz}
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2522 |
Processor} |
| 369 | 2523 |
\label{tab:profile}
|
2524 |
\vspace{2mm}
|
|
2525 |
\begin{tabular}{l|r|r}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2526 |
Element & Mean Duration [\second] & Standard Deviancy [\micro\second] \\ |
| 369 | 2527 |
\hline |
2528 |
\textit{ecrt\_master\_receive()} & 8.04 & 0.48\\
|
|
2529 |
\textit{ecrt\_domain\_process()} & 0.14 & 0.03\\
|
|
2530 |
\textit{ecrt\_master\_run()} & 0.29 & 0.12\\
|
|
2531 |
\textit{ecrt\_master\_send()} & 2.18 & 0.17\\ \hline
|
|
2532 |
Complete Cycle & 10.65 & 0.69\\ \hline |
|
2533 |
\end{tabular}
|
|
2534 |
\end{table}
|
|
2535 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2536 |
It is obvious, that the functions accessing hardware make up the |
| 369 | 2537 |
lion's share. The \textit{ec\_master\_receive()} executes the ISR of
|
2538 |
the Ethernet device, analyzes datagrams and copies their contents into |
|
2539 |
the memory of the datagram objects. The \textit{ec\_master\_send()}
|
|
2540 |
assembles a frame out of different datagrams and copies it to the |
|
2541 |
hardware buffers. Interestingly, this makes up only a quarter of the |
|
2542 |
receiving time. |
|
2543 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2544 |
The functions that only operate on the masters internal data structures are |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2545 |
very fast ($\Delta t < \unit{1}{\micro\second}$). Interestingly the runtime of
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2546 |
\textit{ec\_domain\_process()} has a small standard deviancy relative to the
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2547 |
mean value, while this ratio is about twice as big for |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2548 |
\textit{ec\_master\_run()}: This probably results from the latter function
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2549 |
having to execute code depending on the current state and the different state |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2550 |
functions are more or less complex. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2551 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2552 |
For a realtime cycle makes up about \unit{10}{\micro\second}, the theoretical
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2553 |
frequency can be up to \unit{100}{\kilo\hertz}. For two reasons, this frequency
|
| 369 | 2554 |
keeps being theoretical: |
2555 |
||
2556 |
\begin{enumerate}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2557 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2558 |
\item The processor must still be able to run the operating system between the |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2559 |
realtime cycles. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2560 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2561 |
\item The EtherCAT frame must be sent and received, before the next realtime |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2562 |
cycle begins. The determination of the bus cycle time is difficult and covered |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2563 |
in sec.~\ref{sec:timing-bus}.
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2564 |
|
| 369 | 2565 |
\end{enumerate}
|
2566 |
||
2567 |
%------------------------------------------------------------------------------ |
|
2568 |
||
2569 |
\subsection{Bus Cycle Measuring}
|
|
2570 |
\label{sec:timing-bus}
|
|
2571 |
\index{Bus cycle}
|
|
2572 |
||
| 1297 | 2573 |
For measuring the time, a frame is ``on the wire'', two timestamps must be |
2574 |
taken: |
|
| 369 | 2575 |
|
2576 |
\begin{enumerate}
|
|
| 1297 | 2577 |
|
2578 |
\item The time, the Ethernet hardware begins with physically sending the |
|
2579 |
frame. |
|
2580 |
||
2581 |
\item The time, the frame is completely received by the Ethernet hardware. |
|
2582 |
||
| 369 | 2583 |
\end{enumerate}
|
2584 |
||
2585 |
Both times are difficult to determine. The first reason is, that the |
|
| 1297 | 2586 |
interrupts are disabled and the master is not notified, when a frame is sent |
2587 |
or received (polling would distort the results). The second reason is, that |
|
2588 |
even with interrupts enabled, the time from the event to the notification is |
|
2589 |
unknown. Therefore the only way to confidently determine the bus cycle time is |
|
2590 |
an electrical measuring. |
|
| 369 | 2591 |
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2592 |
Anyway, the bus cycle time is an important factor when designing realtime |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2593 |
code, because it limits the maximum frequency for the cyclic task of the |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2594 |
application. In practice, these timing parameters are highly dependent on the |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2595 |
hardware and often a trial and error method must be used to determine the |
|
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2596 |
limits of the system. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2597 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2598 |
The central question is: What happens, if the cycle frequency is too high? The |
| 1297 | 2599 |
answer is, that the EtherCAT frames that have been sent at the end of the |
2600 |
cycle are not yet received, when the next cycle starts. First this is noticed |
|
2601 |
by \textit{ecrt\_domain\_process()}, because the working counter of the
|
|
2602 |
process data datagrams were not increased. The function will notify the user |
|
2603 |
via Syslog\footnote{To limit Syslog output, a mechanism has been implemented,
|
|
2604 |
that outputs a summarized notification at maximum once a second.}. In this |
|
2605 |
case, the process data keeps being the same as in the last cycle, because it |
|
2606 |
is not erased by the domain. When the domain datagrams are queued again, the |
|
2607 |
master notices, that they are already queued (and marked as sent). The master |
|
2608 |
will mark them as unsent again and output a warning, that datagrams were |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2609 |
``skipped''. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2610 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2611 |
On the mentioned \unit{2.0}{\giga\hertz} system, the possible cycle frequency
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2612 |
can be up to \unit{25}{\kilo\hertz} without skipped frames. This value can
|
| 1297 | 2613 |
surely be increased by choosing faster hardware. Especially the RealTek |
2614 |
network hardware could be replaced by a faster one. Besides, implementing a |
|
2615 |
dedicated ISR for EtherCAT devices would also contribute to increasing the |
|
2616 |
latency. These are two points on the author's to-do list. |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2617 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2618 |
%------------------------------------------------------------------------------ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2619 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2620 |
\chapter{Installation}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2621 |
\label{sec:installation}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2622 |
\index{Master!Installation}
|
| 369 | 2623 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2624 |
\section{Building the Software}
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2625 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2626 |
The current EtherCAT master code is available at~\cite{etherlab} or can be
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2627 |
obtained from the EtherLab CD. The \textit{tar.bz2} file has to be unpacked
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2628 |
with the commands below (or similar): |
| 369 | 2629 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2630 |
\begin{lstlisting}[gobble=2]
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2631 |
$ `\textbf{tar xjf ethercat-\masterversion.tar.bz2}`
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2632 |
$ `\textbf{cd ethercat-\masterversion/}`
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2633 |
\end{lstlisting}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2634 |
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2635 |
The tarball was created with GNU Autotools, so the build process |
| 487 | 2636 |
follows the below commands: |
| 369 | 2637 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2638 |
\begin{lstlisting}[gobble=2]
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2639 |
$ `\textbf{./configure}`
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2640 |
$ `\textbf{make}`
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2641 |
$ `\textbf{make modules}`
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2642 |
\end{lstlisting}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2643 |
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2644 |
Table~\ref{tab:config} lists important configuration switches and options.
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2645 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2646 |
\begin{table}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2647 |
\caption{Configuration options}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2648 |
\label{tab:config}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2649 |
\vspace{2mm}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2650 |
\begin{tabular}{l|p{.3\textwidth}|l}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2651 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2652 |
\bf Option/Switch & \bf Description & \bf Default\\\hline |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2653 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2654 |
\lstinline+--prefix+ & Installation prefix & \textit{/opt/etherlab}\\
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2655 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2656 |
\lstinline+--with-linux-dir+ & Linux kernel sources & Use running kernel\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2657 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2658 |
\lstinline+--with-rtai-dir+ & RTAI path (only for RTAI example) & \\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2659 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2660 |
\hline |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2661 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2662 |
\lstinline+--enable-eoe+ & Enable EoE support & yes\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2663 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2664 |
\lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2665 |
architecture to get finer timing calculation. & no\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2666 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2667 |
\lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2668 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2669 |
\lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2670 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2671 |
\hline |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2672 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2673 |
\lstinline+--enable-8139too+ & Build the 8139too driver & yes\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2674 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2675 |
\lstinline+--with-8139too-kernel+ & 8139too kernel & $\dagger$\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2676 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2677 |
\lstinline+--enable-e100+ & Build the e100 driver & no\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2678 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2679 |
\lstinline+--with-e100-kernel+ & e100 kernel & $\dagger$\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2680 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2681 |
\lstinline+--enable-e1000+ & Enable e1000 driver & no\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2682 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2683 |
\lstinline+--with-e1000-kernel+ & e1000 kernel & $\dagger$\\ |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2684 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2685 |
\end{tabular}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2686 |
\vspace{2mm}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2687 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2688 |
\begin{description}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2689 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2690 |
\item[$\dagger$] If this option is not specified, the kernel version to use is |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2691 |
extracted from the Linux kernel sources. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2692 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2693 |
\end{description}
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2694 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2695 |
\end{table}
|
| 487 | 2696 |
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2697 |
\section{Building the Interface Documentation}
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2698 |
\label{sec:gendoc}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2699 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2700 |
The source code is documented using Doxygen~\cite{doxygen}. To build the HTML
|
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2701 |
documentation, the Doxygen software has to be installed. The below command |
| 1095 | 2702 |
will generate the documents in the subdirectory \textit{doxygen-output}:
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2703 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2704 |
\begin{lstlisting}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2705 |
$ `\textbf{make doc}`
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2706 |
\end{lstlisting}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2707 |
|
|
1204
4e3e8400c338
Removed examples; fixed undefines references; preliminary version.
Florian Pose <fp@igh-essen.com>
parents:
1203
diff
changeset
|
2708 |
The interface documentation can be viewed by pointing a browser to the file |
|
1293
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
2709 |
\textit{doxygen-output/html/index.html}. The functions and data structures of
|
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
2710 |
the application interface a covered by an own module ``Application |
|
a2a03519ee47
Prcess data; slave configuration + attachment; typos.
Florian Pose <fp@igh-essen.com>
parents:
1292
diff
changeset
|
2711 |
Interface''. |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2712 |
|
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2713 |
\section{Installing the Software}
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2714 |
|
|
1106
745a0cc03143
Added depmod call to docs.
Florian Pose <fp@igh-essen.com>
parents:
1095
diff
changeset
|
2715 |
The below commands have to be entered as \textit{root}: The first one will
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2716 |
install the EtherCAT header, init script, sysconfig file and the userspace |
|
1202
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2717 |
tool to the prefix path. The second one will install the kernel modules to the |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2718 |
kernel's modules directory. The final \lstinline+depmod+ call is necessary to |
|
91d190223daa
Next changes for the documentation.
Florian Pose <fp@igh-essen.com>
parents:
1140
diff
changeset
|
2719 |
include the kernel modules into the \textit{modules.dep} file to make it
|
|
1106
745a0cc03143
Added depmod call to docs.
Florian Pose <fp@igh-essen.com>
parents:
1095
diff
changeset
|
2720 |
available to the \lstinline+modprobe+ command, used in the init script. |
| 369 | 2721 |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2722 |
\begin{lstlisting}
|
|
1106
745a0cc03143
Added depmod call to docs.
Florian Pose <fp@igh-essen.com>
parents:
1095
diff
changeset
|
2723 |
# `\textbf{make install}`
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2724 |
# `\textbf{make modules\_install}`
|
|
1106
745a0cc03143
Added depmod call to docs.
Florian Pose <fp@igh-essen.com>
parents:
1095
diff
changeset
|
2725 |
# `\textbf{depmod}`
|
| 369 | 2726 |
\end{lstlisting}
|
2727 |
||
| 1095 | 2728 |
If the target kernel's modules directory is not under \textit{/lib/modules}, a
|
2729 |
different destination directory can be specified with the \lstinline+DESTDIR+ |
|
2730 |
make variable. For example: |
|
| 487 | 2731 |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2732 |
\begin{lstlisting}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2733 |
# `\textbf{make DESTDIR=/vol/nfs/root modules\_install}`
|
| 487 | 2734 |
\end{lstlisting}
|
2735 |
||
2736 |
This command will install the compiled kernel modules to |
|
2737 |
\textit{/vol/nfs/root/lib/modules}, prepended by the kernel release.
|
|
2738 |
||
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2739 |
If the EtherCAT master shall be run as a service\footnote{Even if the EtherCAT
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2740 |
master shall not be loaded on system startup, the use of the init script is |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2741 |
recommended for manual (un-)loading.} (see sec.~\ref{sec:system}), the init
|
|
1086
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2742 |
script and the sysconfig file have to be copied (or linked) to the appropriate |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2743 |
locations. The below example is suitable for SUSE Linux. It may vary for other |
|
722ead4ecc22
Doc: Architecture, master module, system integration.
Florian Pose <fp@igh-essen.com>
parents:
1085
diff
changeset
|
2744 |
distributions. |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2745 |
|
| 1107 | 2746 |
% FIXME relative ln -s? |
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2747 |
\begin{lstlisting}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2748 |
# `\textbf{cd /opt/etherlab}`
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2749 |
# `\textbf{cp etc/sysconfig/ethercat /etc/sysconfig/}`
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2750 |
# `\textbf{ln -s etc/init.d/ethercat /etc/init.d/}`
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2751 |
# `\textbf{insserv ethercat}`
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2752 |
\end{lstlisting}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
2753 |
|
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
2754 |
Now the sysconfig file \texttt{/etc/sysconfig/ethercat} (see
|
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2755 |
sec.~\ref{sec:sysconfig}) has to be customized. The minimal customization is
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2756 |
to set the \lstinline+MASTER0_DEVICE+ variable to the MAC address of the |
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2757 |
Ethernet device to use (or \lstinline+ff:ff:ff:ff:ff:ff+ to use the first |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2758 |
device offered) and selecting the driver(s) to load via the |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2759 |
\lstinline+DEVICE_MODULES+ variable. |
| 369 | 2760 |
|
| 1297 | 2761 |
After the basic configuration is done, the master can be started with the |
2762 |
below command: |
|
| 369 | 2763 |
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2764 |
\begin{lstlisting}
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2765 |
# `\textbf{/etc/init.d/ethercat start}`
|
| 369 | 2766 |
\end{lstlisting}
|
2767 |
||
| 1214 | 2768 |
At this time, the operation of the master can be observed by viewing the |
2769 |
Syslog\index{Syslog} messages, which should look like the ones below. If
|
|
2770 |
EtherCAT slaves are connected to the master's EtherCAT device, the activity |
|
2771 |
indicators should begin to flash. |
|
| 369 | 2772 |
|
2773 |
\begin{lstlisting}[numbers=left]
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2774 |
EtherCAT: Master driver `\masterversion` |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2775 |
EtherCAT: 1 master waiting for devices. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2776 |
EtherCAT Intel(R) PRO/1000 Network Driver - version 6.0.60-k2 |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2777 |
Copyright (c) 1999-2005 Intel Corporation. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2778 |
PCI: Found IRQ 12 for device 0000:01:01.0 |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2779 |
PCI: Sharing IRQ 12 with 0000:00:1d.2 |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2780 |
PCI: Sharing IRQ 12 with 0000:00:1f.1 |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2781 |
EtherCAT: Accepting device 00:0E:0C:DA:A2:20 for master 0. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2782 |
EtherCAT: Starting master thread. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2783 |
ec_e1000: ec0: e1000_probe: Intel(R) PRO/1000 Network |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2784 |
Connection |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2785 |
ec_e1000: ec0: e1000_watchdog_task: NIC Link is Up 100 Mbps |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2786 |
Full Duplex |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2787 |
EtherCAT: Link state changed to UP. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2788 |
EtherCAT: 7 slave(s) responding. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2789 |
EtherCAT: Slave states: PREOP. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2790 |
EtherCAT: Scanning bus. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2791 |
EtherCAT: Bus scanning completed in 431 ms. |
| 369 | 2792 |
\end{lstlisting}
|
2793 |
||
2794 |
\begin{description}
|
|
|
1085
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2795 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2796 |
\item[\linenum{1} -- \linenum{2}] The master module is loading, and one master
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2797 |
is initialized. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2798 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2799 |
\item[\linenum{3} -- \linenum{8}] The EtherCAT-capable e1000 driver is
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2800 |
loading. The master accepts the device with the address |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2801 |
\lstinline+00:0E:0C:DA:A2:20+. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2802 |
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2803 |
\item[\linenum{9} -- \linenum{16}] The master goes to idle phase, starts its
|
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2804 |
state machine and begins scanning the bus. |
|
c75cdcc5ce87
Started to re-write the documentation.
Florian Pose <fp@igh-essen.com>
parents:
917
diff
changeset
|
2805 |
|
| 369 | 2806 |
\end{description}
|
2807 |
||
| 1214 | 2808 |
\section{Automatic Device Node Creation}
|
2809 |
\label{sec:autonode}
|
|
2810 |
||
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2811 |
The \lstinline+ethercat+ command-line tool (see sec.~\ref{sec:tool})
|
| 1214 | 2812 |
communicates with the master via a character device. The corresponding device |
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2813 |
nodes are created automatically, if the udev daemon is running. Note, that on |
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2814 |
some distributions, the \lstinline+udev+ package is not installed by default. |
| 1214 | 2815 |
|
2816 |
The device nodes will be created with mode \lstinline+0660+ and group |
|
| 1292 | 2817 |
\lstinline+root+ by default. If ``normal'' users shall have reading access, a |
2818 |
udev rule file (for example \textit{/etc/udev/rules.d/99-EtherCAT.rules}) has
|
|
2819 |
to be created with the following contents: |
|
| 1214 | 2820 |
|
2821 |
\begin{lstlisting}
|
|
2822 |
KERNEL=="EtherCAT[0-9]*", MODE="0664" |
|
2823 |
\end{lstlisting}
|
|
2824 |
||
2825 |
After the udev rule file is created and the EtherCAT master is restarted with |
|
2826 |
\lstinline[breaklines=true]+/etc/init.d/ethercat restart+, the device node |
|
2827 |
will be automatically created with the desired rights: |
|
2828 |
||
2829 |
\begin{lstlisting}
|
|
2830 |
# `\textbf{ls -l /dev/EtherCAT0}`
|
|
2831 |
crw-rw-r-- 1 root root 252, 0 2008-09-03 16:19 /dev/EtherCAT0 |
|
2832 |
\end{lstlisting}
|
|
2833 |
||
|
1289
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2834 |
Now, the \lstinline+ethercat+ tool can be used (see sec.~\ref{sec:tool}) even
|
|
5b82b6b39c2d
Removed unnecessary modules; renamed references.
Florian Pose <fp@igh-essen.com>
parents:
1283
diff
changeset
|
2835 |
as a non-root user. |
| 1214 | 2836 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2837 |
If non-root users shall have writing access, the following udev rule can be |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2838 |
used instead: |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2839 |
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2840 |
\begin{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2841 |
KERNEL=="EtherCAT[0-9]*", MODE="0664", GROUP="users" |
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2842 |
\end{lstlisting}
|
|
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2843 |
|
| 369 | 2844 |
%------------------------------------------------------------------------------ |
2845 |
||
2846 |
\begin{thebibliography}{99}
|
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2847 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2848 |
\bibitem{etherlab} Ingenieurgemeinschaft IgH: EtherLab -- Open Source Toolkit
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2849 |
for rapid realtime code generation under Linux with Simulink/RTW and EtherCAT |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2850 |
technology. \url{http://etherlab.org/en}, 2008.
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2851 |
|
| 369 | 2852 |
\bibitem{dlspec} IEC 61158-4-12: Data-link Protocol Specification.
|
| 1095 | 2853 |
International Electrotechnical Commission (IEC), 2005. |
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2854 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2855 |
\bibitem{alspec} IEC 61158-6-12: Application Layer Protocol Specification.
|
| 1095 | 2856 |
International Electrotechnical Commission (IEC), 2005. |
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2857 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2858 |
\bibitem{gpl} GNU General Public License, Version 2.
|
|
1275
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2859 |
\url{http://www.gnu.org/licenses/gpl-2.0.html}. October~15, 2008.
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2860 |
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2861 |
\bibitem{lgpl} GNU Lesser General Public License, Version 2.1.
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2862 |
\url{http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html}. October~15,
|
|
c9de1c0c1f51
*space without whitespace; licensing; userspace interfaces.
Florian Pose <fp@igh-essen.com>
parents:
1270
diff
changeset
|
2863 |
2008. |
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2864 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2865 |
\bibitem{lsb} Linux Standard Base.
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2866 |
\url{http://www.linuxfoundation.org/en/LSB}. August~9, 2006.
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2867 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2868 |
\bibitem{wireshark} Wireshark. \url{http://www.wireshark.org}. 2008.
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2869 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2870 |
\bibitem{automata} {\it Hopcroft, J.\,E.\ / Ullman, J.\,D.}: Introduction to
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2871 |
Automata Theory, Languages and Computation. Adison-Wesley, Reading, |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2872 |
Mass.~1979. |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2873 |
|
|
1306
a27c839d043b
merge -r1566:1573 branches/stable-1.4: Documentation.
Florian Pose <fp@igh-essen.com>
parents:
1299
diff
changeset
|
2874 |
\bibitem{fsmmis} {\it Wagner, F.\ / Wolstenholme, P.}: State machine
|
|
1094
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2875 |
misunderstandings. In: IEE journal ``Computing and Control Engineering'', |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2876 |
2004. |
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2877 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2878 |
\bibitem{rtai} RTAI. The RealTime Application Interface for Linux from DIAPM.
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2879 |
\url{http://www.rtai.org}, 2006.
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2880 |
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2881 |
\bibitem{doxygen} Doxygen. Source code documentation generator tool.
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2882 |
\url{http://www.stack.nl/~dimitri/doxygen}, 2008.
|
|
eb0258e53236
App interface; doxygen; bib.
Florian Pose <fp@igh-essen.com>
parents:
1087
diff
changeset
|
2883 |
|
| 369 | 2884 |
\end{thebibliography}
|
2885 |
||
|
917
07b0ad9722a1
Fixed bug concerning listings package.
Florian Pose <fp@igh-essen.com>
parents:
814
diff
changeset
|
2886 |
\printnomenclature |
| 369 | 2887 |
\addcontentsline{toc}{chapter}{\nomname}
|
2888 |
\markleft{\nomname}
|
|
2889 |
||
2890 |
\printindex |
|
2891 |
\markleft{Index}
|
|
2892 |
||
2893 |
%------------------------------------------------------------------------------ |
|
2894 |
||
2895 |
\end{document}
|
|
2896 |
||
2897 |
%------------------------------------------------------------------------------ |