Changes between Version 2 and Version 3 of ioc_device_api

Timestamp:

Nov 7, 2016, 12:34:56 PM (7 years ago)

Author:

alain

Comment:

--

ioc_device_api

@@ -26 +26 @@
 
 == B) Access functions ==
+
+=== 1) '''void dev_ioc_init'''( xptr_t   xp_dev ) ===
+
+This function makes two initialisations:
+ * it initialises the IOC specific fields of the device 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.
+
+=== 2) '''void dev_ioc_read'''( char * buffer , uint32_t  lba , uint32_t  count) ===
+
+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.
+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.
+
+=== 3) '''void dev_ioc_write'''( char * buffer , uint32_t  lba , uint32_t  count) ===
+
+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.