]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
doc: Reflect change of FreeRTOS version
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 27 Aug 2015 05:15:29 +0000 (07:15 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 27 Aug 2015 05:15:29 +0000 (07:15 +0200)
doc/rpp_simulink.tex

index 565f6e77aafe53e4bd507f466f3e4d6a7d2058c8..c9613eb1fe5f6c55a8ac30568669d9c42b00434b 100644 (file)
@@ -323,7 +323,7 @@ The rest of the section provides basic description of each layer.
 
 \subsection{Operating System layer}
 \label{sec-operating-system-layer}
-This is an interchangeable operating system layer containing the
+This is an interchangeable operating system (OS) layer containing the
 FreeRTOS source files. The system can be easily replaced by another
 version. For example it is possible to compile the RPP library for
 Linux (using POSIX version of the FreeRTOS), which can be desirable
@@ -332,20 +332,15 @@ for some testing. The source files can be found in the
 
 The following FreeRTOS versions are distributed:
 \begin{description}
-       \item[6.0.4\_posix] POSIX version, usable for compilation of the library
-for Linux system.
-       \item[7.0.2] Preferred version of the FreeRTOS, distributed by
-Texas Instruments. This version has been tested and is used in the current
-version of the library.
-       \item[7.4.0] Newest version distributed by the Texas Instruments.
-       \item[7.4.2] Newer version available from FreeRTOS pages. Slightly
-modified to run on \tgname{} MCU.
+\item[6.0.4\_posix] POSIX version, usable for compilation of the
+  library for Linux system.
+\item[8.2.2] Currently used FreeRTOS version. This is the version
+  downloaded from FreeRTOS.org with changes in directory structure.
+  Namely, include files have added the \emph{os/} prefix and platform
+  dependent code (portable) for \tgname{} is copied to the same
+  directory as platform independent code.
 \end{description}
 
-\noindent
-Both 7.4.x version were tested and work, but the testing was not so
-extensive as with the used 7.0.2 version.
-
 \subsection{System Layer} 
 \label{sec-system-layer}
 This layer contains system files with data types definitions, clock definitions,
@@ -747,7 +742,7 @@ Release
 
 \item Configure the compiler \#include search path to contain
   project's \texttt{include} directory, \penalty-100
-  \texttt{\$\{RPP\_LIB\_ROOT\}/os/7.0.2/include} and
+  \texttt{\$\{RPP\_LIB\_ROOT\}/os/8.2.2/include} and
   \texttt{\$\{RPP\_LIB\_ROOT\}/rpp/include}, in that order.
 
   \includegraphics[scale=.43]{images/base_5.png}
@@ -1535,7 +1530,7 @@ main steps.
        \begin{compactitem}
     \item Configure include search path to contain the directory of
       used FreeRTOS version, e.g.
-      \texttt{\repo/os/7.0.2/include}. See Section
+      \texttt{\repo/os/8.2.2/include}. See Section
       \ref{sec-software-architecture}.
     \item Include \texttt{rpp/rpp.h} header file or just the needed
       peripheral specific header files such as \texttt{rpp/can.h}.
@@ -1585,7 +1580,7 @@ main_page.dox
 \section{Changing operating system}
 \label{sec-changing-os}
 The C Support Library contains by default the FreeRTOS operating
-system in version 7.0.2. This section describes what is necessary to
+system in version 8.2.2. This section describes what is necessary to
 change in the library and other packages in order to replace the
 operating system.
 
@@ -1600,7 +1595,7 @@ Library, modify the \texttt{\repo/rpp/lib/rpp/include/base.h} file to include
 the operating system header files.
 
 Current implementation for FreeRTOS includes a header file
-\texttt{\repo/rpp/lib/os/\-7.0.2\-include/os.h}, which
+\texttt{\repo/rpp/lib/os/\-8.2.2\-include/os.h}, which
 contains all necessary declarations and definitions for the FreeRTOS.
 We suggest to provide a similar header file for your operating system as
 well.