From f4a41ccc8b92703ad9b8bc7a48dde609e9005c13 Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Tue, 30 Jun 2015 20:03:09 +0200 Subject: [PATCH] doc: Rename \develkitname to \tgtBoardName Also update the text around this macro. More changes is still needed. --- doc/rpp_simulink.tex | 43 +++++++++++++++--------------- doc/rpp_simulink_rm48_hdk.tex | 2 +- doc/rpp_simulink_tms570_hdk.tex | 2 +- doc/rpp_simulink_tms570_hydctr.tex | 2 +- rpp/lib | 2 +- 5 files changed, 26 insertions(+), 25 deletions(-) diff --git a/doc/rpp_simulink.tex b/doc/rpp_simulink.tex index f721e95..000b5d1 100644 --- a/doc/rpp_simulink.tex +++ b/doc/rpp_simulink.tex @@ -218,13 +218,12 @@ provided. \label{sec-background} In this document, the term \emph{Rapid Prototyping Platform} denotes a -hardware board and accompanying software. The hardware is -\develkitname{} development kit from Texas Instruments based on ARM -Cortex R4 safety microcontroller \mcuname{}. This MCU contains several -protective mechanisms (two cores in lockstep, error correction -mechanisms for SRAM and Flash memory, voltage monitoring, etc.) to -fulfill the requirements for safety critical applications. -See~\cite{\tgrefman} for details. +hardware board and accompanying software. The hardware board is +\tgtBoardName{} based on ARM Cortex R4 safety microcontroller +\mcuname{}. This MCU contains several protective mechanisms (two cores +in lockstep, error correction mechanisms for SRAM and Flash memory, +voltage monitoring, etc.) to fulfill the requirements for safety +critical applications. See~\cite{\tgrefman} for details. In order to develop non-trivial applications for the RPP, an operating system is necessary. The RPP is based on FreeRTOS -- a simple @@ -282,15 +281,15 @@ Simulink, Embedded Coder and Simulink Coder, refer to \section{Hardware description} \label{sec-hardware-description} -This section provides a brief description of the Texas Instrument -\develkitname{} development kit. For a more detailed information refer to -\cite{\tghdkman}. The kit is depicted in -Figure~\ref{fig-board_photo}. +This section provides a brief description of the \tgtBoardName{} +board. For a more detailed information refer to \cite{\tghdkman}. The +kit is depicted in Figure~\ref{fig-board_photo}. +% TODO: Fix this section - conditional compilation \begin{figure}\begin{center} \noindent \includegraphics[width=300px]{images/board.png} - \caption{The \develkitname{} kit \cite[p. 8]{\tghdkman}} + \caption{The \tgtBoardName{} \cite[p. 8]{\tghdkman}} \label{fig-board_photo} \end{center}\end{figure} @@ -441,8 +440,8 @@ the MCU via SPI. This layer allows to control the IO pins independently of how that are connected to the MCU, providing a single unified API. -Note that this functionality is not needed in the current version of -for \develkitname, because all IOs are controlled directly by GPIO pins. +Note that this functionality is not needed in the current version for +\tgtBoardName, because all IOs are controlled directly by GPIO pins. As a result, the higher layers do not have to know anything about the wiring of the peripherals, they can just call read, write or configure @@ -682,7 +681,7 @@ are: headers and other files necessary for building and downloading Simulink models. \item[rpp-test-sw] Contains an application for interactive testing and - control of the \develkitname{} board over the serial interface. Details can be + control of the \tgtBoardName{} board over the serial interface. Details can be found in Chapter~\ref{chap-rpp-test-software}. The package also contains the binary of the RPP Library and all @@ -1083,7 +1082,7 @@ can be easily downloaded to the target hardware with the following procedure: \item Connect the Texas Instruments XDS100v2 USB emulator to the JTAG port. \item Connect a USB cable to the XDS100v2 USB emulator and the development computer. \else - \item Connect the USB cable to the \develkitname{} board. + \item Connect the USB cable to the \tgtBoardName{} board. \fi \item Plug in the power supply. \item In the Code Composer Studio click on the @@ -1341,12 +1340,12 @@ Simulink model. Code $\rightarrow$ Build Model}. \end{enumerate} -To run the model on the \develkitname{} board continue with Section +To run the model on the \tgtBoardName{} board continue with Section \ref{sec-running-model-on-hw}. \subsection{Running models on the RPP board} \label{sec-running-model-on-hw} -To run the model on the \develkitname{} hardware you have to enable the download +To run the model on the \tgtBoardName{} hardware you have to enable the download feature and build the model by following this procedure: \begin{enumerate} \item Open the model you want to run (see @@ -1393,8 +1392,10 @@ following settings are the default: \end{itemize} Use GtkTerm on Linux or Bray Terminal on Windows for accessing the -serial interface. On \develkitname{}, the serial line is tunneled over -the USB. % See Section \ref{sec-hardware-description} for reference about +serial interface. On \tgtBoardName{} board, the serial line is tunneled over +the USB. +% TODO: Conditional compilation + % See Section \ref{sec-hardware-description} for reference about % the position of the serial interface connector on the RPP board. \section{Bug reporting} @@ -1860,7 +1861,7 @@ reading. \item[refs/] Contains third party references, which license allows the distribution. \item[rpp/blocks] Contains the Simulink blocks specific to the - \develkitname{} board and their sources (.c and .tlc files). When an + \tgtBoardName{} board and their sources (.c and .tlc files). When an user calls \texttt{rpp\_setup.m}, these files are processed and Simulink block library \texttt{rpp\_lib.slx} is created. \item[rpp/blocks/tlc\_c]Contains the templates for C code generation from the diff --git a/doc/rpp_simulink_rm48_hdk.tex b/doc/rpp_simulink_rm48_hdk.tex index e3836fc..7043fc7 100644 --- a/doc/rpp_simulink_rm48_hdk.tex +++ b/doc/rpp_simulink_rm48_hdk.tex @@ -1,5 +1,5 @@ \newcommand{\tgname}{RM48 } -\newcommand{\develkitname}{TMDSRM48HDK } +\newcommand{\tgtBoardName}{TMDSRM48HDK } \newcommand{\mcuname}{RM48L952 } \newcommand{\ldscriptname}{RM48L952FlashLnk.cmd} \newcommand{\tgconfigfilename}{RM48L952.ccxml} diff --git a/doc/rpp_simulink_tms570_hdk.tex b/doc/rpp_simulink_tms570_hdk.tex index 1c31121..e346efb 100644 --- a/doc/rpp_simulink_tms570_hdk.tex +++ b/doc/rpp_simulink_tms570_hdk.tex @@ -1,6 +1,6 @@ \let\tgtId\tgtIdTMSHDK \newcommand{\tgname}{TMS570} -\newcommand{\develkitname}{TMDS570LS31HDK} +\newcommand{\tgtBoardName}{TMDS570LS31HDK} \newcommand{\mcuname}{TMS570LS3137ZWT} \newcommand{\ldscriptname}{TMS570LS313xFlashLnk.cmd} \newcommand{\tgconfigfilename}{TMS570LS3137.ccxml} diff --git a/doc/rpp_simulink_tms570_hydctr.tex b/doc/rpp_simulink_tms570_hydctr.tex index acfc1a5..d087c3f 100644 --- a/doc/rpp_simulink_tms570_hydctr.tex +++ b/doc/rpp_simulink_tms570_hydctr.tex @@ -1,6 +1,6 @@ \let\tgtId\tgtIdHydCtr \newcommand{\tgname}{TMS570} -\newcommand{\develkitname}{Eaton Hydraulics Controller} +\newcommand{\tgtBoardName}{Eaton Hydraulics Controller} \newcommand{\mcuname}{TMS570LS1227ZWT} \newcommand{\ldscriptname}{TMS570LS1227FlashLnk.cmd} \newcommand{\tgconfigfilename}{TMS570LS1227.ccxml} diff --git a/rpp/lib b/rpp/lib index e3d1543..5a1a6d3 160000 --- a/rpp/lib +++ b/rpp/lib @@ -1 +1 @@ -Subproject commit e3d154361aedaf9b4eacb70e7919503b9a59e179 +Subproject commit 5a1a6d3847b1f9e7dd5f1f1ee96a76a5926e93b0 -- 2.39.2