Changes in trunk/kernel/devices/dev_ioc.h [3:1]

File:

• trunk/kernel/devices/dev_ioc.h (modified) (3 diffs)

trunk/kernel/devices/dev_ioc.h

@@ -25 +25 @@
 #define _DEV_IOC_H
 
-#include <almos_config.h>
 #include <hal_types.h>
 
 /****  Forward declarations  ****/
 
-struct chdev_s;
+struct device_s;
 
 /*****************************************************************************************
@@ -105 +104 @@
 
 /******************************************************************************************
- * This function completes the IOC chdev descriptor initialisation,
+ * This function completes the IOC device descriptor initialisation,
  * namely the link with the implementation specific driver.
- * The func, impl, channel, is_rx, base fields have been previously initialised.
+ * The func, impl, channel, is_rxt, base, and size fields must be previously initialised.
  * It calls the specific driver initialisation function, to initialise the hardware
  * device and the specific data structures when required.
- * It creates the associated server thread and allocates a WTI from local ICU.
- * It must de executed by a local thread.
+ * It creates the associated server thread.
+ * It can be executed in another cluster than the cluster containing the device descriptor
+ * or the hardware device itself.
  ******************************************************************************************
- * @ chdev     : local pointer on IOC chdev descriptor.
+ * @ xp_dev     : extended pointer on IOC device descriptor.
  *****************************************************************************************/
-void dev_ioc_init( struct chdev_s * chdev );
+void dev_ioc_init( xptr_t  xp_dev );
 
 /******************************************************************************************
@@ -149 +149 @@
                        uint32_t       count );
 
+/******************************************************************************************
+ * This function is executed by the server thread associated to the IOC device descriptor. 
+ * This thread is created and activated by the dev_ioc_init() function.
+ * It executes an infinite loop to handle sequencially all commands registered 
+ * by the client threads in the device waiting queue, calling the driver CMD function. 
+ *  
+ * - If the peripheral can only handle one single command, the driver block the server 
+ *   thread on the THREAD_BLOCKED_DEV_ISR condition, waiting I/O operation conmpletion.
+ *   The server thread must be reacticated by the driver ISR function.
+ * - If the peripheral can handle several commands in parallel (AHCI is an example), the
+ *   driver does not block the server thread (it is only descheduled if the number of
+ *   commands exceeeds the max number of parallel commands supported by the peripheral.
+ *
+ * When the waiting queue is empty, the server thread blocks on the THREAD_BLOCKED_CMD
+ * condition and deschedule. It is re-activated by a client thread registering a command.
+ ******************************************************************************************
+ * @ dev     : local pointer on IOC device descriptor.
+ *****************************************************************************************/
+void dev_ioc_server( struct device_s * dev );
+
 #endif  /* _DEV_IOC_H */