Changeset acac2ef in mainline for uspace/drv/char/ps2mouse/ps2mouse.h

Timestamp:

2011-12-27T11:53:42Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

edb3cf2

Parents:

da2d75b

Message:

ps2mouse: Doxygen.

File:

• uspace/drv/char/ps2mouse/ps2mouse.h (modified) (1 diff)

uspace/drv/char/ps2mouse/ps2mouse.h

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** @addtogroup drvkbd
+/** @addtogroup drvmouse
  * @{
  */
 /** @file
- * @brief XT keyboard driver;
+ * @brief ps/2 mouse driver.
  */
 
-#ifndef _XT_KBD_H_
-#define _XT_KBD_H_
+#ifndef _PS2MOUSE_H_
+#define _PS2MOUSE_H_
 
 #include <ddf/driver.h>
 #include <fibril.h>
 
+/** PS/2 mouse driver structure. */
 typedef struct {
-        ddf_fun_t *mouse_fun;
-        async_sess_t *parent_sess;
-        async_sess_t *input_sess;
-        fid_t polling_fibril;
+        ddf_fun_t *mouse_fun;      /**< Mouse function. */
+        async_sess_t *parent_sess; /**< Connection to device providing data. */
+        async_sess_t *input_sess;  /**< Callback connection to consumer. */
+        fid_t polling_fibril;      /**< Fibril retrieving an parsing data. */
 } ps2_mouse_t;