Changes between Version 5 and Version 6 of ioc_device_api

Timestamp:

Jan 20, 2020, 6:53:05 PM (5 years ago)

Author:

alain

Comment:

--

ioc_device_api

@@ -35 +35 @@
 == __B) Initialisation__ ==
 
-== __C) User API__ ==
-
-=== 1) '''void dev_ioc_init'''( xptr_t    xp_dev ) ===
-
 The '''void dev_ioc_init()''' function makes two initializations :
  * it initialises the IOC specific fields of the chdev descriptor.
  * it initialises the implementation specific IOC hardware device and associated data structures if required.
-It can be executed in another cluster than the cluster containing the IOC device descriptor or the IOC hardware device itself.
-The <xp_dev> argument is an extended pointer on the IOC device descriptor.
+It must be called by a local thread.
 
-=== 1) '''void dev_ioc_read'''( char * buffer , uint32_t  lba , uint32_t  count ) ===
+== __C) User API__ ==
 
-This blocking function try to tranfer one or several contiguous blocks of data from the block device to a memory buffer. The calling thread is registered in the device pending request queue, and descheduled, waiting on transfer completion. It is re-activared by the IRQ signaling completion. It must be called in the client cluster.
+=== B.1) '''void dev_ioc_read()''' ===
+
+This blocking function try to tranfer one or several contiguous blocks of data from the block device to a memory buffer. The calling thread is registered in the device pending request queue, and descheduled, waiting on transfer completion. 
+The <buffer> argument is a 
+The <lba> argument is the first block index in block device.
+The <count> argument is the number of blocks to move.
+
+=== 2) '''void dev_ioc_write()''' ===
+
+This blocking function try to tranfer one or several contiguous blocks of data from a memory buffer to the block device. The calling thread is actually registered in the device pending request queue, and descheduled, waiting on transfer completion. 
 The <buffer> argument is...
 The <lba> argument is the first block index in block device.
 The <count> argument is the number of blocks to move.
 
-=== 2) '''void dev_ioc_write'''( char * buffer , uint32_t  lba , uint32_t  count ) ===
+== __D) Driver API__ ==
 
-This blocking function try to tranfer one or several contiguous blocks of data from a memory buffer to the block device. The calling thread is actually registered in the device pending request queue, and descheduled, waiting on transfer completion. It is re-activared by the IRQ signaling completion. It must be called in the client cluster.
-The <buffer> argument is...
-The <lba> argument is the first block index in block device.
-The <count> argument is the number of blocks to move.
+The IOC device defines defines four command types to access the IOC driver(s) :
+ - '''IOC_WRITE''' : move blocks from a kernel buffer to the IOC device, with a descheduling policy.
+ - '''IOC_READ'''  : move blocks from the IOC device to a kernel buffer, with a descheduling policy.
+ - '''IOC_SYNC_WRITE'''   : 
+ - '''IOC_SYNC_READ'''    :  
+
+These four commands use the three following arguments, that must be registered, with the command type, in the ''ioc_command_t'' structure embedded in the client thread descriptor :
+ - '''npixels''' : number of pixels to be moved.
+ - '''buffer''' : pointer on buffer in (can be in user space or in kernel space).
+ - '''offset''' : offset in FBF (number of pixels).