Changes between Version 8 and Version 9 of SrlApi

Timestamp:

Sep 16, 2007, 12:29:01 AM (17 years ago)

Author:

alain

Comment:

--

SrlApi

@@ -1 @@
-= SrlApi =
+= Srl API =
 
-Srl API is your gateway to the [wiki:DsxResource "system resources"].
+The Srl API is an abstraction layer that provides the software programmer
+an easy acces to several [wiki:DsxResource "communication and synchronisation resources"].
+
+Thanks to the Srl (System Ressource Layer) API, the same code can be compiled and executed
+on several platforms such as 
+ * a Linux/Posix workstation
+ * an MP-SoC architecture running the Mutek OS. 
+
+The code of the tasks is supposed to be written in C.
+
+== Mwmr Communication Channels ==
+
+ * {{{srl_mwmr_t channel = GET_ARG(port_name)}}} defines a local variable associated to a MWMR channel acces port. The {{{port_name}}} argument corresponds to the port name defined in the task model defined in the DSX/L description.
+
+ * {{{srl_mwmr_read(channel, local_buffer, size)}}} reads {{{size}}} 32-bit words from the MWMR channel to the local buffer. The {{{local_buffer}}} argument is a {{{void*}}}. The {{{size}}} argument must be a multiple of the channel width.
+
+ * {{{srl_mwmr_write(channel, local_buffer, size)}}} writes {{{size}}} 32-bit words from the local buffer to the MWMR channel. The {{{local_buffer}}} argument is a {{{void*}}}. The {{{size}}} argument must be a multiple of the channel width.
+
+== Locks ==
+
+ * {{{srl_lock_lock( lock )}}} takes a lock, waiting if necessary
+ * {{{srl_lock_unlock( lock )}}} releases the lock
+
+== Barriers ==
+
+ * {{{srl_barrier_wait( barrier )}}} waits for a barrier-global synchronization
 
 == Logging ==
 
-Log API let you define message levels. Levels allow you to let your debug code in the source, and only compile it when needed.
+Log API let you define several message levels. Levels allow you to keep the debug code in the source, and only compile it when needed.
 
 In order, levels are:
@@ -23 +48 @@
 }}}
 
-== Mwmr Communication Channels ==
-
- * {{{srl_mwmr_t channel = GET_ARG(port_name)}}} defines a local variable associated to a MWMR channel acces port. The {{{port_name}}} argument corresponds to the port name defined in the task model defined in the DSX description.
-
- * {{{srl_mwmr_read(channel, local_buffer, size)}}} reads {{{size}}} 32-bit words from the MWMR channel to the local buffer. The {{{local_buffer}}} argument is a {{{void*}}}. The {{{size}}} argument must be a multiple of the channel width.
-
- * {{{srl_mwmr_write(channel, local_buffer, size)}}} writes {{{size}}} 32-bit words from the local buffer to the MWMR channel. The {{{local_buffer}}} argument is a {{{void*}}}. The {{{size}}} argument must be a multiple of the channel width.
-
-== Locks ==
-
- * {{{srl_lock_lock( lock )}}} takes a lock, waiting if necessary
- * {{{srl_lock_unlock( lock )}}} releases the lock
-
-== Barriers ==
-
- * {{{srl_barrier_wait( barrier )}}} waits for a barrier-global synchronization
-
 == Other APIs ==