Changeset a84ddf0 in mainline

Timestamp:

2011-12-27T11:11:01Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

bff90ba

Parents:

336f03b

Message:

xtkbd: Doxygen.

Location:

uspace/drv/char/xtkbd

Files:

• main.c (modified) (2 diffs)
• xtkbd.c (modified) (6 diffs)
• xtkbd.h (modified) (2 diffs)

uspace/drv/char/xtkbd/main.c

@@ -47 +47 @@
 
 static int xt_kbd_add(ddf_dev_t *device);
-
+/*----------------------------------------------------------------------------*/
+/** DDF driver ops. */
 static driver_ops_t kbd_driver_ops = {
         .dev_add = xt_kbd_add,
 };
-
+/*----------------------------------------------------------------------------*/
+/** DDF driver structure. */
 static driver_t kbd_driver = {
         .name = NAME,
         .driver_ops = &kbd_driver_ops
 };
-
+/*----------------------------------------------------------------------------*/
 /** Initialize global driver structures (NONE).
  *
@@ -68 +70 @@
 {
         printf(NAME ": HelenOS XT keyboard driver.\n");
-        ddf_log_init(NAME, LVL_DEBUG2);
+        ddf_log_init(NAME, LVL_NOTE);
         return ddf_driver_main(&kbd_driver);
 }
-
+/*----------------------------------------------------------------------------*/
 /** Initialize a new ddf driver instance of the driver
  *

uspace/drv/char/xtkbd/xtkbd.c

@@ -43 +43 @@
 
 #include "xtkbd.h"
+/** Scancode set 1 table. */
 static const int scanmap_simple[] = {
 
@@ -152 +153 @@
 };
 /*----------------------------------------------------------------------------*/
+#define SCANCODE_SET_EXTENDED 0xe0
+/** Scancode set 1 extended codes table */
 static const int scanmap_e0[] = {
         [0x38] = KC_RALT,
@@ -179 +182 @@
     ipc_callid_t icallid, ipc_call_t *icall);
 /*----------------------------------------------------------------------------*/
+/** Keyboard function ops. */
 static ddf_dev_ops_t kbd_ops = {
         .default_handler = default_connection_handler
@@ -230 +234 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Get data and parse scancodes.
+ * @param arg Pointter to xt_kbd_t structure.
+ * @return Never.
+ */
 int polling(void *arg)
 {
@@ -243 +251 @@
                 ssize_t size = char_dev_read(kbd->parent_sess, &code, 1);
 
-                if (code == 0xe0) {
+                if (code == SCANCODE_SET_EXTENDED) {
                         map = scanmap_e0;
                         map_size = sizeof(scanmap_e0) / sizeof(int);
@@ -279 +287 @@
 }
 /*----------------------------------------------------------------------------*/
+/** 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/xtkbd/xtkbd.h

@@ -30 +30 @@
  */
 /** @file
- * @brief XT keyboard driver;
+ * @brief XT keyboard driver
  */
 
@@ -39 +39 @@
 #include <fibril.h>
 
+/** PC/XT keyboard driver structure. */
 typedef struct {
-        ddf_fun_t *kbd_fun;
-        async_sess_t *parent_sess;
-        async_sess_t *input_sess;
-        fid_t polling_fibril;
+        ddf_fun_t *kbd_fun;        /**< Keyboard 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. */
 } xt_kbd_t;