Changes between Version 133 and Version 134 of library_stdio

Timestamp:

Nov 25, 2015, 11:11:28 AM (9 years ago)

Author:

alain

Comment:

--

library_stdio

@@ -132 +132 @@
 
 
-The list of currently  supported coprocessors and their characteristics are defined below:
-||  Name  || type  ||     Function                             || nb_to_coproc || nb_from_coproc || nb_config  || nb_status ||  
-||  GCD    ||  0      ||   Greater Common Divider      ||    2                 ||          1               ||       1         ||       0        ||
-||  DCT    ||   1      ||   Discrete Cosinus Transform ||    1                 ||          1               ||        1        ||        0       ||
-||  CPY    ||   2      ||   Memory Copy                      ||    1                 ||          1               ||        1        ||       0        ||      
-
- === 1) void '''giet_coproc_alloc'''( unsigned int   coproc_type , unsigned int* coproc_info ) ===
-This function allocates a private coprocessor to the calling thread, taking a lock to grant exclusive ownership, and register the coprocessor coordinates in the thread context.
-In the current implementation, the thread exit if there is no coprocessor of requested type in the same cluster as the calling thread.
-In case of success, it returns the coprocessor characteristics in the '''coproc_info''' variable.
- * '''coproc_type''' : see supported types above.
- * '''coproc_info''' (return value) :  nb_to_coprocs = info[7:0] / nb_from_coproc = info[15:8] / nb_config = info[23:16] / nb_status = info[31:24]
+The list of currently  supported coprocessors and their characteristics are defined below :
+||  coproc_ type                   ||     Function                             || nb_to_coproc || nb_from_coproc || nb_config  || nb_status ||  
+||  MWR_SUBTYPE_GCD     ||   Greater Common Divider      ||    2                 ||          1               ||       1         ||       0        ||
+||  MWR_SUBTYPE_DCT     ||   Discrete Cosinus Transform  ||    1                 ||          1               ||        1        ||        0       ||
+||  MWMR_SUTYPE_CPY    ||    Memory Copy                      ||    1                 ||          1               ||        1        ||       0        ||      
+
+ === 1) void '''giet_coproc_alloc'''( unsigned int x , unsigned int y , unsigned int   coproc_type , unsigned int* return_info ) ===
+This function allocates a private coprocessor of type <coproc_type>, from the cluster identified by the <x,y> arguments. It takes the lock granting exclusive ownership, and register the coprocessor coordinates in the calling thread context.
+In the current implementation, the thread exit if there is no coprocessor of requested type in cluster[x,y].
+The supported values for the caprice_type> argument are specified above (and actually defined in the mapping_info.h file).
+In case of success, it returns the coprocessor characteristics in the <return_info> variable.
+The <return_info> is structured in 4 fields :  nb_to_coprocs = info[7:0] / nb_from_coproc = info[15:8] / nb_config = info[23:16] / nb_status = info[31:24]
 
  === 2) void '''giet_coproc_channel_init'''( unsigned int channel , giet_coproc_channel_t*  desc ) ===
-This function initializes a TO_COPROC/FROM_COPROC communication channel. It uses the he following structure (defined in the [source:soft/giet_vm/giet_libs/stdio.h stdio.h] file) to specify the channel parameters:
+This function initializes a TO_COPROC/FROM_COPROC communication channel for the coprocessor allocated to the calling thread. The <channel> argument define the channel index (TO_COPROC channels use the smallest indexes). The <desc argument is a pointer on the structure containing the channel parameters (defined in the [source:soft/giet_vm/giet_libs/stdio.h stdio.h] file).
 {{{
 typedef struct giet_coproc_channel
@@ -153 +153 @@
     unsigned int  buffer_size;     // memory buffer size
     unsigned int  buffer_vaddr;    // memory buffer virtual address
-    unsigned int  mwmr_vaddr;      // MWMR descriptor virtual address
-    unsigned int  lock_vaddr;      // lock for MWMR virtual address
+    unsigned int  mwmr_vaddr;      // MWMR descriptor virtual address (for MWMR mode only)
+    unsigned int  lock_vaddr;      // lock virtual address (for MWMR mode only)
 } giet_coproc_channel_t;
 }}}
- * '''channel''' communication channel index. TO_COPROC channels use the smallest indexes.
- * '''desc''' pointer on the giet_coproc_channel_t structure.
 
  === 3) void '''giet_coproc_run'''( unsigned int coproc_reg_index ) ===