| author | Florian Pose <fp@igh-essen.com> |
| Fri, 09 Mar 2007 15:11:29 +0000 | |
| changeset 646 | fbbd4e54e031 |
| parent 487 | 448b0b23b905 |
| child 813 | bfc3f1ab52de |
| permissions | -rw-r--r-- |
| 369 | 1 |
%------------------------------------------------------------------------------ |
2 |
% |
|
3 |
% IgH EtherCAT Master Documentation |
|
4 |
% |
|
5 |
% $Id$ |
|
6 |
% |
|
7 |
%------------------------------------------------------------------------------ |
|
8 |
||
9 |
\documentclass[a4paper,12pt,BCOR6mm,bibtotoc,idxtotoc]{scrbook}
|
|
10 |
||
11 |
\usepackage[latin1]{inputenc}
|
|
12 |
\usepackage[automark,headsepline]{scrpage2}
|
|
13 |
\usepackage{graphicx}
|
|
14 |
\usepackage{makeidx}
|
|
15 |
\usepackage[refpage]{nomencl}
|
|
16 |
\usepackage{listings}
|
|
17 |
\usepackage{svn}
|
|
18 |
\usepackage{textcomp}
|
|
19 |
\usepackage{url}
|
|
|
371
97f684433d3b
Improved documentation makefile, removed svn.sty, fixed LaTeX penalties.
Florian Pose <fp@igh-essen.com>
parents:
370
diff
changeset
|
20 |
\usepackage[pdfpagelabels,plainpages=false]{hyperref}
|
| 369 | 21 |
|
22 |
\setlength{\parskip}{0.8ex plus 0.8ex minus 0.5ex}
|
|
23 |
\setlength{\parindent}{0mm}
|
|
24 |
||
25 |
\setcounter{secnumdepth}{\subsubsectionlevel}
|
|
26 |
||
27 |
\DeclareFontShape{OT1}{cmtt}{bx}{n}
|
|
28 |
{
|
|
29 |
<5><6><7><8><9><10><10.95><12><14.4><17.28><20.74><24.88>cmttb10 |
|
30 |
}{}
|
|
31 |
||
32 |
\lstset{basicstyle=\ttfamily\small,numberstyle=\tiny,aboveskip=4mm,
|
|
33 |
belowskip=2mm,gobble=2,escapechar=`} |
|
34 |
\renewcommand\lstlistlistingname{List of Listings}
|
|
35 |
||
36 |
\renewcommand\nomname{Glossary}
|
|
37 |
||
38 |
\newcommand{\IgH}{\raisebox{-0.7667ex}
|
|
39 |
{\includegraphics[height=2.2ex]{images/ighsign}}}
|
|
40 |
||
41 |
\SVN $Date$ |
|
42 |
\SVN $Revision$ |
|
43 |
||
| 487 | 44 |
\newcommand{\masterversion}{1.1.1}
|
45 |
||
| 369 | 46 |
\makeindex |
47 |
\makeglossary |
|
48 |
||
49 |
%------------------------------------------------------------------------------ |
|
50 |
||
51 |
\begin{document}
|
|
52 |
||
53 |
\pagenumbering{roman}
|
|
54 |
\pagestyle{empty}
|
|
55 |
||
56 |
\begin{titlepage}
|
|
57 |
\begin{center}
|
|
58 |
\rule{\textwidth}{1.5mm}
|
|
59 |
||
60 |
{\Huge\bf IgH \includegraphics[height=2.4ex]{images/ethercat}
|
|
| 487 | 61 |
Master \masterversion\\[1ex] |
| 369 | 62 |
Documentation} |
63 |
||
64 |
\vspace{1ex}
|
|
65 |
\rule{\textwidth}{1.5mm}
|
|
66 |
||
67 |
\vspace{\fill}
|
|
68 |
{\Large Florian Pose, \url{fp@igh-essen.com}\\[1ex]
|
|
69 |
Ingenieurgemeinschaft \IgH} |
|
70 |
||
71 |
\vspace{\fill}
|
|
72 |
{\Large Essen, \SVNDate\\[1ex]
|
|
73 |
Revision \SVNRevision} |
|
74 |
\end{center}
|
|
75 |
\end{titlepage}
|
|
76 |
||
77 |
%------------------------------------------------------------------------------ |
|
78 |
||
79 |
\tableofcontents |
|
80 |
\listoftables |
|
81 |
\listoffigures |
|
82 |
\lstlistoflistings |
|
83 |
||
84 |
%------------------------------------------------------------------------------ |
|
85 |
||
86 |
\newpage |
|
87 |
\pagestyle{scrheadings}
|
|
88 |
||
89 |
\section*{Conventions}
|
|
90 |
\addcontentsline{toc}{section}{Conventions}
|
|
91 |
\markleft{Conventions}
|
|
92 |
||
93 |
The following typographic conventions are used: |
|
94 |
||
95 |
\begin{itemize}
|
|
96 |
\item \textit{Italic face} is used for newly introduced terms, file
|
|
97 |
names, parameter names and in-text source code elements. |
|
98 |
\item \texttt{Typewriter face} is used for code examples and
|
|
99 |
command line output. |
|
100 |
\item \texttt{\textbf{Bold typewriter face}} is used for user input in
|
|
101 |
command lines. |
|
102 |
\end{itemize}
|
|
103 |
||
104 |
Data values and addresses are specified as hexadecimal values with the |
|
105 |
prefix 0x. Example: 0x88A4. Unless otherwise noted, address values are |
|
106 |
specified as byte addresses. |
|
107 |
||
108 |
Concerning bit operations, the phrase ``setting a bit'', stands for |
|
109 |
setting the bit to $1$, ``clearing a bit'' means setting it to $0$, |
|
110 |
respectively. |
|
111 |
||
112 |
Function names are always printed with parentheses, but without |
|
113 |
parameters. So, if a function \textit{ecrt\_request\_master()} has
|
|
114 |
empty parentheses, this does not mean, that it has no parameters. |
|
115 |
||
116 |
If shell commands have to be entered, this is marked by a prompt: |
|
117 |
||
118 |
\begin{lstlisting}[gobble=2]
|
|
| 379 | 119 |
`\$` |
| 369 | 120 |
\end{lstlisting}
|
121 |
||
122 |
Further, if a shell command has to be entered as the superuser, the |
|
123 |
prompt ends with a mesh: |
|
124 |
||
125 |
\begin{lstlisting}[gobble=2]
|
|
| 379 | 126 |
# |
| 369 | 127 |
\end{lstlisting}
|
128 |
||
129 |
%------------------------------------------------------------------------------ |
|
130 |
||
131 |
\chapter{The IgH EtherCAT Master}
|
|
132 |
\label{chapter:master}
|
|
133 |
\pagenumbering{arabic}
|
|
134 |
||
135 |
This section will first introduce the master's general features and |
|
136 |
the concepts used for master development and will then explain the |
|
137 |
master's general architecture and offer details of the different |
|
138 |
modules. In addition, it will cover state machine definitions, mailbox |
|
139 |
protocol implementation and the user space interface. The last section |
|
140 |
will deal with timing aspects. |
|
141 |
||
142 |
%------------------------------------------------------------------------------ |
|
143 |
||
144 |
\section{Feature Summary}
|
|
145 |
\label{sec:summary}
|
|
146 |
\index{Master!Features}
|
|
147 |
||
148 |
The list below gives a short summary of the features of the |
|
149 |
implemented EtherCAT master. |
|
150 |
||
151 |
\begin{itemize}
|
|
152 |
\item The master runs as a kernel module for Linux 2.6. |
|
153 |
\item It comes with EtherCAT-capable network driver for RealTek |
|
154 |
RTL8139 (and compatible) network interface cards. |
|
155 |
\begin{itemize}
|
|
156 |
\item The Ethernet hardware is operated without interrupts. |
|
157 |
\item Drivers for additional Ethernet hardware can easily be |
|
158 |
implemented due to a common device interface provided by the |
|
159 |
master. |
|
160 |
\end{itemize}
|
|
161 |
\item The master module supports multiple EtherCAT masters on one |
|
162 |
machine. |
|
163 |
\item The master code supports any Linux realtime extension through |
|
164 |
its independent architecture. |
|
165 |
\begin{itemize}
|
|
166 |
\item RTAI\nomenclature{RTAI}{RealTime Application Interface},
|
|
167 |
ADEOS\nomenclature{ADEOS}{Adaptive Domain Environment for
|
|
168 |
Operating Systems}, etc. |
|
169 |
\item It runs well even without realtime extensions. |
|
170 |
\end{itemize}
|
|
171 |
\item Common ``realtime interface'' for modules, that want to use |
|
172 |
EtherCAT functionality. |
|
173 |
\begin{itemize}
|
|
174 |
\item Synchronous and asynchronous sending and receiving of frames |
|
175 |
is supported. |
|
176 |
\item Avoidance of unnecessary copy operations for process data. |
|
177 |
\end{itemize}
|
|
178 |
\item \textit{Domains} are introduced, to allow grouping of process
|
|
179 |
data objects. |
|
180 |
\begin{itemize}
|
|
181 |
\item Handling of multiple domains with different sampling rates. |
|
182 |
\item Automatic calculation of process data mapping, FMMU and sync manager |
|
183 |
configuration within each domain. |
|
184 |
\end{itemize}
|
|
185 |
\item Communication through serveral finite state machines. |
|
186 |
\begin{itemize}
|
|
187 |
\item Bus monitoring possible during realtime operation. |
|
188 |
\item Automatic reconfiguration of slaves on bus power failure |
|
189 |
during realtime operation. |
|
190 |
\item Controlling of single slaves during realtime operation. |
|
191 |
\end{itemize}
|
|
192 |
\item Master idle mode. |
|
193 |
\begin{itemize}
|
|
194 |
\item Automatic scanning of slaves upon topology changes. |
|
195 |
\item Bus visualisation and EoE processing without a realtime module |
|
196 |
connected. |
|
197 |
\end{itemize}
|
|
198 |
\item Implementation of the CANopen-over-EtherCAT (CoE) protocol. |
|
199 |
\begin{itemize}
|
|
200 |
\item Configuration of CoE-capable slaves via SDO interface. |
|
201 |
\end{itemize}
|
|
202 |
\item Implementation of the Ethernet-over-EtherCAT (EoE) protocol. |
|
203 |
\begin{itemize}
|
|
204 |
\item Each master creates virtual network devices that are |
|
205 |
automatically coupled to EoE-cap\-able slaves found. |
|
206 |
\item This implementation natively supports either a switched or a |
|
207 |
routed EoE network architecture. |
|
208 |
\end{itemize}
|
|
209 |
\item User space interface via the System Filesystem |
|
210 |
(Sysfs)\nomenclature{Sysfs}{System Filesystem}.
|
|
211 |
\begin{itemize}
|
|
212 |
\item User space tool for bus visualisation. |
|
213 |
\item Slave E$^2$PROM image reading and writing. |
|
214 |
\end{itemize}
|
|
215 |
\item Seamless system integration though LSB\nomenclature{LSB}{Linux
|
|
216 |
Standard Base} compliance. |
|
217 |
\begin{itemize}
|
|
218 |
\item Master and network device configuration via Sysconfig files. |
|
219 |
\item Linux Standard Base compatible init script for master control. |
|
220 |
\end{itemize}
|
|
221 |
\item Virtual read-only network interface for monitoring and debugging |
|
222 |
purposes. |
|
223 |
\end{itemize}
|
|
224 |
||
225 |
%------------------------------------------------------------------------------ |
|
226 |
||
227 |
\section{License}
|
|
228 |
\label{sec:license}
|
|
229 |
||
230 |
The master code is released under the terms and conditions of the GNU |
|
231 |
General Public License\index{GPL} \cite{gpl} (version 2). Other
|
|
232 |
developers, that want to use EtherCAT with Linux systems, are invited |
|
233 |
to use the master code or even participate on development. |
|
234 |
||
235 |
%------------------------------------------------------------------------------ |
|
236 |
||
237 |
\section{General Master Architecture}
|
|
238 |
\label{sec:masterarch}
|
|
239 |
\index{Master!Architecture}
|
|
240 |
||
241 |
The EtherCAT master is integrated into the Linux 2.6 kernel. This was |
|
242 |
an early design decision, which has been made for serveral reasons: |
|
243 |
||
244 |
\begin{itemize}
|
|
245 |
\item Kernel code has significantly better realtime characteristics, |
|
246 |
i.~e. less jitter than user space code. It was foreseeable, that a |
|
247 |
fieldbus master has a lot of cyclic work to do. Cyclic work is |
|
248 |
usually triggered by timer interrupts inside the kernel. The |
|
249 |
execution delay of a function that processes timer interrupts is |
|
250 |
less, when it resides in kernel space, because there is no need of |
|
251 |
time-consuming context switches to a user space process. |
|
252 |
\item It was also foreseeable, that the master code has to directly |
|
253 |
communicate with the Ethernet hardware. This has to be done in the |
|
254 |
kernel anyway (through network device drivers), which is one more |
|
255 |
reason for the master code being in kernel space. |
|
256 |
\end{itemize}
|
|
257 |
||
258 |
A general overview of the master architecture can be seen in |
|
259 |
figure~\ref{fig:masterarch}.
|
|
260 |
||
261 |
\begin{figure}[htbp]
|
|
262 |
\centering |
|
263 |
\includegraphics[width=.9\textwidth]{images/masterarch}
|
|
264 |
\caption{Master architecture}
|
|
265 |
\label{fig:masterarch}
|
|
266 |
\end{figure}
|
|
267 |
||
268 |
\paragraph{Master Module}
|
|
269 |
\index{Master module}
|
|
270 |
||
271 |
The EtherCAT master mainly consists of the master module, containing |
|
272 |
one or more EtherCAT masters (section~\ref{sec:mastermod}), the
|
|
273 |
``Device Interface'' (section~\ref{sec:ecdev}) and the ``Realtime
|
|
274 |
Interface'' (section~\ref{sec:ecrt}).
|
|
275 |
||
276 |
\paragraph{Device Modules}
|
|
277 |
\index{Device modules}
|
|
278 |
||
279 |
Furthermore there are EtherCAT-capable network device driver |
|
280 |
modules\index{Device modules}, that connect to the EtherCAT master via
|
|
281 |
the device interface. These modified network drivers can handle both |
|
282 |
network devices used for EtherCAT operation and ``normal'' Ethernet |
|
283 |
devices. The common case is, that the master module offers a single |
|
284 |
EtherCAT master: An EtherCAT-capable network device driver module |
|
285 |
connects one network device to this master, that is now able to send |
|
286 |
and receive EtherCAT frames, while all other network devices handled |
|
287 |
by the network driver get connected to the kernel's network stack as |
|
288 |
usual. |
|
289 |
||
290 |
\paragraph{Realtime Modules}
|
|
291 |
||
292 |
A ``realtime module''\index{Realtime module} is a kernel module, that
|
|
293 |
uses the EtherCAT master for cyclic exchange of process data with |
|
294 |
EtherCAT slaves. Realtime modules are not part of the EtherCAT master |
|
295 |
code\footnote{Although there are serveral examples provided in the
|
|
296 |
\textit{examples} directory, see chapter~\ref{chapter:usage} for
|
|
297 |
more information}, so anybody wanting to use the master has to write |
|
298 |
one. A realtime module can ``request'' a master through the realtime |
|
299 |
interface. If this succeeds, the module has the control over the |
|
300 |
master. It can now configure slaves and set up a process data image |
|
301 |
(see section~\ref{sec:processdata}) for cyclic exchange. This cyclic
|
|
302 |
code has to be provided by the realtime module, so it is in hands of |
|
303 |
the developer, which mechanism to use for this. Moreover he has to |
|
304 |
decide, whether or not using a Linux realtime extension. |
|
305 |
||
306 |
\paragraph{Why ``Realtime'' Module?}
|
|
307 |
||
308 |
The name shall not imply, that a linux realtime extension is |
|
309 |
mandatory: The master runs well even without realtime extensions, as |
|
310 |
section~\ref{sec:mini} shows. However, the code using the master is
|
|
311 |
time-critical, because process data IO has to be done in cyclic work. |
|
312 |
Some EtherCAT slaves support watchdog units, that stop driving the |
|
313 |
outputs when process data was not exchanged for some time. So the |
|
314 |
names ``realtime interface'' and ``realtime module'' are quite |
|
315 |
appropriate. |
|
316 |
||
317 |
%------------------------------------------------------------------------------ |
|
318 |
||
319 |
\subsection{Handling of Process Data}
|
|
320 |
\label{sec:processdata}
|
|
321 |
||
322 |
\paragraph{Process Data Image}
|
|
323 |
\index{Process data}
|
|
324 |
||
325 |
The slaves offer their inputs and outputs by presenting the master |
|
326 |
so-called ``Process Data Objects'' (PDOs\index{PDO}). The available
|
|
327 |
PDOs can be determined by reading out the slave's TXPDO and RXPDO |
|
328 |
E$^2$PROM categories. The realtime module can register the PDOs for |
|
329 |
data exchange during cyclic operation. The sum of all registered PDOs |
|
330 |
defines the ``process data image'', which is exchanged via the |
|
331 |
``Logical ReadWrite'' datagrams introduced |
|
332 |
in~\cite[section~5.4.2.4]{dlspec}.
|
|
333 |
||
334 |
\paragraph{Process Data Domains}
|
|
335 |
\index{Domain}
|
|
336 |
||
337 |
The process data image can be easily managed by creating co-called |
|
338 |
``domains'', which group PDOs and allocate the datagrams needed to |
|
339 |
exchange them. Domains are mandatory for process data exchange, so |
|
340 |
there has to be at least one. They were introduced for the following |
|
341 |
reasons: |
|
342 |
||
343 |
\begin{itemize}
|
|
344 |
\item The maximum size of a ``Logical ReadWrite'' datagram is limited |
|
345 |
due to the limited size of an Ethernet frame: The maximum data size |
|
346 |
is the Ethernet data field size minus the EtherCAT frame header, |
|
347 |
EtherCAT datagram header and EtherCAT datagram footer: $1500 - 2 - |
|
348 |
12 - 2 = 1484$ octets. If the size of the process data image exceeds |
|
349 |
this limit, multiple frames have to be sent, and the image has to be |
|
350 |
partitioned for the use of multiple datagrams. A domain manages this |
|
351 |
automatically. |
|
352 |
\item Not every PDO has to be exchanged with the same frequency: The |
|
353 |
values of PDOs can vary slowly over time (for example temperature |
|
354 |
values), so exchanging them with a high frequency would just waste |
|
355 |
bus bandwidth. For this reason, multiple domains can be created, to |
|
356 |
group different PDOs and so allow separate exchange. |
|
357 |
\end{itemize}
|
|
358 |
||
359 |
There is no upper limit for the number of domains, but each domain |
|
360 |
occupies one FMMU in each slave involved, so the maximum number of |
|
361 |
domains is also limited by the slaves' capabilities. |
|
362 |
||
363 |
\paragraph{FMMU Configuration}
|
|
364 |
\index{FMMU!Configuration}
|
|
365 |
||
366 |
A realtime module can register PDOs for process data exchange. Every |
|
367 |
PDO is part of a memory area in the slave's physical memory, that is |
|
368 |
protected by a sync manager \cite[section~6.7]{dlspec} for
|
|
369 |
synchronized access. In order to make a sync manager react on a |
|
370 |
datagram accessing its memory, it is necessary to access the last byte |
|
371 |
covered by the sync manager. Otherwise the sync manager will not react |
|
372 |
on the datagram and no data will be exchanged. That is why the whole |
|
373 |
synchronized memory area has to be included into the process data |
|
374 |
image: For example, if a certain PDO of a slave is registered for |
|
375 |
exchange with a certain domain, one FMMU will be configured to map the |
|
376 |
complete sync-manager-protected memory, the PDO resides in. If a |
|
377 |
second PDO of the same slave is registered for process data exchange |
|
378 |
within the same domain, and this PDO resides in the same |
|
379 |
sync-manager-protected memory as the first PDO, the FMMU configuration |
|
380 |
is not touched, because the appropriate memory is already part of the |
|
381 |
domain's process data image. If the second PDO belongs to another |
|
382 |
sync-manager-protected area, this complete area is also included into |
|
383 |
the domains process data image. See figure~\ref{fig:fmmus} for an
|
|
384 |
overview, how FMMU's are configured to map physical memory to logical |
|
385 |
process data images. |
|
386 |
||
387 |
\begin{figure}[htbp]
|
|
388 |
\centering |
|
389 |
\includegraphics[width=\textwidth]{images/fmmus}
|
|
390 |
\caption{FMMU configuration for serveral domains}
|
|
391 |
\label{fig:fmmus}
|
|
392 |
\end{figure}
|
|
393 |
||
394 |
\paragraph{Process Data Pointers}
|
|
395 |
||
396 |
The figure also demonstrates the way, the realtime module can access the |
|
397 |
exchanged process data: At PDO registration, the realtime module has |
|
398 |
to provide the address of a process data pointer. Upon calculation of |
|
399 |
the domain image and allocation of process data memory, this pointer |
|
400 |
is redirected to the appropriate location inside the domain's process |
|
401 |
data memory and can later be easily dereferenced by the module code. |
|
402 |
||
403 |
%------------------------------------------------------------------------------ |
|
404 |
||
405 |
\subsection{Operation Modes}
|
|
406 |
\index{Master modes}
|
|
407 |
||
408 |
The EtherCAT master has serveral modes of operation: |
|
409 |
||
410 |
\begin{description}
|
|
411 |
\item[Orphaned Mode] This mode takes effect, when the master has no |
|
412 |
EtherCAT-capable network device connected. No bus communication is |
|
413 |
possible, so this mode is not of further interest. |
|
414 |
\item[Idle Mode]\index{Idle mode} takes effect when the master is
|
|
415 |
unused (i.~e. there is no realtime module, that reserved the |
|
416 |
master). In this case, the master has the ability to scan the bus by |
|
417 |
itsself and generously allow bus access from user space. This mode |
|
418 |
is meant for maintenance and visualisation. |
|
419 |
\item[Operation Mode]\index{Operation mode} The master is reserved for
|
|
420 |
exclusive access by a realtime module. In this mode, the master is |
|
421 |
adjusted for availability and monitoring. Access from user space is |
|
422 |
very restrictive and mostly limited to reading direction. |
|
423 |
||
424 |
\end{description}
|
|
425 |
||
426 |
Figure~\ref{fig:modes} shows the three modes and the possible mode
|
|
427 |
transitions. |
|
428 |
||
429 |
\begin{figure}[htbp]
|
|
430 |
\centering |
|
431 |
\includegraphics[width=.9\textwidth]{images/modes}
|
|
432 |
\caption{Master modes and transitions}
|
|
433 |
\label{fig:modes}
|
|
434 |
\end{figure}
|
|
435 |
||
436 |
\subsubsection{Idle Mode}
|
|
437 |
\index{Idle mode}
|
|
438 |
||
439 |
The master enters idle mode upon connection of a device module (see |
|
440 |
section~\ref{sec:device}) or releasing by a realtime module. The
|
|
441 |
master owns a kernel workqueue and a suitable work structure, which is |
|
442 |
used to cyclically process the ``Idle state machine'' (see |
|
443 |
section~\ref{sec:fsm-idle}). This state machine automatically scans
|
|
444 |
the bus for slaves (and re-scans upon topology changes), configures |
|
445 |
slaves for idle operation and executes pending operations from the |
|
446 |
user space interface (for example E$^2$PROM writing). On device |
|
447 |
disconnection or realtime request, the idle mode is stopped by |
|
448 |
cancelling the work and flushing the workqueue. |
|
449 |
||
450 |
\subsubsection{Operation Mode}
|
|
451 |
\index{Operation mode}
|
|
452 |
||
453 |
Operation mode is entered when a realtime module requests the master. |
|
454 |
The idle mode is stopped and the bus is scanned by getting the number |
|
455 |
of slaves and executing the ``Slave scan state machine'' (see |
|
456 |
section~\ref{sec:fsm-scan}) for each slave. The master is now ready to
|
|
457 |
create domains and accept PDO registrations and slave configurations. |
|
458 |
After that, cyclic communication can be done by the realtime module. |
|
459 |
||
460 |
\paragraph{Master Phases}
|
|
461 |
||
462 |
Every realtime module should use the master in three phases: |
|
463 |
||
464 |
\begin{enumerate}
|
|
465 |
\item \textit{Startup} - The master is requested and the bus is
|
|
466 |
validated. Domains are created and PDOs are registered. Slave |
|
467 |
configurations are applied. |
|
468 |
\item \textit{Operation} - Cyclic code is run, process data is
|
|
469 |
exchanged and the master state machine is executed. |
|
470 |
\item \textit{Shutdown} - Cyclic code is stopped and the master
|
|
471 |
is released. |
|
472 |
\end{enumerate}
|
|
473 |
||
474 |
%------------------------------------------------------------------------------ |
|
475 |
||
476 |
\section{Device Modules}
|
|
477 |
\label{sec:device}
|
|
478 |
\index{Device modules}
|
|
479 |
||
480 |
Device modules are network device driver modules that handle Ethernet |
|
481 |
devices, which the master can use to connect to an EtherCAT bus. |
|
482 |
||
483 |
Section~\ref{sec:networkdrivers} offers an overview of general Linux
|
|
484 |
network driver modules, while section~\ref{sec:requirements} will show
|
|
485 |
the requirements to an EtherCAT-enabled network driver. Finally, |
|
486 |
sections~\ref{sec:seldev} to~\ref{sec:patching} show how to fulfill
|
|
487 |
these requirements and implement such a driver module. |
|
488 |
||
489 |
%------------------------------------------------------------------------------ |
|
490 |
||
491 |
\subsection{Network Driver Basics}
|
|
492 |
\label{sec:networkdrivers}
|
|
493 |
\index{Network drivers}
|
|
494 |
||
495 |
EtherCAT relies on Ethernet hardware and the master needs a physical |
|
496 |
Ethernet device to communicate with the bus. Therefore it is necessary |
|
497 |
to understand how Linux handles network devices and their drivers, |
|
498 |
respectively. |
|
499 |
||
500 |
\paragraph{Tasks of a Network Driver}
|
|
501 |
||
502 |
Network device drivers handle the lower two layers of the OSI model, |
|
503 |
that is the physical layer and the data-link layer. A network device |
|
504 |
itself natively handles the physical layer issues: It represents the |
|
505 |
hardware to connect to the medium and to send and receive data in the |
|
506 |
way, the physical layer protocol describes. The network device driver |
|
507 |
is responsible for getting data from the kernel's networking stack and |
|
508 |
forwarding it to the hardware, that does the physical transmission. |
|
509 |
If data is received by the hardware respectively, the driver is |
|
510 |
notified (usually by means of an interrupt) and has to read the data |
|
511 |
from the hardware memory and forward it to the network stack. There |
|
512 |
are a few more tasks, a network device driver has to handle, including |
|
513 |
queue control, statistics and device dependent features. |
|
514 |
||
515 |
\paragraph{Driver Startup}
|
|
516 |
||
517 |
Usually, a driver searches for compatible devices on module loading. |
|
518 |
For PCI drivers, this is done by scanning the PCI bus and checking for |
|
519 |
known device IDs. If a device is found, data structures are allocated |
|
520 |
and the device is taken into operation. |
|
521 |
||
522 |
\paragraph{Interrupt Operation}
|
|
523 |
\index{Interrupt}
|
|
524 |
||
525 |
A network device usually provides a hardware interrupt that is used to |
|
526 |
notify the driver of received frames and success of transmittion, or |
|
527 |
errors, respectively. The driver has to register an interrupt service |
|
528 |
routine (ISR\index{ISR}\nomenclature{ISR}{Interrupt Service Routine}),
|
|
529 |
that is executed each time, the hardware signals such an event. If the |
|
530 |
interrupt was thrown by the own device (multiple devices can share one |
|
531 |
hardware interrupt), the reason for the interrupt has to be determined |
|
532 |
by reading the device's interrupt register. For example, if the flag |
|
533 |
for received frames is set, frame data has to be copied from hardware |
|
534 |
to kernel memory and passed to the network stack. |
|
535 |
||
536 |
\paragraph{The net\_device structure}
|
|
537 |
\index{net\_device}
|
|
538 |
||
539 |
The driver registers a \textit{net\_device} structure for each device
|
|
540 |
to communicate with the network stack and to create a ``network |
|
541 |
interface''. In case of an Ethernet driver, this interface appears as |
|
542 |
\textit{ethX}, where X is a number assigned by the kernel on
|
|
543 |
registration. The \textit{net\_device} structure receives events
|
|
544 |
(either from user space or from the network stack) via serveral |
|
545 |
callbacks, which have to be set before registration. Not every |
|
546 |
callback is mandatory, but for reasonable operation the ones below are |
|
547 |
needed in any case: |
|
548 |
||
549 |
\begin{description}
|
|
550 |
\item[int (*open)(struct net\_device *)] This function is called when |
|
551 |
network communication has to be started, for example after a command |
|
552 |
\textit{ifconfig ethX up} from user space. Frame reception has to be
|
|
553 |
enabled by the driver. |
|
554 |
\item[int (*stop)(struct net\_device *)] The purpose of this callback |
|
555 |
is to ``close'' the device, i.~e. make the hardware stop receiving |
|
556 |
frames. |
|
557 |
\item[int (*hard\_start\_xmit)(struct sk\_buff *, struct net\_device |
|
558 |
*)] This function is cal\-led for each frame that has to be |
|
559 |
transmitted. The network stack passes the frame as a pointer to an |
|
560 |
\textit{sk\_buff} structure (``socket buffer''\index{Socket buffer},
|
|
561 |
see below), which has to be freed after sending. |
|
562 |
\item[struct net\_device\_stats *(*get\_stats)(struct net\_device *)] |
|
563 |
This call has to return a pointer to the device's |
|
564 |
\textit{net\_device\_stats} structure, which permanently has to be
|
|
565 |
filled with frame statistics. This means, that everytime a frame is |
|
566 |
received, sent, or an error happened, the appropriate counter in |
|
567 |
this structure has to be increased. |
|
568 |
\end{description}
|
|
569 |
||
570 |
The actual registration is done with the \textit{register\_netdev()}
|
|
571 |
call, unregistering is done with \textit{unregister\_netdev()}.
|
|
572 |
||
573 |
\paragraph{The netif Interface}
|
|
574 |
\index{netif}
|
|
575 |
||
576 |
All other communication in the direction interface $\to$ network stack |
|
577 |
is done via the \textit{netif\_*} calls. For example, on successful
|
|
578 |
device opening, the network stack has to be notified, that it can now |
|
579 |
pass frames to the interface. This is done by calling |
|
580 |
\textit{netif\_start\_queue()}. After this call, the
|
|
581 |
\textit{hard\_start\_xmit()} callback can be called by the network
|
|
582 |
stack. Furthermore a network driver usually manages a frame |
|
583 |
transmission queue. If this gets filled up, the network stack has to |
|
584 |
be told to stop passing further frames for a while. This happens with |
|
585 |
a call to \textit{netif\_stop\_queue()}. If some frames have been
|
|
586 |
sent, and there is enough space again to queue new frames, this can be |
|
587 |
notified with \textit{netif\_wake\_queue()}. Another important call is
|
|
588 |
\textit{netif\_receive\_skb()}\footnote{This function is part of the
|
|
589 |
NAPI (``New API''), that replaces the ``old'' kernel 2.4 technique |
|
590 |
for interfacing to the network stack (with \textit{netif\_rx()}).
|
|
591 |
NAPI is a technique to improve network performance on Linux. Read |
|
592 |
more in |
|
593 |
http://www.cyberus.ca/\textasciitilde{}hadi/usenix-paper.tgz}: It
|
|
594 |
passes a frame to the network stack, that was just received by the |
|
595 |
device. Frame data has to be packed into a so-called ``socket |
|
596 |
buffer'' for that (see below). |
|
597 |
||
598 |
\paragraph{Socket Buffers}
|
|
599 |
\index{Socket buffer}
|
|
600 |
||
601 |
Socket buffers are the basic data type for the whole network stack. |
|
602 |
They serve as containers for network data and are able to quickly add |
|
603 |
data headers and footers, or strip them off again. Therefore a socket |
|
604 |
buffer consists of an allocated buffer and serveral pointers that mark |
|
605 |
beginning of the buffer (\textit{head}), beginning of data
|
|
606 |
(\textit{data}), end of data (\textit{tail}) and end of buffer
|
|
607 |
(\textit{end}). In addition, a socket buffer holds network header
|
|
608 |
information and (in case of received data) a pointer to the |
|
609 |
\textit{net\_device}, it was received on. There exist functions that
|
|
610 |
create a socket buffer (\textit{dev\_alloc\_skb()}), add data either
|
|
611 |
from front (\textit{skb\_push()}) or back (\textit{skb\_put()}),
|
|
612 |
remove data from front (\textit{skb\_pull()}) or back
|
|
613 |
(\textit{skb\_trim()}), or delete the buffer (\textit{kfree\_skb()}).
|
|
614 |
A socket buffer is passed from layer to layer, and is freed by the |
|
615 |
layer that uses it the last time. In case of sending, freeing has to |
|
616 |
be done by the network driver. |
|
617 |
||
618 |
%------------------------------------------------------------------------------ |
|
619 |
||
620 |
\subsection{EtherCAT Network Drivers}
|
|
621 |
\label{sec:requirements}
|
|
622 |
||
623 |
There are a few requirements for Ethernet network devices to function |
|
624 |
as EtherCAT devices, when connected to an EtherCAT bus. |
|
625 |
||
626 |
\paragraph{Dedicated Interfaces}
|
|
627 |
||
628 |
For performance and realtime purposes, the EtherCAT master needs |
|
629 |
direct and exclusive access to the Ethernet hardware. This implies |
|
630 |
that the network device must not be connected to the kernel's network |
|
631 |
stack as usual, because the kernel would try to use it as an ordinary |
|
632 |
Ethernet device. |
|
633 |
||
634 |
\paragraph{Interrupt-less Operation}
|
|
635 |
\index{Interrupt}
|
|
636 |
||
637 |
EtherCAT frames travel through the logical EtherCAT ring and are then |
|
638 |
sent back to the master. Communication is highly deterministic: A |
|
639 |
frame is sent and will be received again after a constant time. |
|
640 |
Therefore, there is no need to notify the driver about frame |
|
641 |
reception: The master can instead query the hardware for received |
|
642 |
frames. |
|
643 |
||
644 |
Figure~\ref{fig:interrupt} shows two workflows for cyclic frame
|
|
645 |
transmittion and reception with and without interrupts. |
|
646 |
||
647 |
\begin{figure}[htbp]
|
|
648 |
\centering |
|
649 |
\includegraphics[width=.8\textwidth]{images/interrupt}
|
|
650 |
\caption{Interrupt Operation versus Interrupt-less Operation}
|
|
651 |
\label{fig:interrupt}
|
|
652 |
\end{figure}
|
|
653 |
||
654 |
In the left workflow ``Interrupt Operation'', the data from the last |
|
655 |
cycle is first processed and a new frame is assembled with new |
|
656 |
datagrams, which is then sent. The cyclic work is done for now. |
|
657 |
Later, when the frame is received again by the hardware, an interrupt |
|
658 |
is triggered and the ISR is executed. The ISR will fetch the frame |
|
659 |
data from the hardware and initiate the frame dissection: The |
|
660 |
datagrams will be processed, so that the data is ready for processing |
|
661 |
in the next cycle. |
|
662 |
||
663 |
In the right workflow ``Interrupt-less Operation'', there is no |
|
664 |
hardware interrupt enabled. Instead, the hardware will be polled by |
|
665 |
the master by executing the ISR. If the frame has been received in the |
|
666 |
meantime, it will be dissected. The situation is now the same as at |
|
667 |
the beginning of the left workflow: The received data is processed and |
|
668 |
a new frame is assembled and sent. There is nothing to do for the rest |
|
669 |
of the cycle. |
|
670 |
||
671 |
The interrupt-less operation is desirable, because there is simply no |
|
672 |
need for an interrupt. Moreover hardware interrupts are not conducive |
|
673 |
in improving the driver's realtime behaviour: Their undeterministic |
|
674 |
incidences contribute to increasing the jitter. Besides, if a realtime |
|
675 |
extension (like RTAI) is used, some additional effort would have to be |
|
676 |
made to priorize interrupts. |
|
677 |
||
678 |
\paragraph{Ethernet and EtherCAT Devices}
|
|
679 |
||
680 |
Another issue lies in the way Linux handles devices of the same type. |
|
681 |
For example, a PCI\nomenclature{PCI}{Peripheral Component
|
|
682 |
Interconnect, Computer Bus} driver scans the PCI bus for devices it |
|
683 |
can handle. Then it registers itself as the responsible driver for all |
|
684 |
of the devices found. The problem is, that an unmodified driver can |
|
685 |
not be told to ignore a device because it will be used for EtherCAT |
|
686 |
later. There must be a way to handle multiple devices of the same |
|
687 |
type, where one is reserved for EtherCAT, while the other is treated |
|
688 |
as an ordinary Ethernet device. |
|
689 |
||
690 |
For all this reasons, the author has decided that the only acceptable |
|
691 |
solution is to modify standard Ethernet drivers in a way that they |
|
692 |
keep their normal functionality, but gain the ability to treat one or |
|
693 |
more of the devices as EtherCAT-capable. |
|
694 |
||
695 |
Below are the advantages of this solution: |
|
696 |
||
697 |
\begin{itemize}
|
|
698 |
\item No need to tell the standard drivers to ignore certain devices. |
|
699 |
\item One networking driver for EtherCAT and non-EtherCAT devices. |
|
700 |
\item No need to implement a network driver from scratch and running |
|
701 |
into issues, the former developers already solved. |
|
702 |
\end{itemize}
|
|
703 |
||
704 |
The chosen approach has the following disadvantages: |
|
705 |
||
706 |
\begin{itemize}
|
|
707 |
\item The modified driver gets more complicated, as it must handle |
|
708 |
EtherCAT and non-EtherCAT devices. |
|
709 |
\item Many additional case differentiations in the driver code. |
|
710 |
\item Changes and bugfixes on the standard drivers have to be ported |
|
711 |
to the Ether\-CAT-capable versions from time to time. |
|
712 |
\end{itemize}
|
|
713 |
||
714 |
%------------------------------------------------------------------------------ |
|
715 |
||
716 |
\subsection{Device Selection}
|
|
717 |
\label{sec:seldev}
|
|
718 |
||
719 |
After loading the master module, at least one EtherCAT-capable network |
|
720 |
driver module has to be loaded, that connects one of its devices to |
|
721 |
the master. To specify an EtherCAT device and the master to connect |
|
722 |
to, all EtherCAT-capable network driver modules should provide two |
|
723 |
module parameters: |
|
724 |
||
725 |
\begin{description}
|
|
726 |
\item[ec\_device\_index] PCI device index of the device that is |
|
727 |
connected to the EtherCAT bus. If this parameter is left away, all |
|
728 |
devices found are treated as ordinary Ethernet devices. Default: |
|
729 |
$-1$ |
|
730 |
\item[ec\_master\_index] Index of the master to connect to. Default: |
|
731 |
$0$ |
|
732 |
\end{description}
|
|
733 |
||
734 |
The following command loads the EtherCAT-capable RTL8139 device |
|
735 |
driver, telling it to handle the second device as an EtherCAT device |
|
736 |
and connecting it to the first master: |
|
737 |
||
738 |
\begin{lstlisting}
|
|
| 379 | 739 |
# `\textbf{modprobe ec\_8139too ec\_device\_index=1}`
|
| 369 | 740 |
\end{lstlisting}
|
741 |
||
742 |
Usually, this command does not have to be entered manually, but is |
|
743 |
called by the EtherCAT init script. See section~\ref{sec:init} for
|
|
744 |
more information. |
|
745 |
||
746 |
%------------------------------------------------------------------------------ |
|
747 |
||
748 |
\subsection{The Device Interface}
|
|
749 |
\label{sec:ecdev}
|
|
750 |
\index{Device interface}
|
|
751 |
||
752 |
An anticipation to the section about the master module |
|
753 |
(section~\ref{sec:mastermod}) has to be made in order to understand
|
|
754 |
the way, a network device driver module can connect a device to a |
|
755 |
specific EtherCAT master. |
|
756 |
||
757 |
The master module provides a ``device interface'' for network device |
|
758 |
drivers. To use this interface, a network device driver module must |
|
759 |
include the header |
|
760 |
\textit{devices/ecdev.h}\nomenclature{ecdev}{EtherCAT Device}, coming
|
|
761 |
with the EtherCAT master code. This header offers a function interface |
|
762 |
for EtherCAT devices which is explained below. All functions of the |
|
763 |
device interface are named with the prefix \textit{ecdev}.
|
|
764 |
||
765 |
\paragraph{Device Registration}
|
|
766 |
||
767 |
A network device driver can connect a physical device to an EtherCAT |
|
768 |
master with the \textit{ecdev\_register()} function.
|
|
769 |
||
770 |
\begin{lstlisting}[language=C]
|
|
771 |
ec_device_t *ecdev_register(unsigned int master_index, |
|
772 |
struct net_device *net_dev, |
|
773 |
ec_isr_t isr, |
|
774 |
struct module *module); |
|
775 |
\end{lstlisting}
|
|
776 |
||
777 |
The first parameter \textit{master\_index} must be the index of the
|
|
778 |
EtherCAT master to connect to (see section~\ref{sec:mastermod}),
|
|
779 |
followed by \textit{net\_dev}, the pointer to the corresponding
|
|
780 |
net\_device structure, which represents the network device to connect. |
|
781 |
The third parameter \textit{isr} must be a pointer to the interrupt
|
|
782 |
service routine (ISR\index{ISR}) handling the device. The master will
|
|
783 |
later execute the ISR in order to receive frames and to update the |
|
784 |
device status. The last parameter \textit{module} must be the pointer
|
|
785 |
to the device driver module, which is usually accessible via the macro |
|
786 |
\textit{THIS\_MODULE} (see next paragraph). On success, the function
|
|
787 |
returns a pointer to an \textit{ec\_device\_t} object, which has to be
|
|
788 |
specified when calling further functions of the device interface. |
|
789 |
Therefore the device module has to store this pointer for future use. |
|
790 |
In error case, the \textit{ecdev\_register()} returns \textit{NULL},
|
|
791 |
which means that the device could not be registered. The reason for |
|
792 |
this is printed to \textit{syslog}\index{syslog}. In this case, the
|
|
793 |
device module is supposed to abort the module initialisation and let |
|
794 |
the \textit{insmod} command fail.
|
|
795 |
||
796 |
\paragraph{Implicit Dependencies}
|
|
797 |
||
798 |
The reason for the module pointer has to be specified at device |
|
799 |
registration is a non-trivial one: The master has to know about the |
|
800 |
module, because there will be an implicit dependency between the |
|
801 |
device module and a later connected realtime module: When a realtime |
|
802 |
module connects to the master, the use count of the master module will |
|
803 |
be increased, so that the master module can not be unloaded for the |
|
804 |
time of the connection. This is reasonable, and so automatically done |
|
805 |
by the kernel. The kernel knows about this dependency, because the |
|
806 |
realtime module uses kernel symbols provided by the master module. |
|
807 |
Moreover it is mandatory, that the device module can be unloaded |
|
808 |
neither, because it is implicitely used by the realtime module, too. |
|
809 |
Unloading it would lead to a fatal situation, because the master would |
|
810 |
have no device to send and receive frames for the realtime module. |
|
811 |
This dependency can not be detected automatically, because the |
|
812 |
realtime module does not use any symbols of the device module. |
|
813 |
Therefore the master explicitly increments the use counter of the |
|
814 |
connected device module upon connection of a realtime module and |
|
815 |
decrements it, if the realtime module disconnects. In this manner, it |
|
816 |
is impossible to unload a device module while the master is in use. |
|
817 |
This is done with the kernel function pair \textit{try\_module\_get()}
|
|
818 |
\index{try\_module\_get@\textit{try\_module\_get()}} and
|
|
819 |
\textit{module\_put()} \index{module\_put@\textit{module\_put()}}. The
|
|
820 |
first one increases the use count of a module and only fails, if the |
|
821 |
module is currenly being unloaded. The last one decreases the use |
|
822 |
count again and never fails. Both functions take a pointer to the |
|
823 |
module as their argument, which the device module therefore has to |
|
824 |
specify upon device registration. |
|
825 |
||
826 |
\paragraph{Device Unregistering}
|
|
827 |
||
828 |
The unregistration of a device is usually done in the device module's |
|
829 |
cleanup function, by calling the \textit{ecdev\_unregister()} function
|
|
830 |
and specifying the master index and a pointer to the device object |
|
831 |
again. |
|
832 |
||
833 |
\begin{lstlisting}[language=C]
|
|
834 |
void ecdev_unregister(unsigned int master_index, |
|
835 |
ec_device_t *device); |
|
836 |
\end{lstlisting}
|
|
837 |
||
838 |
This function can fail too (if the master index is invalid, or the |
|
839 |
given device was not registered), but due to the fact, that this |
|
840 |
failure can not be dealt with appropriately, because the device module |
|
841 |
is unloading anyway, the failure code would not be of any interest. So |
|
842 |
the function has a void return value. |
|
843 |
||
844 |
\paragraph{Starting the Master}
|
|
845 |
||
846 |
When a device has been initialized completely and is ready to send and |
|
847 |
receive frames, the master has to be notified about this by calling |
|
848 |
the \textit{ecdev\_start()} function.
|
|
849 |
||
850 |
\begin{lstlisting}[language=C]
|
|
851 |
int ecdev_start(unsigned int master_index); |
|
852 |
\end{lstlisting}
|
|
853 |
||
854 |
The master will then enter ``Idle Mode'' and start scanning the bus |
|
855 |
(and possibly handling EoE slaves). Moreover it will make the bus |
|
856 |
accessible via Sysfs interface and react to user interactions. The |
|
857 |
function takes one parameter \textit{master\_index}, which has to be
|
|
858 |
the same as at the call to \textit{ecdev\_register()}. The return
|
|
859 |
value will be non-zero if the starting process failed. In this case |
|
860 |
the device module is supposed to abort the init sequence and make the |
|
861 |
init function return an error code. |
|
862 |
||
863 |
\paragraph{Stopping the Master}
|
|
864 |
||
865 |
Before a device can be unregistered, the master has to be stopped by |
|
866 |
calling the \textit{ecdev\_stop()} function. It will stop processing
|
|
867 |
messages of EoE slaves and leave ``Idle Mode''. The only parameter is |
|
868 |
\textit{master\_index}. This function can not fail.
|
|
869 |
||
870 |
\begin{lstlisting}[language=C]
|
|
871 |
void ecdev_stop(unsigned int master_index); |
|
872 |
\end{lstlisting}
|
|
873 |
||
874 |
A subsequent call to \textit{ecdev\_unregister()} will now unregister
|
|
875 |
the device savely. |
|
876 |
||
877 |
\paragraph{Receiving Frames}
|
|
878 |
||
879 |
The interrupt service routine handling device events usually has a |
|
880 |
section where new frames are fetched from the hardware and forwarded |
|
881 |
to the kernel network stack via \textit{netif\_receive\_skb()}. For an
|
|
882 |
EtherCAT-capable device, this has to be replaced by calling the |
|
883 |
\textit{ecdev\_receive()} function to forward the received data to the
|
|
884 |
connected EtherCAT master instead. |
|
885 |
||
886 |
\begin{lstlisting}[language=C]
|
|
887 |
void ecdev_receive(ec_device_t *device, |
|
888 |
const void *data, |
|
889 |
size_t size); |
|
890 |
\end{lstlisting}
|
|
891 |
||
892 |
This function takes 3 arguments, a pointer to the device object |
|
893 |
(\textit{device}), a pointer to the received data, and the size of the
|
|
894 |
received data. The data range has to include the Ethernet headers |
|
895 |
starting with the destination address and reach up to the last octet |
|
896 |
of EtherCAT data, excluding the FCS. Most network devices handle the |
|
897 |
FCS in hardware, so it is not seen by the driver code and therefore |
|
898 |
doesn't have to be cut off manually. |
|
899 |
||
900 |
\paragraph{Handling the Link Status}
|
|
901 |
||
902 |
Information about the link status (i.~e. if there is a carrier signal |
|
903 |
detected on the physical port) is also important to the master. This |
|
904 |
information is usually gathered by the ISR and should be forwarded to |
|
905 |
the master by calling the \textit{ecdev\_link\_state()} function. The
|
|
906 |
master then can react on this and warn the realtime module of a lost |
|
907 |
link. |
|
908 |
||
909 |
\begin{lstlisting}[language=C]
|
|
910 |
void ecdev_link_state(ec_device_t *device, |
|
911 |
uint8_t new_state); |
|
912 |
\end{lstlisting}
|
|
913 |
||
914 |
The parameter \textit{device} has to be a pointer to the device object
|
|
915 |
returned by \textit{ecdev\_\-register()}. With the second parameter
|
|
916 |
\textit{new\_state}, the new link state is passed: 1, if the link went
|
|
917 |
up, and 0, if it went down. |
|
918 |
||
919 |
%------------------------------------------------------------------------------ |
|
920 |
||
921 |
\subsection{Patching Network Drivers}
|
|
922 |
\label{sec:patching}
|
|
923 |
\index{Network drivers}
|
|
924 |
||
925 |
This section will demonstrate, how to make a standard Ethernet driver |
|
926 |
EtherCAT-capable. The below code examples are taken out of the |
|
927 |
modified RealTek RTL8139 driver coming with the EtherCAT master |
|
928 |
(\textit{devices/8139too.c}). The driver was originally developed by
|
|
929 |
Donald Becker, and is currently maintained by Jeff Garzik. |
|
930 |
||
931 |
Unfortunately, there is no standard procedure to enable an Ethernet |
|
932 |
driver for use with the EtherCAT master, but there are a few common |
|
933 |
techniques, that are described in this section. |
|
934 |
||
935 |
\begin{enumerate}
|
|
936 |
\item A first simple rule is, that \textit{netif\_*()}-calls must be
|
|
937 |
strictly avoided for all EtherCAT devices. As mentioned before, |
|
938 |
EtherCAT devices have no connection to the network stack, and |
|
939 |
therefore must not call its interface functions. |
|
940 |
\item Another important thing is, that EtherCAT devices should be |
|
941 |
operated without interrupts. So any calls of registering interrupt |
|
942 |
handlers and enabling interrupts at hardware level must be avoided, |
|
943 |
too. |
|
944 |
\item The master does not use a new socket buffer for each send |
|
945 |
operation: Instead there is a fix one allocated on master |
|
946 |
initialization. This socket buffer is filled with an EtherCAT frame |
|
947 |
with every send operation and passed to the |
|
948 |
\textit{hard\_start\_xmit()} callback. For that it is necessary,
|
|
949 |
that the socket buffer is not be freed by the network driver as |
|
950 |
usual. |
|
951 |
\end{enumerate}
|
|
952 |
||
953 |
As mentioned before, the driver will handle both EtherCAT and ordinary |
|
954 |
Ethernet devices. This implies, that for each device-dependent |
|
955 |
operation, it has to be checked if an EtherCAT device is involved, or |
|
956 |
just an Ethernet device. For means of simplicity, this example driver |
|
957 |
will only handle one EtherCAT device. This makes the case |
|
958 |
differentiations easier. |
|
959 |
||
960 |
\paragraph{Global Variables}
|
|
961 |
||
962 |
First of all, there have to be additional global variables declared, |
|
963 |
as shown in the listing: |
|
964 |
||
965 |
\begin{lstlisting}[language=C,numbers=left]
|
|
966 |
static int ec_device_index = -1; |
|
967 |
static int ec_device_master_index = 0; |
|
968 |
static ec_device_t *rtl_ec_dev; |
|
969 |
struct net_device *rtl_ec_net_dev = NULL; |
|
970 |
\end{lstlisting}
|
|
971 |
||
972 |
\begin{description}
|
|
973 |
\item[\normalfont\textcircled{\tiny 1} -- \textcircled{\tiny 2}] To
|
|
974 |
comply to the requirements for parameters of EtherCAT device modules |
|
975 |
described in section~\ref{sec:seldev}, there have to be additional
|
|
976 |
parameter variables: \textit{ec\_\-device\_\-index} holds the index
|
|
977 |
of the EtherCAT device and defaults to $-1$ (no EtherCAT device), |
|
978 |
while \textit{ec\_device\_master\_index} stores index of the master,
|
|
979 |
the single device will be connected to. Default: $0$ |
|
980 |
\item[\normalfont\textcircled{\tiny 3}] \textit{rtl\_ec\_dev} will be
|
|
981 |
the pointer to the later registered RealTek EtherCAT device, which |
|
982 |
can be used as a parameter for device methods. |
|
983 |
\item[\normalfont\textcircled{\tiny 4}] \textit{rtl\_ec\_net\_dev} is
|
|
984 |
a pointer to the \textit{net\_device} structure of the dedicated
|
|
985 |
device and is set while scanning the PCI bus and finding the device |
|
986 |
with the specified index. This is done inside the |
|
987 |
\textit{pci\_module\_init()} function executed as the first thing on
|
|
988 |
module loading. |
|
989 |
\end{description}
|
|
990 |
||
991 |
\paragraph{Module Initialization}
|
|
992 |
||
993 |
Below is the (shortened) coding of the device driver's module init |
|
994 |
function: |
|
995 |
||
996 |
\begin{lstlisting}[language=C,numbers=left]
|
|
997 |
static int __init rtl8139_init_module(void) |
|
998 |
{
|
|
999 |
if (pci_module_init(&rtl8139_pci_driver) < 0) {
|
|
1000 |
printk(KERN_ERR "Failed to init PCI mod.\n"); |
|
1001 |
goto out_return; |
|
1002 |
} |
|
1003 |
||
1004 |
if (rtl_ec_net_dev) {
|
|
1005 |
printk(KERN_INFO "Registering" |
|
1006 |
" EtherCAT device...\n"); |
|
1007 |
if (!(rtl_ec_dev = |
|
1008 |
ecdev_register(ec_device_master_index, |
|
1009 |
rtl_ec_net_dev, |
|
1010 |
rtl8139_interrupt, |
|
1011 |
THIS_MODULE))) {
|
|
1012 |
printk(KERN_ERR "Failed to reg." |
|
1013 |
" EtherCAT device!\n"); |
|
1014 |
goto out_unreg_pci; |
|
1015 |
} |
|
1016 |
||
1017 |
printk(KERN_INFO "Starting EtherCAT" |
|
1018 |
" device...\n"); |
|
1019 |
if (ecdev_start(ec_device_master_index)) {
|
|
1020 |
printk(KERN_ERR "Failed to start" |
|
1021 |
" EtherCAT device!\n"); |
|
1022 |
goto out_unreg_ec; |
|
1023 |
} |
|
1024 |
} else {
|
|
1025 |
printk(KERN_WARNING "No EtherCAT device" |
|
1026 |
" registered!\n"); |
|
1027 |
} |
|
1028 |
||
1029 |
return 0; |
|
1030 |
||
1031 |
out_unreg_ec: |
|
1032 |
ecdev_unregister(ec_device_master_index, rtl_ec_dev); |
|
1033 |
out_unreg_pci: |
|
1034 |
pci_unregister_driver(&rtl8139_pci_driver); |
|
1035 |
out_return: |
|
1036 |
return -1; |
|
1037 |
} |
|
1038 |
\end{lstlisting}
|
|
1039 |
||
1040 |
\begin{description}
|
|
1041 |
\item[\normalfont\textcircled{\tiny 3}] This call initializes all
|
|
1042 |
RTL8139-compatible devices found on the pci bus. If a device with |
|
1043 |
index \textit{ec\_device\_index} is found, a pointer to its
|
|
1044 |
\textit{net\_device} structure is stored in
|
|
1045 |
\textit{rtl\_ec\_net\_dev} for later use (see next listings).
|
|
1046 |
\item[\normalfont\textcircled{\tiny 8}] If the specified device was
|
|
1047 |
found, \textit{rtl\_ec\_net\_dev} is non-zero.
|
|
1048 |
\item[\normalfont\textcircled{\tiny 11}] The device is connected to
|
|
1049 |
the specified master with a call to \textit{ecdev\_register()}. If
|
|
1050 |
this fails, module loading is aborted. |
|
1051 |
\item[\normalfont\textcircled{\tiny 23}] The device registration was
|
|
1052 |
successful and the master is started. This can fail, which aborts |
|
1053 |
module loading. |
|
1054 |
\item[\normalfont\textcircled{\tiny 29}] If no EtherCAT device was
|
|
1055 |
found, a warning is output. |
|
1056 |
\end{description}
|
|
1057 |
||
1058 |
\paragraph{Device Searching}
|
|
1059 |
||
1060 |
During the PCI initialization phase, a variable \textit{board\_idx} is
|
|
1061 |
increased for each RTL8139-compatible device found. The code below is |
|
1062 |
executed for each device: |
|
1063 |
||
1064 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1065 |
if (board_idx == ec_device_index) {
|
|
1066 |
rtl_ec_net_dev = dev; |
|
1067 |
strcpy(dev->name, "ec0"); |
|
1068 |
} |
|
1069 |
\end{lstlisting}
|
|
1070 |
||
1071 |
\begin{description}
|
|
1072 |
\item[\normalfont\textcircled{\tiny 1}] The device with the specified
|
|
1073 |
index will be the EtherCAT device. |
|
1074 |
\end{description}
|
|
1075 |
||
1076 |
\paragraph{Avoiding Device Registration}
|
|
1077 |
||
1078 |
Later in the PCI initialization phase, the net\_devices get |
|
1079 |
registered. This has to be avoided for EtherCAT devices and so this is |
|
1080 |
a typical example for an EtherCAT case differentiation: |
|
1081 |
||
1082 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1083 |
if (dev != rtl_ec_net_dev) {
|
|
1084 |
i = register_netdev(dev); |
|
1085 |
if (i) goto err_out; |
|
1086 |
} |
|
1087 |
\end{lstlisting}
|
|
1088 |
||
1089 |
\begin{description}
|
|
1090 |
\item[\normalfont\textcircled{\tiny 1}] If the current net\_device is
|
|
1091 |
not the EtherCAT device, it is registered at the network stack. |
|
1092 |
\end{description}
|
|
1093 |
||
1094 |
\paragraph{Avoiding Interrupt Registration}
|
|
1095 |
||
1096 |
In the next two listings, there is an interrupt requested and the |
|
1097 |
device's interrupts are enabled. This also has to be encapsulated by |
|
1098 |
if-clauses, because interrupt operation is not wanted for EtherCAT |
|
1099 |
devices. |
|
1100 |
||
1101 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1102 |
if (dev != rtl_ec_net_dev) {
|
|
1103 |
retval = request_irq(dev->irq, rtl8139_interrupt, |
|
1104 |
SA_SHIRQ, dev->name, dev); |
|
1105 |
if (retval) return retval; |
|
1106 |
} |
|
1107 |
\end{lstlisting}
|
|
1108 |
||
1109 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1110 |
if (dev != rtl_ec_net_dev) {
|
|
1111 |
/* Enable all known interrupts by setting |
|
1112 |
the interrupt mask. */ |
|
1113 |
RTL_W16(IntrMask, rtl8139_intr_mask); |
|
1114 |
} |
|
1115 |
\end{lstlisting}
|
|
1116 |
||
1117 |
\paragraph{Frame Sending}
|
|
1118 |
||
1119 |
The listing below shows an exerpt of the function representing the |
|
1120 |
\textit{hard\_start\_xmit()} callback of the net\_device.
|
|
1121 |
||
1122 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1123 |
/* Note: the chip doesn't have auto-pad! */ |
|
1124 |
if (likely(len < TX_BUF_SIZE)) {
|
|
1125 |
if (len < ETH_ZLEN) |
|
1126 |
memset(tp->tx_buf[entry], 0, ETH_ZLEN); |
|
1127 |
skb_copy_and_csum_dev(skb, tp->tx_buf[entry]); |
|
1128 |
if (dev != rtl_ec_net_dev) {
|
|
1129 |
dev_kfree_skb(skb); |
|
1130 |
} |
|
1131 |
} else {
|
|
1132 |
if (dev != rtl_ec_net_dev) {
|
|
1133 |
dev_kfree_skb(skb); |
|
1134 |
} |
|
1135 |
tp->stats.tx_dropped++; |
|
1136 |
return 0; |
|
1137 |
} |
|
1138 |
\end{lstlisting}
|
|
1139 |
||
1140 |
\begin{description}
|
|
1141 |
\item[\normalfont\textcircled{\tiny 6} + \textcircled{\tiny 10}] The
|
|
1142 |
master uses a fixed socket buffer for transmission, which is reused |
|
1143 |
and may not be freed. |
|
1144 |
\end{description}
|
|
1145 |
||
1146 |
\paragraph{Frame Receiving}
|
|
1147 |
||
1148 |
During ordinary frame reception, a socket buffer is created and filled |
|
1149 |
with the received data. This is not necessary for an EtherCAT device: |
|
1150 |
||
1151 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1152 |
if (dev != rtl_ec_net_dev) {
|
|
1153 |
/* Malloc up new buffer, compatible with net-2e. */ |
|
1154 |
/* Omit the four octet CRC from the length. */ |
|
1155 |
||
1156 |
skb = dev_alloc_skb (pkt_size + 2); |
|
1157 |
if (likely(skb)) {
|
|
1158 |
skb->dev = dev; |
|
1159 |
skb_reserve(skb, 2); /* 16 byte align |
|
1160 |
the IP fields. */ |
|
1161 |
eth_copy_and_sum(skb, &rx_ring[ring_off + 4], |
|
1162 |
pkt_size, 0); |
|
1163 |
skb_put(skb, pkt_size); |
|
1164 |
skb->protocol = eth_type_trans(skb, dev); |
|
1165 |
||
1166 |
dev->last_rx = jiffies; |
|
1167 |
tp->stats.rx_bytes += pkt_size; |
|
1168 |
tp->stats.rx_packets++; |
|
1169 |
||
1170 |
netif_receive_skb (skb); |
|
1171 |
} else {
|
|
1172 |
if (net_ratelimit()) |
|
1173 |
printk(KERN_WARNING |
|
1174 |
"%s: Memory squeeze, dropping" |
|
1175 |
" packet.\n", dev->name); |
|
1176 |
tp->stats.rx_dropped++; |
|
1177 |
} |
|
1178 |
} else {
|
|
1179 |
ecdev_receive(rtl_ec_dev, |
|
1180 |
&rx_ring[ring_offset + 4], pkt_size); |
|
1181 |
dev->last_rx = jiffies; |
|
1182 |
tp->stats.rx_bytes += pkt_size; |
|
1183 |
tp->stats.rx_packets++; |
|
1184 |
} |
|
1185 |
\end{lstlisting}
|
|
1186 |
||
1187 |
\begin{description}
|
|
1188 |
\item[\normalfont\textcircled{\tiny 28}] If the device is an EtherCAT
|
|
1189 |
device, no socket buffer is allocated. Instead a pointer to the data |
|
1190 |
(which is still in the device's receive ring) is passed to the |
|
1191 |
EtherCAT master. Unnecessary copy operations are avoided. |
|
1192 |
\item[\normalfont\textcircled{\tiny 30} -- \textcircled{\tiny 32}] The
|
|
1193 |
device's statistics are updated as usual. |
|
1194 |
\end{description}
|
|
1195 |
||
1196 |
\paragraph{Link State}
|
|
1197 |
||
1198 |
The link state (i.~e. if there is a carrier signal detected on the |
|
1199 |
receive port) is determined during execution of the ISR. The listing |
|
1200 |
below shows the different processing for Ethernet and EtherCAT |
|
1201 |
devices: |
|
1202 |
||
1203 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1204 |
if (dev != rtl_ec_net_dev) {
|
|
1205 |
if (tp->phys[0] >= 0) {
|
|
1206 |
mii_check_media(&tp->mii, netif_msg_link(tp), |
|
1207 |
init_media); |
|
1208 |
} |
|
1209 |
} else {
|
|
1210 |
void __iomem *ioaddr = tp->mmio_addr; |
|
1211 |
uint16_t link = RTL_R16(BasicModeStatus) |
|
1212 |
& BMSR_LSTATUS; |
|
1213 |
ecdev_link_state(rtl_ec_dev, link ? 1 : 0); |
|
1214 |
} |
|
1215 |
\end{lstlisting}
|
|
1216 |
||
1217 |
\begin{description}
|
|
1218 |
\item[\normalfont\textcircled{\tiny 3}] The ``media check'' is done
|
|
1219 |
via the media independent interface (MII\nomenclature{MII}{Media
|
|
1220 |
Independent Interface}), a standard interface for Fast Ethernet |
|
1221 |
devices. |
|
1222 |
\item[\normalfont\textcircled{\tiny 7} -- \textcircled{\tiny 10}] For
|
|
1223 |
EtherCAT devices, the link state is fetched manually from the |
|
1224 |
appropriate device register, and passed to the EtherCAT master by |
|
1225 |
calling \textit{ecdev\_\-link\_\-state()}.
|
|
1226 |
\end{description}
|
|
1227 |
||
1228 |
\paragraph{Module Cleanup}
|
|
1229 |
||
1230 |
Below is the module's cleanup function: |
|
1231 |
||
1232 |
\begin{lstlisting}[language=C,numbers=left]
|
|
1233 |
static void __exit rtl8139_cleanup_module (void) |
|
1234 |
{
|
|
1235 |
printk(KERN_INFO "Cleaning up RTL8139-EtherCAT" |
|
1236 |
" module...\n"); |
|
1237 |
||
1238 |
if (rtl_ec_net_dev) {
|
|
1239 |
printk(KERN_INFO "Stopping device...\n"); |
|
1240 |
ecdev_stop(ec_device_master_index); |
|
1241 |
printk(KERN_INFO "Unregistering device...\n"); |
|
1242 |
ecdev_unregister(ec_device_master_index, |
|
1243 |
rtl_ec_dev); |
|
1244 |
rtl_ec_dev = NULL; |
|
1245 |
} |
|
1246 |
||
1247 |
pci_unregister_driver(&rtl8139_pci_driver); |
|
1248 |
||
1249 |
printk(KERN_INFO "RTL8139-EtherCAT module" |
|
1250 |
" cleaned up.\n"); |
|
1251 |
} |
|
1252 |
\end{lstlisting}
|
|
1253 |
||
1254 |
\begin{description}
|
|
1255 |
\item[\normalfont\textcircled{\tiny 6}] Stopping and unregistration is
|
|
1256 |
only done, if a device was registered before. |
|
1257 |
\item[\normalfont\textcircled{\tiny 8}] The master is first stopped,
|
|
1258 |
so it does not access the device any more. |
|
1259 |
\item[\normalfont\textcircled{\tiny 10}] After this, the device is
|
|
1260 |
unregistered. The master is now ``ophaned''. |
|
1261 |
\end{description}
|
|
1262 |
||
1263 |
%------------------------------------------------------------------------------ |
|
1264 |
||
1265 |
\section{The Master Module}
|
|
1266 |
\label{sec:mastermod}
|
|
1267 |
\index{Master module}
|
|
1268 |
||
1269 |
The EtherCAT master is designed to run as a kernel module. Moreover |
|
1270 |
the master kernel module \textit{ec\_master} can handle multiple
|
|
1271 |
masters at the same time: The number of masters has to be passed to |
|
1272 |
the module with the parameter \textit{ec\_master\_count}, that
|
|
1273 |
defaults to $1$. A certain master can later be addressed by its index. |
|
1274 |
For example, if the master module has been loaded with the command |
|
1275 |
||
1276 |
\begin{lstlisting}
|
|
| 379 | 1277 |
# `\textbf{modprobe ec\_master ec\_master\_count=2}`
|
| 369 | 1278 |
\end{lstlisting}
|
1279 |
||
1280 |
the two masters can be addressed by their indices 0 and 1 respectively |
|
1281 |
(see figure~\ref{fig:masters}). This master index mandatory for
|
|
1282 |
certain functions of the master interfaces. |
|
1283 |
||
1284 |
\begin{figure}[htbp]
|
|
1285 |
\centering |
|
1286 |
\includegraphics[width=.5\textwidth]{images/masters}
|
|
1287 |
\caption{Multiple masters in one module}
|
|
1288 |
\label{fig:masters}
|
|
1289 |
\end{figure}
|
|
1290 |
||
1291 |
\paragraph{Master Log Messages}
|
|
1292 |
||
1293 |
The master module gives information about it's state and events via |
|
1294 |
the syslog interface. The module loading command above should result |
|
| 487 | 1295 |
in the syslog messages below (or similar): |
| 369 | 1296 |
|
1297 |
\begin{lstlisting}
|
|
1298 |
EtherCAT: Master driver, 1.1 (stable) - rev. 513, |
|
1299 |
compiled by fp at Aug 09 2006 09:43:50 |
|
1300 |
EtherCAT: Initializing 2 EtherCAT master(s)... |
|
1301 |
EtherCAT: Initializing master 0. |
|
1302 |
EtherCAT: Initializing master 1. |
|
1303 |
EtherCAT: Master driver initialized. |
|
1304 |
\end{lstlisting}
|
|
1305 |
||
1306 |
The master provides information about it's version number, subversion |
|
1307 |
revision number and compile information, like the date of compilation |
|
1308 |
and the user, who compiled. All messages are prefixed either with |
|
1309 |
\texttt{EtherCAT:}, \texttt{EtherCAT WARNING:} or \texttt{EtherCAT
|
|
1310 |
ERROR:}, which makes searching the logs easier. |
|
1311 |
||
1312 |
%------------------------------------------------------------------------------ |
|
1313 |
||
1314 |
\subsection{Class Reference}
|
|
1315 |
\label{sec:classes}
|
|
1316 |
||
1317 |
This section is not intended to be a complete reference of master |
|
1318 |
classes and functions\footnote{The comprehensive master reference can
|
|
1319 |
be obtained at http://etherlab.org/download/download-en.html}, but |
|
1320 |
will give a general survey of the master's classes, and how they |
|
1321 |
interact. |
|
1322 |
||
1323 |
Figure~\ref{fig:uml-all} shows an UML class diagram of the master
|
|
1324 |
classes. |
|
1325 |
||
1326 |
\begin{figure}[htbp]
|
|
1327 |
\centering |
|
1328 |
\includegraphics[width=\textwidth]{images/uml-all}
|
|
1329 |
\caption{UML class diagram with associations}
|
|
1330 |
\label{fig:uml-all}
|
|
1331 |
\end{figure}
|
|
1332 |
||
1333 |
The following subsections introduce serveral classes with their |
|
1334 |
attributes and methods. |
|
1335 |
||
1336 |
%------------------------------------------------------------------------------ |
|
1337 |
||
1338 |
\subsubsection{The Master Class}
|
|
1339 |
\label{sec:class-master}
|
|
1340 |
\index{Master!Class}
|
|
1341 |
||
1342 |
Figure~\ref{fig:uml-master} shows an UML class diagram of the master
|
|
1343 |
class. There is a short explanation of the attributes and methods |
|
1344 |
below. |
|
1345 |
||
1346 |
\begin{figure}[htbp]
|
|
1347 |
\centering |
|
1348 |
\includegraphics[width=.8\textwidth]{images/uml-master}
|
|
1349 |
\caption{Master UML class diagram}
|
|
1350 |
\label{fig:uml-master}
|
|
1351 |
\end{figure}
|
|
1352 |
||
1353 |
\paragraph{Master Attributes}
|
|
1354 |
||
1355 |
\begin{description}
|
|
1356 |
\item[list] is a listhead structure that is needed to manage the list |
|
1357 |
of masters in the master module (see section~\ref{sec:mastermod}).
|
|
1358 |
\item[reserved] is a flag, that marks the master as reserved for a |
|
1359 |
realtime module, so that a call to \textit{ecrt\_request\_master()}
|
|
1360 |
fails, if another module is already using the master. |
|
1361 |
\item[index] contains the number of the master. The first master will |
|
1362 |
get index 0, the second index 1, and so on. |
|
1363 |
\item[kobj] In order to make the master object available via Sysfs |
|
1364 |
(see section~\ref{sec:sysfs}), this structure is needed inside the
|
|
1365 |
master object (see section~\ref{sec:sysfs}).
|
|
1366 |
\item[slaves] is the list of slaves. It consists of objects of the |
|
1367 |
\textit{ec\_slave\_t} class (see section~\ref{sec:class-slave}).
|
|
1368 |
\item[slave\_count] is the number of slaves in the list. |
|
1369 |
\item[device] points to the network device that is used by the master |
|
1370 |
to send and receive frames (see section~\ref{sec:class-device}). It
|
|
1371 |
is \textit{NULL}, if no device is connected.
|
|
1372 |
\item[datagram\_queue] is a list of datagrams (see |
|
1373 |
section~\ref{sec:class-datagram}) that have to be sent by the
|
|
1374 |
master, or have already been sent and wait to be received again. |
|
1375 |
Upon reception or error, the datagrams are dequeued. |
|
1376 |
\item[datagram\_index] contains the index value for the next datagram. |
|
1377 |
The master stores this incrementing index into every datagram, to |
|
1378 |
make it easier to assign a received datagram to the one sent before. |
|
1379 |
\item[domains] contains the list of domains created by the realtime |
|
1380 |
module (section~\ref{sec:class-domain}).
|
|
1381 |
\item[debug\_level] controls, how much debugging output is printed by |
|
1382 |
the master: 0 means no debugging output, 1 means to output certain |
|
1383 |
executing marks and actions, and 2 means to output frame contents in |
|
1384 |
addition. This value can be changed at runtime via the Sysfs |
|
1385 |
interface (see section~\ref{sec:sysfs}).
|
|
1386 |
\item[stats] is a statistics object that contains certain counters |
|
1387 |
(like the number of missed frames). These statistics are output on |
|
1388 |
demand, but at most once a second. |
|
1389 |
\item[workqueue] is the kernel workqueue used for idle mode. |
|
1390 |
\item[idle\_work] is the work object, that is queued. |
|
1391 |
\item[fsm] The attribute \textit{fsm} represents the master's finite
|
|
1392 |
state machine, that does all the slave processing. See |
|
1393 |
sections~\ref{sec:class-fsm} and~\ref{sec:fsm} for further details.
|
|
1394 |
\item[mode] contains the current master mode, if it is orphaned, idle, |
|
1395 |
or in operation mode. |
|
1396 |
\item[eoe\_timer] is the kernel timer used for EoE\index{EoE}
|
|
1397 |
processing. |
|
1398 |
\item[eoe\_running] marks the state of EoE processing. |
|
1399 |
\item[eoe\_handlers] is the list of EoE handlers (see |
|
1400 |
section~\ref{sec:class-eoe}).
|
|
1401 |
\item[internal\_lock] is a spinlock used in idle mode, that controls |
|
1402 |
the concurrency of the idle and EoE processes. |
|
1403 |
\item[request\_cb] The ``request lock'' callback function, the master |
|
1404 |
has to provide for foreign instances, which want to access the |
|
1405 |
master (see section~\ref{sec:concurr}).
|
|
1406 |
\item[release\_cb] The callback function that will release the master |
|
1407 |
lock. |
|
1408 |
\item[cb\_data] This value will be passed as an argument to each |
|
1409 |
callback. |
|
1410 |
\item[eeprom\_write\_enable] flag can be written via Sysfs to enable |
|
1411 |
the general writing of E$^2$PROM contents. |
|
1412 |
\end{description}
|
|
1413 |
||
1414 |
\paragraph{Public Master Methods}
|
|
1415 |
||
1416 |
\begin{description}
|
|
1417 |
\item[ec\_master\_init()] is the master's constructor. It initializes |
|
1418 |
all attributes, creates the workqueue, creates EoE handlers and the |
|
1419 |
state machine object, and adds the kernel object to the Sysfs |
|
1420 |
hierarchy. |
|
1421 |
\item[ec\_master\_clear()] is the destructor and undoes all these |
|
1422 |
actions. |
|
1423 |
\item[ec\_master\_reset()] clears the master, but initializes it |
|
1424 |
again. This is needed, when a realtime module disconnects: Slaves |
|
1425 |
and other attributes are cleared and are later rebuilt by the idle |
|
1426 |
process. |
|
1427 |
\item[ec\_master\_idle\_start/stop()] These methods enable or disable |
|
1428 |
the idle process. |
|
1429 |
\item[ec\_master\_eoe\_start/stop()] These methods do the same for the |
|
1430 |
EoE timer. |
|
1431 |
\item[ec\_master\_receive\_datagrams()] This method is called by the |
|
1432 |
device, which uses it to pass received frames to the master. The |
|
1433 |
frame is dissected and the contained datagrams are assigned to the |
|
1434 |
datagram objects in the datagram queue, which are dequeued on |
|
1435 |
reception or error. |
|
1436 |
\item[ec\_master\_queue\_datagram()] This method is used to queue a |
|
1437 |
new datagram for sending and receiving. |
|
1438 |
\item[ec\_master\_output\_stats()] This method is cyclically called to |
|
1439 |
output a summary of the \textit{stats} attribute at most once a
|
|
1440 |
second. |
|
1441 |
\item[ec\_master\_clear\_slaves()] clears the list of slaves. This is |
|
1442 |
needed on connection/disconnection of a realtime module or at a |
|
1443 |
topology change in idle mode, when all slaves objects are rebuilt. |
|
1444 |
\end{description}
|
|
1445 |
||
1446 |
\paragraph{Private Master Methods}
|
|
1447 |
||
1448 |
A few of a master's methods are private, meaning, that they can only |
|
1449 |
be called from other master methods: |
|
1450 |
||
1451 |
\begin{description}
|
|
1452 |
\item[ec\_master\_send\_datagrams()] searches the datagram queue for |
|
1453 |
unsent datagrams, allocates frames to send them, does the actual |
|
1454 |
sending and marks the datagrams as sent. |
|
1455 |
\item[ec\_master\_idle\_run()] is the work function for the idle mode. |
|
1456 |
It executes the idle state machine, described in |
|
1457 |
section~\ref{sec:fsm-idle}.
|
|
1458 |
\item[ec\_master\_eoe\_run()] is called by the EoE timer and is |
|
1459 |
responsible for communicating with EoE-capable slaves. See |
|
1460 |
section~\ref{sec:eoeimp} for more information.
|
|
1461 |
\end{description}
|
|
1462 |
||
1463 |
\paragraph{Master Methods (Realtime Interface)}
|
|
1464 |
||
1465 |
The master methods belonging to the Eth\-er\-CAT realtime |
|
1466 |
interface\index{ecrt@\textit{ecrt}}\nomenclature{ecrt}{EtherCAT
|
|
1467 |
Realtime Interface} begin with the prefix \textit{ecrt} instead of
|
|
1468 |
\textit{ec}. The functions of the realtime interface are explained in
|
|
1469 |
section~\ref{sec:ecrt-master}.
|
|
1470 |
||
1471 |
%------------------------------------------------------------------------------ |
|
1472 |
||
1473 |
\subsubsection{The Slave Class}
|
|
1474 |
\label{sec:class-slave}
|
|
1475 |
\index{Slave!Class}
|
|
1476 |
||
1477 |
Figure~\ref{fig:uml-slave} shows an UML class diagram of the slave
|
|
1478 |
class. There is a short explanation of the attributes and methods |
|
1479 |
below. |
|
1480 |
||
1481 |
\begin{figure}[htbp]
|
|
1482 |
\centering |
|
1483 |
\includegraphics[width=.8\textwidth]{images/uml-slave}
|
|
1484 |
\caption{Slave UML class diagram}
|
|
1485 |
\label{fig:uml-slave}
|
|
1486 |
\end{figure}
|
|
1487 |
||
1488 |
\paragraph{Slave Attributes}
|
|
1489 |
||
1490 |
\begin{description}
|
|
1491 |
\item[list] The master holds a slave list, therefore the slave class |
|
1492 |
must contain this structure used as an anchor for the linked |
|
1493 |
list. |
|
1494 |
\item[kobj] This pointer serves as base object for the slave's Sysfs |
|
1495 |
representation. |
|
1496 |
\item[master] is the pointer to the master owning this slave object. |
|
1497 |
\item[ring\_position] is the logical position in the logical ring |
|
1498 |
topology. |
|
1499 |
\item[station\_address] is the configured station address. This is |
|
1500 |
always the ring position~+~$1$). |
|
1501 |
\item[coupler\_index] is the index of the last bus coupler. |
|
1502 |
\item[coupler\_subindex] is the slave's position, counted from the |
|
1503 |
last bus coupler. See section~\ref{sec:addr} for more information.
|
|
1504 |
\item[base\_*] These attributes contain base information about the |
|
1505 |
slave, that are read from the ``DL Information'' attribute. |
|
1506 |
\item[dl\_*] These fields store information of the ``DL Status'' |
|
1507 |
attribute, for example states of the the communication ports. |
|
1508 |
\item[sii\_*] These attributes contain values from the ``Slave |
|
1509 |
Information Interface'' \cite[section~6.4]{dlspec}, mostly identity
|
|
1510 |
and mailbox information, but also the list of sync manager |
|
1511 |
configurations and PDOs. |
|
1512 |
\item[registered] This flag is set, if one or more PDOs of the slave |
|
1513 |
have been registered for process data exchange. Otherwise a warning |
|
1514 |
is output, because the slave is unused. |
|
1515 |
\item[fmmus] Is an array of FMMU configurations, that have to be |
|
1516 |
applied to the slave. |
|
1517 |
\item[fmmu\_count] contains number of FMMUs used. |
|
1518 |
\item[eeprom\_*] These fields contain E$^2$PROM contents and the |
|
1519 |
extracted category information \cite[section~5.4]{alspec}.
|
|
1520 |
\item[new\_eeprom\_data] If this pointer is not \textit{NULL}, it
|
|
1521 |
points to new E$^2$PROM contents, that have to be written to the |
|
1522 |
slave. |
|
1523 |
\item[new\_eeprom\_size] This field represents the size of the new |
|
1524 |
E$^2$PROM data. |
|
1525 |
\item[requested\_state] is the requested slave state. |
|
1526 |
\item[current\_state] is the current slave state. |
|
1527 |
\item[error\_flag] is used by the operation and idle state machines |
|
1528 |
to indicate, that a state transisition has failed and should not be |
|
1529 |
tried again until an external event happens. |
|
1530 |
\item[online] This flag contains the online state of the slave (i.~e. |
|
1531 |
if it currently responds to the masters commands). Changes of the |
|
1532 |
online state are always reported. |
|
1533 |
\item[varsize\_fields] is only suitable for slaves that provide PDOs |
|
1534 |
of variable size (like slaves that manage a sub-fieldbus) and |
|
1535 |
contains information about what size this fields actually should |
|
1536 |
have. |
|
1537 |
\end{description}
|
|
1538 |
||
1539 |
\paragraph{Public Slave Methods}
|
|
1540 |
||
1541 |
\begin{description}
|
|
1542 |
\item[ec\_slave\_init()] The slave's constructor. |
|
1543 |
\item[ec\_slave\_clear()] The slave's destructor. |
|
1544 |
\item[ec\_prepare\_fmmu()] prepares an FMMU configuration. The FMMU is |
|
1545 |
configured for a certain sync manager and domain. |
|
1546 |
\item[ec\_fetch\_*()] Serveral methods to extract information of the |
|
1547 |
E$^2$PROM category contents. |
|
1548 |
\item[ec\_slave\_locate\_string()] extracts a string out of a STRING |
|
1549 |
category and allocates string memory. |
|
1550 |
\item[ec\_slave\_calc\_sync\_size()] calculates the size of sync |
|
1551 |
manager contents, because they can be variable due to variable-sized |
|
1552 |
PDOs. |
|
1553 |
\item[ec\_slave\_info()] This method prints all slave information into |
|
1554 |
a buffer for Sysfs reading. |
|
1555 |
\item[ec\_slave\_mbox\_*()] These functions prepare datagrams for |
|
1556 |
mailbox communication, or process mailbox responses, respectively. |
|
1557 |
\end{description}
|
|
1558 |
||
1559 |
\paragraph{Private Slave Methods}
|
|
1560 |
||
1561 |
\begin{description}
|
|
1562 |
\item[ec\_slave\_write\_eeprom()] This function accepts E$^2$PROM data |
|
1563 |
from user space, does a quick validation of the contents and |
|
1564 |
schedules them for writing through the idle state machine. |
|
1565 |
\end{description}
|
|
1566 |
||
1567 |
\paragraph{Slave Methods (Realtime Interface)}
|
|
1568 |
||
1569 |
\begin{description}
|
|
1570 |
\item[ecrt\_slave\_conf\_sdo*()] These methods accept SDO |
|
1571 |
configurations, that are applied on slave activation (i.~e. |
|
1572 |
everytime the slave is configured). The methods differ only in the |
|
1573 |
data size of the SDO (8, 16 or 32 bit). |
|
1574 |
\item[ecrt\_slave\_pdo\_size()] This method specifies the size of a |
|
1575 |
variable-sized PDO. |
|
1576 |
\end{description}
|
|
1577 |
||
1578 |
%------------------------------------------------------------------------------ |
|
1579 |
||
1580 |
\subsubsection{The Device Class}
|
|
1581 |
\label{sec:class-device}
|
|
1582 |
\index{Device!Class}
|
|
1583 |
||
1584 |
The device class is responsible for communicating with the connected |
|
1585 |
EtherCAT-enabled network driver. Figure~\ref{fig:uml-device} shows its
|
|
1586 |
UML class diagram. |
|
1587 |
||
1588 |
\begin{figure}[htbp]
|
|
1589 |
\centering |
|
1590 |
\includegraphics[width=.3\textwidth]{images/uml-device}
|
|
1591 |
\caption{Device UML class diagram}
|
|
1592 |
\label{fig:uml-device}
|
|
1593 |
\end{figure}
|
|
1594 |
||
1595 |
\paragraph{Device Attributes}
|
|
1596 |
||
1597 |
\begin{description}
|
|
1598 |
\item[master] A pointer to the master, which owns the device object. |
|
1599 |
\item[dev] This is the pointer to the \textit{net\_device} structure
|
|
1600 |
of the connected network device driver. |
|
1601 |
\item[open] This flag stores, if the network device is ``opened'' and |
|
1602 |
ready for transmitting and receiving frames. |
|
1603 |
\item[tx\_skb] The transmittion socket buffer. Instead of allocating a |
|
1604 |
new socket buffer for each frame, the same socket buffer is recycled |
|
1605 |
and used for every frame. |
|
1606 |
\item[isr] The pointer to the network device's interrupt service |
|
1607 |
routine. \textit{ec\_isr\_t} is a type definition in the device
|
|
1608 |
interface, which looks like below: |
|
1609 |
\begin{lstlisting}[gobble=4,language=C]
|
|
1610 |
typedef irqreturn_t (*ec_isr_t)(int, void *, |
|
1611 |
struct pt_regs *); |
|
1612 |
\end{lstlisting}
|
|
1613 |
\item[module] A pointer to the network driver module, to increase and |
|
1614 |
decrease the use counter (see paragraph ``Implicit Dependencies'' in |
|
1615 |
section~\ref{sec:ecdev}).
|
|
1616 |
\item[link\_state] The current link state. It can be 0 ``down'' or 1 |
|
1617 |
``up''. |
|
1618 |
\item[dbg] Every device objects contains a debugging interface (see |
|
1619 |
sectios~\ref{sec:class-debug} and~\ref{sec:debug}).
|
|
1620 |
\end{description}
|
|
1621 |
||
1622 |
\paragraph{Public Device Methods}
|
|
1623 |
||
1624 |
\begin{description}
|
|
1625 |
\item[ec\_device\_init()] The device constructor. |
|
1626 |
\item[ec\_device\_clear()] The device destructor. |
|
1627 |
\item[ec\_device\_open()] ``Opens'' the device for transmittion and |
|
1628 |
reception of frames. This is equivalent to the \textit{ifconfig up}
|
|
1629 |
command for ordinary Ethernet devices. |
|
1630 |
\item[ec\_device\_close()] Stops frame transmittion and reception. |
|
1631 |
This is equivalent to the \textit{ifconfig down} command for
|
|
1632 |
ordinary Ethernet devices. |
|
1633 |
\item[ec\_device\_call\_isr()] Calls the interrupt service routine of |
|
1634 |
the device. |
|
1635 |
\item[ec\_device\_tx\_data()] Returns a pointer into the memory of the |
|
1636 |
transmittion socket buffer \textit{tx\_skb}. This is used by the
|
|
1637 |
master to assemble a new EtherCAT frame. |
|
1638 |
\item[ec\_device\_send()] Sends an assembled frame by passing it to |
|
1639 |
the device's \textit{hard\_\-start\_\-xmit()} callback.
|
|
1640 |
\end{description}
|
|
1641 |
||
1642 |
\paragraph{Device Methods (Device Interface)}
|
|
1643 |
||
1644 |
The device methods belonging to the device interface are explained in |
|
1645 |
section~\ref{sec:ecdev}.
|
|
1646 |
||
1647 |
%------------------------------------------------------------------------------ |
|
1648 |
||
1649 |
\subsubsection{The Datagram Class}
|
|
1650 |
\label{sec:class-datagram}
|
|
1651 |
\index{Datagram!Class}
|
|
1652 |
||
1653 |
So send and receive a datagram, an object of the |
|
1654 |
\textit{ec\_datagram\_t} class is needed. It can be initialized with a
|
|
1655 |
datagram type \cite[section~5.4]{dlspec} and length (optionally filled
|
|
1656 |
with data) and appended to the master's datagram queue. |
|
1657 |
Figure~\ref{fig:uml-datagram} shows its UML class diagram.
|
|
1658 |
||
1659 |
\begin{figure}[htbp]
|
|
1660 |
\centering |
|
1661 |
\includegraphics[width=.3\textwidth]{images/uml-datagram}
|
|
1662 |
\caption{Datagram UML class diagram}
|
|
1663 |
\label{fig:uml-datagram}
|
|
1664 |
\end{figure}
|
|
1665 |
||
1666 |
\paragraph{Datagram Attributes}
|
|
1667 |
||
1668 |
\begin{description}
|
|
1669 |
\item[list] This attribute is needed to make a list of datagrams, as |
|
1670 |
used in the domain class (see section~\ref{sec:class-domain}).
|
|
1671 |
\item[queue] This attribute is the anchor to the master's datagram |
|
1672 |
queue, which is implemented as a linked list. |
|
1673 |
\item[type] The datagram type. \textit{ec\_\-datagram\_\-type\_\-t} is
|
|
1674 |
an enumeration, which can have the values |
|
1675 |
\textit{EC\_\-DATAGRAM\_\-APRD}, \textit{EC\_\-DATAGRAM\_\-APWR},
|
|
1676 |
\textit{EC\_\-DATAGRAM\_\-NPRD}, \textit{EC\_\-DATAGRAM\_\-NPWR},
|
|
1677 |
\textit{EC\_\-DATAGRAM\_\-BRD}, \textit{EC\_\-DATAGRAM\_\-BWR} or
|
|
1678 |
\textit{EC\_\-DATAGRAM\_\-LRW}.
|
|
1679 |
\item[address] The slave address. For all addressing schemes take 4 |
|
1680 |
bytes, \textit{ec\_address\_t} is a union type:
|
|
1681 |
\begin{lstlisting}[gobble=4,language=C]
|
|
1682 |
typedef union {
|
|
1683 |
struct {
|
|
1684 |
uint16_t slave; /**< configured or |
|
1685 |
autoincrement |
|
1686 |
address */ |
|
1687 |
uint16_t mem; /**< physical memory |
|
1688 |
address */ |
|
1689 |
} physical; /**< physical address */ |
|
1690 |
uint32_t logical; /**< logical address */ |
|
1691 |
} ec_address_t; |
|
1692 |
\end{lstlisting}
|
|
1693 |
\item[data] The actual data of the datagram. These are either filled |
|
1694 |
in before sending (at writing access) or are inserted by the |
|
1695 |
adressed slave(s) (at reading access). In any case, the data memory |
|
1696 |
must be dynamically allocated. Besides, this can be done before |
|
1697 |
cyclic processing with the \textit{ec\_datagram\_prealloc()} method
|
|
1698 |
(see below). |
|
1699 |
\item[mem\_size] The size of the allocated memory, \textit{data}
|
|
1700 |
points to. |
|
1701 |
\item[data\_size] The size of the actual data in the \textit{data}
|
|
1702 |
memory. |
|
1703 |
\item[index] The sequential EtherCAT datagram index. This value is set |
|
1704 |
by the master on sending, to easier assign a received datagram to a |
|
1705 |
queued datagram object. |
|
1706 |
\item[working\_counter] The working counter of the datagram. This is |
|
1707 |
set to zero on sending and filled with the real value of the working |
|
1708 |
counter on datagram reception. |
|
1709 |
\item[state] The state of the datagram. |
|
1710 |
\textit{ec\_\-datagram\_\-state\_\-t} is an enumeration and can be
|
|
1711 |
\textit{EC\_\-DATA\-GRAM\_\-INIT},
|
|
1712 |
\textit{EC\_\-DATA\-GRAM\_\-QUEU\-ED},
|
|
1713 |
\textit{EC\_\-DATA\-GR\-AM\_\-SEN\-T},
|
|
1714 |
\textit{EC\_\-DATA\-GRAM\_\-REC\-EIVED},
|
|
1715 |
\textit{EC\_\-DATA\-GRAM\_\-TIMED\_\-OUT} or
|
|
1716 |
\textit{EC\_\-DA\-TA\-GRAM\_\-ERR\-OR}.
|
|
1717 |
\item[t\_sent] This attribute is set to the timestamp, when the |
|
1718 |
datagram was sent, to later detect a timeout. |
|
1719 |
\end{description}
|
|
1720 |
||
1721 |
\paragraph{Public Datagram Methods}
|
|
1722 |
||
1723 |
\begin{description}
|
|
1724 |
\item[ec\_datagram\_init()] The datagram's constructor. |
|
1725 |
\item[ec\_datagram\_clear()] The datagram's destructor. |
|
1726 |
\item[ec\_datagram\_prealloc()] Allocates memory for the datagram |
|
1727 |
data. This is especially needed, if the datagram structure will |
|
1728 |
later be used in a context, where no dynamic memory allocation is |
|
1729 |
allowed. |
|
1730 |
\item[ec\_datagram\_nprd()] Initializes a ``Node-Addressed Physical |
|
1731 |
Read'' datagram \cite[section~5.4.1.2]{dlspec}.
|
|
1732 |
\item[ec\_datagram\_npwr()] Initializes a ``Node-Addressed Physical |
|
1733 |
Write'' datagram \cite[section~5.4.2.2]{dlspec}.
|
|
1734 |
\item[ec\_datagram\_aprd()] Initializes a ``Auto-Increment Physical |
|
1735 |
Read'' datagram \cite[section~5.4.1.1]{dlspec}.
|
|
1736 |
\item[ec\_datagram\_apwr()] Initializes a ``Auto-Increment Physical |
|
1737 |
Write'' datagram \cite[section~5.4.2.1]{dlspec}.
|
|
1738 |
\item[ec\_datagram\_brd()] Initializes a ``Broadcast Read'' datagram |
|
1739 |
\cite[section~5.4.1.3]{dlspec}.
|
|
1740 |
\item[ec\_datagram\_bwr()] Initializes a ``Broadcast Write'' datagram |
|
1741 |
\cite[section~5.4.2.3]{dlspec}.
|
|
1742 |
\item[ec\_datagram\_lrw()] Initializes a ``Logical ReadWrite'' |
|
1743 |
datagram \cite[section~5.4.3.4]{dlspec}.
|
|
1744 |
\end{description}
|
|
1745 |
||
1746 |
%------------------------------------------------------------------------------ |
|
1747 |
||
1748 |
\subsubsection{The Domain Class}
|
|
1749 |
\label{sec:class-domain}
|
|
1750 |
\index{Domain!Class}
|
|
1751 |
||
1752 |
The domain class encapsules PDO registration and management of the |
|
1753 |
process data image and its exchange. The UML class diagram can be seen |
|
1754 |
in figure~\ref{fig:uml-domain}.
|
|
1755 |
||
1756 |
\begin{figure}[htbp]
|
|
1757 |
\centering |
|
1758 |
\includegraphics[width=.4\textwidth]{images/uml-domain}
|
|
1759 |
\caption{Domain UML class diagram}
|
|
1760 |
\label{fig:uml-domain}
|
|
1761 |
\end{figure}
|
|
1762 |
||
1763 |
\paragraph{Domain Attributes}
|
|
1764 |
||
1765 |
\begin{description}
|
|
1766 |
\item[kobj] This \textit{kobject} structure is needed for the Sysfs
|
|
1767 |
representation of the domain. |
|
1768 |
\item[list] The master manages a list of domains, so this list anchor |
|
1769 |
is needed. |
|
1770 |
\item[index] The domain's index. The first domain will get index 0, |
|
1771 |
the second index 1, and so on. |
|
1772 |
\item[master] A pointer to the master owning the domain. |
|
1773 |
\item[data\_size] The size of the domain's process data image. |
|
1774 |
\item[datagram] A linked list with the datagram objects, the domain |
|
1775 |
needs for process data exchange (see |
|
1776 |
section~\ref{sec:class-datagram}).
|
|
1777 |
\item[base\_address] This attribute stores the logical offset, to |
|
1778 |
which the domain's process data are mapped. |
|
1779 |
\item[response\_count] The sum of the datagrams' working counters at |
|
1780 |
the last process data exchange. Changes are always reported. |
|
1781 |
\item[data\_regs] The (linked) list of PDO registrations. The realtime |
|
1782 |
module requests the exchange of certain PDOs and supplies the |
|
1783 |
address of process data pointers, that will later point to the |
|
1784 |
respective locations in the process data image. These ``data |
|
1785 |
registrations'' are saved in the \textit{data\_regs} list.
|
|
1786 |
\item[working\_counter\_changes] This field stores the number of |
|
1787 |
working counter changes since the last notification. This helps to |
|
1788 |
reduce syslog output in case of frequent changes. |
|
1789 |
\item[t\_last] The timestamp of the last working counter change |
|
1790 |
notification. |
|
1791 |
\end{description}
|
|
1792 |
||
1793 |
\paragraph{Public Domain Methods}
|
|
1794 |
||
1795 |
\begin{description}
|
|
1796 |
\item[ec\_domain\_init()] The domain's constructor. |
|
1797 |
\item[ec\_domain\_clear()] The domain's destructor. |
|
1798 |
\item[ec\_domain\_alloc()] Allocates the process data image and the |
|
1799 |
respective datagrams based on the process data registrations. |
|
1800 |
\item[ec\_domain\_queue()] Queues the domain's datagrams for exchange |
|
1801 |
via the master. |
|
1802 |
\end{description}
|
|
1803 |
||
1804 |
\paragraph{Private Domain Methods}
|
|
1805 |
||
1806 |
\begin{description}
|
|
1807 |
\item[ec\_domain\_reg\_pdo\_entry()] This method is used to do a PDO |
|
1808 |
registration. It finds the appropriate sync manager covering the PDO |
|
1809 |
data, calculates its offset in the sync-manager-protected memory and |
|
1810 |
prepares the FMMU configurations for the related slave. Then the PDO |
|
1811 |
registration is appended to the list. |
|
1812 |
\item[ec\_domain\_clear\_data\_regs()] Clearing all process data |
|
1813 |
registrations is needed in serveral places and therefore has been |
|
1814 |
sourced out to an own method. |
|
1815 |
\item[ec\_domain\_add\_datagram()] This methods allocates a datagram |
|
1816 |
and appends it to the list. This is done during domain allocation. |
|
1817 |
\end{description}
|
|
1818 |
||
1819 |
\paragraph{Domain Methods (Realtime Interface)}
|
|
1820 |
||
1821 |
The domain methods belonging to the realtime interface are introduced |
|
1822 |
in section~\ref{sec:ecrt-domain}.
|
|
1823 |
||
1824 |
%------------------------------------------------------------------------------ |
|
1825 |
||
1826 |
\subsubsection{The Finite State Machine Class}
|
|
1827 |
\label{sec:class-fsm}
|
|
1828 |
\index{FSM!Class}
|
|
1829 |
||
1830 |
This class encapsules all state machines, except the EoE state |
|
1831 |
machine. Its UML class diagram can be seen in |
|
1832 |
figure~\ref{fig:uml-fsm}.
|
|
1833 |
||
1834 |
\begin{figure}[htbp]
|
|
1835 |
\centering |
|
1836 |
\includegraphics[width=.9\textwidth]{images/uml-fsm}
|
|
1837 |
\caption{Finite State Machine UML class diagram}
|
|
1838 |
\label{fig:uml-fsm}
|
|
1839 |
\end{figure}
|
|
1840 |
||
1841 |
\paragraph{FSM Attributes}
|
|
1842 |
||
1843 |
\begin{description}
|
|
1844 |
\item[master] A pointer to the master owning the FSM object. |
|
1845 |
\item[slave] Serveral sub state machines are executed for single |
|
1846 |
slaves. This pointer stores the current slave for these FSMs. |
|
1847 |
\item[datagram] The FSM class has its own datagram, which is used in |
|
1848 |
every state and sub-state. |
|
1849 |
\item[master\_state] This function pointer stores the current state |
|
1850 |
function for one of the master's state machines. |
|
1851 |
\item[master\_slaves\_responding] This attribute is used in the |
|
1852 |
operation state machine (see section~\ref{sec:fsm-op}) to store the
|
|
1853 |
number of slaves, that responded to the last broadcast command. |
|
1854 |
\item[master\_slave\_states] This attribute stores the slave states, |
|
1855 |
that were determined by the last broadcast command. |
|
1856 |
\item[master\_validation] This flag is used by the operation state |
|
1857 |
machine and is non-zero, if a bus validation has to be done. |
|
1858 |
\item[slave\_state] This function pointer stores the current state of |
|
1859 |
the slave scan state machine (see section~\ref{sec:fsm-scan}) or the
|
|
1860 |
slave configuration state machine (see section~\ref{sec:fsm-conf}).
|
|
1861 |
\item[sii\_state] This function pointer stores the current state of |
|
1862 |
the SII state machine (see section~\ref{sec:fsm-sii}).
|
|
1863 |
\item[sii\_offset] This attribute is used by the SII state machine to |
|
1864 |
store the word address for the current read or write cycle. |
|
1865 |
\item[sii\_mode] If this attribute is zero, the SII access is done |
|
1866 |
with ``auto-increment'' datagrams \cite[section~5.4]{dlspec}.
|
|
1867 |
If it is non-zero, ``station-address'' datagrams are used. |
|
1868 |
\item[sii\_value] This attribute stores the value to write, or the |
|
1869 |
read value, respectively. |
|
1870 |
\item[sii\_start] A timestamp attribute, that stores the beginning |
|
1871 |
time of an SII operation to detect a timeout. |
|
1872 |
\item[change\_state] This function pointer stores the current state of |
|
1873 |
the state change state machine. |
|
1874 |
\item[change\_new] This attribute stores the requested state for the |
|
1875 |
state change state machine. |
|
1876 |
\item[change\_start] A timestamp attribute to detect a timeout while |
|
1877 |
changing slave states. |
|
1878 |
\item[coe\_state] This function pointer stores the current state of |
|
1879 |
the CoE state machines. |
|
1880 |
\item[sdodata] This is an SDO data object that stores information |
|
1881 |
about the current SDO to write. |
|
1882 |
\item[coe\_start] A timestamp attribute to detect timeouts during CoE |
|
1883 |
configuration. |
|
1884 |
\end{description}
|
|
1885 |
||
1886 |
\paragraph{Public FSM Methods}
|
|
1887 |
||
1888 |
\begin{description}
|
|
1889 |
\item[ec\_fsm\_init()] Constructor of the FSM class. |
|
1890 |
\item[ec\_fsm\_clear()] Destructor of the FSM class. |
|
1891 |
\item[ec\_fsm\_reset()] Resets the whole FSM object. This is needed to |
|
1892 |
restart the master state machines. |
|
1893 |
\item[ec\_fsm\_execute()] Executes one state of the current state |
|
1894 |
machine and then returns. |
|
1895 |
\item[ec\_fsm\_startup()] Initializes the master startup state |
|
1896 |
machine, which determines the number of slaves and executes the |
|
1897 |
slave scan state machine for each slave. |
|
1898 |
\item[ec\_fsm\_startup\_running()] Returns non-zero, if the startup |
|
1899 |
state machine did not terminate yet. |
|
1900 |
\item[ec\_fsm\_startup\_success()] Returns non-zero, if the startup |
|
1901 |
state machine terminated with success. |
|
1902 |
\item[ec\_fsm\_configuration()] Initializes the master configuration |
|
1903 |
state machine, which executes the slave configuration state machine |
|
1904 |
for each slave. |
|
1905 |
\item[ec\_fsm\_configuration\_running()] Returns non-zero, if the |
|
1906 |
configuration state machine did not terminate yet. |
|
1907 |
\item[ec\_fsm\_configuration\_success()] Returns non-zero, if the |
|
1908 |
configuration state machine terminated with success. |
|
1909 |
\end{description}
|
|
1910 |
||
1911 |
\paragraph{FSM State Methods}
|
|
1912 |
||
1913 |
The rest of the methods showed in the UML class diagram are state |
|
1914 |
methods of the state machines. These states are described in |
|
1915 |
section~\ref{sec:fsm}.
|
|
1916 |
||
1917 |
%------------------------------------------------------------------------------ |
|
1918 |
||
1919 |
\subsubsection{The EoE Class}
|
|
1920 |
\label{sec:class-eoe}
|
|
1921 |
\index{EoE!Class}
|
|
1922 |
||
1923 |
Objects of the \textit{ec\_eoe\_t} class are called EoE handlers. Each
|
|
1924 |
EoE handler represents a virtual network interface and can be coupled |
|
1925 |
to a EoE-capable slave on demand. The UML class diagram can be seen in |
|
1926 |
figure~\ref{fig:uml-eoe}.
|
|
1927 |
||
1928 |
\begin{figure}[htbp]
|
|
1929 |
\centering |
|
1930 |
\includegraphics[width=.4\textwidth]{images/uml-eoe}
|
|
1931 |
\caption{EoE UML class diagram}
|
|
1932 |
\label{fig:uml-eoe}
|
|
1933 |
\end{figure}
|
|
1934 |
||
1935 |
\paragraph{EoE Attributes}
|
|
1936 |
||
1937 |
\begin{description}
|
|
1938 |
\item[list] The master class maintains a list of EoE handlers. |
|
1939 |
Therefore this list anchor is needed. |
|
1940 |
\item[slave] If an EoE handler is coupled to a slave, this pointer |
|
1941 |
points to the related slave object. Otherwise it is \textit{NULL}.
|
|
1942 |
\item[datagram] Every EoE handler owns a datagram object to exchange |
|
1943 |
data with the coupled slave via its state machine. |
|
1944 |
\item[state] This function pointer points to the current state of the |
|
1945 |
EoE state machine (see section~\ref{sec:eoeimp}).
|
|
1946 |
\item[dev] A pointer to the \textit{net\_device} structure that
|
|
1947 |
represents the network interface to the kernel. |
|
1948 |
\item[stats] The statistics object for the network interface. |
|
1949 |
\item[opened] This flag stores, if the network interface was opened. |
|
1950 |
No EoE processing will be done, if the device is not opened. |
|
1951 |
\item[t\_last] This timestamp attribute stores the time of the last |
|
1952 |
bit rate measurement. |
|
1953 |
\item[rx\_skb] A pointer to the current receive socket buffer. On |
|
1954 |
every first fragment of a received frame, a new receive socket |
|
1955 |
buffer is allocated. On every last fragment, this buffer will be |
|
1956 |
passed to the network stack. |
|
1957 |
\item[rx\_skb\_offset] This attribute stores the offset for the next |
|
1958 |
fragment data in the receive socket buffer. |
|
1959 |
\item[rx\_skb\_size] This attribute stores the current data size of |
|
1960 |
the receive socket buffer. |
|
1961 |
\item[rx\_expected\_fragment] The expected number of the next |
|
1962 |
fragment. If a fragment with an invalid number is received, the |
|
1963 |
whole frame will be dropped. |
|
1964 |
\item[rx\_counter] This is the sum of the octets received since the |
|
1965 |
last bit rate measurement. |
|
1966 |
\item[rx\_rate] This attribute stores the receive bit rate in bps. |
|
1967 |
\item[tx\_queue] Each EoE handler maintains a transmittion queue for |
|
1968 |
frames, that come in via the network interface. This queue is |
|
1969 |
implemented with a linked list and protected by a spinlock. |
|
1970 |
\item[tx\_queue\_active] This flag stores, if the transmittion queue |
|
1971 |
is currently accepting frames from the network stack. If the queue |
|
1972 |
gets filled up, frame transmittion is suspended with a call to |
|
1973 |
\textit{netif\_stop\_queue()}. If the fill state decreases below the
|
|
1974 |
half capacity, frame transmittion is restarted with |
|
1975 |
\textit{netif\_wake\_queue()}.
|
|
1976 |
\item[tx\_queued\_frames] The number of frames in the transmittion |
|
1977 |
queue. |
|
1978 |
\item[tx\_queue\_lock] The spinlock used to protect the transmittion |
|
1979 |
queue. This is needed, because the queue is accessed both from |
|
1980 |
network stack context and from the master's EoE timer. |
|
1981 |
\item[tx\_frame] The frame that is currently sent. The |
|
1982 |
\textit{ec\_eoe\_frame\_t} structure combines the socket buffer
|
|
1983 |
structure with a list head to append it to the transmittion queue. |
|
1984 |
\item[tx\_frame\_number] The EoE protocol demands to maintain a |
|
1985 |
sequencial frame number, that must be increased with every frame |
|
1986 |
sent. |
|
1987 |
\item[tx\_fragment\_number] The sequencial number of the next fragment |
|
1988 |
to transmit. |
|
1989 |
\item[tx\_offset] Current frame data offset for the next fragment to |
|
1990 |
transmit. |
|
1991 |
\item[tx\_counter] The number of octets transferred since the last bit |
|
1992 |
rate measurement. |
|
1993 |
\item[tx\_rate] The recent transmittion bit rate in bps. |
|
1994 |
\end{description}
|
|
1995 |
||
1996 |
\paragraph{Public EoE Methods}
|
|
1997 |
||
1998 |
\begin{description}
|
|
1999 |
\item[ec\_eoe\_init()] The EoE handler's constructor. The network |
|
2000 |
interface is allocated and registered. |
|
2001 |
\item[ec\_eoe\_clear()] The EoE handler's destructor. The network |
|
2002 |
interface is unregistered and all allocated memory is freed. |
|
2003 |
\item[ec\_eoe\_run()] Executes the EoE state machine (see |
|
2004 |
section~\ref{sec:eoeimp}) for this handler.
|
|
2005 |
\item[ec\_eoe\_active()] Returns true, if the handler has a slave |
|
2006 |
coupled and the network interface is opened. |
|
2007 |
\end{description}
|
|
2008 |
||
2009 |
\paragraph{Private EoE Methods}
|
|
2010 |
||
2011 |
\begin{description}
|
|
2012 |
\item[ec\_eoe\_flush()] Clears the transmittion queue and drops all |
|
2013 |
frames queued for sending. |
|
2014 |
\item[ec\_eoe\_send()] Sends one fragment of the current frame. |
|
2015 |
\end{description}
|
|
2016 |
||
2017 |
||
2018 |
\paragraph{EoE State Methods}
|
|
2019 |
||
2020 |
The rest of the private methods are state functions for the EoE state |
|
2021 |
machine, which is discussed in section~\ref{sec:eoeimp}.
|
|
2022 |
||
2023 |
%------------------------------------------------------------------------------ |
|
2024 |
||
2025 |
\subsubsection{The Debug Class}
|
|
2026 |
\label{sec:class-debug}
|
|
2027 |
||
2028 |
The debug class maintains a virtual network interface. All frames that |
|
2029 |
are sent and received by the master will be forwarded to this network |
|
2030 |
interface, so that bus monitoring can be done with third party tools |
|
2031 |
(see section~\ref{sec:debug}). Figure~\ref{fig:uml-debug} shows the
|
|
2032 |
UML class diagram. |
|
2033 |
||
2034 |
\begin{figure}[htbp]
|
|
2035 |
\centering |
|
2036 |
\includegraphics[width=.3\textwidth]{images/uml-debug}
|
|
2037 |
\caption{Debug UML class diagram}
|
|
2038 |
\label{fig:uml-debug}
|
|
2039 |
\end{figure}
|
|
2040 |
||
2041 |
\paragraph{Debug Attributes}
|
|
2042 |
||
2043 |
\begin{description}
|
|
2044 |
\item[dev] A pointer to the allocated \textit{net\_device} structure
|
|
2045 |
that represents the network interface in the kernel. |
|
2046 |
\item[stats] An object for interface statistics. |
|
2047 |
\item[opened] Stores the state of the device. Frames will only be |
|
2048 |
forwarded, if the device was opened with the \textit{ifconfig up}
|
|
2049 |
command (or something similar). |
|
2050 |
\end{description}
|
|
2051 |
||
2052 |
\paragraph{Public Debug Methods}
|
|
2053 |
||
2054 |
\begin{description}
|
|
2055 |
\item[ec\_debug\_init()] The constructor. |
|
2056 |
\item[ec\_debug\_clear()] The destructor. |
|
2057 |
\item[ec\_debug\_send()] This method forwards a frame to the virtual |
|
2058 |
network interface. It dynamically allocates a new socket buffer and |
|
2059 |
passes it to the network stack. |
|
2060 |
\end{description}
|
|
2061 |
||
2062 |
%------------------------------------------------------------------------------ |
|
2063 |
||
2064 |
\subsection{The Realtime Interface}
|
|
2065 |
\label{sec:ecrt}
|
|
2066 |
\index{Realtime interface}
|
|
2067 |
||
2068 |
The realtime interface provides functions and data structures for |
|
2069 |
realtime modules to access and use an EtherCAT master. |
|
2070 |
||
2071 |
\subsubsection{Master Requesting and Releasing}
|
|
2072 |
||
2073 |
Before a realtime module can access am EtherCAT master provided by the |
|
2074 |
master module, it has to reserve one for exclusive use. After use, it |
|
2075 |
has to release the requested master and make it available for other |
|
2076 |
modules. This is done with the following functions: |
|
2077 |
||
2078 |
\begin{lstlisting}[language=C]
|
|
2079 |
ec_master_t *ecrt_request_master(unsigned int master_index); |
|
2080 |
void ecrt_release_master(ec_master_t *master); |
|
2081 |
\end{lstlisting}
|
|
2082 |
||
2083 |
The \textit{ecrt\_request\_master()} function has to be the first
|
|
2084 |
function a module has to call, when using EtherCAT. The function takes |
|
2085 |
the index of the master as its argument. The first master has index 0, |
|
2086 |
the $n$th master has index $n - 1$. The number of existent masters has |
|
2087 |
to be specified when loading the master module (see |
|
2088 |
section~\ref{sec:mastermod}). The function tries to reserve the
|
|
2089 |
specified master and scans for slaves. It returns a pointer to the |
|
2090 |
reserved master object upon success, or \textit{NULL} if an error
|
|
2091 |
occured. |
|
2092 |
||
2093 |
The \textit{ecrt\_release\_master()} function releases a reserved
|
|
2094 |
master after use. It takes the pointer to the master object returned |
|
2095 |
by \textit{ecrt\_request\_master()} as its argument and can never
|
|
2096 |
fail. |
|
2097 |
||
2098 |
\subsubsection{Master Methods}
|
|
2099 |
\label{sec:ecrt-master}
|
|
2100 |
||
2101 |
\paragraph{Domain Creation}
|
|
2102 |
||
2103 |
For process data exchange, at least one process data domain is needed |
|
2104 |
(see section~\ref{sec:processdata}).
|
|
2105 |
||
2106 |
\begin{lstlisting}[language=C]
|
|
2107 |
ec_domain_t *ecrt_master_create_domain(ec_master_t *master); |
|
2108 |
\end{lstlisting}
|
|
2109 |
||
2110 |
The \textit{ecrt\_master\_create\_domain()} method creates a new
|
|
2111 |
process data domain and returns a pointer to the new domain object. |
|
2112 |
This object can be used for registering process data objects and |
|
2113 |
exchange process data in cyclic operation. On failure, the function |
|
2114 |
returns \textit{NULL}.
|
|
2115 |
||
2116 |
\paragraph{Slave Handlers}
|
|
2117 |
||
2118 |
To access a certain slave, there is a method to get a slave handler: |
|
2119 |
||
2120 |
\begin{lstlisting}[language=C]
|
|
2121 |
ec_slave_t *ecrt_master_get_slave(const ec_master_t *, |
|
2122 |
const char *); |
|
2123 |
\end{lstlisting}
|
|
2124 |
||
2125 |
The \textit{ecrt\_master\_get\_slave()} method returns a pointer to a
|
|
2126 |
certain slave object, specified by its ASCII address (see |
|
2127 |
section~\ref{sec:addr}). If the address is invalid, \textit{NULL} is
|
|
2128 |
returned. |
|
2129 |
||
2130 |
\paragraph{Master Activation}
|
|
2131 |
||
2132 |
When all domains are created, and all process data objects are |
|
2133 |
registered, the master can be activated: |
|
2134 |
||
2135 |
\begin{lstlisting}[language=C]
|
|
2136 |
int ecrt_master_activate(ec_master_t *master); |
|
2137 |
void ecrt_master_deactivate(ec_master_t *master); |
|
2138 |
\end{lstlisting}
|
|
2139 |
||
2140 |
By calling the \textit{ecrt\_master\_activate()} method, all slaves
|
|
2141 |
are configured according to the prior method calls and are brought |
|
| 379 | 2142 |
into OP state. In this case, the method has a return value of 0. |
2143 |
Otherwise (wrong configuration or bus failure) the method returns |
|
| 369 | 2144 |
non-zero. |
2145 |
||
2146 |
The \textit{ecrt\_master\_deactivate()} method is the counterpart to
|
|
| 379 | 2147 |
the activate call: It brings all slaves back into INIT state again. |
2148 |
This method should be called prior to |
|
| 369 | 2149 |
\textit{ecrt\_\-master\_\-release()}.
|
2150 |
||
2151 |
\paragraph{Locking Callbacks}
|
|
2152 |
||
2153 |
For concurrent master access, the realtime module has to provide a |
|
2154 |
locking mechanism (see section~\ref{sec:concurr}):
|
|
2155 |
||
2156 |
\begin{lstlisting}[language=C]
|
|
2157 |
void ecrt_master_callbacks(ec_master_t *master, |
|
2158 |
int (*request_cb)(void *), |
|
2159 |
void (*release_cb)(void *), |
|
2160 |
void *cb_data); |
|
2161 |
\end{lstlisting}
|
|
2162 |
||
2163 |
The ``request lock'' and ``release lock'' callbacks can be set with |
|
2164 |
the \textit{ecrt\_master\_call\-backs()} method. It takes two function
|
|
2165 |
pointers and a data value as additional arguments. The arbitrary data |
|
2166 |
value will be passed as argument on every callback. Asynchronous |
|
2167 |
master access (like EoE processing) is only possible if these |
|
2168 |
callbacks have been set. |
|
2169 |
||
2170 |
\paragraph{Preparation of Cyclic Data Exchange}
|
|
2171 |
||
2172 |
Cyclic operation mostly consists of the three steps input, processing |
|
2173 |
and output. In EtherCAT terms this would mean: Receive datagrams, |
|
2174 |
evaluate process data and send datagrams. The first cycle differs from |
|
2175 |
this principle, because no datagrams have been sent yet, so there is |
|
2176 |
nothing to receive. To avoid having a case differantiation (in terms |
|
2177 |
of an \textit{if} clause), the following method exists:
|
|
2178 |
||
2179 |
\begin{lstlisting}[language=C]
|
|
2180 |
void ecrt_master_prepare(ec_master_t *master); |
|
2181 |
\end{lstlisting}
|
|
2182 |
||
2183 |
As a last thing before cyclic operation, a call to the |
|
2184 |
\textit{ecrt\_master\_prepare()} method should be issued. It makes all
|
|
2185 |
process data domains queue their datagrams and issues a send command, |
|
2186 |
so that the first receive call in cyclic operation will not fail. |
|
2187 |
||
2188 |
\paragraph{Frame Sending and Receiving}
|
|
2189 |
||
2190 |
To send all queued datagrams and to later receive the sent datagrams |
|
2191 |
there are two methods: |
|
2192 |
||
2193 |
\begin{lstlisting}[language=C]
|
|
2194 |
void ecrt_master_send(ec_master_t *master); |
|
2195 |
void ecrt_master_receive(ec_master_t *master); |
|
2196 |
\end{lstlisting}
|
|
2197 |
||
2198 |
The \textit{ecrt\_master\_send()} method takes all datagrams, that
|
|
2199 |
have been queued for transmission, packs them into frames, and passes |
|
2200 |
them to the network device for sending. |
|
2201 |
||
2202 |
The \textit{ecrt\_master\_receive()} queries the network device for
|
|
2203 |
received frames (by calling the ISR\index{ISR}), extracts received
|
|
2204 |
datagrams and dispatches the results to the datagram objects in the |
|
2205 |
queue. Received datagrams, and the ones that timed out, will be |
|
2206 |
marked, and then dequeued. |
|
2207 |
||
2208 |
\paragraph{Running the Operation State Machine}
|
|
2209 |
||
2210 |
The master's operation state machine (see section~\ref{sec:fsm-op})
|
|
2211 |
monitors the bus in cyclic operation and reconfigures slaves, if |
|
2212 |
necessary. Therefore, the following method should be called |
|
2213 |
cyclically: |
|
2214 |
||
2215 |
\begin{lstlisting}[language=C]
|
|
2216 |
void ecrt_master_run(ec_master_t *master); |
|
2217 |
\end{lstlisting}
|
|
2218 |
||
2219 |
The \textit{ecrt\_master\_run()} method executes the master's
|
|
2220 |
operation state machine step by step. It returns after processing one |
|
2221 |
state and queuing a datagram. Calling this function is not mandatory, |
|
2222 |
but highly recommended. |
|
2223 |
||
2224 |
\paragraph{Master Monitoring}
|
|
2225 |
||
2226 |
It is also highly recommended to evaluate the master's error state. In |
|
2227 |
this way it is possible to notice lost network links, failed bus |
|
2228 |
segments, and other issues: |
|
2229 |
||
2230 |
\begin{lstlisting}[language=C]
|
|
2231 |
int ecrt_master_state(const ec_master_t *master); |
|
2232 |
\end{lstlisting}
|
|
2233 |
||
2234 |
The \textit{ecrt\_master\_state()} method returns the master's error
|
|
2235 |
state. The following states are defined as part of the realtime |
|
2236 |
interface: |
|
2237 |
||
2238 |
\begin{description}
|
|
2239 |
\item[EC\_MASTER\_OK] means, that no error has occurred. |
|
2240 |
\item[EC\_MASTER\_LINK\_ERROR] means, that the network link is |
|
2241 |
currently down. |
|
2242 |
\item[EC\_MASTER\_BUS\_ERROR] means, that one or more slaves do not |
|
2243 |
respond. |
|
2244 |
\end{description}
|
|
2245 |
||
2246 |
\subsubsection{Domain Methods}
|
|
2247 |
\label{sec:ecrt-domain}
|
|
2248 |
||
2249 |
\paragraph{PDO Registration}
|
|
2250 |
||
2251 |
To access data of a slave's PDO in cyclic operation, it is necessary |
|
2252 |
to make it part of a process data domain: |
|
2253 |
||
2254 |
\begin{lstlisting}[language=C]
|
|
2255 |
ec_slave_t *ecrt_domain_register_pdo(ec_domain_t *domain, |
|
2256 |
const char *address, |
|
2257 |
uint32_t vendor_id, |
|
2258 |
uint32_t product_code, |
|
2259 |
const char *pdo_name |
|
2260 |
void **data_ptr); |
|
2261 |
int ecrt_domain_register_pdo_list(ec_domain_t *domain, |
|
2262 |
const ec_pdo_reg_t *pdos); |
|
2263 |
\end{lstlisting}
|
|
2264 |
||
2265 |
The \textit{ecrt\_domain\_register\_pdo()} method registers a certain
|
|
2266 |
PDO as part of the domain and takes the address of the process data |
|
2267 |
pointer. This pointer will be set on master activation and then can be |
|
2268 |
parameter to the \textit{EC\_READ\_*} and \textit{EC\_WRITE\_*} macros
|
|
2269 |
described below. |
|
2270 |
||
2271 |
A perhaps easier way to register multiple PDOs at the same time is to |
|
2272 |
fill an array of \textit{ec\_pdo\_reg\_t} and hand it to the
|
|
2273 |
\textit{ecrt\_domain\_register\_pdo\_list()} method. Attention: This
|
|
2274 |
array has to be terminated by an empty structure (\textit{\{\}})!
|
|
2275 |
||
2276 |
\paragraph{Evaluating Domain Data}
|
|
2277 |
||
2278 |
To evaluate domain data, the following method has to be used: |
|
2279 |
||
2280 |
\begin{lstlisting}[language=C]
|
|
2281 |
void ecrt_domain_process(ec_domain_t *domain); |
|
2282 |
\end{lstlisting}
|
|
2283 |
||
2284 |
The \textit{ecrt\_domain\_process()} method sets the domains state and
|
|
2285 |
requeues its datagram for sending. |
|
2286 |
||
2287 |
\paragraph{Domain State}
|
|
2288 |
||
2289 |
Similar to the master state, a domain has an own error state: |
|
2290 |
||
2291 |
\begin{lstlisting}[language=C]
|
|
2292 |
int ecrt_domain_state(const ec_domain_t *domain); |
|
2293 |
\end{lstlisting}
|
|
2294 |
||
2295 |
The \textit{ecrt\_domain\_state()} method returns the domain's error
|
|
2296 |
state. It is non-zero if \underline{not} all process data values could
|
|
2297 |
be exchanged, and zero otherwise. |
|
2298 |
||
2299 |
\subsubsection{Slave Methods}
|
|
2300 |
\label{sec:ecrt-slave}
|
|
2301 |
||
2302 |
\paragraph{SDO Configuration}
|
|
2303 |
||
2304 |
To configure slave SDOs, the function interface below can be used: |
|
2305 |
||
2306 |
\begin{lstlisting}[language=C]
|
|
2307 |
int ecrt_slave_conf_sdo8(ec_slave_t *slave, |
|
2308 |
uint16_t sdo_index, |
|
2309 |
uint8_t sdo_subindex, |
|
2310 |
uint8_t value); |
|
2311 |
int ecrt_slave_conf_sdo16(ec_slave_t *slave, |
|
2312 |
uint16_t sdo_index, |
|
2313 |
uint8_t sdo_subindex, |
|
2314 |
uint16_t value); |
|
2315 |
int ecrt_slave_conf_sdo32(ec_slave_t *slave, |
|
2316 |
uint16_t sdo_index, |
|
2317 |
uint8_t sdo_subindex, |
|
2318 |
uint32_t value); |
|
2319 |
\end{lstlisting}
|
|
2320 |
||
2321 |
The \textit{ecrt\_slave\_conf\_sdo*()} methods prepare the
|
|
2322 |
configuration of a certain SDO. The index and subindex of the SDO, and |
|
2323 |
the value have to be specified. The configuration is done each time, |
|
2324 |
the slave is reconfigured. The methods only differ in the SDO's data |
|
2325 |
type. If the configuration could be prepared, zero is returned. If an |
|
2326 |
error occured, non-zero is returned. |
|
2327 |
||
2328 |
\paragraph{Variable-sized PDOs}
|
|
2329 |
||
2330 |
For specifying the size of variable-sized PDOs, the following method |
|
2331 |
can be used: |
|
2332 |
||
2333 |
\begin{lstlisting}[language=C]
|
|
2334 |
int ecrt_slave_pdo_size(ec_slave_t *slave, |
|
2335 |
const char *pdo_name, |
|
2336 |
size_t size); |
|
2337 |
\end{lstlisting}
|
|
2338 |
||
2339 |
The \textit{ecrt\_slave\_pdo\_size()} method takes the name of the PDO
|
|
2340 |
and the size. It returns zero on success, otherwise non-zero. |
|
2341 |
||
2342 |
\subsubsection{Process Data Access}
|
|
2343 |
\label{sec:macros}
|
|
2344 |
||
2345 |
The endianess of the process data could differ from that of the CPU. |
|
2346 |
Therefore, process data access has to be done by the macros below, |
|
2347 |
that are also provided by the realtime interface: |
|
2348 |
||
2349 |
\begin{lstlisting}[language=C]
|
|
2350 |
#define EC_READ_BIT(DATA, POS) |
|
2351 |
#define EC_WRITE_BIT(DATA, POS, VAL) |
|
2352 |
||
2353 |
#define EC_READ_U8(DATA) |
|
2354 |
#define EC_READ_S8(DATA) |
|
2355 |
#define EC_READ_U16(DATA) |
|
2356 |
#define EC_READ_S16(DATA) |
|
2357 |
#define EC_READ_U32(DATA) |
|
2358 |
#define EC_READ_S32(DATA) |
|
2359 |
||
2360 |
#define EC_WRITE_U8(DATA, VAL) |
|
2361 |
#define EC_WRITE_S8(DATA, VAL) |
|
2362 |
#define EC_WRITE_U16(DATA, VAL) |
|
2363 |
#define EC_WRITE_S16(DATA, VAL) |
|
2364 |
#define EC_WRITE_U32(DATA, VAL) |
|
2365 |
#define EC_WRITE_S32(DATA, VAL) |
|
2366 |
\end{lstlisting}
|
|
2367 |
||
2368 |
There are macros for bitwise access (\textit{EC\_READ\_BIT()},
|
|
2369 |
\textit{EC\_WRITE\_BIT()}), and bytewise access
|
|
2370 |
(\textit{EC\_READ\_*()}, \textit{EC\_WRITE\_*()}). The bytewise macros
|
|
2371 |
carry the data type in their name. Example: \textit{EC\_WRITE\_S16()}
|
|
2372 |
writes a 16 bit signed value to EtherCAT data. The \textit{DATA}
|
|
2373 |
parameter is supposed to be a process data pointer, as provided at PDO |
|
2374 |
registration. |
|
2375 |
||
2376 |
The macros use the kernel's endianess conversion macros, that are |
|
2377 |
preprocessed to empty macros in case of equal endianess. This is the |
|
2378 |
definition for the \textit{EC\_\-READ\_\-U16()} macro:
|
|
2379 |
||
2380 |
\begin{lstlisting}[language=C]
|
|
2381 |
#define EC_READ_U16(DATA) \ |
|
2382 |
((uint16_t) le16_to_cpup((void *) (DATA))) |
|
2383 |
\end{lstlisting}
|
|
2384 |
||
2385 |
The \textit{le16\_to\_cpup()} macro converts a little-endian, 16 bit
|
|
2386 |
value to the CPU's architecture and takes a pointer to the input value |
|
2387 |
as its argument. If the CPU's architecture is little-endian, too (for |
|
2388 |
example on X86 and compatible), nothing has to be converted. In this |
|
2389 |
case, the macro is replaced with an empty macro by the preprocessor |
|
2390 |
and so there is no unneeded function call or case differentiation in |
|
2391 |
the code. |
|
2392 |
||
2393 |
For keeping it portable, it is highly recommended to make use of these |
|
2394 |
macros. |
|
2395 |
||
2396 |
%------------------------------------------------------------------------------ |
|
2397 |
||
2398 |
\subsection{Slave Addressing}
|
|
2399 |
\label{sec:addr}
|
|
2400 |
\index{Slave!Addressing}
|
|
2401 |
||
2402 |
The master offers the serveral slave addressing schemes (for PDO |
|
2403 |
registration or configuration) via the realtime interface. For this |
|
2404 |
reason, slave addresses are ASCII\nomenclature{ASCII}{American
|
|
2405 |
Standard Code for Information Interchange}-coded and passed as a |
|
2406 |
string. The addressing schemes are independent of the EtherCAT |
|
2407 |
protocol and represent an additional feature of the master. |
|
2408 |
||
2409 |
Below, the allowed addressing schemes are described. The descriptions |
|
2410 |
are followed by a regular expression formally defining the addressing |
|
2411 |
scheme, and one or more examples. |
|
2412 |
||
2413 |
\begin{description}
|
|
2414 |
\item[Position Addressing] This is the normal addressing scheme, where |
|
2415 |
each slave is addressed by its ring position. The first slave has |
|
2416 |
address 0, and the $n$th slave has address $n - 1$. This addressing |
|
2417 |
scheme is useful for small busses that have a fixed number of slaves.\\ |
|
2418 |
RegEx: \texttt{[0-9]+} --- Example: \texttt{"42"}
|
|
2419 |
\item[Advanced Position Addressing] Bus couplers segment the bus into |
|
2420 |
(physical) blocks. Though the logical ring positions keep being the |
|
2421 |
same, it is easier to address a slave with its block number and the |
|
2422 |
relative position inside the block. This addressing is done by |
|
2423 |
passing the (zero-based) index of the bus coupler (not the coupler's |
|
2424 |
ring position), followed by a colon and the relative position of the |
|
2425 |
actual slave starting at the bus coupler.\\ |
|
2426 |
RegEx: \texttt{[0-9]+:[0-9]+} --- Examples: \texttt{"0:42"},
|
|
2427 |
\texttt{"2:7"}
|
|
2428 |
\item[Alias Addressing] Each slave can have a ``secondary slave |
|
2429 |
address'' or ``alias address''\footnote{Information about how to set
|
|
2430 |
the alias can be found in section~\ref{sec:eepromaccess}} stored
|
|
2431 |
in its E$^2$PROM. The alias is evaluated by the master and can be |
|
2432 |
used to address the slave, which is useful when a clearly defined |
|
2433 |
slave has to be addressed and the ring position is not known or can |
|
2434 |
change over time. This scheme is used by starting the address string |
|
2435 |
with a mesh (\#) followed by the alias address. The latter can also |
|
2436 |
be provided as hexadecimal value, prefixed with \textit{0x}.\\
|
|
2437 |
RegEx: \texttt{\#(0x[0-9A-F]+|[0-9]+)} --- Examples:
|
|
2438 |
\texttt{"\#6622"}, \texttt{"\#0xBEEF"}
|
|
2439 |
\item[Advanced Alias Addressing] This is a mixture of the ``Alias |
|
2440 |
Addressing'' and ``Advanced Position Addressing'' schemes. A certain |
|
2441 |
slave is addressed by specifying its relative position after an |
|
2442 |
aliased slave. This is very useful, if a complete block of slaves |
|
2443 |
can vary its position in the bus. The bus coupler preceeding the |
|
2444 |
block should get an alias. The block slaves can then be addressed by |
|
2445 |
specifying this alias and their position inside the block. This |
|
2446 |
scheme is used by starting the address string with a mesh (\#) |
|
2447 |
followed by the alias address (which can be hexadecimal), then a |
|
2448 |
colon and the relative posision of the slave to |
|
2449 |
address.\\ |
|
2450 |
RegEx: \texttt{\#(0x[0-9A-F]+|[0-9]+):[0-9]+} --- Examples:
|
|
2451 |
\texttt{"\#0xBEEF:7"}, \texttt{"\#6:2"}
|
|
2452 |
\end{description}
|
|
2453 |
||
2454 |
In anticipation of section~\ref{sec:ecrt}, the functions accepting
|
|
2455 |
these address strings are \textit{ecrt\_\-master\_\-get\_slave()},
|
|
2456 |
\textit{ecrt\_domain\_register\_pdo()} and
|
|
2457 |
\textit{ecrt\_domain\_register\_pdo\_list()} (the latter through the
|
|
2458 |
\textit{ec\_pdo\_reg\_t} structure).
|
|
2459 |
||
2460 |
%------------------------------------------------------------------------------ |
|
2461 |
||
2462 |
\subsection{Concurrent Master Access}
|
|
2463 |
\label{sec:concurr}
|
|
2464 |
\index{Concurrency}
|
|
2465 |
||
2466 |
In some cases, one master is used by serveral instances, for example |
|
2467 |
when a realtime module does cyclic process data exchange, and there |
|
2468 |
are EoE-capable slaves that require to exchange Ethernet data with the |
|
2469 |
kernel (see section~\ref{sec:eoeimp}). For this reason, the master is
|
|
2470 |
a shared resource, and access to it has to be sequenctialized. This is |
|
2471 |
usually done by locking with semaphores, or other methods to protect |
|
2472 |
critical sections. |
|
2473 |
||
2474 |
The master itself can not provide locking mechanisms, because it has |
|
2475 |
no chance to know the appropriate kind of lock. Imagine, the realtime |
|
2476 |
module uses RTAI functionality, then ordinary kernel semaphores would |
|
2477 |
not be sufficient. For that, an important design decision was made: |
|
2478 |
The realtime module that reserved a master must have the total |
|
2479 |
control, therefore it has to take responsibility for providing the |
|
2480 |
appropriate locking mechanisms. If another instance wants to access |
|
2481 |
the master, it has to request the master lock by callbacks, that have |
|
2482 |
to be set by the realtime module. Moreover the realtime module can |
|
2483 |
deny access to the master if it consideres it to be awkward at the |
|
2484 |
moment. |
|
2485 |
||
2486 |
\begin{figure}[htbp]
|
|
2487 |
\centering |
|
2488 |
\includegraphics[width=.6\textwidth]{images/master-locks}
|
|
2489 |
\caption{Concurrent master access}
|
|
2490 |
\label{fig:locks}
|
|
2491 |
\end{figure}
|
|
2492 |
||
2493 |
Figure~\ref{fig:locks} exemplary shows, how two processes share one
|
|
2494 |
master: The realtime module's cyclic thread uses the master for |
|
2495 |
process data exchange, while the master-internal EoE process uses it |
|
2496 |
to communicate with EoE-capable slaves. Both have to aquire the master |
|
2497 |
lock before access: The realtime thread can access the lock natively, |
|
2498 |
while the EoE process has to use the master callbacks. |
|
2499 |
Section~\ref{sec:concurrency} gives an example, of how to implement
|
|
2500 |
this. |
|
2501 |
||
2502 |
%------------------------------------------------------------------------------ |
|
2503 |
||
2504 |
\section{The Master's State Machines}
|
|
2505 |
\label{sec:fsm}
|
|
2506 |
\index{FSM}
|
|
2507 |
||
2508 |
Many parts of the EtherCAT master are implemented as \textit{finite
|
|
2509 |
state machines} (FSMs\nomenclature{FSM}{Finite State Machine}).
|
|
2510 |
Though this leads to a higher grade of complexity in some aspects, is |
|
2511 |
opens many new possibilities. |
|
2512 |
||
2513 |
The below short code example exemplary shows how to read all slave |
|
2514 |
states and moreover illustrates the restrictions of ``sequential'' |
|
2515 |
coding: |
|
2516 |
||
2517 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2518 |
ec_datagram_brd(datagram, 0x0130, 2); // prepare datagram |
|
2519 |
if (ec_master_simple_io(master, datagram)) return -1; |
|
2520 |
slave_states = EC_READ_U8(datagram->data); // process datagram |
|
2521 |
\end{lstlisting}
|
|
2522 |
||
2523 |
The \textit{ec\_master\_simple\_io()} function provides a simple
|
|
2524 |
interface for synchronously sending a single datagram and receiving |
|
2525 |
the result\footnote{For all communication issues have been meanwhile
|
|
2526 |
sourced out into state machines, the function is deprecated and |
|
2527 |
stopped existing. Nevertheless it is adequate for showing it's own |
|
2528 |
restrictions.}. Internally, it queues the specified datagram, |
|
2529 |
invokes the \textit{ec\_master\_send\_datagrams()} function to send a
|
|
2530 |
frame with the queued datagram and then waits actively for its |
|
2531 |
reception. |
|
2532 |
||
2533 |
This sequential approach is very simple, reflecting in only three |
|
2534 |
lines of code. The disadvantage is, that the master is blocked for the |
|
2535 |
time it waits for datagram reception. There is no difficulty when only |
|
2536 |
one instance is using the master, but if more instances want to |
|
2537 |
(synchronously\footnote{At this time, synchronous master access will
|
|
2538 |
be adequate to show the advantages of an FSM. The asynchronous |
|
2539 |
approach will be discussed in section~\ref{sec:eoeimp}}) use the
|
|
2540 |
master, it is inevitable to think about an alternative to the |
|
2541 |
sequential model. |
|
2542 |
||
2543 |
Master access has to be sequentialized for more than one instance |
|
2544 |
wanting to send and receive datagrams synchronously. With the present |
|
2545 |
approach, this would result in having one phase of active waiting for |
|
2546 |
each instance, which would be non-acceptable especially in realtime |
|
2547 |
circumstances, because of the huge time overhead. |
|
2548 |
||
2549 |
A possible solution is, that all instances would be executed |
|
2550 |
sequentially to queue their datagrams, then give the control to the |
|
2551 |
next instance instead of waiting for the datagram reception. Finally, |
|
2552 |
bus IO is done by a higher instance, which means that all queued |
|
2553 |
datagrams are sent and received. The next step is to execute all |
|
2554 |
instances again, which then process their received datagrams and issue |
|
2555 |
new ones. |
|
2556 |
||
2557 |
This approach results in all instances having to retain their state, |
|
2558 |
when giving the control back to the higher instance. It is quite |
|
2559 |
obvious to use a \textit{finite state machine} model in this case.
|
|
2560 |
Section~\ref{sec:fsmtheory} will introduce some of the theory used,
|
|
2561 |
while the listings below show the basic approach by coding the example |
|
2562 |
from above as a state machine: |
|
2563 |
||
2564 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2565 |
// state 1 |
|
2566 |
ec_datagram_brd(datagram, 0x0130, 2); // prepare datagram |
|
2567 |
ec_master_queue(master, datagram); // queue datagram |
|
2568 |
next_state = state_2; |
|
2569 |
// state processing finished |
|
2570 |
\end{lstlisting}
|
|
2571 |
||
2572 |
After all instances executed their current state and queued their |
|
2573 |
datagrams, these are sent and received. Then the respective next |
|
2574 |
states are executed: |
|
2575 |
||
2576 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2577 |
// state 2 |
|
2578 |
if (datagram->state != EC_DGRAM_STATE_RECEIVED) {
|
|
2579 |
next_state = state_error; |
|
2580 |
return; // state processing finished |
|
2581 |
} |
|
2582 |
slave_states = EC_READ_U8(datagram->data); // process datagram |
|
2583 |
// state processing finished. |
|
2584 |
\end{lstlisting}
|
|
2585 |
||
2586 |
See section~\ref{sec:statemodel} for an introduction to the
|
|
2587 |
state machine programming concept used in the master code. |
|
2588 |
||
2589 |
%------------------------------------------------------------------------------ |
|
2590 |
||
2591 |
\subsection{State Machine Theory}
|
|
2592 |
\label{sec:fsmtheory}
|
|
2593 |
\index{FSM!Theory}
|
|
2594 |
||
2595 |
A finite state machine \cite{automata} is a model of behavior with
|
|
2596 |
inputs and outputs, where the outputs not only depend on the inputs, |
|
2597 |
but the history of inputs. The mathematical definition of a finite |
|
2598 |
state machine (or finite automaton) is a six-tuple $(\Sigma, \Gamma, |
|
2599 |
S, s_0, \delta, \omega)$, with |
|
2600 |
||
2601 |
\begin{itemize}
|
|
2602 |
\item the input alphabet $\Sigma$, with $\Sigma \neq |
|
2603 |
\emptyset$, containing all input symbols, |
|
2604 |
\item the output alphabet $\Gamma$, with $\Gamma \neq |
|
2605 |
\emptyset$, containing all output symbols, |
|
2606 |
\item the set of states $S$, with $S \neq \emptyset$, |
|
2607 |
\item the set of initial states $s_0$ with $s_0 \subseteq S, s_0 \neq |
|
2608 |
\emptyset$ |
|
2609 |
\item the transition function $\delta: S \times \Sigma \rightarrow S |
|
2610 |
\times \Gamma$ |
|
2611 |
\item the output function $\omega$. |
|
2612 |
\end{itemize}
|
|
2613 |
||
2614 |
The state transition function $\delta$ is often specified by a |
|
2615 |
\textit{state transition table}, or by a \textit{state transition
|
|
2616 |
diagram}. The transition table offers a matrix view of the state |
|
2617 |
machine behavior (see table~\ref{tab:statetrans}). The matrix rows
|
|
2618 |
correspond to the states ($S = \{s_0, s_1, s_2\}$) and the columns
|
|
2619 |
correspond to the input symbols ($\Gamma = \{a, b, \varepsilon\}$).
|
|
2620 |
The table contents in a certain row $i$ and column $j$ then represent |
|
2621 |
the next state (and possibly the output) for the case, that a certain |
|
2622 |
input symbol $\sigma_j$ is read in the state $s_i$. |
|
2623 |
||
2624 |
\begin{table}[htbp]
|
|
2625 |
\caption{A typical state transition table}
|
|
2626 |
\label{tab:statetrans}
|
|
2627 |
\vspace{2mm}
|
|
2628 |
\centering |
|
2629 |
\begin{tabular}{l|ccc}
|
|
2630 |
& $a$ & $b$ & $\varepsilon$\\ \hline |
|
2631 |
$s_0$ & $s_1$ & $s_1$ & $s_2$\\ |
|
2632 |
$s_1$ & $s_2$ & $s_1$ & $s_0$\\ |
|
2633 |
$s_2$ & $s_0$ & $s_0$ & $s_0$\\ \hline |
|
2634 |
\end{tabular}
|
|
2635 |
\end{table}
|
|
2636 |
||
2637 |
The state diagram for the same example looks like the one in |
|
2638 |
figure~\ref{fig:statetrans}. The states are represented as circles or
|
|
2639 |
ellipses and the transitions are drawn as arrows between them. Close |
|
2640 |
to a transition arrow can be the condition that must be fulfilled to |
|
2641 |
allow the transition. The initial state is marked by a filled black |
|
2642 |
circle with an arrow pointing to the respective state. |
|
2643 |
||
2644 |
\begin{figure}[htbp]
|
|
2645 |
\centering |
|
2646 |
\includegraphics[width=.5\textwidth]{images/statetrans}
|
|
2647 |
\caption{A typical state transition diagram}
|
|
2648 |
\label{fig:statetrans}
|
|
2649 |
\end{figure}
|
|
2650 |
||
2651 |
\paragraph{Deterministic and non-deterministic state machines}
|
|
2652 |
||
2653 |
A state machine can be deterministic, meaning that for one state and |
|
2654 |
input, there is one (and only one) following state. In this case, the |
|
2655 |
state machine has exactly one starting state. Non-deterministic state |
|
2656 |
machines can have more than one transitions for a single state-input |
|
2657 |
combination. There is a set of starting states in the latter case. |
|
2658 |
||
2659 |
\paragraph{Moore and Mealy machines}
|
|
2660 |
||
2661 |
There is a distinction between so-called \textit{Moore machines}, and
|
|
2662 |
\textit{Mealy machines}. Mathematically spoken, the distinction lies
|
|
2663 |
in the output function $\omega$: If it only depends on the current |
|
2664 |
state ($\omega: S \rightarrow \Gamma$), the machine corresponds to the |
|
2665 |
``Moore Model''. Otherwise, if $\omega$ is a function of a state and |
|
2666 |
the input alphabet ($\omega: S \times \Sigma \rightarrow \Gamma$) the |
|
2667 |
state machine corresponds to the ``Mealy model''. Mealy machines are |
|
2668 |
the more practical solution in most cases, because their design allows |
|
2669 |
machines with a minimum number of states. In practice, a mixture of |
|
2670 |
both models is often used. |
|
2671 |
||
2672 |
\paragraph{Misunderstandings about state machines}
|
|
2673 |
||
2674 |
There is a phenomenon called ``state explosion'', that is oftenly |
|
2675 |
taken as a counter-argument against general use of state machines in |
|
2676 |
complex environments. It has to be mentioned, that this point is |
|
2677 |
misleading~\cite{fsmmis}. State explosions happen usually as a result
|
|
2678 |
of a bad state machine design: Common mistakes are storing the present |
|
2679 |
values of all inputs in a state, or not dividing a complex state |
|
2680 |
machine into simpler sub state machines. The EtherCAT master uses |
|
2681 |
serveral state machines, that are executed hierarchically and so serve |
|
2682 |
as sub state machines. These are also described below. |
|
2683 |
||
2684 |
%------------------------------------------------------------------------------ |
|
2685 |
||
2686 |
\subsection{The Master's State Model}
|
|
2687 |
\label{sec:statemodel}
|
|
2688 |
||
2689 |
This section will introduce the techniques used in the master to |
|
2690 |
implement state machines. |
|
2691 |
||
2692 |
\paragraph{State Machine Programming}
|
|
2693 |
||
2694 |
There are certain ways to implement a state machine in \textit{C}
|
|
2695 |
code. An obvious way is to implement the different states and actions |
|
2696 |
by one big case differentiation: |
|
2697 |
||
2698 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2699 |
enum {STATE_1, STATE_2, STATE_3};
|
|
2700 |
int state = STATE_1; |
|
2701 |
||
2702 |
void state_machine_run(void *priv_data) {
|
|
2703 |
switch (state) {
|
|
2704 |
case STATE_1: |
|
2705 |
action_1(); |
|
2706 |
state = STATE_2; |
|
2707 |
break; |
|
2708 |
case STATE_2: |
|
2709 |
action_2() |
|
2710 |
if (some_condition) state = STATE_1; |
|
2711 |
else state = STATE_3; |
|
2712 |
break; |
|
2713 |
case STATE_3: |
|
2714 |
action_3(); |
|
2715 |
state = STATE_1; |
|
2716 |
break; |
|
2717 |
} |
|
2718 |
} |
|
2719 |
\end{lstlisting}
|
|
2720 |
||
2721 |
For small state machines, this is an option. The disadvantage is, that |
|
2722 |
with an increasing number of states the code soon gets complex and an |
|
2723 |
additional case differentiation is executed each run. Besides, lots of |
|
2724 |
indentation is wasted. |
|
2725 |
||
2726 |
The method used in the master is to implement every state in an own |
|
2727 |
function and to store the current state function with a function |
|
2728 |
pointer: |
|
2729 |
||
2730 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2731 |
void (*state)(void *) = state1; |
|
2732 |
||
2733 |
void state_machine_run(void *priv_data) {
|
|
2734 |
state(priv_data); |
|
2735 |
} |
|
2736 |
||
2737 |
void state1(void *priv_data) {
|
|
2738 |
action_1(); |
|
2739 |
state = state2; |
|
2740 |
} |
|
2741 |
||
2742 |
void state2(void *priv_data) {
|
|
2743 |
action_2(); |
|
2744 |
if (some_condition) state = state1; |
|
2745 |
else state = state2; |
|
2746 |
} |
|
2747 |
||
2748 |
void state3(void *priv_data) {
|
|
2749 |
action_3(); |
|
2750 |
state = state1; |
|
2751 |
} |
|
2752 |
\end{lstlisting}
|
|
2753 |
||
2754 |
In the master code, state pointers of all state machines\footnote{All
|
|
2755 |
except for the EoE state machine, because multiple EoE slaves have |
|
2756 |
to be handled in parallel. For this reason each EoE handler object |
|
2757 |
has its own state pointer.} are gathered in a single object of the |
|
2758 |
\textit{ec\_fsm\_t} class. This is advantageous, because there is
|
|
2759 |
always one instance of every state machine available and can be |
|
2760 |
started on demand. |
|
2761 |
||
2762 |
\paragraph{Mealy and Moore}
|
|
2763 |
||
2764 |
If a closer look is taken to the above listing, it can be seen that |
|
2765 |
the actions executed (the ``outputs'' of the state machine) only |
|
2766 |
depend on the current state. This accords to the ``Moore'' model |
|
2767 |
introduced in section~\ref{sec:fsmtheory}. As mentioned, the ``Mealy''
|
|
2768 |
model offers a higher flexibility, which can be seen in the listing |
|
2769 |
below: |
|
2770 |
||
2771 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2772 |
void state7(void *priv_data) {
|
|
2773 |
if (some_condition) {
|
|
2774 |
action_7a(); |
|
2775 |
state = state1; |
|
2776 |
} |
|
2777 |
else {
|
|
2778 |
action_7b(); |
|
2779 |
state = state8; |
|
2780 |
} |
|
2781 |
} |
|
2782 |
\end{lstlisting}
|
|
2783 |
||
2784 |
\begin{description}
|
|
2785 |
\item[\normalfont\textcircled{\tiny 3} + \textcircled{\tiny 7}] The
|
|
2786 |
state function executes the actions depending on the state |
|
2787 |
transition, that is about to be done. |
|
2788 |
\end{description}
|
|
2789 |
||
2790 |
The most flexible alternative is to execute certain actions depending |
|
2791 |
on the state, followed by some actions dependent on the state |
|
2792 |
transition: |
|
2793 |
||
2794 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2795 |
void state9(void *priv_data) {
|
|
2796 |
action_9(); |
|
2797 |
if (some_condition) {
|
|
2798 |
action_9a(); |
|
2799 |
state = state7; |
|
2800 |
} |
|
2801 |
else {
|
|
2802 |
action_9b(); |
|
2803 |
state = state10; |
|
2804 |
} |
|
2805 |
} |
|
2806 |
\end{lstlisting}
|
|
2807 |
||
2808 |
This model is oftenly used in the master. It combines the best aspects |
|
2809 |
of both approaches. |
|
2810 |
||
2811 |
\paragraph{Using Sub State Machines}
|
|
2812 |
||
2813 |
To avoid having too much states, certain functions of the EtherCAT |
|
2814 |
master state machine have been sourced out into sub state machines. |
|
2815 |
This helps to encapsule the related workflows and moreover avoids the |
|
2816 |
``state explosion'' phenomenon described in |
|
2817 |
section~\ref{sec:fsmtheory}. If the master would instead use one big
|
|
2818 |
state machine, the number of states would be a multiple of the actual |
|
2819 |
number. This would increase the level of complexity to a |
|
2820 |
non-manageable grade. |
|
2821 |
||
2822 |
\paragraph{Executing Sub State Machines}
|
|
2823 |
||
2824 |
If a state machine starts to execute a sub state machine, it usually |
|
2825 |
remains in one state until the sub state machine terminates. This is |
|
2826 |
usually done like in the listing below, which is taken out of the |
|
2827 |
slave configuration state machine code: |
|
2828 |
||
2829 |
\begin{lstlisting}[language=C,numbers=left]
|
|
2830 |
void ec_fsm_slaveconf_saveop(ec_fsm_t *fsm) |
|
2831 |
{
|
|
2832 |
fsm->change_state(fsm); // execute state change |
|
2833 |
// sub state machine |
|
2834 |
||
2835 |
if (fsm->change_state == ec_fsm_error) {
|
|
2836 |
fsm->slave_state = ec_fsm_end; |
|
2837 |
return; |
|
2838 |
} |
|
2839 |
||
2840 |
if (fsm->change_state != ec_fsm_end) return; |
|
2841 |
||
2842 |
// continue state processing |
|
2843 |
... |
|
2844 |
\end{lstlisting}
|
|
2845 |
||
2846 |
\begin{description}
|
|
2847 |
\item[\normalfont\textcircled{\tiny 3}] \textit{change\_state} is the
|
|
2848 |
state pointer of the state change state machine. The state function, |
|
2849 |
the pointer points on, is executed\ldots |
|
2850 |
\item[\normalfont\textcircled{\tiny 6}] \ldots either until the state
|
|
2851 |
machine terminates with the error state \ldots |
|
2852 |
\item[\normalfont\textcircled{\tiny 11}] \ldots or until the state
|
|
2853 |
machine terminates in the end state. Until then, the ``higher'' |
|
2854 |
state machine remains in the current state and executes the sub |
|
2855 |
state machine again in the next cycle. |
|
2856 |
\end{description}
|
|
2857 |
||
2858 |
\paragraph{State Machine Descriptions}
|
|
2859 |
||
2860 |
The below sections describe every state machine used in the EtherCAT |
|
2861 |
master. The textual descriptions of the state machines contain |
|
2862 |
references to the transitions in the corresponding state transition |
|
2863 |
diagrams, that are marked with an arrow followed by the name of the |
|
2864 |
successive state. Transitions caused by trivial error cases (i.~e. no |
|
2865 |
response from slave) are not described explicitly. These transitions |
|
2866 |
are drawn as dashed arrows in the diagrams. |
|
2867 |
||
2868 |
%------------------------------------------------------------------------------ |
|
2869 |
||
2870 |
\subsection{The Operation State Machine}
|
|
2871 |
\label{sec:fsm-op}
|
|
2872 |
\index{FSM!Operation}
|
|
2873 |
||
2874 |
The Operation state machine is executed by calling the |
|
2875 |
\textit{ecrt\_master\_run()} method in cyclic realtime code. Its
|
|
2876 |
purpose is to monitor the bus and to reconfigure slaves after a bus |
|
2877 |
failure or power failure. Figure~\ref{fig:fsm-op} shows its transition
|
|
2878 |
diagram. |
|
2879 |
||
2880 |
\begin{figure}[htbp]
|
|
2881 |
\centering |
|
2882 |
\includegraphics[width=.8\textwidth]{images/fsm-op}
|
|
2883 |
\caption{Transition diagram of the operation state machine}
|
|
2884 |
\label{fig:fsm-op}
|
|
2885 |
\end{figure}
|
|
2886 |
||
2887 |
\begin{description}
|
|
2888 |
\item[START] This is the beginning state of the operation state |
|
2889 |
machine. There is a datagram issued, that queries the ``AL Control |
|
2890 |
Response'' attribute \cite[section~5.3.2]{alspec} of all slaves via
|
|
2891 |
broadcast. In this way, all slave states and the number of slaves |
|
| 379 | 2892 |
responding can be determined. $\rightarrow$~BROADCAST |
| 369 | 2893 |
|
2894 |
\item[BROADCAST] The broadcast datagram is evaluated. A change in the |
|
2895 |
number of responding slaves is treates as a topology change. If the |
|
2896 |
number of slaves is not as expected, the bus is marked as |
|
2897 |
``tainted''. In this state, no slave reconfiguration is possible, |
|
2898 |
because the assignment of known slaves and those present on the bus |
|
2899 |
is ambiguous. If the number of slaves is considered as right, the |
|
2900 |
bus is marked for validation, because it turned from tainted to |
|
2901 |
normal state and it has to be checked, if all slaves are valid. Now, |
|
2902 |
the state of every single slave has to be determined. For that, a |
|
2903 |
(unicast) datagram is issued, that queries the first slave's ``AL |
|
| 379 | 2904 |
Control Response'' attribute. $\rightarrow$~READ STATES |
| 369 | 2905 |
|
2906 |
\item[READ STATES] If the current slave did not respond to its |
|
2907 |
configured station address, it is marked as offline, and the next |
|
| 379 | 2908 |
slave is queried. $\rightarrow$~READ STATES |
| 369 | 2909 |
|
2910 |
If the slave responded, it is marked as online and its current state |
|
| 379 | 2911 |
is stored. The next slave is queried. $\rightarrow$~READ STATES |
| 369 | 2912 |
|
2913 |
If all slaves have been queried, and the bus is marked for |
|
2914 |
validation, the validation is started by checking the first slaves |
|
| 379 | 2915 |
vendor ID. $\rightarrow$~VALIDATE VENDOR |
| 369 | 2916 |
|
2917 |
If no validation has to be done, it is checked, if all slaves are in |
|
2918 |
the state they are supposed to be. If not, the first of slave with |
|
2919 |
the wrong state is reconfigured and brought in the required state. |
|
| 379 | 2920 |
$\rightarrow$~CONFIGURE SLAVES |
| 369 | 2921 |
|
2922 |
If all slaves are in the correct state, the state machine is |
|
| 379 | 2923 |
restarted. $\rightarrow$~START |
| 369 | 2924 |
|
2925 |
\item[CONFIGURE SLAVES] The slave configuration state machine is |
|
| 379 | 2926 |
executed until termination. $\rightarrow$~CONFIGURE SLAVES |
| 369 | 2927 |
|
2928 |
If there are still slaves in the wrong state after another check, |
|
2929 |
the first of these slaves is configured and brought into the correct |
|
| 379 | 2930 |
state again. $\rightarrow$~CONFIGURE SLAVES |
| 369 | 2931 |
|
2932 |
If all slaves are in the correct state, the state machine is |
|
| 379 | 2933 |
restarted. $\rightarrow$~START |
| 369 | 2934 |
|
2935 |
\item[VALIDATE VENDOR] The SII state machine is executed until |
|
2936 |
termination. If the slave has the wrong vendor ID, the state machine |
|
| 379 | 2937 |
is restarted. $\rightarrow$~START |
| 369 | 2938 |
|
2939 |
If the slave has the correct vendor ID, its product ID is queried. |
|
| 379 | 2940 |
$\rightarrow$~VALIDATE PRODUCT |
| 369 | 2941 |
|
2942 |
\item[VALIDATE PRODUCT] The SII state machine is executed until |
|
2943 |
termination. If the slave has the wrong product ID, the state |
|
| 379 | 2944 |
machine is restarted. $\rightarrow$~START |
| 369 | 2945 |
|
2946 |
If the slave has the correct product ID, the next slave's vendor ID |
|
| 379 | 2947 |
is queried. $\rightarrow$~VALIDATE VENDOR |
| 369 | 2948 |
|
2949 |
If all slaves have the correct vendor IDs and product codes, the |
|
2950 |
configured station addresses can be safely rewritten. This is done |
|
2951 |
for the first slave marked as offline. |
|
| 379 | 2952 |
$\rightarrow$~REWRITE ADDRESSES |
| 369 | 2953 |
|
2954 |
\item[REWRITE ADDRESSES] If the station address was successfully |
|
2955 |
written, it is sear\-ched for the next slave marked as offline. If |
|
2956 |
there is one, its address is reconfigured, too. |
|
| 379 | 2957 |
$\rightarrow$~REWRITE ADDRESSES |
| 369 | 2958 |
|
2959 |
If there are no more slaves marked as offline, the state machine is |
|
| 379 | 2960 |
restarted. $\rightarrow$~START |
| 369 | 2961 |
\end{description}
|
2962 |
||
2963 |
%------------------------------------------------------------------------------ |
|
2964 |
||
2965 |
\subsection{The Idle State Machine}
|
|
2966 |
\label{sec:fsm-idle}
|
|
2967 |
\index{FSM!Idle}
|
|
2968 |
||
2969 |
The Idle state machine is executed by a kernel workqueue, if no |
|
2970 |
realtime module is connected. Its purpose is to make slave information |
|
2971 |
available to user space, operate EoE-capable slaves, read and write |
|
2972 |
E$^2$PROM contents and test slave functionality. |
|
2973 |
Figure~\ref{fig:fsm-idle} shows its transition diagram.
|
|
2974 |
||
2975 |
\begin{figure}[htbp]
|
|
2976 |
\centering |
|
2977 |
\includegraphics[width=.8\textwidth]{images/fsm-idle}
|
|
2978 |
\caption{Transition diagram of the idle state machine}
|
|
2979 |
\label{fig:fsm-idle}
|
|
2980 |
\end{figure}
|
|
2981 |
||
2982 |
\begin{description}
|
|
2983 |
\item[START] The beginning state of the idle state machine. Similar to |
|
2984 |
the operation state machine, a broadcast datagram is issued, to |
|
2985 |
query all slave states and the number of slaves. |
|
| 379 | 2986 |
$\rightarrow$~BROADCAST |
| 369 | 2987 |
|
2988 |
\item[BROADCAST] The number of responding slaves is evaluated. If it |
|
2989 |
has changed since the last time, this is treated as a topology |
|
2990 |
change and the internal list of slaves is cleared and rebuild |
|
2991 |
completely. The slave scan state machine is started for the first |
|
| 379 | 2992 |
slave. $\rightarrow$~SCAN FOR SLAVES |
| 369 | 2993 |
|
2994 |
If no topology change happened, every single slave state is fetched. |
|
| 379 | 2995 |
$\rightarrow$~READ STATES |
| 369 | 2996 |
|
2997 |
\item[SCAN FOR SLAVES] The slave scan state machine is executed until |
|
| 379 | 2998 |
termination. $\rightarrow$~SCAN FOR SLAVES |
| 369 | 2999 |
|
3000 |
If there is another slave to scan, the slave scan state machine is |
|
| 379 | 3001 |
started again. $\rightarrow$~SCAN FOR SLAVES |
| 369 | 3002 |
|
3003 |
If all slave information has been fetched, slave addresses are |
|
3004 |
calculated and EoE processing is started. Then, the state machine is |
|
| 379 | 3005 |
restarted. $\rightarrow$~START |
| 369 | 3006 |
|
3007 |
\item[READ STATES] If the slave did not respond to the query, it is |
|
3008 |
marked as offline. The next slave is queried. |
|
| 379 | 3009 |
$\rightarrow$~READ STATES |
| 369 | 3010 |
|
3011 |
If the slave responded, it is marked as online. And the next slave |
|
| 379 | 3012 |
is queried. $\rightarrow$~READ STATES |
| 369 | 3013 |
|
3014 |
If all slave states have been determined, it is checked, if any |
|
3015 |
slaves are not in the state they supposed to be. If this is true, |
|
3016 |
the slave configuration state machine is started for the first of |
|
| 379 | 3017 |
them. $\rightarrow$~CONFIGURE SLAVES |
| 369 | 3018 |
|
3019 |
If all slaves are in the correct state, it is checked, if any |
|
3020 |
E$^2$PROM write operations are pending. If this is true, the first |
|
3021 |
pending operation is executed by starting the SII state machine for |
|
| 379 | 3022 |
writing access. $\rightarrow$~WRITE EEPROM |
| 369 | 3023 |
|
3024 |
If all these conditions are false, there is nothing to do and the |
|
| 379 | 3025 |
state machine is restarted. $\rightarrow$~START |
| 369 | 3026 |
|
3027 |
\item[CONFIGURE SLAVES] The slave configuration state machine is |
|
| 379 | 3028 |
executed until termination. $\rightarrow$~CONFIGURE SLAVES |
| 369 | 3029 |
|
3030 |
After this, it is checked, if another slave needs a state change. If |
|
3031 |
this is true, the slave state change state machine is started for |
|
| 379 | 3032 |
this slave. $\rightarrow$~CONFIGURE SLAVES |
| 369 | 3033 |
|
3034 |
If all slaves are in the correct state, it is determined, if any |
|
3035 |
E$^2$PROM write operations are pending. If this is true, the first |
|
3036 |
pending operation is executed by starting the SII state machine for |
|
| 379 | 3037 |
writing access. $\rightarrow$~WRITE EEPROM |
| 369 | 3038 |
|
3039 |
If all prior conditions are false, the state machine is restarted. |
|
| 379 | 3040 |
$\rightarrow$~START |
| 369 | 3041 |
|
3042 |
\item[WRITE EEPROM] The SII state machine is executed until |
|
| 379 | 3043 |
termination. $\rightarrow$~WRITE EEPROM |
| 369 | 3044 |
|
3045 |
If the current word has been written successfully, and there are |
|
3046 |
still word to write, the SII state machine is started for the next |
|
| 379 | 3047 |
word. $\rightarrow$~WRITE EEPROM |
| 369 | 3048 |
|
3049 |
If all words have been written successfully, the new E$^2$PROM |
|
3050 |
contents are evaluated and the state machine is restarted. |
|
| 379 | 3051 |
$\rightarrow$~START |
| 369 | 3052 |
|
3053 |
\end{description}
|
|
3054 |
||
3055 |
%------------------------------------------------------------------------------ |
|
3056 |
||
3057 |
\subsection{The Slave Scan State Machine}
|
|
3058 |
\label{sec:fsm-scan}
|
|
3059 |
\index{FSM!Slave Scan}
|
|
3060 |
||
3061 |
The slave scan state machine, which can be seen in |
|
3062 |
figure~\ref{fig:fsm-slavescan}, leads through the process of fetching
|
|
3063 |
all slave information. |
|
3064 |
||
3065 |
\begin{figure}[htbp]
|
|
3066 |
\centering |
|
3067 |
\includegraphics[width=.6\textwidth]{images/fsm-slavescan}
|
|
3068 |
\caption{Transition diagram of the slave scan state machine}
|
|
3069 |
\label{fig:fsm-slavescan}
|
|
3070 |
\end{figure}
|
|
3071 |
||
3072 |
\begin{description}
|
|
3073 |
\item[START] In the beginning state of the slave scan state machine, |
|
3074 |
the station address is written to the slave, which is always the |
|
3075 |
ring position~+~$1$. In this way, the address 0x0000 (default |
|
3076 |
address) is not used, which makes it easy to detect unconfigured |
|
| 379 | 3077 |
slaves. $\rightarrow$~ADDRESS |
| 369 | 3078 |
|
3079 |
\item[ADDRESS] The writing of the station address is verified. After |
|
3080 |
that, the slave's ``AL Control Response'' attribute is queried. |
|
| 379 | 3081 |
$\rightarrow$~STATE |
| 369 | 3082 |
|
3083 |
\item[STATE] The AL state is evaluated. A warning is output, if the |
|
3084 |
slave has still the \textit{Change} bit set. After that, the slave's
|
|
3085 |
``DL Information'' attribute is queried. |
|
| 379 | 3086 |
$\rightarrow$~BASE |
| 369 | 3087 |
|
3088 |
\item[BASE] The queried base data are evaluated: Slave type, revision |
|
3089 |
and build number, and even more important, the number of supported |
|
3090 |
sync managers and FMMUs are stored. After that, the slave's data |
|
3091 |
link layer information is read from the ``DL Status'' attribute at |
|
| 379 | 3092 |
address 0x0110. $\rightarrow$~DATALINK |
| 369 | 3093 |
|
3094 |
\item[DATALINK] In this state, the DL information is evaluated: This |
|
3095 |
information about the communication ports contains, if the link is |
|
3096 |
up, if the loop has been closed and if there is a carrier detected |
|
3097 |
on the RX side of each port. |
|
3098 |
||
3099 |
Then, the state machine starts measuring the size of the slave's |
|
3100 |
E$^2$PROM contents. This is done by subsequently reading out each |
|
3101 |
category header, until the last category is reached (type 0xFFFF). |
|
3102 |
This procedure is started by querying the first category header at |
|
3103 |
word address 0x0040 via the SII state machine. |
|
| 379 | 3104 |
$\rightarrow$~EEPROM SIZE |
| 369 | 3105 |
|
3106 |
\item[EEPROM SIZE] The SII state machine is executed until |
|
| 379 | 3107 |
termination. $\rightarrow$~EEPROM SIZE |
| 369 | 3108 |
|
3109 |
If the category type does not mark the end of the categories, the |
|
3110 |
position of the next category header is determined via the length of |
|
3111 |
the current category, and the SII state machine is started again. |
|
| 379 | 3112 |
$\rightarrow$~EEPROM SIZE |
| 369 | 3113 |
|
3114 |
If the size of the E$^2$PROM contents has been determined, memory is |
|
3115 |
allocated, to read all the contents. The SII state machine is |
|
| 379 | 3116 |
started to read the first word. $\rightarrow$~EEPROM DATA |
| 369 | 3117 |
|
3118 |
\item[EEPROM DATA] The SII state machine is executed until |
|
| 379 | 3119 |
termination. $\rightarrow$~EEPROM DATA |
| 369 | 3120 |
|
3121 |
Two words have been read. If more than one word is needed, the two |
|
3122 |
words are written in the allocated memory. Otherwise only one word |
|
3123 |
(the last word) is copied. If more words are to read, the SII state |
|
3124 |
machine is started again to read the next two words. |
|
| 379 | 3125 |
$\rightarrow$~EEPROM DATA |
| 369 | 3126 |
|
3127 |
The complete E$^2$PROM contents have been read. The slave's identity |
|
3128 |
object and mailbox information are evaluated. Moreover the category |
|
3129 |
types STRINGS, GENERAL, SYNC and PDO are evaluated. The slave |
|
| 379 | 3130 |
scanning has been completed. $\rightarrow$~END |
| 369 | 3131 |
|
3132 |
\item[END] Slave scanning has been finished. |
|
3133 |
||
3134 |
\end{description}
|
|
3135 |
||
3136 |
%------------------------------------------------------------------------------ |
|
3137 |
||
3138 |
\subsection{The Slave Configuration State Machine}
|
|
3139 |
\label{sec:fsm-conf}
|
|
3140 |
\index{FSM!Slave Configuration}
|
|
3141 |
||
3142 |
The slave configuration state machine, which can be seen in |
|
3143 |
figure~\ref{fig:fsm-slaveconf}, leads through the process of
|
|
3144 |
configuring a slave and bringing it to a certain state. |
|
3145 |
||
3146 |
\begin{figure}[htbp]
|
|
3147 |
\centering |
|
3148 |
\includegraphics[width=.6\textwidth]{images/fsm-slaveconf}
|
|
3149 |
\caption{Transition diagram of the slave configuration state
|
|
3150 |
machine} |
|
3151 |
\label{fig:fsm-slaveconf}
|
|
3152 |
\end{figure}
|
|
3153 |
||
3154 |
\begin{description}
|
|
3155 |
\item[INIT] The state change state machine has been initialized to |
|
| 379 | 3156 |
bring the slave into the INIT state. Now, the slave state change |
3157 |
state machine is executed until termination. $\rightarrow$~INIT |
|
| 369 | 3158 |
|
3159 |
If the slave state change failed, the configuration has to be |
|
| 379 | 3160 |
aborted. $\rightarrow$~END |
3161 |
||
3162 |
The slave state change succeeded and the slave is now in INIT state. |
|
3163 |
If this is the target state, the configuration is finished. |
|
3164 |
$\rightarrow$~END |
|
| 369 | 3165 |
|
3166 |
If the slave does not support any sync managers, the sync manager |
|
3167 |
configuration can be skipped. The state change state machine is |
|
| 379 | 3168 |
started to bring the slave into PREOP state. |
3169 |
$\rightarrow$~PREOP |
|
| 369 | 3170 |
|
3171 |
Sync managers are configured conforming to the sync manager category |
|
3172 |
information provided in the slave's E$^2$PROM. The corresponding |
|
| 379 | 3173 |
datagram is issued. $\rightarrow$~SYNC |
| 369 | 3174 |
|
3175 |
\item[SYNC] If the sync manager configuration datagram is accepted, |
|
3176 |
the sync manager configuration was successful. The slave may now |
|
| 379 | 3177 |
enter the PREOP state, and the state change state machine is |
3178 |
started. $\rightarrow$~PREOP |
|
| 369 | 3179 |
|
3180 |
\item[PREOP] The state change state machine is executed until |
|
| 379 | 3181 |
termination. $\rightarrow$~PREOP |
| 369 | 3182 |
|
3183 |
If the state change failed, the configuration has to be aborted. |
|
| 379 | 3184 |
$\rightarrow$~END |
3185 |
||
3186 |
If the PREOP state was the target state, the configuration is |
|
3187 |
finished. $\rightarrow$~END |
|
| 369 | 3188 |
|
3189 |
If the slave supports no FMMUs, the FMMU configuration can be |
|
3190 |
skipped. If the slave has SDOs to configure, it is begun with |
|
| 379 | 3191 |
sending the first SDO. $\rightarrow$~SDO\_CONF |
| 369 | 3192 |
|
3193 |
If no SDO configurations are provided, the slave can now directly be |
|
| 379 | 3194 |
brought into the SAVEOP state and the state change state machine is |
3195 |
started again. $\rightarrow$~SAVEOP |
|
| 369 | 3196 |
|
3197 |
Otherwise, all supported FMMUs are configured according to the PDOs |
|
3198 |
requested via the master's realtime interface. The appropriate |
|
| 379 | 3199 |
datagram is issued. $\rightarrow$~FMMU |
| 369 | 3200 |
|
3201 |
\item[FMMU] The FMMU configuration datagram was accepted. If the slave |
|
3202 |
has SDOs to configure, it is begun with sending the first SDO. |
|
| 379 | 3203 |
$\rightarrow$~SDO\_CONF |
3204 |
||
3205 |
Otherwise, the slave can now be brought into the SAVEOP state. The |
|
3206 |
state change state machine is started. |
|
3207 |
$\rightarrow$~SAVEOP |
|
| 369 | 3208 |
|
3209 |
\item[SDO\_CONF] The CoE state machine is executed until termination. |
|
| 379 | 3210 |
$\rightarrow$~SDO\_CONF |
| 369 | 3211 |
|
3212 |
If another SDO has to be configured, a new SDO download sequence is |
|
| 379 | 3213 |
begun. $\rightarrow$~SDO\_CONF |
3214 |
||
3215 |
Otherwise, the slave can now be brought into the SAVEOP state. The |
|
3216 |
state change state machine is started. |
|
3217 |
$\rightarrow$~SAVEOP |
|
| 369 | 3218 |
|
3219 |
\item[SAVEOP] The state change state machine is executed until |
|
| 379 | 3220 |
termination. $\rightarrow$~SAVEOP |
| 369 | 3221 |
|
3222 |
If the state change failed, the configuration has to be aborted. |
|
| 379 | 3223 |
$\rightarrow$~END |
3224 |
||
3225 |
If the SAVEOP state was the target state, the configuration is |
|
3226 |
finished. $\rightarrow$~END |
|
3227 |
||
3228 |
The slave can now directly be brought into the OP state and the |
|
3229 |
state change state machine is started a last time. |
|
3230 |
$\rightarrow$~OP |
|
| 369 | 3231 |
|
3232 |
\item[OP] The state change state machine is executed until |
|
| 379 | 3233 |
termination. $\rightarrow$~OP |
| 369 | 3234 |
|
3235 |
If the state change state machine terminates, the slave |
|
3236 |
configuration is finished, regardless of its success. |
|
| 379 | 3237 |
$\rightarrow$~END |
| 369 | 3238 |
|
3239 |
\item[END] The termination state. |
|
3240 |
||
3241 |
\end{description}
|
|
3242 |
||
3243 |
%------------------------------------------------------------------------------ |
|
3244 |
||
3245 |
\subsection{The State Change State Machine}
|
|
3246 |
\label{sec:fsm-change}
|
|
3247 |
\index{FSM!State Change}
|
|
3248 |
||
3249 |
The state change state machine, which can be seen in |
|
3250 |
figure~\ref{fig:fsm-change}, leads through the process of changing a
|
|
3251 |
slave's state. This implements the states and transitions described in |
|
3252 |
\cite[section~6.4.1]{alspec}.
|
|
3253 |
||
3254 |
\begin{figure}[htbp]
|
|
3255 |
\centering |
|
3256 |
\includegraphics[width=.9\textwidth]{images/fsm-change}
|
|
3257 |
\caption{Transition diagram of the state change state machine}
|
|
3258 |
\label{fig:fsm-change}
|
|
3259 |
\end{figure}
|
|
3260 |
||
3261 |
\begin{description}
|
|
3262 |
\item[START] The beginning state, where a datagram with the state |
|
3263 |
change command is written to the slave's ``AL Control Request'' |
|
| 379 | 3264 |
attribute. Nothing can fail. $\rightarrow$~CHECK |
| 369 | 3265 |
|
3266 |
\item[CHECK] After the state change datagram has been sent, the ``AL |
|
3267 |
Control Response'' attribute is queried with a second datagram. |
|
| 379 | 3268 |
$\rightarrow$~STATUS |
| 369 | 3269 |
|
3270 |
\item[STATUS] The read memory contents are evaluated: While the |
|
3271 |
parameter \textit{State} still contains the old slave state, the
|
|
3272 |
slave is busy with reacting on the state change command. In this |
|
3273 |
case, the attribute has to be queried again. |
|
| 379 | 3274 |
$\rightarrow$~STATUS |
| 369 | 3275 |
|
3276 |
In case of success, the \textit{State} parameter contains the new
|
|
3277 |
state and the \textit{Change} bit is cleared. The slave is in the
|
|
| 379 | 3278 |
requested state. $\rightarrow$~END |
| 369 | 3279 |
|
3280 |
If the slave can not process the state change, the \textit{Change}
|
|
3281 |
bit is set: Now the master tries to get the reason for this by |
|
3282 |
querying the \textit{AL Status Code} parameter.
|
|
| 379 | 3283 |
$\rightarrow$~CODE |
| 369 | 3284 |
|
3285 |
\item[END] If the state machine ends in this state, the slaves's state |
|
3286 |
change has been successful. |
|
3287 |
||
3288 |
\item[CODE] The status code query has been sent. Reading the |
|
3289 |
\textit{AL Status Code} might fail, because not all slaves support
|
|
3290 |
this parameter. Anyway, the master has to acknowledge the state |
|
3291 |
change error by writing the current slave state to the ``AL Control |
|
3292 |
Request'' attribute with the \textit{Acknowledge} bit set.
|
|
| 379 | 3293 |
$\rightarrow$~ACK |
| 369 | 3294 |
|
3295 |
\item[ACK] After that, the ``AL Control Response'' attribute is |
|
3296 |
queried for the state of the acknowledgement. |
|
| 379 | 3297 |
$\rightarrow$~CHECK ACK |
| 369 | 3298 |
|
3299 |
\item[CHECK ACK] If the acknowledgement has been accepted by the |
|
3300 |
slave, the old state is kept. Still, the state change was |
|
| 379 | 3301 |
unsuccessful. $\rightarrow$~ERROR |
| 369 | 3302 |
|
3303 |
If the acknowledgement is ignored by the slave, a timeout happens. |
|
3304 |
In any case, the overall state change was unsuccessful. |
|
| 379 | 3305 |
$\rightarrow$~ERROR |
| 369 | 3306 |
|
3307 |
If there is still now response from the slave, but the timer did not |
|
3308 |
run out yet, the slave's ``AL Control Response'' attribute is |
|
| 379 | 3309 |
queried again. $\rightarrow$~CHECK ACK |
| 369 | 3310 |
|
3311 |
\item[ERROR] If the state machine ends in this state, the slave's |
|
3312 |
state change was unsuccessful. |
|
3313 |
||
3314 |
\end{description}
|
|
3315 |
||
3316 |
%------------------------------------------------------------------------------ |
|
3317 |
||
3318 |
\subsection{The SII State Machine}
|
|
3319 |
\label{sec:fsm-sii}
|
|
3320 |
\index{FSM!SII}
|
|
3321 |
||
3322 |
The SII\index{SII} state machine (shown in figure~\ref{fig:fsm-sii})
|
|
3323 |
implements the process of reading or writing E$^2$PROM data via the |
|
3324 |
Slave Information Interface described in \cite[section~5.4]{alspec}.
|
|
3325 |
||
3326 |
\begin{figure}[htbp]
|
|
3327 |
\centering |
|
3328 |
\includegraphics[width=.9\textwidth]{images/fsm-sii}
|
|
3329 |
\caption{Transition diagram of the SII state machine}
|
|
3330 |
\label{fig:fsm-sii}
|
|
3331 |
\end{figure}
|
|
3332 |
||
3333 |
\begin{description}
|
|
3334 |
\item[READ\_START] The beginning state for reading access, where the |
|
3335 |
read request and the requested address are written to the SII |
|
3336 |
attribute. Nothing can fail up to now. |
|
| 379 | 3337 |
$\rightarrow$~READ\_CHECK |
| 369 | 3338 |
|
3339 |
\item[READ\_CHECK] When the SII read request has been sent |
|
3340 |
successfully, a timer is started. A check/fetch datagram is issued, |
|
3341 |
that reads out the SII attribute for state and data. |
|
| 379 | 3342 |
$\rightarrow$~READ\_FETCH |
| 369 | 3343 |
|
3344 |
\item[READ\_FETCH] Upon reception of the check/fetch datagram, the |
|
3345 |
\textit{Read Operation} and \textit{Busy} parameters are checked:
|
|
3346 |
\begin{itemize}
|
|
3347 |
\item If the slave is still busy with fetching E$^2$PROM data into |
|
3348 |
the interface, the timer is checked. If it timed out, the reading |
|
| 379 | 3349 |
is aborted ($\rightarrow$~ERROR), if not, the check/fetch datagram |
3350 |
is issued again. $\rightarrow$~READ\_FETCH |
|
| 369 | 3351 |
|
3352 |
\item If the slave is ready with reading data, these are copied from |
|
3353 |
the datagram and the read cycle is completed. |
|
| 379 | 3354 |
$\rightarrow$~END |
| 369 | 3355 |
\end{itemize}
|
3356 |
\end{description}
|
|
3357 |
||
3358 |
The write access states behave nearly the same: |
|
3359 |
||
3360 |
\begin{description}
|
|
3361 |
\item[WRITE\_START] The beginning state for writing access, |
|
3362 |
respectively. A write request, the target address and the data word |
|
3363 |
are written to the SII attribute. Nothing can fail. |
|
| 379 | 3364 |
$\rightarrow$~WRITE\_CHECK |
| 369 | 3365 |
|
3366 |
\item[WRITE\_CHECK] When the SII write request has been sent |
|
3367 |
successfully, the timer is started. A check datagram is issued, that |
|
3368 |
reads out the SII attribute for the state of the write operation. |
|
| 379 | 3369 |
$\rightarrow$~WRITE\_CHECK2 |
| 369 | 3370 |
|
3371 |
\item[WRITE\_CHECK2] Upon reception of the check datagram, the |
|
3372 |
\textit{Write Operation} and \textit{Busy} parameters are checked:
|
|
3373 |
\begin{itemize}
|
|
3374 |
\item If the slave is still busy with writing E$^2$PROM data, the |
|
3375 |
timer is checked. If it timed out, the operation is aborted |
|
| 379 | 3376 |
($\rightarrow$~ERROR), if not, the check datagram is issued again. |
3377 |
$\rightarrow$~WRITE\_CHECK2 |
|
| 369 | 3378 |
\item If the slave is ready with writing data, the write cycle is |
| 379 | 3379 |
completed. $\rightarrow$~END |
| 369 | 3380 |
\end{itemize}
|
3381 |
\end{description}
|
|
3382 |
||
3383 |
%------------------------------------------------------------------------------ |
|
3384 |
||
3385 |
\section{Mailbox Protocol Implementations}
|
|
3386 |
\index{Mailbox}
|
|
3387 |
||
3388 |
The EtherCAT master implements the EoE and the CoE mailbox |
|
3389 |
protocols. See the below section for details. |
|
3390 |
||
3391 |
%------------------------------------------------------------------------------ |
|
3392 |
||
3393 |
\subsection{Ethernet-over-EtherCAT (EoE)}
|
|
3394 |
\label{sec:eoeimp}
|
|
3395 |
\index{EoE}
|
|
3396 |
||
3397 |
The EtherCAT master implements the Ethernet-over-EtherCAT mailbox |
|
3398 |
protocol to enable the tunneling of Ethernet frames to special slaves, |
|
3399 |
that can either have physical Ethernet ports to forward the frames to, |
|
3400 |
or have an own IP stack to receive the frames. |
|
3401 |
||
3402 |
\paragraph{Virtual Network Interfaces}
|
|
3403 |
||
3404 |
The master creates a virtual EoE network interface for every |
|
3405 |
EoE-capable slave. These interfaces are called \textit{eoeX}, where X
|
|
3406 |
is a number provided by the kernel on interface registration. Frames |
|
3407 |
sent to these interfaces are forwarded to the associated slaves by the |
|
3408 |
master. Frames, that are received by the slaves, are fetched by the |
|
3409 |
master and forwarded to the virtual interfaces. |
|
3410 |
||
3411 |
This bears the following advantages: |
|
3412 |
||
3413 |
\begin{itemize}
|
|
3414 |
\item Flexibility: The user can decide, how the EoE-capable slaves are |
|
3415 |
interconnected with the rest of the world. |
|
3416 |
\item Standard tools can be used to monitor the EoE activity and to |
|
3417 |
configure the EoE interfaces. |
|
3418 |
\item The Linux kernel's layer-2-bridging implementation (according to |
|
3419 |
the IEEE 802.1D MAC Bridging standard) can be used natively to |
|
3420 |
bridge Ethernet traffic between EoE-capable slaves. |
|
3421 |
\item The Linux kernel's network stack can be used to route packets |
|
3422 |
between EoE-capable slaves and to track security issues, just like |
|
3423 |
having physical network interfaces. |
|
3424 |
\end{itemize}
|
|
3425 |
||
3426 |
\paragraph{EoE Handlers}
|
|
3427 |
||
3428 |
The virtual EoE interfaces and the related functionality is encapsuled |
|
3429 |
in the \textit{ec\_eoe\_t} class (see section~\ref{sec:class-eoe}).
|
|
3430 |
So the master does not create the network interfaces directly: This is |
|
3431 |
done inside the constructor of the \textit{ec\_eoe\_t} class. An
|
|
3432 |
object of this class is called ``EoE handler'' below. An EoE handler |
|
3433 |
additionaly contains a frame queue. Each time, the kernel passes a new |
|
3434 |
socket buffer for sending via the interface's |
|
3435 |
\textit{hard\_start\_xmit()} callback, the socket buffer is queued for
|
|
3436 |
transmittion by the EoE state machine (see below). If the queue gets |
|
3437 |
filled up, the passing of new socket buffers is suspended with a call |
|
3438 |
to \textit{netif\_stop\_queue()}.
|
|
3439 |
||
3440 |
\paragraph{Static Handler Creation}
|
|
3441 |
||
3442 |
The master creates a pool of EoE handlers at startup, that are coupled |
|
3443 |
to EoE-capable slaves on demand. The lifetime of the corresponding |
|
3444 |
network interfaces is equal to the lifetime of the master module. |
|
3445 |
This approach is opposed to creating the virtual network interfaces on |
|
3446 |
demand (i.~e. on running across a new EoE-capable slave). The latter |
|
3447 |
approach was considered as difficult, because of serveral reasons: |
|
3448 |
||
3449 |
\begin{itemize}
|
|
3450 |
\item The \textit{alloc\_netdev()} function can sleep and must be
|
|
3451 |
called from a non-interrupt context. This reduces the flexibility of |
|
3452 |
choosing an appropriate method for cyclic EoE processing. |
|
3453 |
\item Unregistering network interfaces requires them to be ``down'', |
|
3454 |
which can not be guaranteed upon sudden disappearing of an |
|
3455 |
EoE-capable slave. |
|
3456 |
\item The connection to the EoE-capable slaves must be as continuous |
|
3457 |
as possible. Especially the transition from idle to operation mode |
|
3458 |
(and vice versa) causes the rebuilding of the internal data |
|
3459 |
structures. These transitions must be as transparent as possible for |
|
3460 |
the instances using the network interfaces. |
|
3461 |
\end{itemize}
|
|
3462 |
||
3463 |
\paragraph{Number of Handlers}
|
|
3464 |
||
3465 |
The master module has a parameter \textit{ec\_eoeif\_count} to specify
|
|
3466 |
the number of EoE interfaces (and handlers) per master to create. This |
|
3467 |
parameter can either be specified when manually loading the master |
|
3468 |
module, or (when using the init script) by setting the |
|
| 379 | 3469 |
\$EOE\_INTERFACES variable in the sysconfig file (see |
| 369 | 3470 |
section~\ref{sec:sysconfig}). Upon loading of the master module, the
|
3471 |
virtual interfaces become available: |
|
3472 |
||
3473 |
\begin{lstlisting}
|
|
| 379 | 3474 |
# `\textbf{ifconfig -a}`
|
| 369 | 3475 |
eoe0 Link encap:Ethernet HWaddr 00:11:22:33:44:06 |
3476 |
BROADCAST MULTICAST MTU:1500 Metric:1 |
|
3477 |
RX packets:0 errors:0 dropped:0 overruns:0 frame:0 |
|
3478 |
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0 |
|
3479 |
collisions:0 txqueuelen:1000 |
|
3480 |
RX bytes:0 (0.0 b) TX bytes:0 (0.0 b) |
|
3481 |
||
3482 |
eoe1 Link encap:Ethernet HWaddr 00:11:22:33:44:07 |
|
3483 |
BROADCAST MULTICAST MTU:1500 Metric:1 |
|
3484 |
RX packets:0 errors:0 dropped:0 overruns:0 frame:0 |
|
3485 |
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0 |
|
3486 |
collisions:0 txqueuelen:1000 |
|
3487 |
RX bytes:0 (0.0 b) TX bytes:0 (0.0 b) |
|
3488 |
... |
|
3489 |
\end{lstlisting}
|
|
3490 |
||
3491 |
\paragraph{Coupling of EoE Slaves}
|
|
3492 |
||
3493 |
During execution of the slave scan state machine (see |
|
3494 |
section~\ref{sec:fsm-scan}), the master determines the supported
|
|
3495 |
mailbox protocols. This is done by examining the ``Supported Mailbox |
|
3496 |
Protocols'' mask field at word address 0x001C of the SII\index{SII}.
|
|
3497 |
If bit 1 is set, the slave supports the EoE protocol. After slave |
|
3498 |
scanning, the master runs through all slaves again and couples each |
|
3499 |
EoE-capable slave to a free EoE handler. It can happen, that there are |
|
3500 |
not enough EoE handlers to cover all EoE-capable slaves. In this case, |
|
3501 |
the number of EoE handlers must be increased accordingly. |
|
3502 |
||
3503 |
\paragraph{EoE State Machine}
|
|
3504 |
\index{FSM!EoE}
|
|
3505 |
||
3506 |
Every EoE handler owns an EoE state machine, that is used to send |
|
3507 |
frames to the coupled slave and receive frames from the it via the EoE |
|
3508 |
communication primitives. This state machine is showed in |
|
3509 |
figure~\ref{fig:fsm-eoe}.
|
|
3510 |
||
3511 |
\begin{figure}[htbp]
|
|
3512 |
\centering |
|
3513 |
\includegraphics[width=.7\textwidth]{images/fsm-eoe}
|
|
3514 |
\caption{Transition diagram of the EoE state machine}
|
|
3515 |
\label{fig:fsm-eoe}
|
|
3516 |
\end{figure}
|
|
3517 |
||
3518 |
\begin{description}
|
|
3519 |
\item[RX\_START] The beginning state of the EoE state machine. A |
|
3520 |
mailbox check datagram is sent, to query the slave's mailbox for new |
|
| 379 | 3521 |
frames. $\rightarrow$~RX\_CHECK |
| 369 | 3522 |
|
3523 |
\item[RX\_CHECK] The mailbox check datagram is received. If the |
|
3524 |
slave's mailbox did not contain data, a transmit cycle is started. |
|
| 379 | 3525 |
$\rightarrow$~TX\_START |
| 369 | 3526 |
|
3527 |
If there are new data in the mailbox, a datagram is sent to fetch |
|
| 379 | 3528 |
the new data. $\rightarrow$~RX\_FETCH |
| 369 | 3529 |
|
3530 |
\item[RX\_FETCH] The fetch datagram is received. If the mailbox data |
|
3531 |
do not contain a ``EoE Fragment request'' command, the data are |
|
3532 |
dropped and a transmit sequence is started. |
|
| 379 | 3533 |
$\rightarrow$~TX\_START |
| 369 | 3534 |
|
3535 |
If the received Ethernet frame fragment is the first fragment, a new |
|
3536 |
socket buffer is allocated. In either case, the data are copied into |
|
3537 |
the correct position of the socket buffer. |
|
3538 |
||
3539 |
If the fragment is the last fragment, the socket buffer is forwarded |
|
3540 |
to the network stack and a transmit sequence is started. |
|
| 379 | 3541 |
$\rightarrow$~TX\_START |
| 369 | 3542 |
|
3543 |
Otherwise, a new receive sequence is started to fetch the next |
|
| 379 | 3544 |
fragment. $\rightarrow$~RX\_\-START |
| 369 | 3545 |
|
3546 |
\item[TX\_START] The beginning state of a transmit sequence. It is |
|
3547 |
checked, if the transmittion queue contains a frame to send. If not, |
|
| 379 | 3548 |
a receive sequence is started. $\rightarrow$~RX\_START |
| 369 | 3549 |
|
3550 |
If there is a frame to send, it is dequeued. If the queue was |
|
3551 |
inactive before (because it was full), the queue is woken up with a |
|
3552 |
call to \textit{netif\_wake\_queue()}. The first fragment of the
|
|
| 379 | 3553 |
frame is sent. $\rightarrow$~TX\_SENT |
| 369 | 3554 |
|
3555 |
\item[TX\_SENT] It is checked, if the first fragment was sent |
|
3556 |
successfully. If the current frame consists of further fragments, |
|
| 379 | 3557 |
the next one is sent. $\rightarrow$~TX\_SENT |
| 369 | 3558 |
|
3559 |
If the last fragment was sent, a new receive sequence is started. |
|
| 379 | 3560 |
$\rightarrow$~RX\_START |
| 369 | 3561 |
\end{description}
|
3562 |
||
3563 |
\paragraph{EoE Processing}
|
|
3564 |
||
3565 |
To execute the EoE state machine of every active EoE handler, there |
|
3566 |
must be a cyclic process. The easiest thing would be to execute the |
|
3567 |
EoE state machines synchronously to the operation state machine (see |
|
3568 |
section~\ref{sec:fsm-op}) with every realtime cycle. This approach has
|
|
3569 |
the following disadvantages: |
|
3570 |
||
3571 |
\begin{itemize}
|
|
3572 |
\item Only one EoE fragment can be sent or received every few cycles. |
|
3573 |
This causes the data rate to be very low, because the EoE state |
|
3574 |
machines are not executed in the time between the realtime |
|
3575 |
cycles. Moreover, the data rate would be dependent on the frequency |
|
3576 |
of the realtime process. |
|
3577 |
\item The receiving and forwarding of frames to the kernel requires |
|
3578 |
the dynamic allocation of frames. Some realtime extensions do not |
|
3579 |
support calling memory allocation functions in realtime context, so |
|
3580 |
the EoE state machine may not be executed with each realtime cycle. |
|
3581 |
\end{itemize}
|
|
3582 |
||
3583 |
To overcome these problems, an own cyclic process is needed to |
|
3584 |
asynchronously execute the EoE state machines. For that, the master |
|
3585 |
owns a kernel timer, that is executed each timer interrupt. This |
|
3586 |
guarantees a constant bandwidth, but poses the new problem of |
|
3587 |
concurrent access to the master. The locking mechanisms needed for |
|
3588 |
this are introduced in section~\ref{sec:concurr}.
|
|
3589 |
Section~\ref{sec:concurrency} gives practical implementation examples.
|
|
3590 |
||
3591 |
\paragraph{Idle Mode}
|
|
3592 |
||
3593 |
EoE data must also be exchanged idle mode, to guarantee the continuous |
|
3594 |
availability of the connection to the EoE-capable slaves. Although |
|
3595 |
there is no realtime module connected in this case, the master is |
|
3596 |
still accessed by the idle state machine (see |
|
3597 |
section~\ref{sec:fsm-idle}), that is executed by the master's
|
|
3598 |
workqueue. With the EoE timer running in addition, there is still |
|
3599 |
concurrency, that has to be protected by a lock. Therefore the master |
|
3600 |
owns an internal spinlock that is used protect master access during |
|
3601 |
idle mode. |
|
3602 |
||
3603 |
\paragraph{Automatic Configuration}
|
|
3604 |
||
| 379 | 3605 |
By default, slaves are left in INIT state during idle mode. If an EoE |
3606 |
interface is set to running state (i.~e. with the \textit{ifconfig up}
|
|
3607 |
command), the requested slave state of the related slave is |
|
3608 |
automatically set to OP, whereupon the idle state machine will attempt |
|
3609 |
to configure the slave and put it into operation. |
|
| 369 | 3610 |
|
3611 |
%------------------------------------------------------------------------------ |
|
3612 |
||
3613 |
\subsection{CANopen-over-EtherCAT (CoE)}
|
|
3614 |
\label{sec:coeimp}
|
|
3615 |
\index{CoE}
|
|
3616 |
||
3617 |
The CANopen-over-EtherCAT protocol \cite[section~5.6]{alspec} is used
|
|
3618 |
to configure slaves on application level. Each CoE-capable slave |
|
3619 |
provides a list of SDOs for this reason. |
|
3620 |
||
3621 |
\paragraph{SDO Configuration}
|
|
3622 |
||
3623 |
The SDO configurations have to be provided by the realtime module. |
|
3624 |
This is done via the \textit{ecrt\_slave\_conf\_sdo*()} methods (see
|
|
3625 |
section~\ref{sec:ecrt-slave}), that are part of the realtime
|
|
3626 |
interface. The slave stores the SDO configurations in a linked list, |
|
3627 |
but does not apply them at once. |
|
3628 |
||
3629 |
\paragraph{SDO Download State Machine}
|
|
3630 |
||
| 379 | 3631 |
The best time to apply SDO configurations is during the slave's PREOP |
3632 |
state, because mailbox communication is already possible and slave's |
|
3633 |
application will start with updating input data in the succeeding |
|
3634 |
SAVEOP state. Therefore the SDO configuration has to be part of the |
|
3635 |
slave configuration state machine (see section~\ref{sec:fsm-conf}): It
|
|
3636 |
is implemented via an SDO download state machine, that is executed |
|
3637 |
just before entering the slave's SAVEOP state. In this way, it is |
|
3638 |
guaranteed that the SDO configurations are applied each time, the |
|
3639 |
slave is reconfigured. |
|
| 369 | 3640 |
|
3641 |
The transition diagram of the SDO Download state machine can be seen |
|
3642 |
in figure~\ref{fig:fsm-coedown}.
|
|
3643 |
||
3644 |
\begin{figure}[htbp]
|
|
3645 |
\centering |
|
3646 |
\includegraphics[width=.9\textwidth]{images/fsm-coedown}
|
|
3647 |
\caption{Transition diagram of the CoE download state machine}
|
|
3648 |
\label{fig:fsm-coedown}
|
|
3649 |
\end{figure}
|
|
3650 |
||
3651 |
\begin{description}
|
|
3652 |
\item[START] The beginning state of the CoE download state |
|
3653 |
machine. The ``SDO Download Normal Request'' mailbox command is |
|
| 379 | 3654 |
sent. $\rightarrow$~REQUEST |
| 369 | 3655 |
|
3656 |
\item[REQUEST] It is checked, if the CoE download request has been |
|
3657 |
received by the slave. After that, a mailbox check command is issued |
|
| 379 | 3658 |
and a timer is started. $\rightarrow$~CHECK |
| 369 | 3659 |
|
3660 |
\item[CHECK] If no mailbox data is available, the timer is checked. |
|
3661 |
\begin{itemize}
|
|
3662 |
\item If it timed out, the SDO download is aborted. |
|
| 379 | 3663 |
$\rightarrow$~ERROR |
| 369 | 3664 |
\item Otherwise, the mailbox is queried again. |
| 379 | 3665 |
$\rightarrow$~CHECK |
| 369 | 3666 |
\end{itemize}
|
3667 |
||
3668 |
If the mailbox contains new data, the response is fetched. |
|
| 379 | 3669 |
$\rightarrow$~RESPONSE |
| 369 | 3670 |
|
3671 |
\item[RESPONSE] If the mailbox response could not be fetched, the data |
|
3672 |
is invalid, the wrong protocol was received, or a ``Abort SDO |
|
3673 |
Transfer Request'' was received, the SDO download is aborted. |
|
| 379 | 3674 |
$\rightarrow$~ERROR |
| 369 | 3675 |
|
3676 |
If a ``SDO Download Normal Response'' acknowledgement was received, |
|
| 379 | 3677 |
the SDO download was successful. $\rightarrow$~END |
| 369 | 3678 |
|
3679 |
\item[END] The SDO download was successful. |
|
3680 |
||
3681 |
\item[ERROR] The SDO download was aborted due to an error. |
|
3682 |
||
3683 |
\end{description}
|
|
3684 |
||
3685 |
%------------------------------------------------------------------------------ |
|
3686 |
||
3687 |
\section{User Space}
|
|
3688 |
\label{sec:user}
|
|
3689 |
\index{User space}
|
|
3690 |
||
3691 |
For the master runs as a kernel module, accessing it is natively |
|
3692 |
limited to analyzing syslog messages and controlling using modutils. |
|
3693 |
||
3694 |
It is necessary to implement further interfaces, that make it easier |
|
3695 |
to access the master from user space and allow a finer influence. It |
|
3696 |
should be possible to view and to change special parameters at runtime. |
|
3697 |
||
3698 |
Bus visualization is a second point: For development and debugging |
|
3699 |
purposes it would be nice, if one could show the connected slaves with |
|
3700 |
a single command. |
|
3701 |
||
3702 |
Another aspect is automatic startup and configuration. If the master |
|
3703 |
is to be integrated into a running system, it must be able to |
|
3704 |
automatically start with a persistent configuration. |
|
3705 |
||
3706 |
A last thing is monitoring EtherCAT communication. For debugging |
|
3707 |
purposes, there had to be a way to analyze EtherCAT datagrams. The |
|
3708 |
best way would be with a popular network analyzer, like Wireshark |
|
3709 |
\cite{wireshark} (the former Ethereal) or others.
|
|
3710 |
||
3711 |
This section covers all those points and introduces the interfaces and |
|
3712 |
tools to make all that possible. |
|
3713 |
||
3714 |
%------------------------------------------------------------------------------ |
|
3715 |
||
3716 |
\subsection{The Sysfs Interface}
|
|
3717 |
\label{sec:sysfs}
|
|
3718 |
||
3719 |
The system filesystem (Sysfs\index{Sysfs}) was introduced with Linux
|
|
3720 |
kernel 2.5 and is a well-defined interface for drivers to export |
|
3721 |
information to user space. It serves also as an relief for the process |
|
3722 |
filesystem (Procfs), where over the years much non-process information |
|
3723 |
was concentrated. |
|
3724 |
||
3725 |
Sysfs exports information about devices, classes and busses via a |
|
3726 |
virtual filesystem, usually mounted to \textit{/sys}. The EtherCAT
|
|
3727 |
master slightly differs from this concept, because the only physical |
|
3728 |
device is the network adapter it uses for bus communication, which is |
|
3729 |
already represented in Sysfs. For the EtherCAT bus is no system bus |
|
3730 |
like PCI (with device and driver structures), it would not make any |
|
3731 |
sense to represent it as bus structure in Sysfs. |
|
3732 |
||
3733 |
Therefore, the EtherCAT master is represented as a new directory |
|
3734 |
directly unter the Sysfs root. Every master gets its own Sysfs entry |
|
3735 |
named \textit{ethercatX}, where X is the index of the master. Two
|
|
3736 |
masters would result in the directories \textit{/sys/ethercat0} and
|
|
3737 |
\textit{/sys/ethercat1}, respectively.
|
|
3738 |
||
3739 |
The Sysfs base class in the kernel code is the \textit{kobject}
|
|
3740 |
structure. Each object structure, that is to be represented in Sysfs, |
|
3741 |
has to contain such a structure, because due to the concurrent access |
|
3742 |
(through ``normal'' kernel code and Sysfs code) the object deletion |
|
3743 |
gets a little more complicated: The object may not be freed until no |
|
3744 |
instance uses it any more. Therefore, each kobject maintains a |
|
3745 |
reference counter. If the reference counter gets zero, the object is |
|
3746 |
finally freed. A kobject can be registered to appear as a directory in |
|
3747 |
Sysfs with a call to \textit{kobject\_add()}. Each kobject type can
|
|
3748 |
define attributes, that appear as files in the kobject's |
|
3749 |
directory. Callback functions have to be provided for reading (and |
|
3750 |
perhaps writing) access. |
|
3751 |
||
3752 |
\subsubsection{Master Attributes}
|
|
3753 |
\label{sec:sysfs-master}
|
|
3754 |
||
3755 |
Below is a typical listing of the masters Sysfs directory (that is a |
|
3756 |
file system representation of the master's kobject): |
|
3757 |
||
3758 |
\begin{lstlisting}
|
|
| 379 | 3759 |
`\$` `\textbf{ls /sys/ethercat0}`
|
| 369 | 3760 |
debug_level slave000 slave003 slave006 |
3761 |
eeprom_write_enable slave001 slave004 slave007 |
|
3762 |
info slave002 slave005 slave008 |
|
3763 |
\end{lstlisting}
|
|
3764 |
||
3765 |
The following attributes exist in the master directory: |
|
3766 |
||
3767 |
\begin{description}
|
|
3768 |
\item[debug\_level] (read/write) This attribute contains the master's |
|
3769 |
debug level, which controls, how much information is printed into |
|
3770 |
syslog. The values 0 (no additional debug messages), 1 (a few |
|
3771 |
additional debug messages) and 2 (all additional debug messages) are |
|
3772 |
defined. Writing is done with command like |
|
3773 |
||
3774 |
\begin{lstlisting}[gobble=4]
|
|
| 379 | 3775 |
# `\textbf{echo 1 > /sys/ethercat0/debug\_level}`
|
| 369 | 3776 |
\end{lstlisting}
|
3777 |
||
3778 |
and is receipted with a syslog message by the master: |
|
3779 |
||
3780 |
\begin{lstlisting}[gobble=4]
|
|
3781 |
EtherCAT: Master debug level set to 1. |
|
3782 |
\end{lstlisting}
|
|
3783 |
||
3784 |
\item[enable\_eeprom\_writing] (read/write) See |
|
3785 |
section~\ref{sec:eepromaccess} for how to use this attribute.
|
|
3786 |
||
3787 |
\item[info] (read only) This attribute contains information about the |
|
3788 |
master. Example contents are below: |
|
3789 |
||
3790 |
\begin{lstlisting}[gobble=4]
|
|
| 379 | 3791 |
`\$` `\textbf{cat /sys/ethercat0/info}`
|
| 369 | 3792 |
|
3793 |
Mode: IDLE |
|
3794 |
Slaves: 9 |
|
3795 |
||
3796 |
Timing (min/avg/max) [us]: |
|
3797 |
Idle cycle: 4 / 4.38 / 34 |
|
3798 |
EoE cycle: 9 / 11.91 / 23 |
|
3799 |
||
3800 |
EoE statistics (RX/TX) [bps]: |
|
3801 |
eoe0: 0 / 3184 |
|
3802 |
\end{lstlisting}
|
|
3803 |
||
3804 |
The mode can be \textit{ORPHANED}, \textit{IDLE} or
|
|
3805 |
\textit{OPERATION}. The other parameters are self-explanatory.
|
|
3806 |
||
3807 |
\end{description}
|
|
3808 |
||
3809 |
\subsubsection{Domain Attributes}
|
|
3810 |
\label{sec:sysfs-domain}
|
|
3811 |
||
3812 |
In operation mode, each created domain is represented as a directory |
|
3813 |
\textit{domainX}, where X is the domain index. Below is a listing of
|
|
3814 |
the domain directory contents: |
|
3815 |
||
3816 |
\begin{lstlisting}
|
|
| 379 | 3817 |
`\$` `\textbf{ls /sys/ethercat0/domain0}`
|
| 369 | 3818 |
image_size |
3819 |
\end{lstlisting}
|
|
3820 |
||
3821 |
The domain directories currently only export the domain's image size. |
|
3822 |
It is planned to export the whole process data mapping for debugging |
|
3823 |
purposes. |
|
3824 |
||
3825 |
\subsubsection{Slave Attributes}
|
|
3826 |
\label{sec:sysfs-slave}
|
|
3827 |
||
3828 |
Each slave on the bus is represented in its own directory |
|
3829 |
\textit{slaveXXX}, where XXX is the slave's 3-digit ring position in
|
|
3830 |
the EtherCAT bus. Below is a listing of a slave directory: |
|
3831 |
||
3832 |
\begin{lstlisting}
|
|
| 379 | 3833 |
`\$` `\textbf{ls /sys/ethercat0/slave003}`
|
| 369 | 3834 |
eeprom info state |
3835 |
\end{lstlisting}
|
|
3836 |
||
3837 |
\begin{description}
|
|
3838 |
\item[eeprom] (read/write) See section~\ref{sec:eepromaccess} for how
|
|
3839 |
to use this attribute. |
|
3840 |
||
3841 |
\item[info] (read only) This attribute contains a bunch of information |
|
3842 |
about the slave. Below is an example output: |
|
3843 |
||
3844 |
\begin{lstlisting}[gobble=4]
|
|
| 379 | 3845 |
`\$` `\textbf{cat /sys/ethercat0/slave003/info}`
|
| 369 | 3846 |
|
3847 |
Name: EL4132 2K. Ana. Ausgang +/-10V |
|
3848 |
Vendor ID: 0x00000002 |
|
3849 |
Product code: 0x10243052 |
|
3850 |
||
3851 |
State: INIT |
|
3852 |
Ring position: 3 |
|
3853 |
Advanced position: 1:3 |
|
3854 |
||
3855 |
Data link status: |
|
3856 |
Port 0 (EBUS) Link down, Loop open, Signal detected |
|
3857 |
Port 1 (EBUS) Link down, Loop open, Signal detected |
|
3858 |
Port 2 (EBUS) Link down, Loop closed, No signal |
|
3859 |
Port 3 (EBUS) Link down, Loop closed, No signal |
|
3860 |
||
3861 |
Mailboxes: |
|
3862 |
RX mailbox: 0x1800/246, TX mailbox: 0x18F6/246 |
|
3863 |
Supported protocols: CoE, FoE |
|
3864 |
||
3865 |
SII data: |
|
3866 |
Group: AnaOut |
|
3867 |
Image: TERM_AO |
|
3868 |
Order#: EL4132 |
|
3869 |
||
3870 |
Sync-Managers: |
|
3871 |
0: 0x1800, length 246, control 0x26, enable |
|
3872 |
1: 0x18F6, length 246, control 0x22, enable |
|
3873 |
2: 0x1000, length 0, control 0x24, enable |
|
3874 |
3: 0x1100, length 0, control 0x20, enable |
|
3875 |
||
3876 |
PDOs: |
|
3877 |
RXPDO "Channel 1" (0x1600), Sync-Manager 2 |
|
3878 |
"Output" 0x6411:1, 16 bit |
|
3879 |
RXPDO "Channel 2" (0x1601), Sync-Manager 2 |
|
3880 |
"Output" 0x6411:2, 16 bit |
|
3881 |
\end{lstlisting}
|
|
3882 |
||
3883 |
This is nearly all of the SII category information needed to |
|
3884 |
configure the slave, supplemented with state and addressing |
|
3885 |
information. |
|
3886 |
||
3887 |
\item[state] (read/write) This attribute contains the slave's state. |
|
3888 |
It can be read or written: |
|
3889 |
||
3890 |
\begin{lstlisting}[gobble=4]
|
|
| 379 | 3891 |
# `\textbf{cat /sys/ethercat0/slave003/state}`
|
| 369 | 3892 |
OP |
| 379 | 3893 |
# `\textbf{echo SAVEOP > /sys/ethercat0/slave003/state}`
|
| 369 | 3894 |
\end{lstlisting}
|
3895 |
||
3896 |
This command should also be receipted with a syslog message: |
|
3897 |
||
3898 |
\begin{lstlisting}[gobble=4]
|
|
3899 |
EtherCAT: Accepted new state SAVEOP for slave 3. |
|
3900 |
EtherCAT: Changing state of slave 3 from OP to SAVEOP. |
|
3901 |
EtherCAT: Slave states: INIT, SAVEOP, OP. |
|
3902 |
\end{lstlisting}
|
|
3903 |
||
3904 |
After the new requested state was accepted from user space, the |
|
3905 |
operation state machine (see section~\ref{sec:fsm-op}) or the idle
|
|
3906 |
state machine (section~\ref{sec:fsm-idle}) notices, that the
|
|
3907 |
requested slave state differs from the current one, and therefore |
|
3908 |
executes the slave configuration state machine, until the slave has |
|
3909 |
reached the requested state. |
|
3910 |
\end{description}
|
|
3911 |
||
3912 |
%------------------------------------------------------------------------------ |
|
3913 |
||
3914 |
\subsubsection{E$^2$PROM Access}
|
|
3915 |
\label{sec:eepromaccess}
|
|
3916 |
\index{E$^2$PROM!Access}
|
|
3917 |
||
3918 |
It is possible to directly read or write the complete E$^2$PROM |
|
3919 |
contents of the slaves. This was introduced for the reasons below: |
|
3920 |
||
3921 |
\begin{itemize}
|
|
3922 |
\item The format of the E$^2$PROM data is still in development and |
|
3923 |
categories can be added in the future. With read and write access, |
|
3924 |
the complete memory contents can be easily backed up and restored. |
|
3925 |
\item Some E$^2$PROM data fields have to be altered (like the alias |
|
3926 |
address). A quick writing must be possible for that. |
|
3927 |
\item Through read access, analyzing category data is possible from |
|
3928 |
user space. |
|
3929 |
\end{itemize}
|
|
3930 |
||
3931 |
Reading out E$^2$PROM data is as easy as reading other |
|
3932 |
attributes. Though the data are in binary format, analyzation is |
|
3933 |
easier with a tool like \textit{hexdump}:
|
|
3934 |
||
3935 |
\begin{lstlisting}
|
|
| 379 | 3936 |
`\$` `\textbf{cat /sys/ethercat0/slave003/eeprom | hexdump}`
|
| 369 | 3937 |
0000000 0103 0000 0000 0000 0000 0000 0000 008c |
3938 |
0000010 0002 0000 3052 07f0 0000 0000 0000 0000 |
|
3939 |
0000020 0000 0000 0000 0000 0000 0000 0000 0000 |
|
3940 |
... |
|
3941 |
\end{lstlisting}
|
|
3942 |
||
3943 |
Backing up E$^2$PROM contents gets as easy as copying a file: |
|
3944 |
||
3945 |
\begin{lstlisting}
|
|
| 379 | 3946 |
`\$` `\textbf{cp /sys/ethercat0/slave003/eeprom slave003.eep}`
|
| 369 | 3947 |
\end{lstlisting}
|
3948 |
||
3949 |
Writing access is only possible as \textit{root}. Moreover writing has
|
|
3950 |
to be explicitly enabled and is only allowed in idle mode. This is a |
|
3951 |
safety measure, because without the correct memory contents, a slave |
|
3952 |
is unusable. Writing E$^2$PROM contents in operation mode is not |
|
3953 |
provided yet. |
|
3954 |
||
3955 |
E$^2$PROM writing is enabled with the command below: |
|
3956 |
||
3957 |
\begin{lstlisting}
|
|
| 379 | 3958 |
# `\textbf{echo 1 > /sys/ethercat0/eeprom\_write\_enable}`
|
| 369 | 3959 |
\end{lstlisting}
|
3960 |
||
3961 |
The success can be seen in the syslog messages again: |
|
3962 |
||
3963 |
\begin{lstlisting}
|
|
3964 |
EtherCAT: Slave EEPROM writing enabled. |
|
3965 |
\end{lstlisting}
|
|
3966 |
||
3967 |
Now, it is possible to write E$^2$PROM contents to a slave. The master |
|
3968 |
will accept data through the \textit{eeprom} file and will perform a
|
|
3969 |
short validation of the contents, before starting the write operation. |
|
3970 |
This validation checks the complete size and the category headers. |
|
3971 |
||
3972 |
\begin{lstlisting}
|
|
| 379 | 3973 |
# `\textbf{cat slave003.eep > /sys/ethercat0/slave003/eeprom}`
|
| 369 | 3974 |
\end{lstlisting}
|
3975 |
||
3976 |
The write operation can take a few seconds. |
|
3977 |
||
3978 |
\begin{lstlisting}
|
|
3979 |
EtherCAT: EEPROM writing scheduled for slave 3, 88 words. |
|
3980 |
EtherCAT: Writing EEPROM of slave 3... |
|
3981 |
EtherCAT: Finished writing EEPROM of slave 3. |
|
3982 |
\end{lstlisting}
|
|
3983 |
||
3984 |
%------------------------------------------------------------------------------ |
|
3985 |
||
3986 |
\subsection{User Space Tools}
|
|
3987 |
\index{User space!Tools}
|
|
3988 |
||
3989 |
There is a user space tool called \textit{lsec}\index{lsec} (``List
|
|
3990 |
EtherCAT'') to visualize the EtherCAT bus. Running it usually results |
|
3991 |
in an output like this: |
|
3992 |
||
3993 |
\begin{lstlisting}
|
|
| 379 | 3994 |
`\$` `\textbf{lsec}`
|
| 369 | 3995 |
EtherCAT bus listing for master 0: |
3996 |
0 1:0 OP EK1100 Ethernet Kopplerklemme (2A E-Bus) |
|
3997 |
1 1:1 INIT EL4132 2K. Ana. Ausgang +/-10V |
|
3998 |
2 1:2 INIT EL4132 2K. Ana. Ausgang +/-10V |
|
3999 |
3 1:3 SAVEOP EL4132 2K. Ana. Ausgang +/-10V |
|
4000 |
4 1:4 INIT EL5101 Incremental Encoder Interface |
|
4001 |
5 1:5 INIT EL1014 4K. Dig. Eingang 24V, 10s |
|
4002 |
6 1:6 OP EL6601 1 Port Switch (Ethernet, CoE) |
|
4003 |
7 1:7 INIT EL5101 Incremental Encoder Interface |
|
4004 |
8 1:8 INIT EL5001 1K. SSI Encoder |
|
4005 |
\end{lstlisting}
|
|
4006 |
||
4007 |
Every slave is displayed as one text row. The first column shows its |
|
4008 |
ring position, the second displays the ``advanced position address'' |
|
4009 |
(see section~\ref{sec:addr}) and the third column displays the current
|
|
4010 |
slave state. The last column is the slave's name, as it appears in the |
|
4011 |
``general'' E$^2$PROM category. |
|
4012 |
||
4013 |
The lsec program is a Perl script, that evaluates the Sysfs |
|
4014 |
\textit{info} attributes of the slaves (see
|
|
4015 |
section~\ref{sec:sysfs-slave}). This is done for master $0$ by
|
|
4016 |
default, but the master index can be specified via command line: |
|
4017 |
||
4018 |
\begin{lstlisting}
|
|
| 379 | 4019 |
`\$` `\textbf{lsec -h}`
|
| 369 | 4020 |
Usage: ec_list [OPTIONS] |
4021 |
-m <IDX> Query master <IDX>. |
|
4022 |
-h Show this help. |
|
4023 |
\end{lstlisting}
|
|
4024 |
||
4025 |
This script has proved as useful for troubleshooting: If it displays |
|
4026 |
slaves, the master is up and running, and the bus connection is |
|
4027 |
present, too. It is also useful when building up a bus: It can verify |
|
4028 |
the list of slaves and help to create a process data image (see |
|
4029 |
chapter~\ref{chapter:usage}).
|
|
4030 |
||
4031 |
%------------------------------------------------------------------------------ |
|
4032 |
||
4033 |
\subsection{System Integration}
|
|
4034 |
\label{sec:system}
|
|
4035 |
||
4036 |
To integrate the EtherCAT master into a running system, it has to be |
|
4037 |
guaranteed, that it is started on system startup. In addition, there has |
|
4038 |
to be a persistent configuration, that is also applied on startup. |
|
4039 |
||
4040 |
\subsubsection{The EtherCAT Init Script}
|
|
4041 |
\label{sec:init}
|
|
4042 |
\index{Init script}
|
|
4043 |
||
4044 |
The EtherCAT master provides an ``init script'', that conforms to the |
|
4045 |
requirements of the ``Linux Standard Base'' (LSB\index{LSB},
|
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4046 |
\cite{lsb}). The script is installed to \textit{etc/init.d/ethercat}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4047 |
below the installation prefix and has to be copied to the appropriate |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4048 |
location (see section~\ref{sec:make}), before the master can be
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4049 |
inserted as a service. The different Linux distributions offer |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4050 |
different ways to mark the service for starting and stopping in |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4051 |
certain runlevels (for example, SUSE Linux provides the |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4052 |
\textit{insserv} command).
|
| 369 | 4053 |
|
4054 |
To provide service dependencies (i.~e. which services have to be |
|
4055 |
started before) right inside the init script code, LSB defines a |
|
4056 |
special comment block. System tools can extract this information to |
|
4057 |
insert the EtherCAT init script at the correct place in the startup |
|
4058 |
sequence: |
|
4059 |
||
4060 |
\begin{lstlisting}
|
|
4061 |
### BEGIN INIT INFO |
|
4062 |
# Provides: ethercat |
|
4063 |
# Required-Start: $local_fs $syslog $network |
|
4064 |
# Should-Start: $time |
|
4065 |
# Required-Stop: $local_fs $syslog $network |
|
4066 |
# Should-Stop: $time |
|
4067 |
# Default-Start: 3 5 |
|
4068 |
# Default-Stop: 0 1 2 6 |
|
4069 |
# Short-Description: EtherCAT master modules |
|
4070 |
# Description: |
|
4071 |
### END INIT INFO |
|
4072 |
\end{lstlisting}
|
|
4073 |
||
4074 |
The init script can also be used for manually starting and stopping |
|
4075 |
the EtherCAT master. It has to be executed with one of the parameters |
|
| 379 | 4076 |
\texttt{start}, \texttt{stop}, \texttt{restart} or \texttt{status}.
|
| 369 | 4077 |
|
4078 |
\begin{lstlisting}
|
|
| 379 | 4079 |
# `\textbf{/etc/init.d/ethercat restart}`
|
| 369 | 4080 |
Shutting down EtherCAT master done |
4081 |
Starting EtherCAT master done |
|
4082 |
\end{lstlisting}
|
|
4083 |
||
4084 |
\subsubsection{The EtherCAT Sysconfig File}
|
|
4085 |
\label{sec:sysconfig}
|
|
4086 |
\index{Sysconfig file}
|
|
4087 |
||
4088 |
For persistent configuration, the init script uses a sysconfig file |
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4089 |
installed to \textit{etc/sysconfig/ethercat} (below the installation
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4090 |
prefix), that is mandatory for the init script. The sysconfig file |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4091 |
contains all configuration variables needed to operate a master: |
| 369 | 4092 |
|
4093 |
\begin{description}
|
|
4094 |
\item[DEVICE\_INDEX] This variable must contain the PCI index of the |
|
4095 |
EtherCAT device. Setting this is mandatory for the EtherCAT init |
|
4096 |
script. Default: $-1$ |
|
4097 |
\item[EOE\_INTERFACES] The number of virtual Ethernet-over-EtherCAT |
|
4098 |
interfaces, every master creates on startup. See |
|
4099 |
section~\ref{sec:eoeimp}. Default: $0$
|
|
4100 |
\item[EOE\_BRIDGE] If this variable is set, all EoE interfaces will be |
|
4101 |
added to a network bridge according to IEEE 802.1D after master |
|
4102 |
startup. The variable must contain the name of the bridge. To use |
|
4103 |
this functionality, the kernel must be configured with the |
|
| 379 | 4104 |
CONFIG\_BRIDGE option and the \textit{bridge-utils} package must be
|
4105 |
installed (i.~e. the \textit{brctl} command is needed).
|
|
| 369 | 4106 |
\item[EOE\_IP\_ADDRESS] The IP address of the EoE bridge. Setting this |
| 379 | 4107 |
together with \$EOE\_IP\_NETMASK will let the local host communicate |
4108 |
with devices on the EoE bridge. |
|
| 369 | 4109 |
\item[EOE\_IP\_NETMASK] IP netmask of the EoE bridge. |
4110 |
\item[EOE\_EXTRA\_INTERFACES] The list of extra interfaces to include |
|
4111 |
in the EoE brid\-ge. Set this to interconnect the EoE bridge with |
|
| 379 | 4112 |
other local interfaces. If \$EOE\_\-BRIDGE is empty or undefined, |
4113 |
setting this variable has no effect. Important: The IP address of |
|
4114 |
the listed interfaces will be cleared. Setting |
|
4115 |
\$EOE\_\-IP\_\-ADDRESS and \$EOE\_IP\_NETMASK will re-enable them |
|
4116 |
for IP traffic. |
|
| 369 | 4117 |
\item[EOE\_GATEWAY] The IP address of the default gateway. If this |
4118 |
variable is set, the gateway will be renewed after bridge |
|
4119 |
installation. This is necessary, if the default gateway's interface |
|
| 379 | 4120 |
is one of the \$EOE\_EXTRA\_INTERFACES. |
| 369 | 4121 |
\end{description}
|
4122 |
||
4123 |
%------------------------------------------------------------------------------ |
|
4124 |
||
4125 |
\subsection{Monitoring and Debugging}
|
|
4126 |
\label{sec:debug}
|
|
4127 |
\index{Monitoring}
|
|
4128 |
||
4129 |
For debugging purposes, every EtherCAT master registeres a read-only |
|
4130 |
network interface \textit{ecX}, where X is a number, provided by the
|
|
4131 |
kernel on device registration. While it is ``up'', the master forwards |
|
4132 |
every frame sent and received to this interface. |
|
4133 |
||
4134 |
This makes it possible to connect an network monitor (like Wireshark |
|
4135 |
or tcpdump) to the debug interface and monitor the EtherCAT frames. |
|
4136 |
||
4137 |
It has to be considered, that can be frame rate can be very high. The |
|
4138 |
idle state machine usually runs every kernel timer interrupt (up to |
|
4139 |
$1$~kHz) and with a connected realtime module, the rate can be even |
|
4140 |
higher. |
|
4141 |
||
4142 |
\paragraph{Attention:} The socket buffers needed for the operation of
|
|
4143 |
the debugging interface have to be allocated dynamically. Some Linux |
|
4144 |
realtime extensions do not allow this in realtime context! |
|
4145 |
||
4146 |
%------------------------------------------------------------------------------ |
|
4147 |
||
4148 |
\section{Timing Aspects}
|
|
4149 |
\label{sec:timing}
|
|
4150 |
||
4151 |
Although EtherCAT's timing is highly deterministic and therefore |
|
4152 |
timing issues are rare, there are a few aspects that can (and should |
|
4153 |
be) dealt with. |
|
4154 |
||
4155 |
%------------------------------------------------------------------------------ |
|
4156 |
||
4157 |
\subsection{Realtime Interface Profiling}
|
|
4158 |
\label{sec:timing-profile}
|
|
4159 |
\index{Realtime!Profiling}
|
|
4160 |
||
4161 |
One of the most important timing aspects are the runtimes of the |
|
4162 |
realtime interface functions, that are called in cyclic context. These |
|
4163 |
functions make up an important part of the overall timing of the |
|
4164 |
realtime module. To measure the timing of the functions, the following |
|
4165 |
code was used: |
|
4166 |
||
4167 |
\begin{lstlisting}[gobble=2,language=C]
|
|
4168 |
c0 = get_cycles(); |
|
4169 |
ecrt_master_receive(master); |
|
4170 |
c1 = get_cycles(); |
|
4171 |
ecrt_domain_process(domain1); |
|
4172 |
c2 = get_cycles(); |
|
4173 |
ecrt_master_run(master); |
|
4174 |
c3 = get_cycles(); |
|
4175 |
ecrt_master_send(master); |
|
4176 |
c4 = get_cycles(); |
|
4177 |
\end{lstlisting}
|
|
4178 |
||
4179 |
Between each call of an interface function, the CPU timestamp counter |
|
4180 |
is read. The counter differences are converted to microseconds with |
|
4181 |
help of the \textit{cpu\_khz} variable, that contains the number of
|
|
4182 |
increments per millisecond. |
|
4183 |
||
4184 |
For the actual measuring, a system with a $2.0$~GHz CPU was used, that |
|
4185 |
ran the above code in an RTAI thread with a cycle time of $100$ |
|
4186 |
\textmu s. The measuring was repeated $n = 100$ times and the results |
|
4187 |
were averaged. These can be seen in table~\ref{tab:profile}.
|
|
4188 |
||
4189 |
\begin{table}[htpb]
|
|
4190 |
\centering |
|
4191 |
\caption{Profiling of a Realtime Cycle on a $2.0$~GHz Processor}
|
|
4192 |
\label{tab:profile}
|
|
4193 |
\vspace{2mm}
|
|
4194 |
\begin{tabular}{l|r|r}
|
|
4195 |
Element & Mean Duration [\textmu s] & Standard Deviancy [\textmu s] \\ |
|
4196 |
\hline |
|
4197 |
\textit{ecrt\_master\_receive()} & 8.04 & 0.48\\
|
|
4198 |
\textit{ecrt\_domain\_process()} & 0.14 & 0.03\\
|
|
4199 |
\textit{ecrt\_master\_run()} & 0.29 & 0.12\\
|
|
4200 |
\textit{ecrt\_master\_send()} & 2.18 & 0.17\\ \hline
|
|
4201 |
Complete Cycle & 10.65 & 0.69\\ \hline |
|
4202 |
\end{tabular}
|
|
4203 |
\end{table}
|
|
4204 |
||
4205 |
It is obvious, that the the functions accessing hardware make up the |
|
4206 |
lion's share. The \textit{ec\_master\_receive()} executes the ISR of
|
|
4207 |
the Ethernet device, analyzes datagrams and copies their contents into |
|
4208 |
the memory of the datagram objects. The \textit{ec\_master\_send()}
|
|
4209 |
assembles a frame out of different datagrams and copies it to the |
|
4210 |
hardware buffers. Interestingly, this makes up only a quarter of the |
|
4211 |
receiving time. |
|
4212 |
||
4213 |
The functions that only operate on the masters internal data |
|
4214 |
structures are very fast ($\Delta t < 1$~\textmu s). Interestingly the |
|
4215 |
runtime of \textit{ec\_domain\_process()} has a small standard
|
|
4216 |
deviancy relative to the mean value, while this ratio is about twice |
|
4217 |
as big for \textit{ec\_master\_run()}: This probably results from the
|
|
4218 |
latter function having to execute code depending on the current state |
|
4219 |
and the different state functions are more or less complex. |
|
4220 |
||
4221 |
For a realtime cycle makes up about $10$~\textmu s, the theoretical |
|
4222 |
frequency can be up to $100$~kHz. For two reasons, this frequency |
|
4223 |
keeps being theoretical: |
|
4224 |
||
4225 |
\begin{enumerate}
|
|
4226 |
\item The processor must still be able to run the operating system |
|
4227 |
between the realtime cycles. |
|
4228 |
\item The EtherCAT frame must be sent and received, before the next |
|
4229 |
realtime cycle begins. The determination of the bus cycle time is |
|
4230 |
difficult and covered in section~\ref{sec:timing-bus}.
|
|
4231 |
\end{enumerate}
|
|
4232 |
||
4233 |
%------------------------------------------------------------------------------ |
|
4234 |
||
4235 |
\subsection{Bus Cycle Measuring}
|
|
4236 |
\label{sec:timing-bus}
|
|
4237 |
\index{Bus cycle}
|
|
4238 |
||
4239 |
For measuring the time, a frame is ``on the wire'', two timestamps |
|
4240 |
must be be taken: |
|
4241 |
||
4242 |
\begin{enumerate}
|
|
4243 |
\item The time, the Ethernet hardware begins with physically sending |
|
4244 |
the frame. |
|
4245 |
\item The time, the frame is completely received by the Ethernet |
|
4246 |
hardware. |
|
4247 |
\end{enumerate}
|
|
4248 |
||
4249 |
Both times are difficult to determine. The first reason is, that the |
|
4250 |
interrupts are disabled and the master is not notified, when a frame |
|
4251 |
is sent or received (polling would distort the results). The second |
|
4252 |
reason is, that even with interrupts enabled, the time from the event |
|
4253 |
to the notification is unknown. Therefore the only way to confidently |
|
4254 |
determine the bus cycle time is an electrical measuring. |
|
4255 |
||
4256 |
Anyway, the bus cycle time is an important factor when designing |
|
4257 |
realtime code, because it limits the maximum frequency for the cyclic |
|
4258 |
part of the realtime module. In practice, these timing parameters are |
|
4259 |
highly dependent on the hardware and often a trial and error method |
|
4260 |
must be used to determine the limits of the system. |
|
4261 |
||
4262 |
The central question is: What happens, if the cycle frequency is too |
|
4263 |
high? The answer is, that the EtherCAT frames that have been sent at |
|
4264 |
the end of the cycle are not yet received, when the next cycle starts. |
|
4265 |
First this is noticed by \textit{ecrt\_domain\_process()}, because the
|
|
4266 |
working counter of the process data datagrams were not increased. The |
|
4267 |
function will notify the user via syslog\footnote{To limit syslog
|
|
4268 |
output, a mechanism has been implementet, that outputs a summarized |
|
4269 |
notification at maximum once a second.}. In this case, the process |
|
4270 |
data keeps being the same as in the last cycle, because it is not |
|
4271 |
erased by the domain. When the domain datagrams are queued again, the |
|
4272 |
master notices, that they are already queued (and marked as sent). The |
|
4273 |
master will mark them as unsent again and output a warning, that |
|
4274 |
datagrams were ``skipped''. |
|
4275 |
||
4276 |
On the mentioned $2.0$~GHz system, the possible cycle frequency can be |
|
4277 |
up to $25$~kHz without skipped frames. This value can surely be |
|
4278 |
increased by choosing faster hardware. Especially the RealTek network |
|
4279 |
hardware could be replaced by a faster one. Besides, implementing a |
|
4280 |
dedicated ISR for EtherCAT devices would also contribute to increasing |
|
4281 |
the latency. These are two points on the author's to-do list. |
|
4282 |
||
4283 |
%------------------------------------------------------------------------------ |
|
4284 |
||
4285 |
\chapter{Using the EtherCAT Master}
|
|
4286 |
\label{chapter:usage}
|
|
4287 |
\index{Master!Usage}
|
|
4288 |
||
4289 |
This chapter will give practical examples of how to use the EtherCAT |
|
4290 |
master via the realtime interface by writing a realtime module. |
|
4291 |
||
4292 |
Section~\ref{sec:make} shows how to compile and install the master,
|
|
4293 |
while the sections~\ref{sec:mini} to~\ref{sec:concurrency} give
|
|
4294 |
examples for different realtime modules. |
|
4295 |
||
4296 |
%------------------------------------------------------------------------------ |
|
4297 |
||
4298 |
\section{Compiling and Installing}
|
|
4299 |
\label{sec:make}
|
|
4300 |
\index{Master!Compilation}
|
|
4301 |
||
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4302 |
The current EtherCAT master code is available at~\cite{etherlab} or
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4303 |
can be obtained from the EtherLab\textsuperscript{\textregistered} CD.
|
| 487 | 4304 |
The \textit{tar.bz2} file has to be unpacked with the commands below
|
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4305 |
(or similar): |
| 369 | 4306 |
|
4307 |
\begin{lstlisting}
|
|
| 487 | 4308 |
`\$` `\textbf{tar xjf ethercat-\masterversion.tar.bz2}`
|
4309 |
`\$` `\textbf{cd ethercat-\masterversion/}`
|
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4310 |
\end{lstlisting}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4311 |
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4312 |
The tarball was created with GNU Autotools, so the build process |
| 487 | 4313 |
follows the below commands: |
| 369 | 4314 |
|
4315 |
\begin{lstlisting}
|
|
| 379 | 4316 |
`\$` `\textbf{./configure}`
|
| 487 | 4317 |
`\$` `\textbf{make modules}`
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4318 |
\end{lstlisting}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4319 |
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4320 |
The default installation prefix is \textit{/opt/etherlab}. It can be
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4321 |
changed with the \texttt{--prefix} argument.
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4322 |
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4323 |
Linux kernel sources are needed for compilation\footnote{If a realtime
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4324 |
extension shall to be used, the kernel should be patched before |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4325 |
compiling the EtherCAT master.}. To compile the EtherCAT master |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4326 |
modules for a different kernel than the running kernel, the target |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4327 |
kernel version can be specified with the \texttt{--with-linux}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4328 |
argument. Example: |
| 369 | 4329 |
|
4330 |
\begin{lstlisting}
|
|
| 379 | 4331 |
`\$` `\textbf{./configure --with-linux="2.6.17-ipipe"}`
|
| 487 | 4332 |
`\$` `\textbf{make modules}`
|
4333 |
\end{lstlisting}
|
|
4334 |
||
4335 |
The below commands have to be entered as \textit{root}: The first one
|
|
4336 |
will install the kernel modules to the kernel's modules directory. The |
|
4337 |
second one will install EtherCAT headers, the init script, the |
|
4338 |
sysconfig file and the user space tools to the prefix path. |
|
| 369 | 4339 |
|
4340 |
\begin{lstlisting}
|
|
| 487 | 4341 |
# `\textbf{make modules\_install}`
|
| 379 | 4342 |
# `\textbf{make install}`
|
| 369 | 4343 |
\end{lstlisting}
|
4344 |
||
| 487 | 4345 |
If the target kernel's modules directory is not under |
4346 |
\textit{/lib/modules}, a different destination directory can be
|
|
4347 |
specified with the \textit{DESTDIR} make variable. For example:
|
|
4348 |
||
4349 |
\begin{lstlisting}
|
|
4350 |
# `\textbf{make DESTDIR=/vol/nfs/root modules\_install}`
|
|
4351 |
\end{lstlisting}
|
|
4352 |
||
4353 |
This command will install the compiled kernel modules to |
|
4354 |
\textit{/vol/nfs/root/lib/modules}, prepended by the kernel release.
|
|
4355 |
||
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4356 |
If the EtherCAT master shall be run as a service |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4357 |
(recommended\footnote{Even if the EtherCAT master shall not be loaded
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4358 |
on system startup, the use of the init script is recommended for |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4359 |
manual (un-)loading.}), the init script and the sysconfig file have |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4360 |
to be copied to the appropriate locations. The below example is |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4361 |
suitable for SUSE Linux. It may vary for other distributions. |
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4362 |
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4363 |
\begin{lstlisting}
|
| 379 | 4364 |
# `\textbf{cd /opt/etherlab}`
|
4365 |
# `\textbf{cp etc/sysconfig/ethercat /etc/sysconfig/}`
|
|
4366 |
# `\textbf{cp etc/init.d/ethercat /etc/init.d/}`
|
|
4367 |
# `\textbf{insserv ethercat}`
|
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4368 |
\end{lstlisting}
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4369 |
|
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4370 |
Now the sysconfig file \texttt{/etc/sysconfig/ethercat} (see
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4371 |
section~\ref{sec:sysconfig}) has to be customized: This is mainly done
|
| 379 | 4372 |
by uncommenting and adjusting the \$DEVICE\_INDEX variable. It has to |
4373 |
be set to the index of the compatible network device to use with |
|
4374 |
EtherCAT, where the order of devices is dependent on their position in |
|
4375 |
the PCI bus: |
|
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4376 |
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4377 |
\begin{lstlisting}[numbers=left,basicstyle=\ttfamily\scriptsize]
|
| 379 | 4378 |
# `\textbf{lspci}`
|
|
376
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4379 |
00:00.0 Host bridge: VIA Technologies, Inc. VT8363/8365 [KT133/KM133] (rev 03) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4380 |
00:01.0 PCI bridge: VIA Technologies, Inc. VT8363/8365 [KT133/KM133 AGP] |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4381 |
00:04.0 ISA bridge: VIA Technologies, Inc. VT82C686 [Apollo Super South] (rev 40) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4382 |
00:04.1 IDE interface: VIA Technologies, Inc. VT82C586A/B/VT82C686/A/B/VT823x/A/C... |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4383 |
00:04.2 USB Controller: VIA Technologies, Inc. VT82xxxxx UHCI USB 1.1 Controller... |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4384 |
00:04.3 USB Controller: VIA Technologies, Inc. VT82xxxxx UHCI USB 1.1 Controller... |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4385 |
00:04.4 Bridge: VIA Technologies, Inc. VT82C686 [Apollo Super ACPI] (rev 40) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4386 |
00:09.0 Ethernet controller: D-Link System Inc RTL8139 Ethernet (rev 10) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4387 |
00:0a.0 Ethernet controller: Intel Corporation 82557/8/9 [Ethernet Pro 100] (rev 08) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4388 |
00:0b.0 Ethernet controller: D-Link System Inc RTL8139 Ethernet (rev 10) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4389 |
00:0c.0 VGA compatible controller: ATI Technologies Inc Rage XL (rev 27) |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4390 |
00:11.0 Unknown mass storage controller: Promise Technology, Inc. PDC20265... |
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4391 |
\end{lstlisting}
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4392 |
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4393 |
In the above output of the \textit{lspci} command, two compatible
|
|
d1441d87f5c1
Documentation: EtherLab-CD; obtaining the DEVICE_INDEX.
Florian Pose <fp@igh-essen.com>
parents:
374
diff
changeset
|
4394 |
network devices can be found in lines~\textcircled{\tiny 9} and
|
| 379 | 4395 |
\textcircled{\tiny 11}. The \$DEVICE\_INDEX variable should be set to
|
4396 |
$0$ or $1$, respectively. |
|
| 369 | 4397 |
|
4398 |
After the basic configuration is done, the master can be started with |
|
4399 |
the below command: |
|
4400 |
||
4401 |
\begin{lstlisting}
|
|
| 379 | 4402 |
# `\textbf{/etc/init.d/ethercat start}`
|
| 369 | 4403 |
\end{lstlisting}
|
4404 |
||
4405 |
The operation of the master can be observed by looking at the |
|
|
374
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4406 |
syslog\index{syslog} messages, which should look like the ones below.
|
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4407 |
If EtherCAT slaves are connected to the master's EtherCAT device, the |
|
e43a29f9079e
Updated documentation concerning autotools/installation.
Florian Pose <fp@igh-essen.com>
parents:
371
diff
changeset
|
4408 |
activity indicators should begin to flash. |
| 369 | 4409 |
|
4410 |
\begin{lstlisting}[numbers=left]
|
|
4411 |
EtherCAT: Master driver, 1.1 (stable) - rev. 513, |
|
4412 |
compiled by fp at Aug 09 2006 10:23:20 |
|
4413 |
EtherCAT: Initializing 1 EtherCAT master(s)... |
|
4414 |
EtherCAT: Initializing master 0. |
|
4415 |
EtherCAT: Master driver initialized. |
|
4416 |
ec_8139too Fast Ethernet driver 0.9.27 Revision 513, |
|
4417 |
compiled by fp at Aug 09 2006 10:23:20 |
|
4418 |
ec_device_index is 0 |
|
4419 |
ACPI: PCI Interrupt 0000:01:00.0[A] -> Link [LNKC] |
|
4420 |
-> GSI 11 (level, low) -> IRQ 11 |
|
4421 |
ec0: RealTek RTL8139 at 0xd047c000, 00:c0:26:00:c6:aa, IRQ 11 |
|
4422 |
ec0: Identified 8139 chip type 'RTL-8100B/8139D' |
|
4423 |
Registering EtherCAT device... |
|
4424 |
Starting EtherCAT device... |
|
4425 |
EtherCAT: Link state changed to UP. |
|
4426 |
EtherCAT: Starting Idle mode. |
|
4427 |
EtherCAT: 11 slaves responding. |
|
4428 |
EtherCAT: Slave states: INIT, OP. |
|
4429 |
EtherCAT: Scanning bus. |
|
4430 |
EtherCAT: Bus scanning completed. |
|
4431 |
EtherCAT: No EoE handlers coupled. |
|
4432 |
\end{lstlisting}
|
|
4433 |
||
4434 |
\begin{description}
|
|
4435 |
\item[\normalfont\textcircled{\tiny 1}] The master module is loaded,
|
|
4436 |
and one master is initialized. |
|
4437 |
\item[\normalfont\textcircled{\tiny 6}] The EtherCAT-capable RTL8139
|
|
4438 |
device driver is loaded. It connects its first network device to the |
|
4439 |
master. |
|
4440 |
\item[\normalfont\textcircled{\tiny 16}] The master starts idle mode
|
|
4441 |
and begins scanning the bus for slaves. |
|
4442 |
\end{description}
|
|
4443 |
||
4444 |
%------------------------------------------------------------------------------ |
|
4445 |
||
4446 |
\section{A Minimal Example Module}
|
|
4447 |
\label{sec:mini}
|
|
4448 |
\index{Examples!Minimal}
|
|
4449 |
||
4450 |
This section will explain the usage of the EtherCAT master from a |
|
4451 |
minimal kernel module. The complete module code is obtainable as a |
|
4452 |
part of the EtherCAT master code release (see~\cite{etherlab}, file
|
|
4453 |
\textit{examples/mini/mini.c}).
|
|
4454 |
||
4455 |
The minimal example uses a kernel timer (software interrupt) to handle |
|
4456 |
cyclic code. After the timer function is executed, it re-adds itself |
|
4457 |
with a delay of one \textit{jiffy}\index{jiffies}, which results in a
|
|
4458 |
timer frequency of \textit{HZ}\nomenclature{HZ}{Kernel macro
|
|
4459 |
containing the timer interrupt frequency} |
|
4460 |
||
4461 |
The module-global variables, needed to operate the master can be seen |
|
4462 |
in listing~\ref{lst:minivar}.
|
|
4463 |
||
4464 |
\begin{lstlisting}[language=C,numbers=left,caption={Minimal
|
|
4465 |
variables},label=lst:minivar] |
|
4466 |
struct timer_list timer; |
|
4467 |
||
4468 |
ec_master_t *master = NULL; |
|
4469 |
ec_domain_t *domain1 = NULL; |
|
4470 |
||
4471 |
void *r_dig_in, *r_ana_out; |
|
4472 |
||
4473 |
ec_pdo_reg_t domain1_pdos[] = {
|
|
4474 |
{"1", Beckhoff_EL1014_Inputs, &r_dig_in},
|
|
4475 |
{"2", Beckhoff_EL4132_Ouput1, &r_ana_out},
|
|
4476 |
{}
|
|
4477 |
}; |
|
4478 |
\end{lstlisting}
|
|
4479 |
||
4480 |
\begin{description}
|
|
4481 |
\item[\normalfont\textcircled{\tiny 1}] There is a timer object
|
|
4482 |
declared, that is needed to tell the kernel to install a timer and |
|
4483 |
execute a certain function, if it runs out. This is done by a |
|
4484 |
variable of the \textit{timer\_list} structure.
|
|
4485 |
\item[\normalfont\textcircled{\tiny 3} -- \textcircled{\tiny 4}] There
|
|
4486 |
is a pointer declared, that will later point to a requested EtherCAT |
|
4487 |
master. Additionally there is a pointer to a domain object needed, |
|
4488 |
that will manage process data IO. |
|
4489 |
\item[\normalfont\textcircled{\tiny 6}] The pointers \textit{r\_*}
|
|
4490 |
will later point to the \underline{r}aw process data values inside
|
|
4491 |
the domain memory. The addresses they point to will be set during a |
|
4492 |
call to \textit{ec\_\-master\_\-activate()}, that will create the
|
|
4493 |
domain memory and configure the mapped process data image. |
|
4494 |
\item[\normalfont\textcircled{\tiny 8} -- \textcircled{\tiny 12}] The
|
|
4495 |
configuration of the mapping of certain PDOs in a domain can easily |
|
4496 |
be done with the help of an initialization array of the |
|
4497 |
\textit{ec\_pdo\_reg\_t} type, defined as part of the realtime
|
|
4498 |
interface. Each record must contain the ASCII bus-address of the |
|
4499 |
slave (see section~\ref{sec:addr}), the slave's vendor ID and
|
|
4500 |
product code, and the index and subindex of the PDO to map (these |
|
4501 |
four fields can be specified in junction, by using one of the |
|
4502 |
defines out of the \textit{include/ecdb.h} header). The last field
|
|
4503 |
has to be the address of the process data pointer, so it can later |
|
4504 |
be redirected appropriately. Attention: The initialization array |
|
4505 |
must end with an empty record (\textit{\{\}})!
|
|
4506 |
\end{description}
|
|
4507 |
||
4508 |
The initialization of the minimal realtime module is done by the |
|
4509 |
``Minimal init function'' in listing~\ref{lst:miniinit}.
|
|
4510 |
||
4511 |
\begin{lstlisting}[language=C,numbers=left,caption={Minimal init
|
|
4512 |
function},label={lst:miniinit}]
|
|
4513 |
int __init init_mini_module(void) |
|
4514 |
{
|
|
4515 |
if (!(master = ecrt_request_master(0))) {
|
|
4516 |
goto out_return; |
|
4517 |
} |
|
4518 |
||
4519 |
if (!(domain1 = ecrt_master_create_domain(master))) {
|
|
4520 |
goto out_release_master; |
|
4521 |
} |
|
4522 |
||
4523 |
if (ecrt_domain_register_pdo_list(domain1, |
|
4524 |
domain1_pdos)) {
|
|
4525 |
goto out_release_master; |
|
4526 |
} |
|
4527 |
||
4528 |
if (ecrt_master_activate(master)) {
|
|
4529 |
goto out_release_master; |
|
4530 |
} |
|
4531 |
||
4532 |
ecrt_master_prepare(master); |
|
4533 |
||
4534 |
init_timer(&timer); |
|
4535 |
timer.function = run; |
|
4536 |
timer.expires = jiffies + 10; |
|
4537 |
add_timer(&timer); |
|
4538 |
||
4539 |
return 0; |
|
4540 |
||
4541 |
out_release_master: |
|
4542 |
ecrt_release_master(master); |
|
4543 |
out_return: |
|
4544 |
return -1; |
|
4545 |
} |
|
4546 |
\end{lstlisting}
|
|
4547 |
||
4548 |
\begin{description}
|
|
4549 |
\item[\normalfont\textcircled{\tiny 3}] It is tried to request the
|
|
4550 |
first EtherCAT master (index 0). On success, the |
|
4551 |
\textit{ecrt\_\-request\_\-master()} function returns a pointer to
|
|
4552 |
the reserved master, that can be used as an object to following |
|
4553 |
functions calls. On failure, the function returns \textit{NULL}.
|
|
4554 |
\item[\normalfont\textcircled{\tiny 7}] In order to exchange process
|
|
4555 |
data, a domain object has to be created. The |
|
4556 |
\textit{ecrt\_\-master\_\-create\_domain()} function also returns a
|
|
4557 |
pointer to the created domain, or \textit{NULL} in error case.
|
|
4558 |
\item[\normalfont\textcircled{\tiny 11}] The registration of domain
|
|
4559 |
PDOs with an initialization array results in a single function call. |
|
4560 |
Alternatively the data fields could be registered with individual |
|
4561 |
calls of \textit{ecrt\_domain\_register\_pdo()}.
|
|
4562 |
\item[\normalfont\textcircled{\tiny 16}] After the configuration of
|
|
4563 |
process data mapping, the master can be activated for cyclic |
|
4564 |
operation. This will configure all slaves and bring them into |
|
| 379 | 4565 |
OP state. |
| 369 | 4566 |
\item[\normalfont\textcircled{\tiny 20}] This call is needed to avoid
|
4567 |
a case differentiation in cyclic operation: The first operation in |
|
4568 |
cyclic mode is a receive call. Due to the fact, that there is |
|
4569 |
nothing to receive during the first cycle, there had to be an |
|
4570 |
\textit{if}-statement to avoid a warning. A call to
|
|
4571 |
\textit{ec\_master\_prepare()} sends a first datagram containing a
|
|
4572 |
process data exchange datagram, so that the first receive call will |
|
4573 |
not fail. |
|
4574 |
\item[\normalfont\textcircled{\tiny 22} -- \textcircled{\tiny 25}] The
|
|
4575 |
master is now ready for cyclic operation. The kernel timer that |
|
4576 |
cyclically executes the \textit{run()} function is initialized and
|
|
4577 |
started. |
|
4578 |
\end{description}
|
|
4579 |
||
4580 |
The coding of a cleanup function fo the minimal module can be seen in |
|
4581 |
listing~\ref{lst:miniclean}.
|
|
4582 |
||
4583 |
\begin{lstlisting}[language=C,numbers=left,caption={Minimal cleanup
|
|
4584 |
function},label={lst:miniclean}]
|
|
4585 |
void __exit cleanup_mini_module(void) |
|
4586 |
{
|
|
4587 |
del_timer_sync(&timer); |
|
4588 |
ecrt_master_deactivate(master); |
|
4589 |
ecrt_release_master(master); |
|
4590 |
} |
|
4591 |
\end{lstlisting}
|
|
4592 |
||
4593 |
\begin{description}
|
|
4594 |
\item[\normalfont\textcircled{\tiny 3}] To cleanup the module, it it
|
|
4595 |
necessary to stop the cyclic processing. This is done by a call to |
|
4596 |
\textit{del\_timer\_sync()} which safely removes a queued timer
|
|
4597 |
object. It is assured, that no cyclic work will be done after this |
|
4598 |
call returns. |
|
4599 |
\item[\normalfont\textcircled{\tiny 4}] This call deactivates the
|
|
| 379 | 4600 |
master, which results in all slaves being brought to their INIT |
4601 |
state again. |
|
| 369 | 4602 |
\item[\normalfont\textcircled{\tiny 5}] This call releases the master,
|
4603 |
removes any existing configuration and silently starts the idle |
|
4604 |
mode. The value of the master pointer is invalid after this call and |
|
4605 |
the module can be safely unloaded. |
|
4606 |
\end{description}
|
|
4607 |
||
4608 |
The final part of the minimal module is that for the cyclic work. Its |
|
4609 |
coding can be seen in listing~\ref{lst:minirun}.
|
|
4610 |
||
4611 |
\begin{lstlisting}[language=C,numbers=left,caption={Minimal cyclic
|
|
4612 |
function},label={lst:minirun}]
|
|
4613 |
void run(unsigned long data) |
|
4614 |
{
|
|
4615 |
static uint8_t dig_in_0; |
|
4616 |
||
4617 |
ecrt_master_receive(master); |
|
4618 |
ecrt_domain_process(domain1); |
|
4619 |
||
4620 |
dig_in_0 = EC_READ_BIT(r_dig_in, 0); |
|
4621 |
EC_WRITE_S16(r_ana_out, dig_in_0 * 0x3FFF); |
|
4622 |
||
4623 |
ecrt_master_run(master); |
|
4624 |
ecrt_master_send(master); |
|
4625 |
||
4626 |
timer.expires += 1; // frequency = HZ |
|
4627 |
add_timer(&timer); |
|
4628 |
} |
|
4629 |
\end{lstlisting}
|
|
4630 |
||
4631 |
\begin{description}
|
|
4632 |
\item[\normalfont\textcircled{\tiny 5}] The cyclic processing starts
|
|
4633 |
with receiving datagrams, that were sent in the last cycle. The |
|
4634 |
frames containing these datagrams have to be received by the network |
|
4635 |
interface card prior to this call. |
|
4636 |
\item[\normalfont\textcircled{\tiny 6}] The process data of domain 1
|
|
4637 |
has been automatically copied into domain memory while datagram |
|
4638 |
reception. This call checks the working counter for changes and |
|
4639 |
re-queues the domain's datagram for sending. |
|
4640 |
\item[\normalfont\textcircled{\tiny 8}] This is an example for reading
|
|
4641 |
out a bit-oriented process data value (i.~e. bit 0) via the |
|
4642 |
\textit{EC\_READ\_BIT()} macro. See section~\ref{sec:macros} for
|
|
4643 |
more information about those macros. |
|
4644 |
\item[\normalfont\textcircled{\tiny 9}] This line shows how to write a
|
|
4645 |
signed, 16-bit process data value. In this case, the slave is able |
|
4646 |
to output voltages of $-10$~V to $+10$~V with a resolution of 16 |
|
4647 |
bit. This write command outputs either $0$~V or $+5$~V, depending |
|
4648 |
of the value of \textit{dig\_in\_0}.
|
|
4649 |
\item[\normalfont\textcircled{\tiny 11}] This call runs the master's
|
|
4650 |
operation state machine (see section~\ref{sec:fsm-op}). A single
|
|
4651 |
state is processed, and datagrams are queued. Mainly bus observation |
|
4652 |
is done: The bus state is determined and in case of slaves that lost |
|
4653 |
their configuration, reconfiguration is tried. |
|
4654 |
\item[\normalfont\textcircled{\tiny 12}] This method sends all queued
|
|
4655 |
datagrams, in this case the domain's datagram and one of the master |
|
4656 |
state machine. In best case, all datagrams fit into one frame. |
|
4657 |
\item[\normalfont\textcircled{\tiny 14} -- \textcircled{\tiny 15}]
|
|
4658 |
Kernel timers are implemented as ``one-shot'' timers, so they have |
|
4659 |
to be re-added after each execution. The time of the next execution |
|
4660 |
is specified in \textit{jiffies} and will happen at the time of the
|
|
4661 |
next system timer interrupt. This results in the \textit{run()}
|
|
4662 |
function being executed with a frequency of \textit{HZ}.
|
|
4663 |
\end{description}
|
|
4664 |
||
4665 |
%------------------------------------------------------------------------------ |
|
4666 |
||
4667 |
\section{An RTAI Example Module}
|
|
4668 |
\label{sec:rtai}
|
|
4669 |
\index{Examples!RTAI}
|
|
4670 |
||
4671 |
The whole code can be seen in the EtherCAT master code release |
|
4672 |
(see~\cite{etherlab}, file \textit{examples/rtai/rtai\_sample.c}).
|
|
4673 |
||
4674 |
Listing~\ref{lst:rtaivar} shows the defines and global variables
|
|
4675 |
needed for a minimal RTAI module with EtherCAT processing. |
|
4676 |
||
4677 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI task
|
|
4678 |
declaration},label={lst:rtaivar}]
|
|
4679 |
#define FREQUENCY 10000 |
|
4680 |
#define TIMERTICKS (1000000000 / FREQUENCY) |
|
4681 |
||
4682 |
RT_TASK task; |
|
4683 |
\end{lstlisting}
|
|
4684 |
||
4685 |
\begin{description}
|
|
4686 |
\item[\normalfont\textcircled{\tiny 1} -- \textcircled{\tiny 2}] RTAI
|
|
4687 |
takes the cycle period as nanoseconds, so the easiest way is to |
|
4688 |
define a frequency and convert it to a cycle time in nanoseconds. |
|
4689 |
\item[\normalfont\textcircled{\tiny 4}] The \textit{task} variable
|
|
4690 |
later contains information about the running RTAI task. |
|
4691 |
\end{description}
|
|
4692 |
||
4693 |
Listing~\ref{lst:rtaiinit} shows the module init function for the RTAI
|
|
4694 |
module. Most lines are the same as in listing~\ref{lst:miniinit},
|
|
4695 |
differences come up when starting the cyclic code. |
|
4696 |
||
4697 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI module init
|
|
4698 |
function},label={lst:rtaiinit}]
|
|
4699 |
int __init init_mod(void) |
|
4700 |
{
|
|
4701 |
RTIME requested_ticks, tick_period, now; |
|
4702 |
||
4703 |
if (!(master = ecrt_request_master(0))) {
|
|
4704 |
goto out_return; |
|
4705 |
} |
|
4706 |
||
4707 |
if (!(domain1 = ecrt_master_create_domain(master))) {
|
|
4708 |
goto out_release_master; |
|
4709 |
} |
|
4710 |
||
4711 |
if (ecrt_domain_register_pdo_list(domain1, |
|
4712 |
domain1_pdos)) {
|
|
4713 |
goto out_release_master; |
|
4714 |
} |
|
4715 |
||
4716 |
if (ecrt_master_activate(master)) {
|
|
4717 |
goto out_release_master; |
|
4718 |
} |
|
4719 |
||
4720 |
ecrt_master_prepare(master); |
|
4721 |
||
4722 |
requested_ticks = nano2count(TIMERTICKS); |
|
4723 |
tick_period = start_rt_timer(requested_ticks); |
|
4724 |
||
4725 |
if (rt_task_init(&task, run, 0, 2000, 0, 1, NULL)) {
|
|
4726 |
goto out_stop_timer; |
|
4727 |
} |
|
4728 |
||
4729 |
now = rt_get_time(); |
|
4730 |
if (rt_task_make_periodic(&task, now + tick_period, |
|
4731 |
tick_period)) {
|
|
4732 |
goto out_stop_task; |
|
4733 |
} |
|
4734 |
||
4735 |
return 0; |
|
4736 |
||
4737 |
out_stop_task: |
|
4738 |
rt_task_delete(&task); |
|
4739 |
out_stop_timer: |
|
4740 |
stop_rt_timer(); |
|
4741 |
out_deactivate: |
|
4742 |
ecrt_master_deactivate(master); |
|
4743 |
out_release_master: |
|
4744 |
ecrt_release_master(master); |
|
4745 |
out_return: |
|
4746 |
return -1; |
|
4747 |
} |
|
4748 |
\end{lstlisting}
|
|
4749 |
||
4750 |
\begin{description}
|
|
4751 |
\item[\normalfont\textcircled{\tiny 24} -- \textcircled{\tiny 25}] The
|
|
4752 |
nanoseconds are converted to RTAI timer ticks and an RTAI timer is |
|
4753 |
started. \textit{tick\_period} will be the ``real'' number of ticks
|
|
4754 |
used for the timer period (which can be different to the requested |
|
4755 |
one). |
|
4756 |
\item[\normalfont\textcircled{\tiny 27}] The RTAI task is initialized
|
|
4757 |
by specifying the cyclic function, the parameter to hand over, the |
|
4758 |
stack size, priority, a flag that tells, if the function will use |
|
4759 |
floating point operations and a signal handler. |
|
4760 |
\item[\normalfont\textcircled{\tiny 32}] The task is made periodic by
|
|
4761 |
specifying a start time and a period. |
|
4762 |
\end{description}
|
|
4763 |
||
4764 |
The cleanup function of the RTAI module in listing~\ref{lst:rtaiclean}
|
|
4765 |
is nearly as simple as that of the minimal module. |
|
4766 |
||
4767 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI module
|
|
4768 |
cleanup function},label={lst:rtaiclean}]
|
|
4769 |
void __exit cleanup_mod(void) |
|
4770 |
{
|
|
4771 |
rt_task_delete(&task); |
|
4772 |
stop_rt_timer(); |
|
4773 |
ecrt_master_deactivate(master); |
|
4774 |
ecrt_release_master(master); |
|
4775 |
rt_sem_delete(&master_sem); |
|
4776 |
} |
|
4777 |
\end{lstlisting}
|
|
4778 |
||
4779 |
\begin{description}
|
|
4780 |
\item[\normalfont\textcircled{\tiny 2}] The RTAI task will be stopped
|
|
4781 |
and deleted. |
|
4782 |
\item[\normalfont\textcircled{\tiny 3}] After that, the RTAI timer can
|
|
4783 |
be stopped. |
|
4784 |
\end{description}
|
|
4785 |
||
4786 |
The rest is the same as for the minimal module. |
|
4787 |
||
4788 |
Worth to mention is, that the cyclic function of the RTAI module |
|
4789 |
(listing~\ref{lst:rtairun}) has a slightly different architecture. The
|
|
4790 |
function is not executed until returning for every cycle, but has an |
|
4791 |
infinite loop in it, that is placed in a waiting state for the rest of |
|
4792 |
each cycle. |
|
4793 |
||
4794 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI module cyclic
|
|
4795 |
function},label={lst:rtairun}]
|
|
4796 |
void run(long data) |
|
4797 |
{
|
|
4798 |
while (1) {
|
|
4799 |
ecrt_master_receive(master); |
|
4800 |
ecrt_domain_process(domain1); |
|
4801 |
||
4802 |
k_pos = EC_READ_U32(r_ssi_input); |
|
4803 |
||
4804 |
ecrt_master_run(master); |
|
4805 |
ecrt_master_send(master); |
|
4806 |
||
4807 |
rt_task_wait_period(); |
|
4808 |
} |
|
4809 |
} |
|
4810 |
\end{lstlisting}
|
|
4811 |
||
4812 |
\begin{description}
|
|
4813 |
\item[\normalfont\textcircled{\tiny 3}] The \textit{while (1)} loop
|
|
4814 |
executes for the lifetime of the RTAI task. |
|
4815 |
\item[\normalfont\textcircled{\tiny 12}] The
|
|
4816 |
\textit{rt\_task\_wait\_period()} function sets the process into a
|
|
4817 |
sleeping state until the beginning of the next cycle. It also |
|
4818 |
checks, if the cyclic function has to be terminated. |
|
4819 |
\end{description}
|
|
4820 |
||
4821 |
%------------------------------------------------------------------------------ |
|
4822 |
||
4823 |
\section{Concurrency Example}
|
|
4824 |
\label{sec:concurrency}
|
|
4825 |
\index{Examples!Concurrency}
|
|
4826 |
||
4827 |
As mentioned before, there can be concurrent access to the EtherCAT |
|
4828 |
master. The realtime module and a EoE\index{EoE} process can compete
|
|
4829 |
for master access, for example. In this case, the module has to |
|
4830 |
provide the locking mechanism, because it depends on the module's |
|
4831 |
architecture which lock has to be used. The module makes this locking |
|
4832 |
mechanism available to the master through the master's locking |
|
4833 |
callbacks. |
|
4834 |
||
4835 |
In case of RTAI, the lock can be an RTAI semaphore, as shown in |
|
4836 |
listing~\ref{lst:convar}. A normal linux semaphore would not be
|
|
4837 |
appropriate, because it could not block the RTAI task due to RTAI |
|
4838 |
running in a higher domain than the linux kernel (see~\cite{rtai}).
|
|
4839 |
||
4840 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI semaphore for
|
|
4841 |
concurrent access},label={lst:convar}]
|
|
4842 |
SEM master_sem; |
|
4843 |
\end{lstlisting}
|
|
4844 |
||
4845 |
The module has to implement the two callbacks for requesting and |
|
4846 |
releasing the master lock. An exemplary coding can be seen in |
|
4847 |
listing~\ref{lst:conlock}.
|
|
4848 |
||
4849 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI locking
|
|
4850 |
callbacks for concurrent access},label={lst:conlock}]
|
|
4851 |
int request_lock(void *data) |
|
4852 |
{
|
|
4853 |
rt_sem_wait(&master_sem); |
|
4854 |
return 0; |
|
4855 |
} |
|
4856 |
||
4857 |
void release_lock(void *data) |
|
4858 |
{
|
|
4859 |
rt_sem_signal(&master_sem); |
|
4860 |
} |
|
4861 |
\end{lstlisting}
|
|
4862 |
||
4863 |
\begin{description}
|
|
4864 |
\item[\normalfont\textcircled{\tiny 1}] The \textit{request\_lock()}
|
|
4865 |
function has a data parameter. The master always passes the value, |
|
4866 |
that was specified when registering the callback function. This can |
|
4867 |
be used for handing the master pointer. Notice, that it has an |
|
4868 |
integer return value (see line 4). |
|
4869 |
\item[\normalfont\textcircled{\tiny 3}] The call to
|
|
4870 |
\textit{rt\_sem\_wait()} either returns at once, when the semaphore
|
|
4871 |
was free, or blocks until the semaphore is freed again. In any case, |
|
4872 |
the semaphore finally is reserved for the process calling the |
|
4873 |
request function. |
|
4874 |
\item[\normalfont\textcircled{\tiny 4}] When the lock was requested
|
|
4875 |
successfully, the function should return 0. The module can prohibit |
|
4876 |
requesting the lock by returning non-zero (see paragraph ``Tuning |
|
4877 |
the jitter'' below). |
|
4878 |
\item[\normalfont\textcircled{\tiny 7}] The \textit{release\_lock()}
|
|
4879 |
function gets the same argument passed, but has a void return value, |
|
4880 |
because is always succeeds. |
|
4881 |
\item[\normalfont\textcircled{\tiny 9}] The \textit{rt\_sem\_signal()}
|
|
4882 |
function frees the semaphore, that was prior reserved with |
|
4883 |
\textit{rt\_sem\_wait()}.
|
|
4884 |
\end{description}
|
|
4885 |
||
4886 |
In the module's init function, the semaphore must be initialized, and |
|
4887 |
the callbacks must be passed to the EtherCAT master: |
|
4888 |
||
4889 |
\begin{lstlisting}[language=C,numbers=left,caption={Module init
|
|
4890 |
function for concurrent access},label={lst:coninit}]
|
|
4891 |
int __init init_mod(void) |
|
4892 |
{
|
|
4893 |
RTIME tick_period, requested_ticks, now; |
|
4894 |
||
4895 |
rt_sem_init(&master_sem, 1); |
|
4896 |
||
4897 |
if (!(master = ecrt_request_master(0))) {
|
|
4898 |
goto out_return; |
|
4899 |
} |
|
4900 |
||
4901 |
ecrt_master_callbacks(master, request_lock, |
|
4902 |
release_lock, NULL); |
|
4903 |
// ... |
|
4904 |
\end{lstlisting}
|
|
4905 |
||
4906 |
\begin{description}
|
|
4907 |
\item[\normalfont\textcircled{\tiny 5}] The call to
|
|
4908 |
\textit{rt\_sem\_init()} initializes the semaphore and sets its
|
|
4909 |
value to 1, meaning that only one process can reserve the semaphore |
|
4910 |
without blocking. |
|
4911 |
\item[\normalfont\textcircled{\tiny 11}] The callbacks are passed to
|
|
4912 |
the master with a call to \textit{ecrt\_master\_callbacks()}. The
|
|
4913 |
last parameter is the argument, that the master should pass with |
|
4914 |
each call to a callback function. Here it is not used and set to |
|
4915 |
\textit{NULL}.
|
|
4916 |
\end{description}
|
|
4917 |
||
4918 |
For the cyclic function being only one competitor for master access, |
|
4919 |
it has to request the lock like any other process. There is no need to |
|
4920 |
use the callbacks (which are meant for processes of lower priority), |
|
4921 |
so it can access the semaphore directly: |
|
4922 |
||
4923 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI cyclic
|
|
4924 |
function for concurrent access},label={lst:conrun}]
|
|
4925 |
void run(long data) |
|
4926 |
{
|
|
4927 |
while (1) {
|
|
4928 |
rt_sem_wait(&master_sem); |
|
4929 |
||
4930 |
ecrt_master_receive(master); |
|
4931 |
ecrt_domain_process(domain1); |
|
4932 |
||
4933 |
k_pos = EC_READ_U32(r_ssi_input); |
|
4934 |
||
4935 |
ecrt_master_run(master); |
|
4936 |
ecrt_master_send(master); |
|
4937 |
||
4938 |
rt_sem_signal(&master_sem); |
|
4939 |
rt_task_wait_period(); |
|
4940 |
} |
|
4941 |
} |
|
4942 |
\end{lstlisting}
|
|
4943 |
||
4944 |
\begin{description}
|
|
4945 |
\item[\normalfont\textcircled{\tiny 4}] Every access to the master has
|
|
4946 |
to be preceeded by a call to \textit{rt\_sem\_wait()}, because
|
|
4947 |
another instance might currently access the master. |
|
4948 |
\item[\normalfont\textcircled{\tiny 14}] When cyclic processing
|
|
4949 |
finished, the semaphore has to be freed again, so that other |
|
4950 |
processes have the possibility to access the master. |
|
4951 |
\end{description}
|
|
4952 |
||
4953 |
A little change has to be made to the cleanup function in case of |
|
4954 |
concurrent master access. |
|
4955 |
||
4956 |
\begin{lstlisting}[language=C,numbers=left,caption={RTAI module
|
|
4957 |
cleanup function for concurrent access},label={lst:conclean}]
|
|
4958 |
void __exit cleanup_mod(void) |
|
4959 |
{
|
|
4960 |
rt_task_delete(&task); |
|
4961 |
stop_rt_timer(); |
|
4962 |
ecrt_master_deactivate(master); |
|
4963 |
ecrt_release_master(master); |
|
4964 |
rt_sem_delete(&master_sem); |
|
4965 |
} |
|
4966 |
\end{lstlisting}
|
|
4967 |
||
4968 |
\begin{description}
|
|
4969 |
\item[\normalfont\textcircled{\tiny 7}] Upon module cleanup, the
|
|
4970 |
semaphore has to be deleted, so that memory can be freed. |
|
4971 |
\end{description}
|
|
4972 |
||
4973 |
\paragraph{Tuning the Jitter}
|
|
4974 |
\index{Jitter}
|
|
4975 |
||
4976 |
Concurrent access leads to higher jitter of the realtime process, |
|
4977 |
because there are situations, in which the realtime process has to |
|
4978 |
wait for a process of lower priority to finish accessing the master. |
|
4979 |
In most cases this is acceptable, because a master access cycle |
|
4980 |
(receive/process/send) only takes $10$~\textmu s to $20$~\textmu s on |
|
4981 |
recent systems, what would be the maximum additional jitter. However |
|
4982 |
some applications demand a minimum jitter. For this reason the master |
|
4983 |
access can be prohibited by the realtime module: If the time, another |
|
4984 |
process wants to access the master, is to close to the beginning of |
|
4985 |
the next realtime cycle, the module can disallow, that the lock is |
|
4986 |
taken. In this case, the request callback has to return $1$, meaning |
|
4987 |
that the lock has not been taken. The foreign process must abort its |
|
4988 |
master access and try again next time. |
|
4989 |
||
4990 |
This measure helps to significantly reducing the jitter produced by |
|
4991 |
concurrent master access. Below are exerpts of an example coding: |
|
4992 |
||
4993 |
\begin{lstlisting}[language=C,numbers=left,caption={Variables for
|
|
4994 |
jitter reduction},label={lst:redvar}]
|
|
4995 |
#define FREQUENCY 10000 // RTAI task frequency in Hz |
|
4996 |
// ... |
|
4997 |
cycles_t t_last_cycle = 0; |
|
4998 |
const cycles_t t_critical = cpu_khz * 1000 / FREQUENCY |
|
4999 |
- cpu_khz * 30 / 1000; |
|
5000 |
\end{lstlisting}
|
|
5001 |
||
5002 |
\begin{description}
|
|
5003 |
\item[\normalfont\textcircled{\tiny 3}] The variable
|
|
5004 |
\textit{t\_last\_cycle} holds the timer ticks at the beginning of
|
|
5005 |
the last realtime cycle. |
|
5006 |
\item[\normalfont\textcircled{\tiny 4}] \textit{t\_critical} contains
|
|
5007 |
the number of ticks, that may have passed since the beginning of the |
|
5008 |
last cycle, until there is no more foreign access possible. It is |
|
5009 |
calculated by substracting the ticks for $30$~\textmu s from the |
|
5010 |
ticks for a complete cycle. |
|
5011 |
\end{description}
|
|
5012 |
||
5013 |
\begin{lstlisting}[language=C,numbers=left,caption={Cyclic function
|
|
5014 |
with reduced jitter},label={lst:redrun}]
|
|
5015 |
void run(long data) |
|
5016 |
{
|
|
5017 |
while (1) {
|
|
5018 |
t_last_cycle = get_cycles(); |
|
5019 |
rt_sem_wait(&master_sem); |
|
5020 |
// ... |
|
5021 |
\end{lstlisting}
|
|
5022 |
||
5023 |
\begin{description}
|
|
5024 |
\item[\normalfont\textcircled{\tiny 4}] The ticks of the beginning of
|
|
5025 |
the current realtime cycle are taken before reserving the semaphore. |
|
5026 |
\end{description}
|
|
5027 |
||
5028 |
\begin{lstlisting}[language=C,numbers=left,caption={Request callback
|
|
5029 |
for reduced jitter},label={lst:redreq}]
|
|
5030 |
int request_lock(void *data) |
|
5031 |
{
|
|
5032 |
// too close to the next RT cycle: deny access. |
|
5033 |
if (get_cycles() - t_last_cycle > t_critical) |
|
5034 |
return -1; |
|
5035 |
||
5036 |
// allow access |
|
5037 |
rt_sem_wait(&master_sem); |
|
5038 |
return 0; |
|
5039 |
} |
|
5040 |
\end{lstlisting}
|
|
5041 |
||
5042 |
\begin{description}
|
|
5043 |
\item[\normalfont\textcircled{\tiny 4}] If the time of request is too
|
|
5044 |
close to the next realtime cycle (here: \textless~$30$~\textmu s |
|
5045 |
before the estimated beginning), the locking is denied. The |
|
5046 |
requesting process must abort its cycle. |
|
5047 |
\end{description}
|
|
5048 |
||
5049 |
%------------------------------------------------------------------------------ |
|
5050 |
||
5051 |
\begin{thebibliography}{99}
|
|
5052 |
\bibitem{etherlab} Ingenieurgemeinschaft IgH: EtherLab -- Open Source
|
|
5053 |
Toolkit for rapid realtime code generation under Linux with |
|
5054 |
Simulink/RTW and EtherCAT technology. URL: http://etherlab.org, |
|
5055 |
July~31, 2006. |
|
5056 |
\bibitem{dlspec} IEC 61158-4-12: Data-link Protocol Specification.
|
|
5057 |
International Electrotechnical Comission (IEC), 2005. |
|
5058 |
\bibitem{alspec} IEC 61158-6-12: Application Layer Protocol
|
|
5059 |
Specification. International Electrotechnical Comission (IEC), 2005. |
|
5060 |
\bibitem{gpl} GNU General Public License, Version 2. URL:
|
|
5061 |
http://www.gnu.org/licenses/gpl.txt. August~9, 2006. |
|
5062 |
\bibitem{lsb} Linux Standard Base. URL:
|
|
5063 |
http://www.freestandards.org/en/LSB. August~9, 2006. |
|
5064 |
\bibitem{wireshark} Wireshark. URL: http://www.wireshark.org.
|
|
5065 |
August~9, 2006. |
|
5066 |
\bibitem{automata} {\it Hopcroft, J.~E. / Ullman, J.~D.}: Introduction
|
|
5067 |
to Automata Theory, Languages and Computation. Adison-Wesley, |
|
5068 |
Reading, Mass.~1979. |
|
5069 |
\bibitem{fsmmis} {\it Wagner, F. / Wolstenholme, P.}: State machine
|
|
5070 |
misunderstandings. In: IEE journal ``Computing and Control |
|
5071 |
Engineering'', 2004. |
|
5072 |
\bibitem{rtai} RTAI. The RealTime Application Interface for Linux from
|
|
5073 |
DIAPM. URL: http://www.rtai.org, 2006. |
|
5074 |
\end{thebibliography}
|
|
5075 |
||
5076 |
\printglossary |
|
5077 |
\addcontentsline{toc}{chapter}{\nomname}
|
|
5078 |
\markleft{\nomname}
|
|
5079 |
||
5080 |
\printindex |
|
5081 |
\markleft{Index}
|
|
5082 |
||
5083 |
%------------------------------------------------------------------------------ |
|
5084 |
||
5085 |
\end{document}
|
|
5086 |
||
5087 |
%------------------------------------------------------------------------------ |