1 \documentclass{scrreprt}
3 \usepackage{graphicx} % images and graphics
4 \usepackage{paralist} % needed for compact lists
5 \usepackage[normalem]{ulem} % needed by strike
6 \usepackage{listings} % required for code blocks
7 \usepackage[urlcolor=blue,colorlinks=true,hyperfootnotes=false]{hyperref} % links
8 \usepackage[utf8]{inputenc} % char encoding
9 \usepackage[bottom]{footmisc} % footnotes
10 \usepackage{todonotes}
11 \usepackage[backend=biber,style=alphabetic,sortcites=true]{biblatex}
13 \addbibresource{rpp_simulink.bib}
16 \usepackage[top=2.5cm, bottom=2.5cm, left=2.5cm, right=2.5cm]{geometry}
17 \usepackage{float} % To fix images position
19 % Prettify code documentation
22 % \usepackage[table]{xcolor}
24 \definecolor{gray97}{gray}{.97}
25 \definecolor{gray75}{gray}{.75}
26 \definecolor{gray45}{gray}{.45}
31 framexbottommargin=3pt,
32 framexleftmargin=0.4cm,
35 backgroundcolor=\color{gray97},
36 rulesepcolor=\color{black},
38 stringstyle=\ttfamily,
39 showstringspaces = false,
40 basicstyle=\small\ttfamily,
41 commentstyle=\color{gray45},
42 keywordstyle=\bfseries,
47 numberfirstline = false,
56 \linespread{1.15} % Lines spacing
57 \setlength{\plitemsep}{0.5\baselineskip} % List items spacing
58 \definecolor{deepblue}{RGB}{0,0,61}
59 \definecolor{deepgreen}{RGB}{0,80,0}
60 \hypersetup{linkcolor=deepblue,citecolor=deepgreen,}
62 % Table of content depth
63 \setcounter{tocdepth}{2}
67 \usepackage{pdflscape}
70 \usepackage{changepage}
74 % \renewcommand{\familydefault}{\sfdefault}
82 \newcommand{\repo}{$\langle$repo$\rangle$}
83 \newcommand{\superscript}[1]{\ensuremath{^{\textrm{\small#1}}}}
84 \newcommand{\subscript}[1]{\ensuremath{_{\textrm{\small#1}}}}
86 % Supported targets - to be used with \ifx\tgtId\tgtIdXXX
87 \def\tgtIdTMSHDK{tms570\_hdk}
88 \def\tgtIdRMHDK{rm48\_hdk}
89 \def\tgtIdTMSRPP{tms570\_rpp}
90 \def\tgtIdHydCtr{tms570\_hydctr}
92 % Include target specific macros etc.
98 \newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
103 % Upper part of the page
106 \includegraphics[width=0.35\textwidth]{images/cvut.pdf}\\[1cm]
107 \textsc{\LARGE Czech Technical University in Prague}\\[1.5cm]
113 {\huge \bfseries Simulink code generation target for Texas~Instruments
114 \tgname{} platform\par}
116 {\Large Version for \tgtBoardName{} board\par}
123 Carlos \textsc{Jenkins}\\
124 Michal \textsc{Horn}\\
125 Michal \textsc{Sojka}\\[\baselineskip]
138 \section*{Revision history}
140 \noindent\begin{tabularx}{\linewidth}{|l|l|l|X|}
141 \rowcolor[gray]{0.9}\hline
142 Revision & Date & Author(s) & Comments \\ \hline
144 0.1 beta & 2014-12-04 & Sojka, Horn & Initial version \\ \hline
146 0.2 & 2015-02-16 & Sojka, Horn & Improvements, clarifications,
149 0.3 & 2015-03-31 & Sojka, Horn & Added sections
150 \ref{sec-changing-os}, \ref{sec:adding-new-funct} and
151 \ref{sec:mult-single-thre}. Minor
154 0.4 & 2015-04-30 & Sojka, Horn & Added support for TMS570 HDK
155 platform. All RPP software
158 recompilation. \\ \hline
160 0.5 beta & 2015-07-03 & Sojka & Updated section \ref{sec:adding-new-funct}.
161 Added support for Eaton Hydraulics
162 Controller board (TMS570LS1227).
174 \fancypagestyle{plain}{%
175 \fancyhf{} % clear all header and footer fields
176 \renewcommand{\footrulewidth}{0.4pt}
177 \renewcommand{\headrulewidth}{0pt}
178 \fancyfoot[L]{Version \input{version.tex}}
180 \fancyfoot[R]{Page {\thepage} of \pageref{LastPage}}
182 \renewcommand{\headrulewidth}{0.4pt}
183 \renewcommand{\footrulewidth}{0.4pt}
185 \fancyhead[R]{\includegraphics[width=1cm]{images/cvut.pdf}}
187 \fancyhead[L]{\nouppercase \leftmark}
188 \fancyfoot[L]{Version \input{version.tex}}
190 \fancyfoot[R]{Page {\thepage} of \pageref{LastPage}}
193 %\addtolength{\parskip}{\baselineskip} % Paragraph spacing
195 \chapter{Introduction}
196 \label{chap-introduction}
198 This text documents software part of Rapid Prototyping Platform (RPP)
199 project for Texas Instruments \tgname{} safety microcontroller
200 developed by Czech Technical University in Prague (CTU). The software
201 consists of code generation target for Simulink Embedded Coder, a
202 low-level run-time C library and a tool for interactive testing of
203 hardware and software functionality.
205 Originally, the RPP project was created for a custom TMS570-based board
206 and the port to other platforms such as RM48 HDK and TMS570 HDK
207 development kits. Porting to other platforms was done under a contract
208 from Eaton Corporation.
210 The document contains step-by-step instructions for installation of
211 development tools, information about Simulink Coder configuration,
212 describes how to create new models as well as how to download the
213 resulting firmware to the hardware. It can also be used as a reference
214 for the testing tool, Matlab Simulink blocks and RPP Matlab Simulink
215 Code generator. Additionally, an overall description of the used
216 hardware platform and the architecture of included software is
220 \label{sec-background}
222 In this document, the term \emph{Rapid Prototyping Platform} denotes a
223 hardware board and accompanying software. The hardware board is
224 \tgtBoardName{} based on ARM Cortex R4 safety microcontroller
225 \mcuname{}. This MCU contains several protective mechanisms (two cores
226 in lockstep, error correction mechanisms for SRAM and Flash memory,
227 voltage monitoring, etc.) to fulfill the requirements for safety
228 critical applications. See~\cite{\tgrefman} for details.
230 In order to develop non-trivial applications for the RPP, an operating
231 system is necessary. The RPP is based on FreeRTOS -- a simple
232 opensource real-time operating system kernel. The FreeRTOS provides an
233 API for creating and managing and scheduling multiple tasks, memory
234 manager, semaphores, queues, mutexes, timers and a few of other
235 features which can be used in the applications.
236 See~\cite{usingthefreertos2009} for more details.
238 Even with the operating system it is quite hard and non-intuitive to
239 manipulate the hardware directly. That is the point when abstraction
240 comes into the play. The RPP software is made of several layers
241 implementing, from the bottom to the top, low-level device drivers,
242 hardware abstraction for common functionality on different hardware
243 and an API which is easy to use in applications. The operating system
244 and the basic software layers, can be compiled as a library and easily
245 used in any project. More details about the library can be found in
246 Chapter~\ref{chap-c-support-library} and in~\cite{michalhorn2013}.
248 Because human beings make mistakes and in safety critical applications
249 any mistake can cause damage, loos of money or in the worst case even
250 death of other people, the area for making mistakes has to be as small
251 as possible. An approach called Model-based development
252 \cite{modelbasedwiki2013} has been introduced to reduce the
253 probability of making mistakes. In model-based development, the
254 applications are designed at higher level from models and the
255 functionality of the models can be simulated in a computer before the
256 final application/hardware is finished. This allows to discover
257 potential errors earlier in the development process.
259 One commonly used tool-chain for model-based development is
260 Matlab/Simulink. In Simulink the application is developed as a model
261 made of interconnected blocks. Every block implements some
262 functionality. For example one block reads a value from an
263 analog-to-digital converter and provides the value as an input to
264 another block. This block can implement some clever algorithm and its
265 output is passed to another block, which sends the computed value as a
266 message over CAN bus to some other MCU. Such a model can be simulated
267 and tested even before the real hardware is available by replacing the
268 input and output blocks with simulated ones. Once the hardware is
269 ready, C code is automatically generated from the model by a Simulink
270 Coder. The code is then compiled by the MCU compatible compiler and
271 downloaded to the MCU Flash memory on the device. Because every block
272 and code generated from the block has to pass a series of tests during
273 their development, the area for making mistakes during the application
274 development has been significantly reduced and developers can focus on
275 the application instead of the hardware and control software
276 implementation. More information about code generation can be found in
277 Chapter \ref{chap-simulink-coder-target}. For information about Matlab
278 Simulink, Embedded Coder and Simulink Coder, refer to
279 \cite{embeddedcoderreference2013, ebmeddedcoderusersguide2013,
280 simulinkcoderreference2013, targetlanguagecompiler2013,
281 simulinkcoderusersguide2013, simulinkdevelopingsfunctions2013}.
283 \section{Hardware description}
284 \label{sec-hardware-description}
288 \section{Software architecture}
289 \label{sec-software-architecture}
291 The core of the RPP software is the so called RPP Library. This
292 library is conceptualy structured into 5 layers, depicted in
293 Figure~\ref{fig-layers}. The architecture design was driven by the
294 following guidelines:
297 \item Top-down dependency only. No lower layer depends on anything from
299 % \item 1-1 layer dependency only. The top layer depends
300 % exclusively on the bottom layer, not on any lower level layer (except for a
301 % couple of exceptions).
302 \item Each layer should provide a unified layer interface
303 (\texttt{rpp.h}, \texttt{drv.h}, \texttt {hal.h}, \texttt{sys.h} and
304 \texttt{os.h}), so that higher layers depend on the lower layer's interface
305 and not on individual elements from that layer.
311 \includegraphics[width=250px]{images/layers.pdf}
312 \caption{The RPP library layers.}
317 As a consequence of this division the source code files and interface files are
318 placed in private directories like \texttt{drv/din.h}. With this organization
319 user applications only needs to include the top layer interface files (for
320 example \texttt{rpp/rpp\_can.h}) to be able to use the selected library API.
322 The rest of the section provides basic description of each layer.
324 \subsection{Operating System layer}
325 \label{sec-operating-system-layer}
326 This is an interchangeable operating system layer containing the
327 FreeRTOS source files. The system can be easily replaced by another
328 version. For example it is possible to compile the RPP library for
329 Linux (using POSIX version of the FreeRTOS), which can be desirable
330 for some testing. The source files can be found in the
331 \texttt{$\langle$rpp\_lib$\rangle$/os} folder.
333 The following FreeRTOS versions are distributed:
335 \item[6.0.4\_posix] POSIX version, usable for compilation of the library
337 \item[7.0.2] Preferred version of the FreeRTOS, distributed by
338 Texas Instruments. This version has been tested and is used in the current
339 version of the library.
340 \item[7.4.0] Newest version distributed by the Texas Instruments.
341 \item[7.4.2] Newer version available from FreeRTOS pages. Slightly
342 modified to run on \tgname{} MCU.
346 Both 7.4.x version were tested and work, but the testing was not so
347 extensive as with the used 7.0.2 version.
349 \subsection{System Layer}
350 \label{sec-system-layer}
351 This layer contains system files with data types definitions, clock definitions,
352 interrupts mapping, MCU start-up sequence, MCU selftests, and other low level
353 code for controlling some of the MCU peripherals. The source files can be found
354 in \texttt{$\langle$rpp\_lib$\rangle$/rpp/src/sys}, the header files can
355 be found in \texttt{$\langle$rpp\_lib$\rangle$/rpp/include/sys}
358 Large part of this layer was generated by the HalCoGen tool (see
359 Section~\ref{sec-halcogen}).
361 \subsection{Drivers layer}
362 \label{sec-drivers-layer}
363 The Drivers layer contains code for controlling the RPP peripherals.
364 Typically, it contains code implementing IRQ handling, software
365 queues, management threads, etc. The layer benefits from the lower
366 layers thus it is not too low level, but still there are some
367 peripherals like ADC, which need some special procedure for
368 initialization and running, that would not be very intuitive for the
371 The source files can be found in
372 \texttt{$\langle$rpp\_lib$\rangle$/rpp/src/drv} and the header files can
373 be found in \texttt{$\langle$rpp\_lib$\rangle$/rpp/include/drv} folder.
375 \subsection{RPP Layer}
376 \label{sec-rpp-layer}
377 The RPP Layer is the highest layer of the library. It provides an easy
378 to use set of functions for every peripheral and requires only basic
379 knowledge about them. For example, to use the ADC, the user can just
380 call \texttt{rpp\_adc\_init()} function and it calls a sequence of
381 Driver layer functions to initialize the hardware and software.
383 The source files can be found in
384 \texttt{$\langle$rpp\_lib$\rangle$/rpp/src/rpp} and the header files can
385 be found in \texttt{$\langle$rpp\_lib$\rangle$/rpp/include/rpp}.
387 \section{Document structure}
388 \label{sec-document-structure}
389 The structure of this document is as follows:
390 Chapter~\ref{chap-getting-started} gets you started using the RPP
391 software. Chapter~\ref{chap-c-support-library} describes the RPP
392 library. Chapter~\ref{chap-simulink-coder-target} covers the Simulink
393 code generation target and finally
394 Chapter~\ref{chap-rpp-test-software} documents a tool for interactive
395 testing of the RPP functionality.
397 \chapter{Getting started}
398 \label{chap-getting-started}
400 \section{Software requirements}
401 \label{sec-software-requirements}
402 The RPP software stack can be used on Windows and Linux platforms. The
403 following subsections mention the recommended versions of the required
404 software tools/packages.
406 \subsection{Linux environment}
407 \label{sec-linux-environment}
409 \item Debian based 64b Linux distribution (Debian 7.0 or Ubuntu 14.4 for
411 \item Kernel version 3.11.0-12.
412 \item GCC version 4.8.1
413 \item GtkTerm 0.99.7-rc1
414 \item TI Code Composer Studio 5.5.0.00077
415 \item Matlab 2013b 64b with Embedded Coder
416 \item HalCoGen 4.00 (optional)
417 \item Uncrustify 0.59 (optional, see Section \ref{sec-compilation})
418 \item Doxygen 1.8.4 (optional, see Section \ref{sec-compiling-api-documentation})
419 \item Git 1.7.10.4 (optional)
422 \subsection{Windows environment}
423 \label{sec-windows-environment}
425 \item Windows 7 Enterprise 64b Service Pack 1.
426 \item Microsoft Windows SDK v7.1
427 \item Bray Terminal v1.9b
428 \item TI Code Composer Studio 5.5.0.00077
429 \item Matlab 2013b 64b with Embedded Coder
430 \item HalCoGen 4.00 (optional)
431 \item Doxygen 1.8.4 (optional, see Section \ref{sec-compiling-api-documentation})
432 \item Uncrustify 0.59 (optional, see Section \ref{sec-compilation})
433 \item Git 1.9.4.msysgit.2 (optional)
436 \section{Software tools}
437 \label{sec-software-and-tools}
439 This section covers tool which are needed or recommended for work with
442 \subsection{TI Code Composer Studio}
444 Code Composer Studio (CCS) is the official Integrated Development Environment
445 (IDE) for developing applications for Texas Instruments embedded processors. CCS
446 is multiplatform software based on
447 Eclipse open source IDE.
449 CCS includes Texas Instruments Code Generation Tools (CGT)
450 \cite{armoptimizingccppcompiler2012, armassemblylanguagetools2012}
451 (compiler, linker, etc). Simulink code generation target requires the
452 CGT to be available in the system, and thus, even if no library
453 development will be done or the IDE is not going to be used CCS is
456 You can find documentation for CGT compiler in \cite{armoptimizingccppcompiler2012} and
457 for CGT archiver in \cite{armassemblylanguagetools2012}.
459 \subsubsection{Installation on Linux}
460 \label{sec-installation-on-linux}
461 Download CCS for Linux from:\\
462 \url{http://processors.wiki.ti.com/index.php/Category:Code\_Composer\_Studio\_v5}
464 Once downloaded, add executable permission to the installation file
465 and launch the installation by executing it. Installation must be done
466 by the root user in order to install a driver set.
468 \lstset{language=bash}
470 chmod +x ccs_setup_5.5.0.00077.bin
471 sudo ./ccs_setup_5.5.0.00077.bin
474 After installation the application can be executed with:
476 \lstset{language=bash}
478 cd <ccs>/ccsv5/eclipse/
482 The first launch on 64bits systems might fail. This can happen because CCS5 is
483 a 32 bit application and thus requires 32 bit libraries. They can be
486 \lstset{language=bash}
488 sudo apt-get install libgtk2.0-0:i386 libxtst6:i386
491 If the application crashes with a segmentation fault edit file:
493 \lstset{language=bash}
495 nano <ccs>/ccsv5/eclipse/plugins/com.ti.ccstudio.branding_<version>/plugin_customization.ini
498 And change key \texttt{org.eclipse.ui/showIntro} to \texttt{false}.
500 \subsubsection{Installation on Windows}
501 \label{sec-installation-on-windows}
502 Installation for Windows is more straightforward than the installation
503 procedure for Linux. Download CCS for Windows from:\\
504 \url{http://processors.wiki.ti.com/index.php/Category:Code\_Composer\_Studio\_v5}
506 Once downloaded run the ccs\_setup\_5.5.0.00077.exe and install the CCS.
508 \subsubsection{First launch}
509 \label{sec-first-launch}
510 If no other licence is available, choose ``FREE License -- for use
511 with XDS100 JTAG Emulators'' from the licensing options. Code download
512 for the board uses the XDS100 hardware.
514 \subsection{Matlab/Simulink}
515 \label{sec-matlab-simulink}
516 Matlab Simulink is a set of tools, runtime environment and development
517 environment for Model--Based \cite{modelbasedwiki2013} applications development,
518 simulations and code generation for target platforms. Supported Matlab Simulink
519 version is R2013b for 64 bits Linux and Windows. A licence for an Embedded Coder is
520 necessary to be able to generate code from Simulink models, containing RPP blocks.
522 \subsection{HalCoGen}
524 HalCoGen (HAL Code Generator) is a tool for graphical configuration of peripherals, clocks, interrupts and other MCU parameters. It generates C code which can be imported to the Code Composer Studio.
526 The tool is available for Windows at
528 \url{http://www.ti.com/tool/halcogen}
531 The HalCoGen has been used in early development stage of the RPP
532 project to generate the base code for some of the peripheral. The
533 trend is to not to use the HalCoGen any more, because the generated
534 code is not reliable enough for safety critical applications. Anyway it is
535 sometimes helpful to use it as a reference.
537 The HalCoGen is distributed for Windows only, but can be run on Linux
538 under Wine (tested with Wine version 1.6.2).
540 \subsection{GtkTerm and Bray Terminal}
541 \label{sec-gtkterm-bray-terminal}
542 Most of the interaction with the board is done through a RS-232 serial
543 connection. The terminal software used for communication is called GtkTerm for
544 Linux and Bray terminal for Windows.
546 To install GtkTerm execute:
548 \lstset{language=bash}
550 sudo apt-get install gtkterm
553 The Bray Terminal does not require any installation and the executable file is
555 \url{https://sites.google.com/site/terminalbpp/}
557 \subsection{C Compiler}
558 \label{sec-c-compiler}
559 A C language compiler has to be available on the development system to be able to
560 compile Matlab Simulink blocks S-functions.
562 For Linux a GCC 4.8.1 compiler is recommended and can be installed with a
565 \lstset{language=bash}
567 sudo apt-get install gcc
570 For Windows, the C/C++ compiler is a part of Windows SDK, which is available from\\
571 \url{http://www.microsoft.com/en-us/download/details.aspx?id=8279}
573 \section{Project installation}
574 \label{sec-project-installation}
575 The RPP software is distributed in three packages and a standalone pdf
576 file containing this documentation. Every package is named like
577 \emph{$\langle$package\_name$\rangle$-version.zip}. The three packages
581 \item[rpp-simulink] Contains the source code of Matlab Simulink
582 blocks, demo models and scripts for downloading the generated
583 firmware to the target board from Matlab/Simulink. Details can be
584 found in Chapter \ref{chap-simulink-coder-target}.
586 The package also contains the binary of the RPP Library and all its
587 headers and other files necessary for building and downloading
589 \item[rpp-test-sw] Contains an application for interactive testing and
590 control of the \tgtBoardName{} board over the serial interface. Details can be
591 found in Chapter~\ref{chap-rpp-test-software}.
593 The package also contains the binary of the RPP Library and all
594 headers and other files necessary for building and downloading the
596 \item[rpp-lib] Contains the source code of the RPP library, described
597 in Chapter \ref{chap-c-support-library}. If you want to make any
598 changes in the drivers or the RPP API, this library has to be
599 compiled and linked with applications in the other two packages.
600 Library compilation is described in Section \ref{sec-compilation}.
603 The following sections describe how to start working with individual
606 \ifx\tgtId\tgtIdTMSRPP
607 \subsection{Getting sources from git repository}
609 git clone --recursive git@rtime.felk.cvut.cz:jenkicar/rpp-simulink
611 If you get release packages, follow the instructions in the next sections.
614 \subsection{rpp-simulink}
615 \label{sec-rpp-simulink-installation}
616 This section describes how to install the rpp-simulink project, which
617 is needed to try the demo models or to build your own models that use
621 \item Unzip the \texttt{rpp-simulink-version.zip} file.
622 \item Follow the procedure from Section
623 \ref{sec-configuration-simulink-for-rpp} for configuring Matlab
624 Simulink for the RPP project.
625 \item Follow the procedure from Section \ref{sec-crating-new-model}
626 for instructions about creating your own model which will use the
627 RPP Simulink blocks or follow the instructions in
628 Section~\ref{sec-running-model-on-hw} for downloading the firmware to the RPP hardware.
631 \subsection{rpp-test-sw}
632 \label{sec-test-sw-installation}
633 This section describes how to install and run the application that
634 allows you to interactively control the RPP hardware. This can be
635 useful, for example, to test your modifications of the RPP library.
638 \item Unzip the \texttt{rpp-test-sw-version.zip} file.
639 \item Open the Code Composer Studio (see Section \ref{sec-ti-ccs}).
640 \item Import the \texttt{rpp-test-sw} project as described in
641 Section \ref{sec-openning-of-existing-project}.
642 \item Right click on the \texttt{rpp-test-sw} project in the
643 \textsc{Project Explorer} and select \textsc{Build Project}.
644 \item Follow the instructions in
645 Section~\ref{sec-running-software-on-hw} to download, debug and
646 run the software on the target hardware.
650 \label{sec-rpp-lib-installation}
652 This section describes how to open the rpp-lib project in Code
653 Composer Studio and how to use the resulting static library in an
654 application. This is only necessary if you need to modify the library
658 \item Unzip the \texttt{rpp-lib-version.zip} file.
659 \item Open the Code Composer Studio (see Section \ref{sec-ti-ccs}).
660 \item Import the rpp-lib project from directory
661 \texttt{rpp-lib-XXX/build/\tgtId} as described in
662 Section~\ref{sec-openning-of-existing-project}.
663 \item Compile the static library by selecting \textsc{Project
664 $\rightarrow$ Build Project} (see Section
665 \ref{sec-compilation} for more information). The compiled
666 library \texttt{rpp-lib.lib} and file
667 \texttt{Makefile.config} will appear in the
668 \texttt{rpp-lib-XXX} directory.
669 \item Either copy the compiled library and the content of the
670 \texttt{rpp/include} directory to the application, where you
671 want to use it or use the library in place, as described in
672 Section~\ref{sec:creating-new-project}.
674 \item In the rpp-simulink application the library is located in
675 the \texttt{rpp/lib} folder.
676 \item In the rpp-test-sw application the library is located in
677 the \texttt{rpp-lib} folder.
681 \section{Code Composer Studio usage}
682 \label{sec-code-composerpstudio-usage}
684 \subsection{Opening an existing project}
685 \label{sec-openning-of-existing-project}
686 The procedure for opening a project is similar to opening a project in
687 the standard Eclipse IDE.
690 \item Launch Code Composer Studio
691 \item Select \textsc{File$\rightarrow$Import}
692 \item In the dialog window select \textsc{Code Composer
693 Studio$\rightarrow$Existing CCS Eclipse project} as an import
694 source (see Figure \ref{fig-import-project}).
695 \item In the next dialog window click on \textsc{Browse} button
696 and find the root directory of the project.
697 \item Select the requested project in the \textsc{Discovered
698 project} section so that the result looks like in Figure
699 \ref{fig-select-project}.
700 \item Click the \textsc{Finish} button.
703 \begin{figure}[H]\begin{center}
704 \includegraphics[width=350px]{images/import_project.png}
705 \caption{Import project dialog}
706 \label{fig-import-project}
707 \end{center}\end{figure}
709 \begin{figure}[H]\begin{center}
710 \includegraphics[width=350px]{images/select_project.png}
711 \caption{Select project dialog}
712 \label{fig-select-project}
713 \end{center}\end{figure}
716 \subsection{Creating new project}
717 \label{sec:creating-new-project}
718 Follow these steps to create an application for \tgname{} MCU compiled with
722 \item Create a new empty CCS project. Select \mcuname{} device, XDS100v2
723 connection and set Linker command file to
724 \texttt{rpp-lib/build/\tgtId/\ldscriptname}.
726 \noindent\includegraphics[scale=0.45]{images/base_1.png}
728 \item In \textsc{Project Explorer}, create normal folders
729 named \texttt{include} and \texttt{src}.
731 \item If you use Git version control system, add \texttt{.gitignore}
732 file with the following content to the root of that project:
741 \item In project \textsc{Properties}, add new variable of type
742 \texttt{Directory} named \texttt{RPP\_LIB\_ROOT} and set it to the
746 \noindent\includegraphics[scale=.45]{images/base_2.png}
748 \item Configure the compiler \#include search path to contain
749 project's \texttt{include} directory, \penalty-100
750 \texttt{\$\{RPP\_LIB\_ROOT\}/os/7.0.2/include} and
751 \texttt{\$\{RPP\_LIB\_ROOT\}/rpp/include}, in that order.
753 \includegraphics[scale=.43]{images/base_5.png}
756 \item Add \texttt{\$\{RPP\_LIB\_ROOT\}/rpp-lib.lib} to the list of
757 linked libraries before the runtime support library
758 (\texttt{\tgtRtlib}).
760 \noindent\includegraphics[scale=.45]{images/base_3.png}
762 \item Configure the compiler to allow GCC extensions.
764 \noindent\includegraphics[scale=.45]{images/base_6.png}
767 \item Create \texttt{main.c} file with the following content:
768 \begin{lstlisting}[language=C]
774 rpp_sci_printf("Hello world\n");
775 vTaskStartScheduler();
776 return 0; /* not reached */
779 void vApplicationMallocFailedHook()
781 void vApplicationStackOverflowHook()
785 \item Compile the application by e.g. \textsc{Project $\rightarrow$
787 \item Select \textsc{Run} $\rightarrow$ \textsc{Debug}. The
788 application will be downloaded to the processor and run. A
789 breakpoint is automatically placed at \texttt{main()} entry. To
790 continue executing the application select \textsc{Run} $\rightarrow$
792 \item If your application fails to run with a \texttt{\_dabort} interrupt, check
793 that the linker script selected in step 1 is not excluded from the build.
794 You can do this by right clicking the \texttt{\ldscriptname} file
795 in the \textsc{Project Explorer} and unchecking the \textsc{Exclude from build}
796 item. The Code Composer Studio sometimes automaticaly excludes this file from
797 the build process when creating a new project.
799 % \item If not already created for another project, create new target
800 % configuration. Select \textsc{Windows $\rightarrow$ Show View
801 % $\rightarrow$ Target Configurations}. In the shown window, click
802 % on \textsc{New Target Configuration} icon and configure XDS100v2
803 % connection and \mcuname{} device as shown below. Click \textsc{Save},
804 % connect your board and click \textsc{Test Connection}.
807 % \includegraphics[width=\linewidth]{images/target_conf.png}
810 \item Optionally, you can change debugger configuration by selecting
811 \textsc{Run $\rightarrow$ Debug Configurations}. In the
812 \textsc{Target} tab, you can configure not to break at \texttt{main}
813 or not to erase the whole flash, but necessary sectors only (see the
816 \includegraphics[width=\linewidth]{images/debug_conf_flash.png}
821 %% Comment this out for Eaton
822 % \subsubsection{Steps to configure new POSIX application:}
823 % Such an application can be used to test certain FreeRTOS features on
824 % Linux and can be compiled with a native GCC compiler.
826 % \begin{compactenum}
827 % \item Create a new managed C project that uses Linux GCC toolchain.
828 % \item Create a source folder \texttt{src}. Link all files from original
829 % CCS application to this folder.
830 % \item Create a normal folder \texttt{include}. Create a folder
831 % \texttt{rpp} inside of it.
832 % \item Add common \texttt{.gitignore} to the root of that project:
839 % \item Add new variable \texttt{RPP\_LIB\_ROOT} and point to this
840 % repository branch root.\newline{}
841 % \noindent\includegraphics[width=\linewidth]{images/base_posix_1.png}
842 % \item Configure compiler to include local includes, CCS application
843 % includes, OS includes for POSIX and RPP includes, in that order.\newline{}
844 % \noindent\includegraphics[width=\linewidth]{images/base_posix_2.png}
846 % \item Add \texttt{rpp} and \texttt{pthread} to linker libraries and add
847 % \texttt{RPP\_LIB\_ROOT} to the library search path.\newline{}
848 % \noindent\includegraphics[width=\linewidth]{images/base_posix_3.png}
851 \subsubsection{Content of the application}
854 \item Include RPP library header file.
855 \lstset{language=c++}
860 If you want to reduce the size of the final application, you can
861 include only the headers of the needed modules. In that case, you
862 need to include two additional headers: \texttt{base.h} and, in case
863 when SCI is used for printing, \texttt{rpp/sci.h}.
865 #include "rpp/hbr.h" /* We want to use H-bridge */
866 #include <base.h> /* This is the necessary base header file of the rpp library. */
867 #include "rpp/sci.h" /* This is needed, because we use rpp_sci_printf in following examples. */
871 \item Create one or as many FreeRTOS task function definitions as
872 required. Those tasks can use functions from the RPP library. Beware
873 that currently not all RPP functions are
874 reentrant\footnote{Determining which functions are not reentrant and
875 marking them as such (or making them reentrant) is planned as
876 future work.}. \lstset{language=c++}
878 void my_task(void* p)
880 static const portTickType freq_ticks = 1000 / portTICK_RATE_MS;
881 portTickType last_wake_time = xTaskGetTickCount();
883 /* Wait until next step */
884 vTaskDelayUntil(&last_wake_time, freq_ticks);
885 rpp_sci_printf((const char*)"Hello RPP.\r\n");
890 \item Create the main function that will:
892 \item Initialize the RPP board. If you have included only selected
893 modules in step 1, initialize only those modules by calling their init
895 example \texttt{rpp\_hbr\_init\(\)}.
896 \item Spawn the tasks the application requires. Refer to FreeRTOS API
898 \item Start the FreeRTOS Scheduler. Refer to FreeRTOS API for details
900 \item Handle error when the FreeRTOS scheduler cannot be started.
902 \lstset{language=c++}
906 /* In case whole library is included: */
907 /* Initialize RPP board */
909 /* In case only selected modules are included: */
912 /* Initialize sci for printf */
914 /* Enable interrups */
918 if (xTaskCreate(my_task, (const signed char*)"my_task",
919 512, NULL, 0, NULL) != pdPASS) {
921 rpp_sci_printf((const char*)
922 "ERROR: Cannot spawn control task.\r\n"
928 /* Start the FreeRTOS Scheduler */
929 vTaskStartScheduler();
931 /* Catch scheduler start error */
933 rpp_sci_printf((const char*)
934 "ERROR: Problem allocating memory for idle task.\r\n"
942 \item Create hook functions for FreeRTOS:
944 \item \texttt{vApplicationMallocFailedHook()} allows to catch memory allocation
946 \item \texttt{vApplicationStackOverflowHook()} allows to catch stack
949 \lstset{language=c++}
951 #if configUSE_MALLOC_FAILED_HOOK == 1
953 * FreeRTOS malloc() failed hook.
955 void vApplicationMallocFailedHook(void) {
957 rpp_sci_printf((const char*)
958 "ERROR: manual memory allocation failed.\r\n"
965 #if configCHECK_FOR_STACK_OVERFLOW > 0
967 * FreeRTOS stack overflow hook.
969 void vApplicationStackOverflowHook(xTaskHandle xTask,
970 signed portCHAR *pcTaskName) {
972 rpp_sci_printf((const char*)
973 "ERROR: Stack overflow : \"%s\".\r\n", pcTaskName
985 \subsection{Downloading and running the software}
986 \label{sec-running-software-on-hw}
987 \subsubsection{Code Composer Studio Project}
988 \label{sec-ccs-run-project}
989 When an application is distributed as a CCS project, you have to open the
990 project in the CCS as described in the Section
991 \ref{sec-openning-of-existing-project}. Once the project is opened and built, it
992 can be easily downloaded to the target hardware with the following procedure:
995 \ifx\tgtId\tgtIdTMSRPP
996 \item Connect the Texas Instruments XDS100v2 USB emulator to the JTAG port.
997 \item Connect a USB cable to the XDS100v2 USB emulator and the development computer.
999 \item Connect the USB cable to the \tgtBoardName{} board.
1001 \item Plug in the power supply.
1002 \item In the Code Composer Studio click on the
1003 \textsc{Run$\rightarrow$Debug}. The project will be optionally built and
1004 the download process will start. The Code Composer Studio will switch into the debug
1005 perspective, when the download is finished.
1006 \item Run the program by clicking on the \textsc{Run} button, with the
1010 \subsubsection{Binary File}
1011 \label{sec-binary-file}
1012 If the application is distributed as a binary file, without source code and CCS
1013 project files, you can download and run just the binary file by creating a new
1014 empty CCS project and configuring the debug session according to the following
1018 \item In Code Composer Studio click on
1019 \textsc{File$\rightarrow$New$\rightarrow$CCS Project}.
1020 \item In the dialog window, type in a project name, for example
1021 myBinaryLoad, Select \textsc{Device
1022 variant} (ARM, Cortex R, \mcuname, Texas Instruments XDS100v2 USB Emulator)
1023 and select project template to \textsc{Empty Project}. The filled dialog should
1024 look like in Figure~\ref{fig-new-empty-project}
1025 \item Click the \textsc{Finish} button and a new empty project will
1027 \item In the \textsc{Project Explorer} right-click on the project and
1028 select \textsc{Debug as$\rightarrow$Debug configurations}.
1029 \item Click \textsc{New launch configuration} button
1030 \item Rename the New\_configuration to, for example, myConfiguration.
1031 \item Select configuration target file by clicking the \textsc{File
1032 System} button, finding and selecting the \texttt{rpp-lib-XXX/build/\tgtId/\tgconfigfilename} file. The result
1033 should look like in Figure~\ref{fig-debug-conf-main-diag}.
1034 \item In the \textsc{program} pane select the binary file you want to
1035 download to the board. Click on the \textsc{File System} button,
1036 find and select the binary file. Try, for example
1037 \texttt{rpp-test-sw.out}. The result should look like in
1038 Figure~\ref{fig-debug-conf-program-diag}.
1039 \item You may also tune the target configuration as described in
1040 Section \ref{sec-target-configuration}.
1041 \item Finish the configuration by clicking the \textsc{Apply} button
1042 and download the code by clicking the \textsc{Debug} button. You can
1043 later invoke the download also from the
1044 \textsc{Run$\rightarrow$Debug} CCS menu. It is not necessary to
1045 create more Debug configurations and CCS empty projects as you can
1046 easily change the binary file in the Debug configuration to load a
1047 different binary file.
1050 \begin{figure}[H]\begin{center}
1051 \includegraphics[scale=.45]{images/new_empty_project.png}
1052 \caption{New empty project dialog}
1053 \label{fig-new-empty-project}
1054 \end{center}\end{figure}
1056 \begin{figure}[H]\begin{center}
1057 \includegraphics[scale=.45]{images/debug_configuration_main.png}
1058 \caption{Debug Configuration Main dialog}
1059 \label{fig-debug-conf-main-diag}
1060 \end{center}\end{figure}
1062 \subsection{Target configuration}
1063 \label{sec-target-configuration}
1064 Default target configuration erases the whole Flash memory, before
1065 downloading the code. This takes long time and in most cases it is
1066 not necessary. You may disable this feature by the following procedure:
1068 \item Right click on the project name in the \textsc{Project Browser}
1069 \item Select \textsc{Debug as$\rightarrow$Debug Configurations}
1070 \item In the dialog window select \textsc{Target} pane.
1071 \item In the \textsc{Flash Settings}, \textsc{Erase Options} select
1072 \textsc{Necessary sectors only}.
1073 \item Save the configuration by clicking the \textsc{Apply} button
1074 and close the dialog.
1077 \begin{figure}[H]\begin{center}
1078 \includegraphics[scale=.45]{images/debug_configuration_program.png}
1079 \caption{Configuration Program dialog}
1080 \label{fig-debug-conf-program-diag}
1081 \end{center}\end{figure}
1083 \section{Matlab Simulink usage}
1084 \label{sec-matlab-simulink-usage}
1085 This section describes the basics of working with the RPP code
1086 generation target for Simulink. For a more detailed description of the
1087 code generation target refer to
1088 Chapter~\ref{chap-simulink-coder-target}.
1090 \subsection{Configuring Simulink for RPP}
1091 \label{sec-configuration-simulink-for-rpp}
1092 Before any work or experiments with the RPP blocks and models, the RPP
1093 target has to be configured to be able to find the ARM cross-compiler,
1094 native C compiler and some other necessary files. Also the S-Functions
1095 of the blocks have to be compiled by the mex tool.
1097 \item Download and install Code Composer Studio CCS (see
1098 Section~\ref{sec-ti-ccs}).
1099 \item Install a C compiler. On Windows follow Section~\ref{sec-c-compiler}.
1100 \item On Windows you have to tell the \texttt{mex} which C compiler to
1101 use. In the Matlab command window run the \texttt{mex -setup}
1102 command and select the native C compiler.
1104 \begin{lstlisting}[basicstyle=\tt\footnotesize]
1107 Welcome to mex -setup. This utility will help you set up
1108 a default compiler. For a list of supported compilers, see
1109 http://www.mathworks.com/support/compilers/R2013b/win64.html
1111 Please choose your compiler for building MEX-files:
1113 Would you like mex to locate installed compilers [y]/n? y
1116 [1] Microsoft Software Development Kit (SDK) 7.1 in c:\Program Files (x86)\Microsoft Visual Studio 10.0
1122 Please verify your choices:
1124 Compiler: Microsoft Software Development Kit (SDK) 7.1
1125 Location: c:\Program Files (x86)\Microsoft Visual Studio 10.0
1127 Are these correct [y]/n? y
1129 ***************************************************************************
1130 Warning: MEX-files generated using Microsoft Windows Software Development
1131 Kit (SDK) require that Microsoft Visual Studio 2010 run-time
1132 libraries be available on the computer they are run on.
1133 If you plan to redistribute your MEX-files to other MATLAB
1134 users, be sure that they have the run-time libraries.
1135 ***************************************************************************
1138 Trying to update options file: C:\Users\Michal\AppData\Roaming\MathWorks\MATLAB\R2013b\mexopts.bat
1139 From template: C:\PROGRA~1\MATLAB\R2013b\bin\win64\mexopts\mssdk71opts.bat
1143 **************************************************************************
1144 Warning: The MATLAB C and Fortran API has changed to support MATLAB
1145 variables with more than 2^32-1 elements. In the near future
1146 you will be required to update your code to utilize the new
1147 API. You can find more information about this at:
1148 http://www.mathworks.com/help/matlab/matlab_external/upgrading-mex-files-to-use-64-bit-api.html
1149 Building with the -largeArrayDims option enables the new API.
1150 **************************************************************************
1153 \item Configure the RPP code generation target:
1155 Open Matlab and in the command window run:
1157 \lstset{language=Matlab}
1159 cd <rpp-simulink>/rpp/rpp/
1163 This will launch the RPP setup script. This script will ask the user to provide
1164 the path to the CCS compiler root directory (the directory where \texttt{armcl}
1165 binary is located), normally:
1168 <ccs>/tools/compiler/arm_5.X.X/
1171 Then Matlab path will be updated and block S-Functions will be built.
1173 \item Create new model or load a demo:
1175 Demos are located in \texttt{\repo/rpp/demos}. Creation of new
1176 models is described in Section~\ref{sec-crating-new-model} below.
1180 \subsection{Working with demo models}
1181 \label{sec-openning-demo-models}
1182 The demo models are available from the directory
1183 \texttt{\repo/rpp/demos}. To access the demo models for reference or
1184 for downloading to the RPP board open them in Matlab. Use either the
1185 GUI or the following commands:
1187 \begin{lstlisting}[language=Matlab]
1188 cd <rpp-simulink>/rpp/demos
1189 open cantransmit.slx
1192 The same procedure can be used to open any other models. To build the
1193 demo select \textsc{Code$\rightarrow$C/C++ Code $\rightarrow$Build
1194 Model}. This will generate the C code and build the binary firmware
1195 for the RPP board. To run the model on the target hardware see
1196 Section~\ref{sec-running-model-on-hw}.
1198 \subsection{Creating new model}
1199 \label{sec-crating-new-model}
1201 \item Create a model by clicking \textsc{New$\rightarrow$Simulink Model}.
1202 \item Open the configuration dialog by clicking \textsc{Simulation$\rightarrow$Model Configuration Parameters}.
1203 \item The new Simulink model needs to be configured in the following way:
1205 \item Solver (Figure \ref{fig-solver}):
1207 \item Solver type: \emph{Fixed-step}
1208 \item Solver: \emph{discrete}
1209 \item Fixed-step size: \emph{Sampling period in seconds. Minimum
1211 \item Tasking mode: \textit{SingleTasking}.
1214 \includegraphics[scale=.45]{images/simulink_solver.png}
1215 \caption{Solver settings}
1219 % \item Diagnostics $\rightarrow$ Sample Time (Figure~\ref{fig-sample-time-settings}):
1220 % \begin{compactitem}
1221 % \item Disable warning ``Source block specifies -1 sampling
1222 % time''. It's ok for the source blocks to run once per tick.
1225 % \includegraphics[scale=.45]{images/simulink_diagnostics.png}
1226 % \caption{Sample Time settings}
1227 % \label{fig-sample-time-settings}
1230 \item Code generation (Figure~\ref{fig-code-gen-settings}):
1232 \item Set ``System target file'' to \texttt{rpp.tlc}.
1235 \includegraphics[scale=.45]{images/simulink_code.png}
1236 \caption{Code Generation settings}
1237 \label{fig-code-gen-settings}
1241 \item Once the model is configured, you can open the Library Browser
1242 (\textsc{View $\rightarrow$ Library Browser}) and add the necessary
1243 blocks to create the model. The RPP-specific blocks are located in
1244 the RPP Block Library.
1245 \item From Matlab command window change the current directory to where
1246 you want your generated code to appear, e.g.:
1247 \begin{lstlisting}[language=Matlab]
1250 The code will be generated in a subdirectory named
1251 \texttt{<model>\_rpp}, where \texttt{model} is the name of the
1253 \item Generate the code by choosing \textsc{Code $\rightarrow$ C/C++
1254 Code $\rightarrow$ Build Model}.
1257 To run the model on the \tgtBoardName{} board continue with Section
1258 \ref{sec-running-model-on-hw}.
1260 \subsection{Running models on the RPP board}
1261 \label{sec-running-model-on-hw}
1262 To run the model on the \tgtBoardName{} hardware you have to enable the download
1263 feature and build the model by following this procedure:
1265 \item Open the model you want to run (see
1266 Section~\ref{sec-openning-demo-models} for example with demo
1268 \item Click on \textsc{Simulation$\rightarrow$Model Configuration
1270 \item In the \textsc{Code Generation$\rightarrow$RPP Options} pane
1271 check the \textsc{Download compiled binary to RPP} checkbox. Click
1272 the \textsc{OK} button
1273 \item Connect the target hardware to the computer (see Section
1274 \ref{sec-ccs-run-project}) and build the model by \textsc{Code
1275 $\rightarrow$ C/C++ Code $\rightarrow$ Build Model}. If the build
1276 succeeds, the download process will start automatically and once
1277 the downloading is finished, the application will run immediately.
1280 %%\subsubsection{Using OpenOCD for downloading}
1281 %%\label{sec:using-open-downl}
1283 %%On Linux systems, it is possible to use an alternative download
1284 %%mechanism based on the OpenOCD tool. This results in much shorter
1285 %%download times. Using OpenOCD is enabled by checking ``Use OpenOCD to
1286 %%download the compiled binary'' checkbox. For more information about
1287 %%the OpenOCD configuration refer to our
1288 %%wiki\footnote{\url{http://rtime.felk.cvut.cz/hw/index.php/TMS570LS3137\#OpenOCD_setup_and_Flashing}}.
1290 %%Note: You should close any ongoing Code Composer Studio debug sessions
1291 %%before downloading the generated code to the RPP board. Otherwise the
1294 \section{Configuring serial interface}
1295 \label{sec-configuration-serial-interface}
1296 The main mean for communication with the RPP board is the serial line.
1297 Each application may define its own serial line settings, but the
1298 following settings are the default:
1301 \item Baudrate: 115200
1305 \item Flow control: none
1308 Use GtkTerm on Linux or Bray Terminal on Windows for accessing the
1309 serial interface. On \tgtBoardName{} board, the serial line is tunneled over
1311 % TODO: Conditional compilation
1312 % See Section \ref{sec-hardware-description} for reference about
1313 % the position of the serial interface connector on the RPP board.
1315 \section{Bug reporting}
1316 \label{sec-bug-reporting}
1318 Please report any problems to CTU's bug tracking system at
1319 \url{https://redmine.felk.cvut.cz/projects/eaton-rm48}. New users have
1320 to register in the system and notify Michal Sojka about their
1321 registration via $\langle{}sojkam1@fel.cvut.cz\rangle{}$ email
1324 \chapter{C Support Library}
1325 \label{chap-c-support-library}
1327 This chapter describes the implementation of the C support library
1328 (RPP Library), which is used both for Simulink code generation target
1329 and command line testing tool.
1331 \section{Introduction}
1332 \label{sec-description}
1333 The RPP C Support Library (also called RPP library) defines the API for
1334 working with the board. It includes drivers and the operating system.
1336 designed from the board user perspective and exposes a simplified high-level API
1337 to handle the board's peripheral modules in a safe manner. The library is
1338 compiled as static library named \texttt{rpp-lib.lib} and can be found in
1339 \texttt{\repo/rpp/lib}.
1341 The RPP library can be used in any project, where the RPP hardware
1342 support is required and it is also used in two applications --
1343 Simulink Coder Target, described in Chapter
1344 \ref{chap-simulink-coder-target}, and the command line testing tool,
1345 described in Chapter \ref{chap-rpp-test-software}.
1347 For details about the library architecture, refer to Section~\ref{sec-software-architecture}.
1349 \section{API development guidelines}
1350 \label{sec-api-development-guidlines}
1352 The following are the development guidelines used for developing the RPP API:
1355 \item User documentation should be placed in header files, not in source
1356 code, and should be Doxygen formatted using autobrief. Documentation for each
1357 function present is mandatory.
1358 \item Function declarations in the headers files is for public functions
1359 only. Do not declare local/static/private functions in the header.
1360 \item Documentation in source code files should be non-doxygen formatted
1361 and intended for developers, not users. Documentation here is optional and at
1362 the discretion of the developer.
1363 \item Always use standard data types for IO when possible. Use custom
1364 structs as very last resort. \item Use prefix based functions names to avoid
1365 clash. The prefix is of the form \texttt{$\langle$layer$\rangle$\_$\langle$module$\rangle$\_}, for example
1366 \texttt{rpp\_din\_update()} for the update function of the DIN module in the RPP
1368 \item Be very careful about symbol export. Because it is used as a
1369 static library the modules should not export any symbol that is not intended to
1370 be used (function) or \texttt{extern}'ed (variable) from application. As a rule
1371 of thumb declare all global variables as static.
1372 \item Only the RPP Layer symbols are available to user applications. All
1373 information related to lower layers is hidden for the application. This is
1374 accomplished by the inclusion of the rpp.h or rpp\_\{mnemonic\}.h file on the
1375 implementations files only and never on the interface files. Never expose any
1376 other layer to the application or to the whole system below the RPP layer. In
1377 other words, never \texttt{\#include "foo/bar.h"} in any RPP Layer header
1381 \section{Coding style}
1382 \label{sec-coding-style}
1383 In order to keep the code as clean as possible, unified coding style
1384 should be followed by any contributor to the code. The used coding
1385 style is based on the default configuration of Code Composer Studio
1386 editor. Most notable rule is that the Tab character is 4 spaces.
1388 The RPP library project is prepared for use of a tool named
1389 Uncrustify. The Uncrustify tool checks the code and fixes those lines
1390 that do not match the coding style. However, keep in mind that the
1391 program is not perfect and sometimes it can modify code where the
1392 suggested coding style has been followed. This does not causes
1393 problems as long as the contributor follows the committing procedure
1394 described in next paragraph.
1396 When contributing to the code, the contributor should learn the
1397 current coding style from existing code. When a new feature is
1398 implemented and committed to the local repository, the following
1399 commands should be called in Linux terminal:
1401 \begin{lstlisting}[language=bash]
1405 The first line command corrects many found coding style violations and
1406 the second command displays them. If the user agree with the
1407 modification, he/she should amend the last commit, for example by:
1408 \begin{lstlisting}[language=bash]
1413 \section{Subdirectory content description}
1414 \label{sec-rpp-lib-subdirectory-content-description}
1416 The following files and directories are present in the library source
1420 \item[rpp-lib.lib] Compiled RPP library.
1422 The library is needed for Simulink models and other ARM/\tgname{}
1423 applications. It is placed here by the Makefile, when the library is
1426 \item[apps/] Various applications related to the RPP library.
1428 This include the CCS studio project for generating of the static
1429 library and a test suite. The test suit in this directory has
1430 nothing common with the test suite described later in
1431 Chapter~\ref{chap-rpp-test-software} and those two suits are going
1432 to be merged in the future. Also other Hello World applications are
1433 included as a reference about how to create an \tgname{}
1435 \item[build] The library can be compiled for multiple targets. Each
1436 supported target has a subdirectory here, which stores configuration
1437 of how to compile the library and applications for different target.
1438 Each subdirectory contains a CCS project and Makefiles to build the
1439 library for the particular target.
1440 \item[build/$\langle$target$\rangle$/Makefile.config] Configuration
1441 for the particular target. This includes compiler and linker
1443 \item[build/$\langle$target$\rangle$/*.cmd]
1444 CGT Linker command file.
1446 This file is used by all applications that need to tun on the RPP
1447 board, including the Simulink models and test suite. It includes
1448 instructions for the CGT Linker about target memory layout and where
1449 to place various code sections.
1450 \item[os/] OS layers directory. See
1451 Section~\ref{sec-operating-system-layer} for more information about
1452 currently available operating system versions and
1453 Section~\ref{sec-changing-os} for information how to replace the
1455 \item[rpp/] Main directory for the RPP library.
1456 \item[rpp/doc/] RPP Library API
1458 \item[rpp/include/\{layer\} and rpp/src/\{layer\}] Interface files and
1459 implementations files for given \texttt{\{layer\}}. See
1460 Section~\ref{sec-software-architecture} for details on the RPP
1462 \item[rpp/include/rpp/rpp.h] Main library header file.
1464 To use this library with all its modules, just include this file
1465 only. Also, before using any library function call the
1466 \texttt{rpp\_init()} function for hardware initialization.
1467 \item[rpp/include/rpp/rpp\_\{mnemonic\}.h] Header file for
1468 \texttt{\{mnemonic\}} module.
1470 These files includes function definitions, pin definitions, etc,
1471 specific to \{mnemonic\} module. See also
1472 Section~\ref{sec-api-development-guidlines}.
1474 If you want to use only a subset of library functions and make the
1475 resulting binary smaller, you may include only selected
1476 \texttt{rpp\_\{mnemonic\}.h} header files and call the specific
1477 \texttt{rpp\_\{mnemonic\}\_init} functions, instead of the
1478 \texttt{rpp.h} and \texttt{rpp\_init} function.
1479 \item[rpp/src/rpp/rpp\_\{mnemonic\}.c] Module implementation.
1481 Implementation of \texttt{rpp\_\{mnemonic\}.h}'s functions on
1482 top of the DRV library.
1483 \item[rpp/src/rpp/rpp.c] Implementation of library-wide functions.
1486 \section{Compilation}
1487 \label{sec-compilation}
1489 To compile the library open the Code Composer studio project
1490 \texttt{rpp-lib} from appropriate \texttt{build/<target>} directory
1491 (see Section~\ref{sec-openning-of-existing-project}) and build the
1492 project (\textsc{Project $\rightarrow$ Build Project}). If the build
1493 process is successful, the \texttt{rpp-lib.lib} and
1494 \texttt{Makefile.config} files will appear in the library root
1497 It is also possible to compile the library using the included
1498 \texttt{Makefile}. From the Linux command line run:
1499 \begin{lstlisting}[language=bash]
1500 cd <library-root>/build/<target>/Debug #or Release
1503 Note that this only works if Code Composer Studio is installed in
1504 \texttt{/opt/ti} directory. Otherwise, you have to set
1505 \texttt{CCS\_UTILS\_DIR} variable.
1507 On Windows command line run:
1508 \begin{lstlisting}[language=bash]
1509 cd <library-root>\build\<target>\Debug
1510 set CCS_UTILS_DIR=C:\ti\ccsv5\utils
1511 C:\ti\ccsv5\utils\bin\gmake.exe lib
1514 You have to use \texttt{gmake.exe} instead of \texttt{make} and it is
1515 necessary to set variable \texttt{CCS\_UTILS\_DIR} manually. You can
1516 also edit \texttt{\repo/build/Makefile.rules.arm} and set the variable
1519 Note that the Makefile still requires the Code Composer Studio (ARM
1520 compiler) to be installed because of the CGT.
1522 \section{Compiling applications using the RPP library}
1523 \label{sec:comp-appl-using}
1525 The relevant aspects for compiling and linking an application using
1526 the RPP library are summarized below.
1528 % \subsection{ARM target (RPP board)}
1529 % \label{sec:arm-target-rpp}
1531 The detailed instructions are presented in
1532 Section~\ref{sec:creating-new-project}. Here we briefly repeat the
1536 \item Configure include search path to contain the directory of
1537 used FreeRTOS version, e.g.
1538 \texttt{\repo/os/7.0.2/include}. See Section
1539 \ref{sec-software-architecture}.
1540 \item Include \texttt{rpp/rpp.h} header file or just the needed
1541 peripheral specific header files such as \texttt{rpp/can.h}.
1542 \item Add library \texttt{rpp-lib.lib} to the linker libraries.
1543 The RPP library must be placed before Texas Instruments
1544 support library \tgtRtlib.
1545 \item Use the provided linker command file
1546 \texttt{\ldscriptname}.
1549 % \subsection{POSIX target}
1550 % \label{sec:posix-target}
1552 % \begin{compactitem}
1553 % \item Include headers files of the OS for Simulation. At the time
1554 % of this writing the OS is POSIX FreeRTOS 6.0.4.
1555 % \item Include header files for the RPP library or for modules you
1556 % want to use (rpp\_can.h for CAN module for example).
1557 % \item Add library \texttt{librpp.a} to the linker libraries.
1558 % \item Add \texttt{pthread} to the linker libraries.
1561 \section{Compiling API documentation}
1562 \label{sec-compiling-api-documentation}
1563 The documentation of the RPP layer is formatted using Doxygen
1564 documentation generator. This allows to generate a high quality API
1565 reference. To generate the API reference run in a Linux terminal:
1567 \lstset{language=bash}
1569 cd <repo>/rpp/doc/api
1571 xdg-open html/index.html
1574 The files under \texttt{\repo/rpp/doc/api/content} are used for the API
1575 reference generation are their name is self-explanatory:
1585 \section{Changing operating system}
1586 \label{sec-changing-os}
1587 The C Support Library contains by default the FreeRTOS operating
1588 system in version 7.0.2. This section describes what is necessary to
1589 change in the library and other packages in order to replace the
1592 \subsection{Operating system code and API}
1594 The source and header files of the current operating system (OS) are
1595 stored in directory \texttt{\repo/rpp/lib/os}. The files of the new
1596 operating system should also be placed in this directory.
1598 To make the methods and resources of the new OS available to the C Support
1599 Library, modify the \texttt{\repo/rpp/lib/rpp/include/base.h} file to include
1600 the operating system header files.
1602 Current implementation for FreeRTOS includes a header file
1603 \texttt{\repo/rpp/lib/os/\-7.0.2\-include/os.h}, which
1604 contains all necessary declarations and definitions for the FreeRTOS.
1605 We suggest to provide a similar header file for your operating system as
1608 In order to compile another operating system into the library, it is
1609 necessary to modify \texttt{\repo/rpp/lib/Makefile.var} file, which
1610 contains a list of files that are compiled into the library. All lines
1611 starting with \texttt{os/} should be updated.
1613 \subsection{Device drivers}
1614 Drivers for SCI and ADC depend on the FreeRTOS features. These
1615 features need to be replaced by equivalent features of the new
1616 operating system. Those files should be modified:
1618 \item[\repo/rpp/lib/rpp/include/sys/ti\_drv\_sci.h] Defines a data
1619 structure, referring to FreeRTOS queue and semaphore.
1620 \item[\repo/rpp/lib/rpp/src/sys/ti\_drv\_sci.c] Uses FreeRTOS queues
1622 \item[\repo/rpp/lib/rpp/include/drv/sci.h] Declaration of
1623 \texttt{drv\_sci\_receive()} contains \texttt{portTick\-Type}. We
1624 suggest replacing this with OS independent type, e.g. number of
1625 milliseconds to wait, with $-1$ meaning infinite waiting time.
1626 \item[\repo/rpp/lib/rpp/src/drv/sci.c] Uses the following FreeRTOS
1627 specific features: semaphores, queues, data types
1628 (\texttt{portBASE\_TYPE}) and
1629 critical sections (\texttt{taskENTER\_CRITICAL} and
1630 \texttt{task\-EXIT\_CRITICAL}). Inside FreeRTOS critical sections,
1631 task preemption is disabled. The same should be ensured by the other
1632 operating system or the driver should be rewritten to use other
1633 synchronization primitives.
1634 \item[\repo/rpp/lib/rpp/src/drv/adc.c] Uses FreeRTOS semaphores.
1637 \subsection{System start}
1638 The initialization of the MCU and the system is in the
1639 \texttt{\repo/rpp/lib/rpp/src/sys/sys\_startup.c} file. If the new
1640 operating system needs to handle interrupts generated by the Real-Time
1641 Interrupt module, the pointer to the Interrupt Service Routine (ISR)
1642 \texttt{vPreemptiveTick} has to be replaced.
1644 \subsection{Simulink template for main function}
1646 When the operating system in the library is replaced, the users of the
1647 library must be changed as well. In case of Simulink code generation
1648 target, described in Chapter~\ref{chap-simulink-coder-target}, the
1649 template for generation of the \texttt{ert\_main.c} file, containing
1650 the main function, has to be modified to use proper functions for task
1651 creation, task timing and semaphores. The template is stored in
1652 \texttt{\repo/rpp/rpp/rpp\_srmain.tlc} file.
1654 \chapter{Simulink Coder Target}
1655 \label{chap-simulink-coder-target}
1657 The Simulink Coder Target allows to convert Simulink models to C code,
1658 compile it and download to the board.
1660 \section{Introduction}
1661 \label{sec-introduction}
1663 The Simulink RPP Target provides support for C source code generation from Simulink models and
1664 compilation of that code on top of the RPP library and the FreeRTOS operating system. This target
1665 uses Texas Instruments ARM compiler (\texttt{armcl}) included in the Code Generation Tools distributed with
1666 Code Composer Studio, and thus it depends on it for proper functioning.
1668 This target also provides support for automatic download of the compiled binary to the RPP
1671 \begin{figure}\begin{center}
1673 \includegraphics[scale=.45]{images/tlc_process.png}
1674 \caption{TLC code generation process. \cite[p. 1-6]{targetlanguagecompiler2013}}
1675 \end{center}\end{figure}
1677 \section{Features and limitations}
1678 \label{sec-features}
1681 \item Sampling frequencies up to 1\,kHz.
1682 \item Multi-rate models are executed in a single thread in
1683 non-preemptive manner. Support for multi-threaded execution will be
1684 available in the final version and will require careful audit of the
1685 RPP library with respect to thread-safe code.
1686 \item No External mode support yet. We work on it.
1687 \item Custom compiler options, available via OPTS variable in
1688 \emph{Make command} at \emph{Code Generation} tab (see Figure
1689 \ref{fig-code-gen-settings}). For example \texttt{make\_rtw
1693 \section{RPP Options pane}
1694 \label{sec-rpp-target-options}
1696 The RPP Target includes the following configuration options, all of them
1697 configurable per model under \textsc{Code Generation} \noindent$\rightarrow$
1698 \textsc{RPP Options}:
1701 \item \textbf{C system stack size}: this parameter is passed directly
1702 to the linker for the allocation of the stack. Note that this stack
1703 is used only for initializing the application and FreeRTOS. Once
1704 everything is initialized, another stack is used by the generated
1705 code. See below. Default value is 4096.
1707 \item \textbf{C system heap size}:
1708 \label{sec-rpp-target-options-heap-size} this parameter is passed
1709 directly to the linker for the allocation of the heap. Currently,
1710 the heap is not used, but will be used by the external mode in the future.
1711 Note that FreeRTOS uses its own heap whose size is independent of this
1713 \item \textbf{Model step task stack size}: this parameter will be
1714 passed to the \texttt{xTaskCreate()} that
1715 creates the task for the model to run. In a Simulink model there are always two tasks:
1717 \item The worker task. This task is the one that executes the model
1718 step. This task requires enough stack memory to execute the step.
1719 If your model does not run, it might be caused by too small stack.
1720 The memory needed for the stack depends on the size and structure
1722 \item The control task. This task controls when the worker task should execute and controls overruns.
1725 \item \textbf{Download compiled binary to RPP}: if set, this option will download the generated binary to
1726 the board after the model is successfully built. Note that this option is unaware of the option
1727 \textit{Generate code only} in the \textit{Code Generation} options panel, so it will try to download even if
1728 only source code has been generated, failing graciously or uploading an old binary laying around
1729 in the build directory. This option calls the \texttt{rpp\_download.m} script, which is in turn a
1730 wrapper on the \texttt{loadti.sh}, \texttt{loadti.bat} and \texttt{loadopenocd.sh} script. More information on the \texttt{loadti.sh}
1731 script can be found in:
1733 <ccs>/ccs_base/scripting/examples/loadti/readme.txt
1734 http://processors.wiki.ti.com/index.php/Loadti
1737 The \texttt{loadti.sh} and \texttt{loadti.bat} script will close after the
1738 download of the generated program, leaving the loaded program running.
1740 The \texttt{loadopenocd.sh} script will close after the download of the
1741 generated program as well, but the program will be stopped. In order to run
1742 the loaded program a manual reset of the board is required.
1744 \item \textbf{Download compiled binary to SDRAM}: This feature is not yet
1745 implemented for the simulink target.
1747 \item \textbf{Use OpenOCD to download the compiled binary}: This feature is not yet
1748 implemented for the \mcuname{} simulink target.
1749 % TODO Not true - use conditional compilation here.
1751 \item \textbf{Print model metadata to SCI at start}: if set this option will
1752 print a message to the Serial Communication Interface when the model start
1753 execution on the board. This is very helpful to identify the model running on
1754 the board. The message is in the form:
1757 `model_name' - generated_date (TLC tlc_version)
1762 `hbridge_analog_control' - Wed Jun 19 14:10:44 2013 (TLC 8.3 (Jul 20 2012))
1766 \section{Subdirectory content description}
1767 \label{sec-simulink-subdirectory-content-description}
1768 This section describes the directories of the Simulink Coder. If you are
1769 interested in particular file, refer the description at the beginning of the
1773 \item[doc/] Contains the sources of the documentation, you are now
1775 \item[refs/] Contains third party references, which license allows the
1777 \item[rpp/blocks] Contains the Simulink blocks specific to the
1778 \tgtBoardName{} board and their sources (.c and .tlc files). When an
1779 user calls \texttt{rpp\_setup.m}, these files are processed and
1780 Simulink block library \texttt{rpp\_lib.slx} is created.
1781 \item[rpp/blocks/tlc\_c]Contains the templates for C code generation from the
1782 Matlab Simulink model.
1783 \item[rpp/demos] Contains demo models, which purpose is to serve as a
1784 reference for the usage and for testing.
1785 \item[rpp/lib] Contains the C Support Library. See Chapter
1786 \ref{chap-c-support-library}. \item[rpp/loadopenocd] Contains download scripts
1787 for Linux support of the OpenOCD, for code downloading to the target.
1788 \item[rpp/loadti] Contains download scripts for Linux and Windows
1789 support for code downloading to the target, using Texas Instruments CCS code
1791 \item[rpp/rpp] Contains set of support script for the Code Generator.
1794 \section{Block Library Overview}
1795 \label{sec-block-library-overview}
1796 The Simulink Block Library is a set of blocks that allows Simulink models to use
1797 board IO and communication peripherals. The available blocks are summarized in
1798 Table~\ref{tab:block-lib-status} and more detailed description is
1799 given in Section~\ref{sec-blocks-description}.
1802 \begin{center}\begin{tabular}{|lp{5cm}lll|}
1804 \textbf{Category} & \textbf{Name} & \textbf{Status} & \textbf{Mnemonic} & \textbf{Header} \\
1806 \input{block_table.tex}
1808 \end{tabular}\end{center}
1810 \caption{Block library overview}
1811 \label{tab:block-lib-status}
1814 \label{sec-blocks-implementation}
1815 All of the blocks are implemented as manually created C Mex S-Function . In this section the
1816 approach taken is briefly explained.
1818 \subsection{C MEX S-Functions}
1819 \label{sec-c-mex-functions}
1821 \item C : Implemented in C language. Other options are Fortran and Matlab language itself.
1822 \item MEX: Matlab Executable. They are compiled by Matlab - C compiler wrapper called MEX.
1823 \item S-Function: System Function, as opposed to standard functions, or user functions.
1826 A C MEX S-Function is a structured C file that implements some mandatory and
1827 optional callbacks for a specification of a number of inputs, outputs, data
1828 types, parameters, rate, validity checking, etc. A complete list of callbacks
1831 \htmladdnormallink{http://www.mathworks.com/help/simulink/create-cc-s-functions.html}{http://www.mathworks.com/help/simulink/create-cc-s-functions.html}
1834 The way a C MEX S-Function participates in a Simulink simulation is shown on the
1835 diagram \ref{fig-sfunctions-process}:
1837 \begin{figure}[H]\begin{center}
1839 \includegraphics[scale=.45]{images/sfunctions_process.png}
1840 \caption{Simulation cycle of a S-Function. \cite[p. 57]{simulinkdevelopingsfunctions2013}}
1841 \label{fig-sfunctions-process}
1842 \end{center}\end{figure}
1844 In general, the S-Function can perform calculations, inputs and outputs for simulation. Because
1845 the RPP blocks are for hardware peripherals control and IO the blocks are
1846 implemented as pure sink or pure source, the S-Function is just a descriptor of
1847 the block and does not perform any calculation and does not provide any input or
1848 output for simulations.
1850 The implementation of the S-Functions in the RPP project has following layout:
1853 \item Define S-Function name \texttt{S\_FUNCTION\_NAME}.
1854 \item Include header file \texttt{header.c}, which in connection with
1855 \texttt{trailer.c} creates a miniframework for writing S-Functions.
1856 \item In \texttt{mdlInitializeSizes} define:
1858 \item Number of \textit{dialog} parameter.
1859 \item Number of input ports.
1861 \item Data type of each input port.
1863 \item Number of output ports.
1865 \item Data type of each output port.
1867 \item Standard options for driver blocks.
1869 \item In \texttt{mdlCheckParameters}:
1871 \item Check data type of each parameter.
1872 \item Check range, if applicable, of each parameter.
1874 \item In \texttt{mdlSetWorkWidths}:
1876 \item Map \textit{dialog} parameter to \textit{runtime} parameters.
1878 \item Data type of each \textit{runtime} parameter.
1881 \item Define symbols for unused functions.
1882 \item Include trailer file \texttt{trailer.c}.
1885 The C MEX S-Function implemented can be compiled with the following command:
1887 \lstset{language=bash}
1889 <matlabroot>/bin/mex sfunction_{mnemonic}.c
1892 As noted the standard is to always prefix S-Function with \texttt{sfunction\_}
1893 and use lower case mnemonic of the block.
1895 Also a script called \texttt{compile\_blocks.m} is included. The script that
1896 allows all \texttt{sfunctions\_*.c} to be fed to the \texttt{mex} compiler so
1897 all S-Functions are compiled at once. To use this script, in Matlab do:
1899 \lstset{language=Matlab}
1901 cd <repo>/rpp/blocks/
1905 \subsection{Target Language Compiler files}
1906 \label{sec-target-language-compiler-files}
1908 In order to generate code for each one of the S-Functions, every S-Function implements a TLC file
1909 for \textit{inlining} the S-Function on the generated code. The TLC files describe how to
1910 generate code for a specific C MEX S-Function block. They are programmed using TLC own language and
1911 include C code within TLC instructions, just like LaTeX files include normal text in between LaTeX
1914 The standard for a TLC file is to be located under the \texttt{tlc\_c} subfolder from where the
1915 S-Function is located and to use the very exact file name as the S-Function but with the \texttt{.tlc}
1916 extension: \texttt{sfunction\_foo.c} \noindent$\rightarrow$ \texttt{tlc\_c/sfunction\_foo.tlc}
1918 The TLC files implemented for this project use 3 hook functions in particular (other are available,
1919 see TLC reference documentation):
1921 \item \texttt{BlockTypeSetup}: \newline{}
1922 BlockTypeSetup executes once per block type before code generation begins.
1923 This function can be used to include elements required by this block type, like includes or
1925 \item \texttt{Start}: \newline{}
1926 Code here will be placed in the \texttt{void
1927 $\langle$modelname$\rangle$\_initialize(void)}. Code placed here will execute
1929 \item \texttt{Outputs}: \newline{}
1930 Code here will be placed in the \texttt{void
1931 $\langle$modelname$\rangle$\_step(void)} function. Should be used to get the
1932 inputs of a block and/or to set the outputs of that block.
1935 The general layout of the TLC files implemented for this project is:
1937 \item In \texttt{BlockTypeSetup}: \newline{}
1938 Call common function \texttt{\%$<$RppCommonBlockTypeSetup(block, system)$>$} that will include the
1939 \texttt{rpp/rpp\i\_mnemonic.h} header file (can be called multiple times but header is included only once).
1940 \item \texttt{Start}: \newline{}
1941 Call setup routines from RPP Layer for the specific block type, like HBR enable, DIN pin setup,
1942 DAC value initialization, SCI baud rate setup, among others.
1943 \item \texttt{Outputs}: \newline{}
1944 Call common IO routines from RPP Layer, like DIN read, DAC set, etc. Success of this functions
1945 is checked and in case of failure error is reported to the block using ErrFlag.
1948 C code generated from a Simulink model is placed on a file called
1949 \texttt{$\langle$modelname$\rangle$.c} along with other support files in a
1950 folder called \texttt{$\langle$modelname$\rangle$\_$\langle$target$\rangle$/}.
1951 For example, the source code generated for model \texttt{foobar} will be placed
1952 in current Matlab directory \texttt{foobar\_rpp/foobar.c}.
1954 The file \texttt{$\langle$modelname$\rangle$.c} has 3 main functions:
1956 \item \texttt{void $\langle$modelname$\rangle$\_step(void)}: \newline{}
1957 This function recalculates all the outputs of the blocks and should be called once per step. This
1958 is the main working function.
1959 \item \texttt{void $\langle$modelname$\rangle$\_initialize(void)}: \newline{}
1960 This function is called only once before the first step is issued. Default values for blocks IOs
1961 should be placed here.
1962 \item \texttt{void $\langle$modelname$\rangle$\_terminate(void)}: \newline{}
1963 This function is called when terminating the model. This should be used to free memory or revert
1964 other operations made in the initialization function. With current implementation this function
1965 should never be called unless an error is detected and in most models it is empty.
1968 \section{Block reference}
1969 \label{sec-blocks-description}
1971 This section describes each one of the Simulink blocks present in the Simulink
1972 RPP block library, shown in Figure \ref{fig-block-library}.
1976 \includegraphics[width=\textwidth]{images/block_library.png}
1978 \caption{Simulink RPP Block Library.}
1979 \label{fig-block-library}
1982 \input{block_desc.tex}
1984 \section{Compilation}
1985 \label{sec-simulink-compilation}
1986 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:
1987 \lstset{language=Matlab}
1989 cd <rpp-simulink>/rpp/blocks
1993 Once the S-Functions are compiled, the C code can be generated from the models. Demos can be compiled one by one with a procedure described in Section \ref{sec-openning-demo-models} or all at once with one of those procedures:
1996 \item Open Matlab and run those commands in the Matlab command line:
1997 \lstset{language=Matlab}
1999 cd <rpp-simulink>/rpp/demos
2002 \item Run those commands in a Linux terminal:
2003 \begin{lstlisting}[language=bash]
2004 cd <rpp-simulink>/rpp/demos
2008 or Windows command line:
2010 \begin{lstlisting}[language=bash]
2011 cd <rpp-simulink>\rpp\demos
2012 "C:\ti\ccsv5\utils\bin\"gmake.exe lib
2015 Both commands will create a directory for each compiled demo, which will contain the generated C code and binary file with the firmware. To download the firmware to the board and run it, see Section \ref{sec-running-software-on-hw}.
2018 \section{Adding new functionality}
2019 \label{sec:adding-new-funct}
2020 This section describes how to create new Simulink blocks and how to add them to the RPP
2021 blocks library. The new block creation process consists of several steps:
2023 \item Addition of the new functionality to the RPP C support library.
2024 \item Definition of the block interface as a C MEX S-Function
2025 (Section~\ref{sec:block-definition-c})
2026 \item Compilation of the block definition to MEX file
2027 (Section~\ref{sec:c-mex-file})
2028 \item Creation of the code generator template (TLC) file
2029 (Section~\ref{sec:tlc-file-creation}).
2030 \item Creation of an S-Function block in the RPP block library
2031 and ``connecting'' this block with the C MEX and TLC files
2032 (Section~\ref{sec:creation-an-s})
2033 \item Optional: Creation of the mask for the new block. The mask
2034 specifies graphical representation of the block as well as
2035 the content of the block parameters dialog box.
2037 The following subsections demonstrate the procedure on an example of a simple user defined block.
2039 \subsection{Block interface definition in a C MEX S-function}
2040 \label{sec:block-definition-c}
2041 In order to use a custom block in the Simulink model, Simulink must know
2042 a certain number of block attributes, such as the number and type of
2043 block inputs, outputs and parameters. These attributes are specified
2044 by a set of functions in a C file. This C file gets compiled by the MEX
2045 compiler into a MEX file and is then used in an S-Function block.
2046 Simulink calls the functions in the C MEX file to obtain the above
2047 mentioned block attributes. In case of RPP blocks, no other
2048 functionality is present in the C MEX file.
2050 The C files are stored in \texttt{\repo/rpp/blocks} directory and are named as
2051 \texttt{sfunction\_$\langle$name$\rangle$.c}. Feel free to open any of
2052 the C files as a reference.
2054 Every C file that will be used with the RPP library should begin with
2055 a comment in YAML\footnote{\url{http://yaml.org/},
2056 \url{https://en.wikipedia.org/wiki/YAML}} format. The information in
2057 this block is used to automatically generate both printed and on-line
2058 documentation. Although this block is not mandatory, it is highly
2059 recommended, as it helps keeping the documentation consistent and
2062 The YAML documentation block may look like this:
2063 \begin{lstlisting}[language=c,basicstyle=\tt\footnotesize]
2067 Name: Name Of The Block
2073 - { name: "Some Input Signal", type: "bool" }
2076 - { name: "Some Output Signal", type: "bool" }
2080 # Description and Help is in Markdown mark-up
2083 This is a stub of an example block.
2087 This block is a part of an example about how to create
2088 new Matlab Simulink blocks for RPP board.
2092 RPP API functions used:
2100 Following parts are obligatory and the block will not work without them. It starts with a
2101 definition of the block name and inclusion of a common source file:
2103 \begin{lstlisting}[language=c]
2104 #define S_FUNCTION_NAME sfunction_myblock
2108 To let Simulink know the type of the inputs, outputs and how many parameters
2109 will the block have, the \texttt{mdlInitializeSizes()} function has to be defined like this:
2111 \begin{lstlisting}[language=c]
2112 static void mdlInitializeSizes(SimStruct *S)
2114 /* The block will have no parameters. */
2115 if (!rppSetNumParams(S, 0)) {
2118 /* The block will have one input signal. */
2119 if (!ssSetNumInputPorts(S, 1)) {
2122 /* The input signal will be of type boolean */
2123 rppAddInputPort(S, 0, SS_BOOLEAN);
2124 /* The block will have one output signal */
2125 if (!ssSetNumOutputPorts(S, 1)) {
2128 /* The output signal will be of type boolean */
2129 rppAddOutputPort(S, 0, SS_BOOLEAN);
2131 rppSetStandardOptions(S);
2135 The C file may contain several other optional functions definitions for parameters check,
2136 run-time parameters definition and so on. For information about those functions refer the comments
2137 in the header.c file, trailer.c file and documentation of Simulink S-Functions.
2139 The minimal C file compilable into C MEX has to contain following
2140 macros to avoid linker error messages about some of the optional
2141 functions not being defined:
2142 \begin{lstlisting}[language=c]
2143 #define COMMON_MDLINITIALIZESAMPLETIMES_INHERIT
2144 #define UNUSED_MDLCHECKPARAMETERS
2145 #define UNUSED_MDLOUTPUTS
2146 #define UNUSED_MDLTERMINATE
2149 Every C file should end by inclusion of a common trailer source file:
2151 \begin{lstlisting}[language=c]
2152 #include "trailer.c"
2155 \subsection{C MEX file compilation}
2156 \label{sec:c-mex-file}
2157 In order to compile the created C file, the development environment
2158 has to be configured first as described in
2159 Section~\ref{sec-matlab-simulink-usage}.
2161 All C files in the directory \texttt{\repo/rpp/blocks} can be compiled
2162 into C MEX by running script
2163 \texttt{\repo/rpp/blocks/compile\_blocks.m} from Matlab command
2164 prompt. If your block requires some special compiler options, edit the
2165 script and add a branch for your block.
2167 To compile only one block run the \texttt{mex sfunction\_myblock.c}
2168 from Matlab command prompt.
2170 \subsection{TLC file creation}
2171 \label{sec:tlc-file-creation}
2172 The TLC file is a template used by the code generator to generate the
2173 C code for the RPP board. The TLC files are stored in
2174 \texttt{\repo/rpp/blocks/tlc\_c} folder and their names must be the
2175 same (except for the extension) as the names of the corresponding
2176 S-Functions, i.e. \texttt{sfunction\_$\langle$name$\rangle$.tlc}. Feel
2177 free to open any of the TLC files as a reference.
2179 TLC files for RPP blocks should contain a header:
2180 \begin{lstlisting}[language=c]
2181 %implements sfunction_myblock "C"
2182 %include "common.tlc"
2185 Code Generator expects several functions to be implemented in the TLC file. The functions are not obligatory, but most of the blocks will probably need them:
2187 \item BlockTypeSetup
2188 \item BlockInstanceSetup
2193 For detailed description about each one of those functions, refer to
2194 \cite{targetlanguagecompiler2013}. A simple TLC file, which generates
2195 some code may look like this:
2196 \begin{lstlisting}[language=c]
2197 %implements sfunction_myblock "C"
2198 %include "common.tlc"
2200 %function BlockTypeSetup(block, system) void
2201 %% Ensure required header files are included
2202 %<RppCommonBlockTypeSetup(block, system)>
2203 %<LibAddToCommonIncludes("rpp/sci.h")>
2206 %function Outputs(block, system) Output
2207 %if !SLibCodeGenForSim()
2208 %assign in_signal = LibBlockInputSignal(0, "", "", 0)
2209 %assign out_signal = LibBlockOutputSignal(0, "", "", 0)
2211 %<out_signal> = !%<in_signal>;
2212 rpp_sci_printf("Value: %d\r\n", %<in_signal>);
2218 The above template causes the generated code to contain
2219 \texttt{\#include "rpp/sci.h"} line and whenever the block is
2220 executed, its output will be the negation of its input and the value
2221 of the input signal will be printed to the serial line.
2223 \subsection{Creation of an S-Function block in the RPP block library}
2224 \label{sec:creation-an-s}
2225 User defined Simulink blocks can be included in the model as
2226 S-Function blocks. Follow this procedure to create a new block in the
2229 \item Create a new Simulink library by selecting
2230 \textsc{File$\rightarrow$New$\rightarrow$Library} and save it as
2231 \texttt{\repo\-/rpp/blocks/rpp\_$\langle$name$\rangle$.slx}.
2232 Alternatively, open an existing library.
2233 \item In case of opening an existing library, unlock it for editing by
2234 choosing \textsc{Diagram$\rightarrow$Unlock Library}.
2235 \item Open a Simulink Library Browser
2236 (\textsc{View$\rightarrow$Library Browser}) open
2237 \textsc{Simulink$\rightarrow$User-Defined Functions} and drag the
2238 \textsc{S-Function} block into the newly created library.
2239 \item Double click on the just created \textsc{S-Function} block and
2240 fill in the \textsc{S-function name} field. Put there the name
2241 (without the extension) of the created C MEX S-Function, e.g.
2242 sfunction\_myblock. The result should like like in
2243 Figure~\ref{fig-simulink_s_fun_cfg}.
2244 \begin{figure}[h]\begin{center}
2246 \includegraphics[scale=.45]{images/simulink_s_fun_config.png}
2247 \caption{Configuration dialog for user defined S-function.}
2248 \label{fig-simulink_s_fun_cfg}
2249 \end{center}\end{figure}
2250 \item If your block has some parameters, write their names (you can
2251 choose them arbitrarily) in the \textsc{S-function parameters}
2252 field, separated by commas. \label{item:1}
2253 \item Now you should see the new Simulink block with the right number
2254 of inputs and outputs.
2255 \item Optional: Every user-defined block can have a \emph{mask}, which
2256 provides some useful information about the name of the block,
2257 configuration dialog for parameters and names of the IO signals. The
2258 block can be used even without the mask, but it is not as user
2259 friendly as with proper mask. Right-click the block and select
2260 \textsc{Mask$\rightarrow$Create Mask...}. In the definition of
2261 parameters, use the same names as in step~\ref{item:1}. See
2262 \cite[Section ``Block Masks'']{mathworks13:simul_2013b} for more
2264 \item Save the library and run \texttt{rpp\_setup} (or just
2265 \texttt{rpp\_generate\_lib}) from Matlab command line to add the newly
2266 created block to RPP block library (\texttt{rpp\_lib.slx}).
2269 Now, you can start using the new block in Simulink models as described
2270 in Section~\ref{sec-crating-new-model}.
2273 \section{Demos reference}
2274 The Simulink RPP Demo Library is a set of Simulink models that use blocks from
2275 the Simulink RPP Block Library and generates code using the Simulink RPP Target.
2277 This demos library is used as a test suite for the Simulink RPP Block Library
2278 but they are also intended to show basic programs built using it. Because of
2279 this, the demos try to use more than one
2280 type of block and more than one block per block type.
2282 In the reference below you can find a complete description for each of the demos.
2284 \subsection{ADC demo}
2285 \begin{figure}[H]\begin{center}
2287 \includegraphics[scale=.45]{images/demo_adc.png}
2288 \caption{Example of the usage of the Analog Input blocks for RPP.}
2289 \end{center}\end{figure}
2291 \textbf{Description:}
2293 Demostrates how to use Analog Input blocks in order to measure voltage. This demo
2294 measures voltage on every available Analog Input and prints the values on the
2297 \subsection{Simple CAN demo}
2298 \begin{figure}[H]\begin{center}
2300 \includegraphics[scale=.45]{images/demo_simple_can.png}
2301 \caption{The simplest CAN demonstration.}
2302 \end{center}\end{figure}
2304 \textbf{Description:}
2306 The simplest possible usage of the CAN bus. This demo is above all designed for
2307 testing the CAN configuration and transmission.
2309 \subsection{CAN transmit}
2310 \begin{figure}[H]\begin{center}
2312 \includegraphics[scale=.45]{images/demo_cantransmit.png}
2313 \caption{Example of the usage of the CAN blocks for RPP.}
2314 \end{center}\end{figure}
2316 \textbf{Description:}
2318 Demostrates how to use CAN Transmit blocks in order to:
2321 \item Send unpacked data with data type uint8, uint16 and uint32.
2322 \item Send single and multiple signals packed into CAN\_MESSAGE by CAN Pack block.
2323 \item Send a message as extended frame type to be received by CAN Receive
2324 configured to receive both, standard and extended frame types.
2327 Demostrates how to use CAN Receive blocks in order to:
2330 \item Receive unpacked data of data types uint8, uint16 and uint32.
2331 \item Receive and unpack received CAN\_MESSAGE by CAN Unpack block.
2332 \item Configure CAN Receive block to receive Standard, Extended and both frame types.
2333 \item Use function-call mechanism to process received messages
2336 \subsection{Continuous time demo}
2337 \begin{figure}[H]\begin{center}
2339 \includegraphics[scale=.45]{images/demo_continuous.png}
2340 \caption{The demonstration of contiuous time.}
2341 \end{center}\end{figure}
2343 \textbf{Description:}
2345 This demo contains two integrators, which are running at continuous time. The main goal
2346 of this demo is to verify that the generated code is compilable and is working even when
2347 discrete and continuous time blocks are combined together.
2349 \subsection{Simulink Demo model}
2350 \begin{figure}[H]\begin{center}
2352 \includegraphics[scale=.45]{images/demo_board.png}
2353 \caption{Model of the complex demonstration of the boards peripherals.}
2354 \end{center}\end{figure}
2356 \textbf{Description:}
2358 This model demonstrates the usage of RPP Simulink blocks in a complex and interactive
2359 application. The TI HDK kit has eight LEDs placed around the MCU. The application
2360 rotates the light around the MCU in one direction. Every time the user presses the button
2361 on the HDK, the direction is switched.
2363 The state of the LEDs is sent on the CAN bus as a message with ID 0x1. The button can
2364 be emulated by CAN messages with ID 0x0. The message 0x00000000 simulates button release
2365 and the message 0xFFFFFFFF simulates the button press.
2367 Information about the state of the application are printed on the Serial Interface.
2369 \subsection{Echo char}
2370 \begin{figure}[H]\begin{center}
2372 \includegraphics[scale=.45]{images/demo_echo_char.png}
2373 \caption{Echo Character Simulink demo for RPP.}
2374 \end{center}\end{figure}
2376 \textbf{Description:}
2378 This demo will echo (print back) any character received through the Serial Communication
2379 Interface (115200-8-N-1).
2381 Note that the send subsystem is implemented a as \textit{triggered} subsystem and will execute only
2382 if data is received, that is, Serial Receive output is non-negative. Negative values are errors.
2384 \subsection{GIO demo}
2385 \begin{figure}[H]\begin{center}
2387 \includegraphics[scale=.45]{images/demo_gio.png}
2388 \caption{Demonstration of DIN and DOUT blocks}
2389 \end{center}\end{figure}
2391 \textbf{Description:}
2393 The model demonstrates how to use the DIN blocks and DOUT blocks, configured in every mode. The DOUTs
2394 are pushed high and low with period 1 second. The DINs are reading inputs and printing the values
2395 on the Serial Interface with the same period.
2397 \subsection{Hello world}
2398 \begin{figure}[H]\begin{center}
2400 \includegraphics[scale=.45]{images/demo_hello_world.png}
2401 \caption{Hello World Simulink demo for RPP.}
2402 \end{center}\end{figure}
2404 \textbf{Description:}
2406 This demo will print \texttt{Hello Simulink} to the Serial Communication Interface (115200-8-N-1) one
2407 character per second. The output speed is driven by the Simulink model step which is set to one
2410 \subsection{Multi-rate single thread demo}
2411 \label{sec:mult-single-thre}
2413 \begin{figure}[H]\begin{center}
2415 \includegraphics[scale=.45]{images/demo_multirate_st.png}
2416 \caption{Multi-rate singlet hread Simulink demo for RPP.}
2417 \end{center}\end{figure}
2419 \textbf{Description:}
2421 This demo will toggle LEDs on the Hercules Development Kit with
2422 different rate. This is implemented with multiple Simulink tasks, each
2423 running at different rate. In the generated code, these tasks are
2424 called from a singe thread and therefore no task can preempt another
2425 one. See Section \ref{sec-singlet-mode} for more details.
2427 The state of each LED is printed to the Serial Communication Interface
2428 (115200-8-N-1) when toggled.
2431 \begin{tabular}{lll}
2432 \rowcolor[gray]{0.9}
2433 LED & pin & rate [s] \\
2434 1 & NHET1\_25 & 0.3 \\
2435 2 & NHET1\_05 & 0.5 \\
2436 3 & NHET1\_00 & 1.0 \\
2438 \captionof{table}{LEDs connection and rate}
2439 \label{tab:multirate_st_led_desc}
2442 \subsection{Multi-rate MultiTasking demo}
2443 \label{sec:mult-multi-thre}
2445 \begin{figure}[H]\begin{center}
2447 \includegraphics[scale=.45]{images/demo_multirate_mt.png}
2448 \caption{Multi-rate MultiTasking Simulink demo for RPP.}
2449 \end{center}\end{figure}
2451 \textbf{Description:}
2453 This demo will toggle LEDs on the Hercules Development Kit with
2454 different rate. This is implemented with multiple Simulink tasks, each
2455 running at different rate. In the generated code, every subrate task
2456 runs in its own thread. See Section \ref{sec-multit-mode} for more details.
2458 The state of each LED is printed to the Serial Communication Interface
2459 (115200-8-N-1) when toggled.
2462 \begin{tabular}{lll}
2463 \rowcolor[gray]{0.9}
2464 LED & pin & rate [s] \\
2465 1 & NHET1\_25 & 0.3 \\
2466 2 & NHET1\_05 & 0.5 \\
2467 3 & NHET1\_00 & 1.0 \\
2469 \captionof{table}{LEDs connection and rate}
2470 \label{tab:multirate_mt_led_desc}
2475 \chapter{Command line testing tool}
2476 \label{chap-rpp-test-software}
2477 \section{Introduction}
2478 \label{sec-rpp-test-sw-intro}
2479 The \texttt{rpp-test-suite} is a RPP application developed testing and direct
2480 control of the RPP hardware. The test suite implements a command processor,
2481 which is listening for commands and prints some output related to the commands
2482 on the serial interface. The command processor is modular and each peripheral
2483 has its commands in a separate module.
2485 The command processor is implemented in \texttt{$\langle$rpp-test-sw$\rangle$/cmdproc} and commands
2486 modules are implemented in \texttt{$\langle$rpp-test-sw$\rangle$/commands} directory.
2488 The application enables a command processor using the SCI at
2489 \textbf{115200-8-N-1}. When the software starts, the received welcome message
2490 and prompt should look like:
2493 \ifx\tgtId\tgtIdTMSRPP
2495 Rapid Prototyping Platform v00.01-001
2496 Test Software version v0.2-261-gb6361ca
2502 Ti HDK \mcuname, FreeRTOS 7.0.2
2503 Test Software version eaton-0.1-beta-8-g91419f5
2504 CTU in Prague 10/2014
2509 Type in command help for a complete list of available command, or help command
2510 for a description of concrete command.
2512 \section{Compilation}
2513 \label{sec-rpp-test-sw-compilation}
2514 Before the Testing tool can be compiled, the RPP Library has to be built and the binary file \texttt{rpp-lib.lib} has to be present in the \texttt{\repo/rpp-lib/} directory. Once this requirement is fulfilled, there are two ways how to compile the Testing tool.
2516 \item Using a Code Composer Studio, which is described in Section \ref{sec-project-installation}. The procedure of downloading the firmware right from the CCS and running it on the hardware is described in Section \ref{sec-running-software-on-hw}.
2517 \item Using a make from a Linux terminal or gmake from a Windows command line. The procedure of how to download and run the binary on the hardware is described in Section \ref{sec-binary-file}.
2519 To build the Testing tool from Linux terminal run:
2520 \begin{lstlisting}[language=bash]
2525 or from Windows command line:
2527 \begin{lstlisting}[language=bash]
2529 "C:\ti\ccsv5\utils\bin\"gmake.exe
2532 On Windows \texttt{gmake.exe} supplied with CCS is used instead of
2536 \section{Commands description}
2538 This section contains the description of the available commands. The
2539 same description is also available in the program itself via the
2540 \texttt{help} command.
2542 \input{rpp-test-sw-cmds.tex}
2548 \textit{Analog to Digital Converter.} \newline{}
2549 Hardware circuitry that converts a continuous physical quantity (usually voltage) to a
2550 digital number that represents the quantity's amplitude.
2553 \textit{Analog Input.} \newline{}
2554 Mnemonic to refer to or something related to the analog input (ADC) hardware module.
2557 \textit{Analog Output.} \newline{}
2558 Mnemonic to refer to or something related to the analog output (DAC) hardware module.
2560 \item[API] \textit{Application Programming Interface}
2563 \textit{Controller Area Network.} \newline{}
2564 The CAN Bus is a vehicle bus standard designed to allow microcontrollers and devices to
2565 communicate with each other within a vehicle without a host computer.
2566 In this project it is also used as mnemonic to refer to or something related to the CAN
2569 \item[CCS] \textit{Code Composer Studio} \\
2570 Eclipse-based IDE provided by Texas Instruments.
2573 \textit{Code Generation Tools.} \newline{}
2574 Name given to the tool set produced by Texas Instruments used to compile, link, optimize,
2575 assemble, archive, among others. In this project is normally used as synonym for
2576 ``Texas Instruments ARM compiler and linker."
2579 \textit{Digital to Analog Converter.} \newline{}
2580 Hardware circuitry that converts a digital (usually binary) code to an analog signal
2581 (current, voltage, or electric charge).
2584 \textit{Digital Input.} \newline{}
2585 Mnemonic to refer to or something related to the digital input hardware module.
2588 \textit{Engine Control Unit.} \newline{}
2589 A type of electronic control unit that controls a series of actuators on an internal combustion
2590 engine to ensure the optimum running.
2593 \textit{Ethernet.} \newline{}
2594 Mnemonic to refer to or something related to the Ethernet hardware module.
2597 \textit{FlexRay.} \newline{}
2598 FlexRay is an automotive network communications protocol developed to govern on-board automotive
2600 In this project it is also used as mnemonic to refer to or something related to the FlexRay
2604 \textit{General Purpose Input/Output.} \newline{}
2605 Generic pin on a chip whose behavior (including whether it is an input or output pin) can be
2606 controlled (programmed) by the user at run time.
2609 \textit{H-Bridge.} \newline{}
2610 Mnemonic to refer to or something related to the H-Bridge hardware module. A H-Bridge is
2611 an electronic circuit that enables a voltage to be applied across a load in either direction.
2614 \textit{High-Power Output.} \newline{}
2615 Mnemonic to refer to or something related to the 10A, PWM, with current sensing, high-power
2616 output hardware module.
2619 \textit{Integrated Development Environment.} \newline{}
2620 An IDE is a Software application that provides comprehensive facilities to computer programmers
2621 for software development.
2624 \textit{Legacy Code Tool.} \newline{}
2625 Matlab tool that allows to generate source code for S-Functions given the descriptor of a C
2629 \textit{Model-Based Design.} \newline{}
2630 Model-Based Design (MBD) is a mathematical and visual method of addressing problems associated
2631 with designing complex control, signal processing and communication systems. \cite{modelbasedwiki2013}
2634 \textit{Matlab Executable.} \newline{}
2635 Type of binary executable that can be called within Matlab. In this document the common term
2636 used is `C MEX S-Function", which means Matlab executable written in C that implements a system
2640 \textit{Pulse-width modulation.} \newline{}
2641 Technique for getting analog results with digital means. Digital control is used to create a
2642 square wave, a signal switched between on and off. This on-off pattern can simulate voltages
2643 in between full on and off by changing the portion of the time the signal spends on versus
2644 the time that the signal spends off. The duration of ``on time" is called the pulse width or
2645 \textit{duty cycle}.
2647 \item[RPP] \textit{Rapid Prototyping Platform.} \newline{} Name of the
2648 developed platform, that includes both hardware and software.
2651 \textit{Serial Communication Interface.} \newline{}
2652 Serial Interface for communication through hardware's UART using communication standard RS-232.
2653 In this project it is also used as mnemonic to refer to or something related to the Serial
2654 Communication Interface hardware module.
2657 \textit{SD-Card.} \newline{}
2658 Mnemonic to refer to or something related to the SD-Card hardware module.
2661 \textit{SD-RAM.} \newline{}
2662 Mnemonic to refer to or something related to the SD-RAM hardware module for logging.
2665 \textit{Target Language Compiler.} \newline{}
2666 Technology and language used to generate code in Matlab/Simulink.
2669 \textit{Universal Asynchronous Receiver/Transmitter.} \newline{}
2670 Hardware circuitry that translates data between parallel and serial forms.
2677 % LocalWords: FreeRTOS RPP POSIX microcontroller HalCoGen selftests
2678 % LocalWords: MCU UART microcontrollers DAC CCS simulink SPI GPIO
2679 % LocalWords: IOs HDK TMDSRM