Changes in uspace/drv/usbhid/kbddev.h [2391aaf:48d2765] in mainline

File:

• uspace/drv/usbhid/kbddev.h (modified) (1 diff)

uspace/drv/usbhid/kbddev.h

@@ -46 +46 @@
 
 /*----------------------------------------------------------------------------*/
-
 /**
- * @brief USB/HID keyboard device type.
+ * USB/HID keyboard device type.
+ *
+ * Holds a reference to generic USB/HID device structure and keyboard-specific
+ * data, such as currently pressed keys, modifiers and lock keys.
+ *
+ * Also holds a IPC phone to the console (since there is now no other way to 
+ * communicate with it).
+ *
+ * @note Storing active lock keys in this structure results in their setting
+ *       being device-specific.
  */
 typedef struct {
+        /** Structure holding generic USB/HID device information. */
         usbhid_dev_t *hid_dev;
         
-        uint8_t *keycodes;
-        size_t keycode_count;
+        /** Currently pressed keys (not translated to key codes). */
+        uint8_t *keys;
+        /** Count of stored keys (i.e. number of keys in the report). */
+        size_t key_count;
+        /** Currently pressed modifiers (bitmap). */
         uint8_t modifiers;
         
+        /** Currently active modifiers including locks. Sent to the console. */
         unsigned mods;
+        
+        /** Currently active lock keys. */
         unsigned lock_keys;
         
+        /** IPC phone to the console device (for sending key events). */
         int console_phone;
         
+        /** State of the structure (for checking before use). */
         int initialized;
 } usbhid_kbd_t;