Changeset acac2ef in mainline

Timestamp:

2011-12-27T11:53:42Z (13 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.

Location:

uspace/drv/char/ps2mouse

Files:

• main.c (modified) (3 diffs)
• ps2mouse.c (modified) (4 diffs)
• ps2mouse.h (modified) (1 diff)

uspace/drv/char/ps2mouse/main.c

@@ -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
  */
 
@@ -47 +47 @@
 
 static int mouse_add(ddf_dev_t *device);
-
+/*----------------------------------------------------------------------------*/
+/** DDF driver ops. */
 static driver_ops_t mouse_driver_ops = {
         .dev_add = mouse_add,
 };
-
+/*----------------------------------------------------------------------------*/
+/** DDF driver structure. */
 static driver_t mouse_driver = {
         .name = NAME,
         .driver_ops = &mouse_driver_ops
 };
-
+/*----------------------------------------------------------------------------*/
 /** Initialize global driver structures (NONE).
  *
@@ -71 +73 @@
         return ddf_driver_main(&mouse_driver);
 }
-
-/** Initialize a new ddf driver instance of the driver
+/*----------------------------------------------------------------------------*/
+/** Initialize a new ddf driver instance
  *
  * @param[in] device DDF instance of the device to initialize.

uspace/drv/char/ps2mouse/ps2mouse.c

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** @addtogroup drvkbd
+/** @addtogroup drvmouse
  * @{
  */
 /** @file
- * @brief XT keyboard driver;
+ * @brief ps2 mouse driver.
  */
 
@@ -64 +64 @@
 /*----------------------------------------------------------------------------*/
 static int polling_ps2(void *);
-static void default_connection_handler(ddf_fun_t *fun,
-    ipc_callid_t icallid, ipc_call_t *icall);
-/*----------------------------------------------------------------------------*/
+static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *);
+/*----------------------------------------------------------------------------*/
+/** ps/2 mouse driver ops. */
 static ddf_dev_ops_t mouse_ops = {
         .default_handler = default_connection_handler
 };
 /*----------------------------------------------------------------------------*/
+/** Initialize mouse driver structure.
+ * @param kbd Mouse driver structure to initialize.
+ * @param dev DDF device structure.
+ *
+ * Connects to parent, creates keyboard function, starts polling fibril.
+ */
 int ps2_mouse_init(ps2_mouse_t *mouse, ddf_dev_t *dev)
 {
@@ -139 +145 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Get data and parse ps2 protocol packets.
+ * @param arg Pointer to ps2_mouse_t structure.
+ * @return Never.
+ */
 int polling_ps2(void *arg)
 {
         assert(arg);
-        ps2_mouse_t *mouse = arg;
+        const ps2_mouse_t *mouse = arg;
 
         assert(mouse->parent_sess);
@@ -186 +196 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Default handler for IPC methods not handled by DDF.
+ *
+ * @param fun Device function handling the call.
+ * @param icallid Call id.
+ * @param icall Call data.
+ */
 void default_connection_handler(ddf_fun_t *fun,
     ipc_callid_t icallid, ipc_call_t *icall)

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;