]> rtime.felk.cvut.cz Git - pes-rpp/rpp-simulink.git/blobdiff - doc/rpp_simulink.tex
doc: Update description of library layers
[pes-rpp/rpp-simulink.git] / doc / rpp_simulink.tex
index 22bc0bfa328a9f74f3433c0a0ccf20d8798dd71a..37ba877b25cbe06c0027fbdc852ab53201c1a8fe 100644 (file)
@@ -161,6 +161,10 @@ Michal \textsc{Sojka}\\[\baselineskip]
                                            Added support for Eaton Hydraulics
                                            Controller board (TMS570LS1227).
            \\\hline
+
+           0.5.5 & 2015-08-27 & Sojka, Horn & rpp-lib: HAL merged into DRV
+                                              layer, FreeRTOS upgraded to version 8.2.2.
+           \\\hline
 \end{tabularx}
 
 \tableofcontents
@@ -323,7 +327,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 +336,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,
@@ -356,39 +355,17 @@ be found in \texttt{$\langle$rpp\_lib$\rangle$/rpp/include/sys}
 folder.
 
 Large part of this layer was generated by the HalCoGen tool (see
-Section~\ref{sec-halcogen}).
-
-\subsection{HAL abstraction layer}
-\label{sec-hal-abstraction-layer}
-Hardware Abstraction Layer (HAL) provides an abstraction over the real
-hardware. For example imagine an IO port with 8 pins. First four pins
-are connected directly to the GPIO pins on the MCU, another four pins
-are connected to an external integrated circuit, communicating with
-the MCU via SPI. This layer allows to control the IO pins
-independently of how that are connected to the MCU, providing a single
-unified API.
-
-Note that this functionality is not needed in the current version for
-\tgtBoardName, because all IOs are controlled directly by GPIO pins.
-
-As a result, the higher layers do not have to know anything about the
-wiring of the peripherals, they can just call read, write or configure
-function with a pin name as a parameter and the HAL handles all the
-details.
-
-The source files can be found in
-\texttt{$\langle$rpp\_lib$\rangle$/rpp/src/hal} and the header files can
-be found in \texttt{$\langle$rpp\_lib$\rangle$/rpp/include/hal} folder.
+Section~\ref{sec-halcogen}). Some files were then modified by hand.
 
 \subsection{Drivers layer} 
 \label{sec-drivers-layer}
 The Drivers layer contains code for controlling the RPP peripherals.
 Typically, it contains code implementing IRQ handling, software
 queues, management threads, etc. The layer benefits from the lower
-layers thus it is not too low level, but still there are some
+layer thus it is not too low level, but still there are some
 peripherals like ADC, which need some special procedure for
 initialization and running, that would not be very intuitive for the
-user.
+typical end user.
 
 The source files can be found in
 \texttt{$\langle$rpp\_lib$\rangle$/rpp/src/drv} and the header files can
@@ -769,7 +746,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}
@@ -1557,7 +1534,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}.
@@ -1607,7 +1584,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.
 
@@ -1622,7 +1599,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.