Improved documentation on the RPP Target library.

Finished repository layout for this subtree.

diff --git a/rpp/blocks/slblocks.m b/rpp/blocks/slblocks.m
index 672f74d35b2f56d37d7e4429805397c32f5010c8..4e044f2d73b6d2c4ad910715c136aaea5fbc3892 100644 (file)
--- a/rpp/blocks/slblocks.m
+++ b/rpp/blocks/slblocks.m
@@ -1,4 +1,5 @@
 function blkStruct = slblocks
+
 % Copyright (C) 2013 Czech Technical University in Prague
 %
 % Authors:

diff --git a/rpp/rpp/README.txt b/rpp/rpp/README.txt
index 62c6f326867a4249e7b4ada63eff67e97b1cc0dd..a4fbba03472805aa4124df7196ccfca713e0c571 100644 (file)
--- a/rpp/rpp/README.txt
+++ b/rpp/rpp/README.txt
@@ -44,7 +44,7 @@ machine using the CCS Linux version.
         http://processors.wiki.ti.com/index.php/TI_Compiler_Information#Compiler_Manuals
 
     loadti.sh reference documentation:
-        loadti.sh file itself, has great documentation on arguments and function.
+        <css>/ccs_base/scripting/examples/loadti/readme.txt
         http://processors.wiki.ti.com/index.php/Loadti
 
 Notes on installing Code Composer Studio on Ubuntu 64bits:
@@ -64,8 +64,9 @@ Notes on installing Code Composer Studio on Ubuntu 64bits:
         Edit <ccs>/ccsv5/eclipse/plugins/com.ti.ccstudio.branding_<your version number>/plugin_customization.ini
         And change key org.eclipse.ui/showIntro to false.
 
-    Choose "FREE License - for use with XDS100 JTAG Emulators" on the licensing options.
-    This target is configured to upload using this particular hardware.
+    Choose "FREE License - for use with XDS100 JTAG Emulators" on the licensing
+    options. This target is configured to download to the board using this
+    particular hardware.
 
     You may create a symbolic link and a desktop entry:
 
@@ -117,75 +118,135 @@ Library file layout:
         CCS paths, add paths to Matlab path and build S-Function blocks for
         user's arquitecture (using Matlab's mex command line tool).
 
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1137
+
 
     -> rpp.tlc
 
-        Short description.
+        Embedded real-time system target file for RPP.
+
+        This file is the system target file (STF), or target manifest file.
+        Functions of the STF include:
+
+            - Making the target visible in the System Target File Browser.
+            - Definition of code generation options for the target (inherited
+              and target-specific).
+            - Providing an entry point for the top-level control of the TLC code
+              generation process.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1129 and _1144_
 
 
     -> rpp.tmf
 
-        Short description.
+        Embedded Coder Template Makefile.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        This is just standard Embedded Coder Template Makefile, provided by
+        Matlab. It was slightly to support armcl particularities and added
+        template rules for assembler files, which are included by the
+        rpp_lib_support.m function to provide support for the OS and RPP
+        library.
+
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1130 and _1183_
 
 
     -> rpp_download.m
 
-        Short description.
+        Code download utility for Simulink RPP Target.
+
+        This function is optionally executed at the end of the build process
+        if it is successful and the user selected "Download compiled binary to
+        RPP" option on the build configuration panel. This function calls
+        loadti.sh script with the generated binary and using configuration for
+        the XDS100v2 JTAG Emulators. The board should be powered and correctly
+        wired. See "Wiring the RPP board for programming" on the main
+        documentation files.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        Reference:
+            Readme file in <css>/ccs_base/scripting/examples/loadti/readme.txt
+            loadti utility wiki at http://processors.wiki.ti.com/index.php/Loadti
 
 
     -> rpp_file_process.tlc
 
-        Short description.
+        Code generation custom file processing template.
+
+        This file should decide which "main" to generate according to
+        configuration, in particular which mode, Single Tasking or Multitasking,
+        is chosen. The RPP Target ignores this settings because it uses a
+        tasking system based on tasking features provided by FreeRTOS. In
+        consequence is only a wrapper to the "Single Tasking" main, which
+        clearly is not for single tasking.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        Reference:
+            <repo>/refs/ecoder_ug.pdf p. 556
+            <repo>/refs/ecoder_ref.pdf p. 1347
 
 
     -> rpp_lib_support.m
 
-        Short description.
+        Simulink support for RPP library and operating system setup.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        This file adds the source code from the RPP library and operating
+        to the build.
+
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1058
+            <repo>/refs/rtw_ref.pdf p. 56
+            Readme file in <repo>/rpp/lib/rpp/doc/os.txt
 
 
     -> rpp_make_rtw_hook.m
 
-        Short description.
+        Build process hooks file.
+
+        This file is hook file that invoke target-specific functions or
+        executables at specified points in the build process. In particular,
+        this file handle the copying of required files before the compilation
+        stage.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1066-1072 and 1131
 
 
     -> rpp_select_callback_handler.m
 
-        Short description.
+        RPP Target select callback handler.
+
+        This callback function is triggered whenever the user selects the target
+        in the System Target File Browser. Default values for Simulation and
+        configurations parameters are set. Some options are disabled if it is
+        not allowed to be changed by user.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        Reference:
+            <repo>/refs/rtw_ug.pdf p. 1211
 
 
     -> rpp_srmain.tlc
 
-        Short description.
+        Custom file processing to generate a "main" file.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        This file generated the "main" file for the RPP target on top of the RPP
+        library and the FreeRTOS operating system. The "sr" is standard to mark
+        Single Tasking main, which is not the case. See rpp_file_process.m
+        description above for more information about this.
+
+        Reference:
+            Example in <matlab>/rtw/c/tlc/mw/bareboard_srmain.tlc
 
 
     -> target_tools.mk
 
