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

File:

• trunk/kernel/devices/dev_txt.h (modified) (5 diffs)

trunk/kernel/devices/dev_txt.h

@@ -30 +30 @@
 /****  Forward declarations  ****/
 
-struct chdev_s ;
+struct device_s ;
 
 /******************************************************************************************
@@ -79 +79 @@
 
 /******************************************************************************************
- * This function completes the TXT chdev descriptor initialisation,
+ * This function completes the TXT device descriptor initialisation,
  * namely the link with the implementation specific driver.
- * The func, impl, channel, is_rxt, 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 driver 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 cluster containing the device descriptor
+ * or the hardware device itself.
  ******************************************************************************************
- * @ chdev     : local pointer on TXT device descriptor.
+ * @ xp_dev     : extended pointer on TXT device descriptor.
  *****************************************************************************************/
-void dev_txt_init( struct chdev_s * chdev );
+void dev_txt_init( xptr_t xp_dev );
 
 /******************************************************************************************
  * This blocking function read a single character from the terminal identified
  * by the "channel" argument. The corresponding request is actually registered in the
- * chdev requests queue, and the calling thread is descheduled, blocked until
+ * device pending requests queue, and the calling thread is descheduled, blocked until
  * transfer completion.
  * It must be called in the client cluster.
@@ -108 +109 @@
  * This blocking function writes a character string on the terminal identified
  * by the "channel" argument. The corresponding request is actually registered in the
- * chdev requests queue, and the calling thread is descheduled, blocked until
+ * device pending requests queue, and the calling thread is descheduled, blocked until
  * transfer completion.
  * It must be called in the client cluster.
@@ -122 +123 @@
 
  /***************************************************************************************
- * This low-level blocking function is used by the kernel to display one string on a 
+ * This low-level blocking function is used by the kernel to display one character on a 
  * given TXT channel without descheduling the calling thread,  without registering it 
  * in the TXT device waiting queue, and without using the TXT irq. 
@@ -135 +136 @@
                             uint32_t   count );
 
+/******************************************************************************************
+ * This function is executed by the server thread associated to the TXT device descriptor.
+ * This thread is created and lauched by the dev_txt_init() function, and is used
+ * by the TXT_READ and TXT_WRITE operation types. It executes an infinite loop to handle
+ * sequencially all commands registered by the client threads in the device waiting queue.
+ *  
+ * The driver CMD function is blocking, and returns only when the command is completed.
+ * can use a busy waiting policy, or block the server thread on the THREAD_BLOCKED_IO_ISR
+ * condition and deschedule, using the ISR to reactivate the server thread.
+ *
+ * When the waiting queue is empty, the server thread blocks on the THREAD_BLOCKED_IO_CMD
+ * condition and deschedule. It is re-activated by a client thread registering a command.
+ ******************************************************************************************
+ * @ dev     : local pointer on device descriptor.
+ *****************************************************************************************/
+void dev_txt_server( struct device_s * dev );
+
 
 #endif  /* _DEV_TXT_H_ */