merge -c1541 trunk: Userspace applications (excerpts). stable-1.4
authorFlorian Pose <fp@igh-essen.com>
Wed, 05 Nov 2008 10:44:42 +0000
branchstable-1.4
changeset 1659 f04865a2454f
parent 1658 5212bb4a73e5
child 1660 f183b0c12b1f
merge -c1541 trunk: Userspace applications (excerpts).
documentation/ethercat_doc.tex
documentation/images/architecture.fig
--- a/documentation/ethercat_doc.tex	Wed Nov 05 10:37:28 2008 +0000
+++ b/documentation/ethercat_doc.tex	Wed Nov 05 10:44:42 2008 +0000
@@ -322,39 +322,38 @@
 \begin{figure}[htbp]
   \centering
   \includegraphics[width=.9\textwidth]{images/architecture}
-  \caption{Master architecture}
+  \caption{Master Architecture}
   \label{fig:arch}
 \end{figure}
 
-\paragraph{Master Module}
-\index{Master module}
-
-Kernel module containing one or more EtherCAT master instances (see
-sec.~\ref{sec:mastermod}), the ``Device Interface'' (see sec.~\ref{sec:ecdev})
-and the ``Application Interface'' (see chap.~\ref{chap:api}).
-
-\paragraph{Device Modules}
-\index{Device modules}
-
-EtherCAT-capable Ethernet device driver modules\index{Device modules}, that
-offer their devices to the EtherCAT master via the device interface (see
-sec.~\ref{sec:ecdev}). These modified network drivers can handle network
-devices used for EtherCAT operation and ``normal'' Ethernet devices in
-parallel. A master can accept a certain device and then is able to send and
-receive EtherCAT frames. Ethernet devices declined by the master module are
-connected to the kernel's network stack as usual.
-
-\paragraph{Application Modules}
-\index{Application module}
-
-Kernel modules, that use the EtherCAT master (usually for cyclic exchange of
-process data with EtherCAT slaves). These modules are not part of the EtherCAT
-master code\footnote{Although there are some examples provided in the
+The components of the master environment are described below:
+
+\begin{description}
+
+\item[Master Module]\index{Master Module} Kernel module containing one or more
+EtherCAT master instances (see sec.~\ref{sec:mastermod}), the ``Device
+Interface'' (see sec.~\ref{sec:ecdev}) and the ``Application Interface'' (see
+chap.~\ref{chap:api}).
+
+\item[Device Modules]\index{Device modules} EtherCAT-capable Ethernet device
+driver modules\index{Device modules}, that offer their devices to the EtherCAT
+master via the device interface (see sec.~\ref{sec:ecdev}). These modified
+network drivers can handle network devices used for EtherCAT operation and
+``normal'' Ethernet devices in parallel. A master can accept a certain device
+and then is able to send and receive EtherCAT frames. Ethernet devices
+declined by the master module are connected to the kernel's network stack as
+usual.
+
+\item[Application Modules]\index{Application} A kernel module that uses the
+EtherCAT master (usually for cyclic exchange of process data with EtherCAT
+slaves). These modules are not part of the EtherCAT master
+code\footnote{Although there are some examples provided in the
 \textit{examples/} directory.}, but have to be generated or written by the
 user. An application module can ``request'' a master through the application
-interface (see chap.~\ref{chap:api}). If this succeeds, the module has the
-control over the master: It can provide a bus configuration and exchange
-process data.
+interface (see chap.~\ref{chap:api}). If this succeeds, it has the control
+over the master: It can provide a bus configuration and exchange process data.
+
+\end{description}
 
 %------------------------------------------------------------------------------
 
@@ -369,6 +368,7 @@
   \caption{Master phases and transitions}
   \label{fig:phases}
 \end{figure}
+
 \begin{description}
 
 \item[Orphaned phase]\index{Orphaned phase} This mode takes effect, when the
@@ -584,7 +584,10 @@
 sec.~\ref{sec:masterconfig}).
 
 \item[Operation] Cyclic code is run, process data is exchanged (see
-sec.~\ref{sec:cyclic}).
+sec.~\ref{sec:cyclic}). To enter operation mode, the master has to be
+``activated'' to calculate the process data image and apply the bus
+configuration for the first time. After activation, the application is in
+charge to send and receive frames.
 
 \end{description}
 
@@ -630,14 +633,14 @@
 semaphores, or other methods to protect critical sections.
 
 The master itself can not provide locking mechanisms, because it has no chance
-to know the appropriate kind of lock. For example if the application uses RTAI
-functionality, ordinary kernel semaphores would not be sufficient. For that, an
-important design decision was made: The application that reserved a master must
-have the total control, therefore it has to take responsibility for providing
-the appropriate locking mechanisms. If another instance wants to access the
-master, it has to request the master lock by callbacks, that have to be set by
-the application. Moreover the application can deny access to the master if it
-considers it to be awkward at the moment.
+to know the appropriate kind of lock. For example if the application module
+uses RTAI functionality, ordinary kernel semaphores would not be sufficient.
+For that, an important design decision was made: The application that reserved
+a master must have the total control, therefore it has to take responsibility
+for providing the appropriate locking mechanisms.  If another instance wants
+to access the master, it has to request the master lock by callbacks, that
+have to be set by the application. Moreover the application can deny access to
+the master if it considers it to be awkward at the moment.
 
 \begin{figure}[htbp]
   \centering
--- a/documentation/images/architecture.fig	Wed Nov 05 10:37:28 2008 +0000
+++ b/documentation/images/architecture.fig	Wed Nov 05 10:44:42 2008 +0000
@@ -84,8 +84,8 @@
 6 1575 2430 7785 2925
 2 1 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 2
 	 7785 2655 1575 2655
-4 0 0 50 -1 16 12 0.0000 4 180 1110 1665 2880 Kernel space\001
-4 0 0 50 -1 16 12 0.0000 4 180 945 1665 2565 User space\001
+4 0 0 50 -1 16 12 0.0000 4 180 1110 1665 2880 Kernelspace\001
+4 0 0 50 -1 16 12 0.0000 4 180 945 1665 2565 Userspace\001
 -6
 6 4673 1298 5677 2302
 1 4 0 1 0 7 50 -1 -1 4.000 1 0.0000 5175 1800 495 495 5670 2295 4680 1305