Changes between Version 134 and Version 135 of library_stdio

Timestamp:

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

Author:

alain

Comment:

--

library_stdio

@@ -121 +121 @@
    - In '''MODE_DMA_NO_IRQ''', the ''giet_coproc_run()'' system call returns after coprocessor activation, and the user application must use the blocking ''giet_coproc_completed()'' system call that directly scan the channels registers to detect  completion, report errors, and reset the channels.
 
-'''WARNING''': For a given coprocessor, all channels must be running in the same mode.
-
-'''WARNING''' : For all channels, the memory buffer base address and size  must be multiple of the hardware burst size.
-
 The VCI transactions corresponding to different TO_COPROC / FROM_COPROC channels are interleaved and parallelized on the VCI network. 
 
-Besides the TO_COPROC/FROM_COPROC communication channels, the '''vci_mwmr_dma''' component support up to 16 coprocessor-specific configuration/status registers. 
+Besides the TO_COPROC/FROM_COPROC communication channels, the '''vci_mwmr_dma''' component support up to 16 coprocessor-specific '''configuration''' or '''status''' registers. 
  * The '''configuration''' registers are Read and Write. 
  * The '''status''' registers are Read only.
+
+'''WARNING''': For a given coprocessor, all channels must be running in the same mode.
+
+'''WARNING''' : For all channels, the memory buffer base address and size  must be multiple of the hardware burst size.
+
+'''WARNING''': All coprocessors must have at least one '''configuration''' register : writing a non zero value in the '''configuration''' register with offset = 0 activates the coprocessor; writing a zero value deactivates the coprocessor.
 
 
@@ -138 +140 @@
 ||  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).
+ === 1) void '''giet_coproc_alloc'''( unsigned int cluster_xy , unsigned int   coproc_type , unsigned int* return_info ) ===
+This function allocates a private coprocessor of type <coproc_type>, located in cluster identified by the <cluster_xy> arguments. It takes the lock granting exclusive ownership to the calling application.
+In the current implementation, the calling thread exit if there is no coprocessor of requested type in cluster[x,y].
+The supported values for the <coproc_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 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).
+ === 2) void '''giet_coproc_release'''( unsigned int cluster_xy , unsigned int coproc_type ) ===
+ This function releases the lock granting exclusive access to the coprocessor identified by the <cluster_xy> and <coproc_type> arguments, after coprocessor and channels deactivation.
+
+ === 3) void '''giet_coproc_channel_init'''( unsigned int cluster_xy , unsigned int coproc_type , unsigned int channel , giet_coproc_channel_t*  desc ) ===
+This function initializes a TO_COPROC/FROM_COPROC communication channel for the coprocessor identified by the <cluster_xy> and <coproc_type> arguments. 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 ( actually defined in the [source:soft/giet_vm/giet_libs/stdio.h stdio.h] file).
 {{{
 typedef struct giet_coproc_channel
@@ -158 +163 @@
 }}}
 
- === 3) void '''giet_coproc_run'''( unsigned int coproc_reg_index ) ===
-This function activates all communication channels and the allocated coprocessor itself.
- * '''coproc_reg_index''' : coprocessor configuration register index to be written for coprocessor activation.
-
- === 4) void '''giet_coproc_completed'''( ) ===
-This blocking function can be used to synchronize a software thread with an hardware coprocessor running in DMA_NO_IRQ mode.
+ === 4) void '''giet_coproc_run'''( unsigned int cluster_xy , unsigned int coproc_type ) ===
+This function activates all communication channels and the allocated coprocessor itself in the cluster identified by the <x,y> arguments.
+
+ === 5) void '''giet_coproc_completed'''( unsigned int cluster_xy , unsigned int cluster_xy ) ===
+This blocking function can be used to synchronize a software thread with an hardware coprocessor identified by the <x,y> arguments, and running in DMA_NO_IRQ mode.
 It polls the status register of all communication channels, and returns only when all transfers are completed. 
 This function exit when at least one channel status register indicates a  bus error (illegal memory access). 
-
- === 5) void '''giet_coproc_release'''( unsigned int coproc_reg_index ) ===
- This function releases the coprocessor allocated to the calling thread, after deactivation.
- * '''coproc_reg_index''' : coprocessor configuration register index to be written for coprocessor deactivation.