Changes between Version 11 and Version 12 of library_mwmr

Timestamp:

Nov 12, 2014, 10:56:05 PM (10 years ago)

Author:

alain

Comment:

--

library_mwmr

@@ -18 +18 @@
 WARNING (iii) The channel must be declared in a non cacheable segment, if the platform does not provide hardware cache coherence.
 
-== __Initialisation Function__ ==
+== Initialisation Function ==
 
 === void '''mwmr_init'''( mwmr_channel_t* mwmr, unsigned int width, unsigned int    items ) ===
@@ -27 +27 @@
 It must be called by one single task.
 
-== __ Blocking Access Functions__ ==
+== Blocking Access Functions ==
 
 The ''mwmr_read()'' and ''mwmr_write()'' functions are blocking functions, that return only when the requested transfer is completed.
@@ -34 +34 @@
 This function transfer (nitems * width) 32 bits words from a task private buffer to the MWMR channel.
  * '''mwmr''' : MWMR channel virtual base address.
+ * '''buffer''' : virtual base address of local buffer.
  * '''nitems''' : number of items to be transfered.
- * '''buffer''' : virtual base address of local buffer.
 It takes the lock for exclusive access before testing the channel state. If there is not enough space in mwmr channel to write nitems, it writes as many items as possible, releases the lock, and retry  after a random delay.
 
@@ -41 +41 @@
 This function transfer (nitems * width) 32 bits words from the MWMR channel to a task private buffer.
  * '''mwmr''' : MWMR channel virtual base address.
+ * '''buffer''' : virtual base address of local buffer.
  * '''nitems''' : number of items to be transfered.
- * '''buffer''' : virtual base address of local buffer.
 It takes the lock for exclusive access before testing the channel state. If there is not enough space in mwmr channel to write nitems, it writes as many items as possible, releases the lock, and retry  after a random delay.
 
 
-== __Non Blocking Access Functions__ ==
+== Non Blocking Access Functions ==
 
 The ''nb_mwmr_read()'' and ''nb_mwmr_write()'' functions are non-blocking functions. 
@@ -53 +53 @@
 This function request to transfer (nitems * width) 32 bits words from a task private buffer tot he MWMR channel.
  * '''mwmr''' : MWMR channel virtual base address.
+ * '''buffer''' : virtual base address of local buffer.
  * '''nitems''' : number of items to be transfered.
- * '''buffer''' : virtual base address of local buffer.
 It takes the lock for exclusive access before testing the channel state. If there is not enough free space in the channel, it transfer as many items as possible, releases the lock, and returns the number of actually transfered items (it can be 0).
 
@@ -60 +60 @@
 This function request to transfer (nitems * width) 32 bits words from the MWMR channel to a task private buffer.
  * '''mwmr''' : MWMR channel virtual base address.
+ * '''buffer''' : virtual base address of local buffer.
  * '''nitems''' : number of items to be transfered.
- * '''buffer''' : virtual base address of local buffer.
 It takes the lock for exclusive access before testing the channel state. If there is not enough data in the channel, it transfer as many items as possible, releases the lock, and returns the number of actually transfered items (it can be 0).