aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYuji Mano <yuji.mano@am.sony.com>2008-12-15 22:37:58 -0800
committerGeoff Levand <geoffrey.levand@am.sony.com>2008-12-23 11:25:26 -0800
commit9dcdc3171d45bb8e02036de8a84f3e7a2a1bf8f3 (patch)
treee6bd92cb2bf87d32def13453513733c16612cc78
parente56a04a8395c0365e92289f2e312f7b5254bf19d (diff)
downloadmars-src-9dcdc3171d45bb8e02036de8a84f3e7a2a1bf8f3.tar.gz
doxygen: Fix errors in documentation
Signed-off-by: Yuji Mano <yuji.mano@am.sony.com>
-rw-r--r--doxygen/src/doxygen38
1 files changed, 21 insertions, 17 deletions
diff --git a/doxygen/src/doxygen b/doxygen/src/doxygen
index 72396bd..1027b3a 100644
--- a/doxygen/src/doxygen
+++ b/doxygen/src/doxygen
@@ -376,12 +376,12 @@ for grouped execution of tasks to run concurrently.
********************************************************************************
\section sec_2_3 2.3 Workload Module
-The MARS workload module is the initial MPU program loaded into MPU storage and
-executed by the MARS kernel when a workload is scheduled for execution and
-loaded to MPU storage. The main responsibility of the workload module is to
-load and process the necessary MPU program or programs as specified by the
-design of the workload model, update the state of the workload, and return
-execution back to the MARS kernel.
+The MARS workload module is the initial MPU program executed by the MARS kernel
+when a workload is scheduled for execution and loaded to MPU storage.
+The main responsibility of the workload module is to load and process the
+necessary MPU program or programs as specified by the design of the workload
+model, update the state of the workload, and return execution back to the MARS
+kernel.
Each workload model needs its own workload module implementation that handles
the model specific processing of workloads. The workload module will make use of
@@ -455,7 +455,7 @@ following header:
\endcode
The host program written for the host processor needs to link in the MARS host
-libraries
+libraries.
MARS provides both static and dynamic libraries for the host processor.
@@ -790,10 +790,10 @@ Each workload context needs to know the corresponding workload module that will
be responsible for the execution and mangement of the workload.
The workload module will remain resident in the MPU storage as long as the
-workload it is responsible for remains in running. Its main function is to load
-and execute the MPU program specified by the currently scheduled workload
-context. The workload module also serves as the communication layer between the
-user's workload specific MPU program and the MARS kernel.
+workload it is responsible for remains in the running state. Its main function
+is to load and execute the MPU program specified by the currently scheduled
+workload context. The workload module also serves as the communication layer
+between the user's workload specific MPU program and the MARS kernel.
<b>Fig. 6.1c</b>
\image html img_workload_model_module.png
@@ -808,7 +808,7 @@ address in MPU storage.
returns execution back to the MARS kernel, it will not resume execution. Each
time the workload module runs, it begins execution from its entry point. If
workloads must be resumed, it is the workload module's responsibility to save
-the workload program state and store any necessary information into the
+the workload's program state and store any necessary information into the
workload context.
\n
@@ -1975,11 +1975,15 @@ Print out message to stdout. Print out the unique value specified by the main
This tutorial will explain how to use the MARS task barrier to synchronize
execution between multiple MARS tasks.
-The sample code creates a task barrier, 10 task instances of task 1 program,
-and a final task instance of task 2 program. When each of the 10 first tasks
-finishes its own processing, they each notify the barrier. Once all tasks notify
-the barrier and the barrier is released, the final task waiting on the barrier
-is allowed to process.
+The sample code creates a task barrier and 10 task instances of a task program.
+Each task program must do several iterations of some pre-processing work and
+some post-processing work. For each iteration, all tasks must complete the
+pre-processing work before any tasks can continue to do the post-processing
+work. In order to synchronize the tasks to accomplish this, a task barrier will
+be used. After finishing the pre-processing and before starting the
+post-processing work, the tasks will notify arrival to the barrier. Once all
+tasks notify the barrier and the barrier is released, all tasks can proceed to
+finish the post-processing work.
\n
<b>(host program)</b>