-        Short description.
+        Makefile for CCS (armcl) toolchain support.
+
+        This file set variables to CCS tools to support build for this toolchain.
+        This file is included by rpp.tmf before declaring the rules for source
+        code.
 
-        Lorens ipsum large description.
-        Reference: <Jam>
+        Reference:
+            "Include a tool specification settings" comment block in rpp.tmf
+            Compiler options documentation available in armcl.pdf
 

diff --git a/rpp/rpp/rpp.tlc b/rpp/rpp/rpp.tlc
index 4a1638b5d11c5ead7eb1bc7c83b354155f36d421..afe80e9cdea23324fcaa6060378010d9217f0375 100644 (file)
--- a/rpp/rpp/rpp.tlc
+++ b/rpp/rpp/rpp.tlc
@@ -22,6 +22,15 @@
 %% Abstract:
 %%     Embedded real-time system target file for RPP.
 %%
+%%     This file is the system target file (STF), or target manifest file.
+%%     Functions of the STF include:
+%%
+%%          - Making the target visible in the System Target File Browser.
+%%          - Definition of code generation options for the target (inherited
+%%            and target-specific).
+%%          - Providing an entry point for the top-level control of the TLC code
+%%            generation process.
+%%
 %% References:
 %%     rtw_ug.pdf p. 1129 and _1144_
 

diff --git a/rpp/rpp/rpp_download.m b/rpp/rpp/rpp_download.m
index b14e2f28c32dfa97d3e20e21954639975b65969e..4a47228825f39397003bf68229e73ddf74fdefe9 100644 (file)
--- a/rpp/rpp/rpp_download.m
+++ b/rpp/rpp/rpp_download.m
@@ -20,6 +20,12 @@
 % Abstract:
 %     Code download utility for Simulink RPP Target.
 %
+%     This function is optionally executed at the end of the build process
+%     if it is successful and the user selected "Download compiled binary to
+%     RPP" option on the build configuration panel. This function calls
+%     loadti.sh script with the generated binary and using configuration for
+%     the XDS100v2 JTAG Emulators.
+%
 % References:
 %     loadti utility wiki at http://processors.wiki.ti.com/index.php/Loadti
 %     Readme file in <cssroot>/ccs_base/scripting/examples/loadti/readme.txt

diff --git a/rpp/rpp/rpp_make_rtw_hook.m b/rpp/rpp/rpp_make_rtw_hook.m
index 0e933ed41740f7acef40fb896e204299101699aa..906d352358d885cf0d7575885f6f645a54a77750 100644 (file)
--- a/rpp/rpp/rpp_make_rtw_hook.m
+++ b/rpp/rpp/rpp_make_rtw_hook.m
@@ -18,6 +18,8 @@
 %
 % File : rpp_make_rtw_hook.m
 % Abstract:
+%     Build process hooks file.
+%
 %     This file is hook file that invoke target-specific functions or
 %     executables at specified points in the build process. In particular, this
 %     file handle the copying of required files before the compilation stage.

diff --git a/rpp/rpp/rpp_select_callback_handler.m b/rpp/rpp/rpp_select_callback_handler.m
index aec07b3638703d7738943b3116c9694a08f61253..9f043a47203c5749605a215cf716a6873fbcc8fd 100644 (file)
--- a/rpp/rpp/rpp_select_callback_handler.m
+++ b/rpp/rpp/rpp_select_callback_handler.m
@@ -18,9 +18,12 @@
 %
 % File : rpp_select_callback_handler.m
 % Abstract:
-%     Custom callback funtion for rtwgensettings.SelectCallback event.
-%     Default values of Simulation configurations parameters are set.
-%     Some options are disabled if it is not allowed to be changed by user.
+%     RPP Target select callback handler.
+%
+%     This callback function is triggered whenever the user selects the target
+%     in the System Target File Browser. Default values for Simulation and
+%     configurations parameters are set. Some options are disabled if it is not
+%     allowed to be changed by user.
 %
 % References:
 %     rtw_ug.pdf p. 1211?

diff --git a/rpp/rpp/rpp_srmain.tlc b/rpp/rpp/rpp_srmain.tlc
index 40d369c855261514eeb87c41a77b3b4b5a778280..2aebc90dc4bee6df129271df424d436d93139263 100644 (file)
--- a/rpp/rpp/rpp_srmain.tlc
+++ b/rpp/rpp/rpp_srmain.tlc
@@ -18,7 +18,10 @@
 %%
 %% File : rpp_srmain.tlc
 %% Abstract:
-%%     Custom file processing to generate a "main" file.
+%%     Custom TLC file to generate a "main" file.
+%%
+%%     This file generated the "main" file for the RPP target on top of the RPP
+%%     library and the FreeRTOS operating system.
 %%
 %% References:
 %%     Example in <matlabroot>/rtw/c/tlc/mw/bareboard_srmain.tlc

diff --git a/rpp/rpp/target_tools.mk b/rpp/rpp/target_tools.mk
index 6555f87f87f580b8b516bdc1e4d682d806efeb0f..5aa2e0321b5b8d5d5fb6e1b27ce254cd133166df 100644 (file)
--- a/rpp/rpp/target_tools.mk
+++ b/rpp/rpp/target_tools.mk
@@ -20,6 +20,10 @@
 # Abstract:
 #     Makefile for CCS toolchain support.
 #
+#     This file set variables to CCS tools to support build for this toolchain.
+#     This file is included by rpp.tmf before declaring the rules for source
+#     code.
+#
 # References:
 #     "Include a tool specification settings" comment block in rpp.tmf
 #      Compiler options documentation available in armcl.pdf