]> rtime.felk.cvut.cz Git - pes-rpp/rpp-simulink.git/blobdiff - doc/rpp_simulink.tex
doc: Replace deprecated \tt with \texttt
[pes-rpp/rpp-simulink.git] / doc / rpp_simulink.tex
index 6dc4b0cad8f574703f3e5ff9cc91270321d93b60..d01a1a4cfd0dc2f8c3de93c5169c55795a6e5110 100644 (file)
@@ -138,6 +138,7 @@ Michal \textsc{Sojka}\\[\baselineskip]
 
 \section*{Revision history}
 
+{\small
 \noindent\begin{tabularx}{\linewidth}{|l|l|l|X|}
   \rowcolor[gray]{0.9}\hline
   Revision     & Date      & Author(s) & Comments \\ \hline
@@ -177,8 +178,28 @@ Michal \textsc{Sojka}\\[\baselineskip]
                                       Documented halcogen directory in
                                       sec.~\ref{sec-rpp-lib-subdirectory-content-description}.
            \\\hline
-\end{tabularx}
 
+           0.6a & 2015-09-11 & Sojka & Removed reference of
+                                       Simulink blocks that are not
+                                       part of Eaton distribution.
+           \\\hline
+
+           0.7 & 2015-10-05 & Sojka & Simulink GIO blocks
+                                      (sec.
+                                      \ref{sec:block:sfunction_gio_in.c},
+                                      \ref{sec:block:sfunction_gio_out.c})
+                                      have different parameters and
+                                      support certain SPI5 pins on the
+                                      tms570\_hydctr board. Parameters
+                                      of old GIO blocks are
+                                      automatically transformed to the
+                                      new ones.
+
+                                      Added section \ref{sec:board-init-hydctr}: ``Hydraulics controller
+                                      initialization demo''.
+           \\\hline
+\end{tabularx}
+}
 \tableofcontents
 
 \newpage
@@ -218,10 +239,9 @@ consists of code generation target for Simulink Embedded Coder, a
 low-level run-time C library and a tool for interactive testing of
 hardware and software functionality.
 
-Originally, the RPP project was created for a custom TMS570-based board
-and the port to other platforms such as RM48 HDK and TMS570 HDK
-development kits. Porting to other platforms was done under a contract
-from Eaton Corporation.
+Originally, the RPP project was created for a custom TMS570-based
+board. Subsequently, it was ported to other board such as RM48 HDK and
+TMS570 HDK development kits under a contract from Eaton Corporation.
 
 The document contains step-by-step instructions for installation of
 development tools, information about Simulink Coder configuration,
@@ -316,7 +336,7 @@ upper layers.
 % exclusively on the bottom layer, not on any lower level layer (except for a
 % couple of exceptions).
 \item Each layer should provide a unified layer interface
-  (\texttt{rpp.h}, \texttt{drv.h}, \texttt {hal.h}, \texttt{sys.h} and
+  (\texttt{rpp.h}, \texttt{drv.h}, \texttt{sys.h} and
   \texttt{os.h}), so that higher layers depend on the lower layer's interface
   and not on individual elements from that layer.
 \end{compactitem}
@@ -333,7 +353,7 @@ upper layers.
 As a consequence of this division the source code files and interface files are
 placed in private directories like \texttt{drv/din.h}. With this organization
 user applications only needs to include the top layer interface files (for
-example \texttt{rpp/rpp\_can.h}) to be able to use the selected library API.
+example \texttt{rpp/rpp.h}) to be able to use the selected library API.
 
 The rest of the section provides basic description of each layer.
 
@@ -1112,7 +1132,7 @@ of the blocks have to be compiled by the mex tool.
   use. In the Matlab command window run the \texttt{mex -setup}
   command and select the native C compiler.
 
-\begin{lstlisting}[basicstyle=\tt\footnotesize]
+\begin{lstlisting}[basicstyle=\texttt\footnotesize]
 >> mex -setup
 
 Welcome to mex -setup.  This utility will help you set up
@@ -2047,6 +2067,7 @@ RPP block library, shown in Figure \ref{fig-block-library}.
 \clearpage
 \input{block_desc.tex}
 
+\newpage
 \section{Compilation}
 \label{sec-simulink-compilation}
 The first step, before any attempt to compile demo or other models, is to compile the S-Functions of the RPP blocks. The S-Functions are compiled during the Configuring Simulink for RPP, described in Section \ref{sec-configuration-simulink-for-rpp}. If you want to recompile the S-Functions without reconfiguring the Simulink, open the Matlab and run those commands in the Matlab commad line:
@@ -2126,7 +2147,7 @@ recommended, as it helps keeping the documentation consistent and
 up-to-date.
 
 The YAML documentation block may look like this:
-\begin{lstlisting}[language=c,basicstyle=\tt\footnotesize]
+\begin{lstlisting}[language=c,basicstyle=\texttt\footnotesize]
 /*
 %YAML 1.2
 ---
@@ -2539,7 +2560,25 @@ Interface (115200-8-N-1) when toggled.
        \label{tab:multirate_mt_led_desc}
 \end{center}
 
+\subsection{Hydraulics controller initialization demo}
+\label{sec:board-init-hydctr}
+\begin{figure}[H]
+  \centering
+  \includegraphics[scale=0.45]{images/demo_board_init_hydctr.png}
+  \caption{board\_init\_hydctr demo}
+  \label{fig:board_init_hydctr}
+\end{figure}
+
+\paragraph{Description}
 
+This demo shows how to use the \emph{Board Init} block to initialize
+SPI devices on the Hydraulics Controller board. Additionally, it shows
+how to use unused SPI pins on the MCU as general-purpose IOs. If both
+Board Init and GIO SPI blocks are used together, care must be taken
+about the order in which the blocks are initialized. GIO blocks that
+represent SPI pins must be initialized \emph{after} the Board Init
+block. This can be ensured by giving the GIO blocks higher priority
+than the Board Init block.
 
 \chapter{Command line testing tool}
 \label{chap-rpp-test-software}
@@ -2558,23 +2597,23 @@ The application enables a command processor using the SCI at
 \textbf{115200-8-N-1}. When the software starts, the received welcome message
 and prompt should look like:
 
-
+\bigskip
 \ifx\tgtId\tgtIdTMSRPP
-\begin{verbatim}
-Rapid Prototyping Platform v00.01-001
-Test Software version v0.2-261-gb6361ca
-CTU in Prague 2014
---> 
-\end{verbatim}
+\noindent\texttt{Rapid Prototyping Platform v00.01-001\\
+Test Software version \input{version.tex}\\
+CTU in Prague 2014\\
+-->
+}
 \else
-\begin{verbatim}
-Ti HDK \mcuname, FreeRTOS 7.0.2
-Test Software version eaton-0.1-beta-8-g91419f5
-CTU in Prague 10/2014
---> 
-\end{verbatim}
+\noindent\texttt{Ti HDK \mcuname, FreeRTOS 7.0.2\\
+Test Software version \input{version.tex}\\
+CTU in Prague 10/2014\\
+-->
+}
 \fi
 
+\bigskip
+
 Type in command help for a complete list of available command, or help command
 for a description of concrete command.
 
@@ -2608,6 +2647,11 @@ This section contains the description of the available commands. The
 same description is also available in the program itself via the
 \texttt{help} command.
 
+% Pandoc generates \tightlist in its output. Since we don't use pandoc
+% template, we have put its definition here.
+\providecommand{\tightlist}{%
+  \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}
+
 \input{rpp-test-sw-cmds.tex}
 
 \chapter{Glossary}