Changes between Version 2 and Version 3 of Component/Virtual Coprocessor Wrapper

Timestamp:

Jan 15, 2013, 10:01:39 AM (11 years ago)

Author:

meunier

Comment:

--

Component/Virtual Coprocessor Wrapper

@@ -14 +14 @@
 
 The task thread communicates with the ''wrapper'' with two fifo channels:
- * the `cmd` channel, which transmits to the ''wrapper'' the SRL commands:
+ * the `cmd` channel, which transmits to the ''wrapper'' the SRL commands. These commands take the form of function calls in the task code:
    * `srl_mwmr_read(channel, buffer, size)`
    * `srl_mwmr_write(channel, buffer, size)`
@@ -65 +65 @@
 
 
-(A finir)
-
 = Component usage =
 
-The virtual Coprocessor Wrapper is primarily intended to be used with Dsx-vm (to be released soon?), but it can also be used "by hand". In the following is an example of a dummy ''adder'' task, which makes a vectorial 32-bit addition of size 8 (i.e. there are 16 words in input and 8 words in output). 3 files must be created:
+The virtual Coprocessor Wrapper is primarily intended to be used with Dsx-vm (to be released soon?), but it can also be used "by hand".
+
+== Example ==
+
+In the following is an example of a dummy ''adder'' task, which makes a vectorial 32-bit addition of size 8 (i.e. there are 16 words in input and 8 words in output). 3 files must be created:
  * `my_adder_copro.sd`
  * `my_adder_copro.h`
@@ -124 +126 @@
 {
 
-
-public:
+    public:
     ~MyAdderCopro();
     MyAdderCopro(sc_core::sc_module_name insname);
 
-private:
+
+    private:
     void * task_func(); // Task code
 
@@ -155 +157 @@
 
 tmpl(/**/)::MyAdderCopro(sc_core::sc_module_name insname)
-            dsx::caba::VirtualCoprocessorWrapper(insname, stringArray("output", NULL), intArray(1, 8), stringArray("input0", "input1", NULL), intArray(2, 8, 8))
+           :dsx::caba::VirtualCoprocessorWrapper(insname, stringArray("output", NULL), intArray(1, 8), stringArray("input0", "input1", NULL), intArray(2, 8, 8))
 {
 }
@@ -173 +175 @@
          out[i] = in0[i] + in1[i];
       }
+      srl_busy_cycles(2); // The computation takes 2 cycles
       srl_mwmr_write(output, &out, 1); // Write 8 words to output
    }
@@ -180 +183 @@
 }}}
 
-
-À compléter...
-
+The prototype of the parent class `VirtualCoprocessorWrapper` is:
+{{{
+#!cpp
+VirtualCoprocessorWrapper(
+        sc_core::sc_module_name insname,
+        const vector<string> &fifos_out,
+        const vector<int32_t>    &fifos_out_width,
+        const vector<string> &fifos_in,
+        const vector<int32_t>    &fifos_in_width)
+: soclib::caba::BaseModule(insname)
+}}}
+
+with
+ fifos_out::
+   a vector containing the names of the output fifos
+ fifos_out_width::
+   a vector containing the width of the output fifos
+ fifos_in::
+   a vector containing the names of the input fifos
+ fifos_in_width::
+   a vector containing the width of the input fifos
+
+The functions `stringArray` and `intArray` construct these vectors, the first argument of intArray being the number of fifos.
+
+
+== Component Instanciation ==
+
+=== CABA Ports ===
+
+ * `sc_in<bool>` '''p_resetn''' : Global system reset
+ * `sc_in<bool>` '''p_clk''' : Global system clock
+ * `FifoOutput<uint32_t> *` '''p_to_ctrl''' : list of output ports to connect to a `soclib::caba::VciMwmrControllerCas` via a `soclib::caba::FifoSignals<uint32_t>`.
+ * `FifoInput<uint32_t> *` '''p_from_ctrl''' : list of input ports to connect to a `soclib::caba::VciMwmrControllerCas` via a `soclib::caba::FifoSignals<uint32_t>`.
+
+