]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
doc add sections in Getting Started chapter
authorMichal Horn <hornmich@fel.cvut.cz>
Tue, 2 Dec 2014 12:10:41 +0000 (13:10 +0100)
committerMichal Horn <hornmich@fel.cvut.cz>
Tue, 2 Dec 2014 12:10:41 +0000 (13:10 +0100)
doc/images/debug_configuration_main.png [new file with mode: 0644]
doc/images/debug_configuration_program.png [new file with mode: 0644]
doc/images/new_empty_project.png [new file with mode: 0644]
doc/rpp_simulink.tex

diff --git a/doc/images/debug_configuration_main.png b/doc/images/debug_configuration_main.png
new file mode 100644 (file)
index 0000000..848e2d7
Binary files /dev/null and b/doc/images/debug_configuration_main.png differ
diff --git a/doc/images/debug_configuration_program.png b/doc/images/debug_configuration_program.png
new file mode 100644 (file)
index 0000000..6c7d8d3
Binary files /dev/null and b/doc/images/debug_configuration_program.png differ
diff --git a/doc/images/new_empty_project.png b/doc/images/new_empty_project.png
new file mode 100644 (file)
index 0000000..b2c9bc6
Binary files /dev/null and b/doc/images/new_empty_project.png differ
index 89e665b7aad3c89f83835cdf072fac4004964fb6..cccbf258c248dcdf192c6bbbb836cc3a786b2433 100644 (file)
@@ -714,6 +714,64 @@ void vApplicationStackOverflowHook(xTaskHandle xTask,
 
 
 \subsection{Running software on the HW}
+\label{sec-running-software-on-hw}
+\subsubsection{Code Composer Studio Project}
+\label{sec-ccs-run-project}
+When the application is distributed as a CCS project, you have to open the project in the CCS as following the procedure in Section. Once the project is opened and build, it can be easily downloaded to the target hardware with the following procedure;
+
+\begin{enumerate}
+       \item Connect the Texas Instruments XDS100v2 USB JTAG emulator to the JTAG port (see Figure \ref{pinout}, port 1).
+       \item Connect a USB cable to the XDS100v2 USB emulator and the development computer.
+       \item Plug in the power supply.
+       \item In the Code Composer Studio click on the Run$\rightarrow$Debug. The project will optionally build and the download process will start. The Code Composer Studio will switch into debug mode, when the download is finished.
+       \item Run the program by clicking on the Run button, with the green arrow.
+\end{enumerate}
+
+\subsubsection{Binary File}
+\label{sec-binary-file}
+If tha application is distributed as a binary file, without source codes and CCS project files, you can download and run just the binary file by creating a new empty CCS project and configuring the debug session according the following procedure:
+
+\begin{enumerate}
+       \item In Code Composer Studio click on File$\rightarrow$New$\rightarrow$CCS Project.
+       \item In the dialog window, type in a project name, for example myBinaryLoad, Select Device variant (ARM, Cortex R, TMS570LS3137, Texas Instruments XDS100v2 USB Emulator) and select project template to Empty Project. The filled dialog should look like on the Figure \ref{fig-new-empty-project}
+       \item Click on the Finish button and new empty project will be created.
+       \item In the Project Explorer click on the project with a right mouse button and in the context menu select Debug as$\rightarrow$Debug configuration.
+       \item Click on a button New launch configuration
+       \item Rename the New\_configuration, for example to myConfiguration.
+       \item Select configuration target file by clicking the File System button, finding and selecting the TMS5703137.ccxml file. The result should look like on the Figure \ref{fig-debug-conf-main-diag}.
+       \item On the program pane select the binary file you want to download to the board. Click on the File System button, find and select the binary file. rpp-test-sw.out for example. The result should look like on the Figure \ref{fig-debug-conf-program-diag}.
+       \item You may also tune the target configuration like in the Section TODO: fill link to the section.
+       \item Finish the configuration by clickiing on the Apply button and download the code by clicking on the Debug button. You can later invoke the download also from the Run$\rightarrow$Debug CCS menu. You may not need to create more Debug configurations and CCS empty project as you can easily change the binary file in the Debug configuration to load different binary file.
+\end{enumerate}
+
+\subsubsection{Target configuration}
+\label{sec-target-configuration}
+Default target configuration erases the whole Flash memory, before downloading the code. This is however not needed in most cases. You may disable this feature by the following procedure:
+\begin{enumerate}
+       \item Right click on the project name ini the Project Browser
+       \item Select Debug as$\rightarrow$Debug Configurations
+       \item In the dialog window select Targe pane.
+       \item In the Flash Settings, Erase Options select Necessary sectors only.
+       \item Save the configuration by clicking on the Apply button and close the dialog.
+\end{enumerate}
+
+\begin{center}
+       \includegraphics[scale=0.66]{images/new_empty_project.png}
+       \captionof{figure}{New empty project dialog}
+       \label{fig-new-empty-project}
+\end{center}
+
+\begin{center}
+       \includegraphics[scale=0.66]{images/debug_configuration_main.png}
+       \captionof{figure}{Debug Configuration Main dialog}
+       \label{fig-debug-conf-main-diag}
+\end{center}
+
+\begin{center}
+       \includegraphics[scale=0.66]{images/debug_configuration_program.png}
+       \captionof{figure}{Debug Configuration Program dialog}
+       \label{fig-debug-conf-program-diag}
+\end{center}
 
 \section{Matlab Simulink usage}
 
@@ -753,6 +811,15 @@ For new models see \htmladdnormallink{Target Reference}{\#target\_reference} sec
 
 
 \subsection{Working with demo models}
+\label{sec-openning-demo-models}
+The demo models are available from the directory $\langle$rpp-simulink-root$\rangle$/rpp/demos. To asscess the demo models for reference or for downloading to the RPP board you have only to change the directoru to the one, containig the desired demo. For example to open the cantransmit demo you have to type these commands into the Matlab command line:
+
+\begin{verbatim}
+cd <rpp-simulink-root>/rpp/demos
+open('cantransmit.slx')
+\end{verbatim}
+
+The same procedure can be used to openning any other models.
 
 \subsection{Creating new model}
 \begin{enumerate}
@@ -819,10 +886,39 @@ The new Simulink model needs to be configured in the following way:
 
 
 \subsection{Running model on the HW}
+\label{sec-running-model-on-hw}
+To run the model on the target RPP hardware you have to enable the download feature and build the model by following this procedure:
+\begin{enumerate}
+       \item Open the model you want to run (See Section \ref{sec-openning-demo-models}.)
+       \item Click on Simulation$\rightarrow$Model Configuration Parameters.
+       \item In the Code Generation$\rightarrow$RPP Options pane check Download compiled binary to RPP checkbox.
+       \item Click on OK button, connect the target HW to the computer like in the Section \ref{sec-ccs-run-project} and build the model. If the build ends with a success, the download process will start and once the downloading is finished, the application will run immediatelly.
+\end{enumerate}
 
+The code downloading is supported for Windows and Linux development systems. If you are using Linux, you may also try to use the OpenOCD by checking Use OpenOCD to download the compiled binary checkbox in addition. Refer 
+
+\begin{verbatim}
+http://rtime.felk.cvut.cz/hw/index.php/TMS570LS3137#OpenOCD_setup_and_Flashing
+\end{verbatim}
+fore more information about the OpenOCD configuration.
 \section{Configuring serial interface}
+\label{sec-configuration-serial-interface}
+The main interface for communicating with the RPP board is the serial interface. The application may define its own interface settings, but the following settings is the default one:
+\begin{itemize}
+       \item Baudrate: 115200
+       \item Parity: none
+       \item Bits: 8
+       \item Stopbits: 1
+       \item Flow control: none
+\end{itemize}
+
+Use GtkTerm in Linux or Bray Terminal for accessing the serial interface. See Section for referenc about the position of the serial interface connector on the RPP board.
 
 \section{Bug reporting}
+\label{sec-bug-reporting}
+
+TODO: implement
 
 \chapter{C Support Library}