Add kbd_peekMask() and kbd_getMask() functions.
[bertos.git] / bertos / drv / kbd.h
index c022c3c61d3a716a7b8cfb8660ea47dbba2a33c4..eb699602d26cf3158c5f6cad080da70fb8893bd5 100644 (file)
  *
  * -->
  *
- * \brief Keyboard driver (interface)
+ * \defgroup kbd Keyboard handling driver
+ * \ingroup drivers
+ * \{
+ * \brief Keyboard driver.
+ *
+ * <b>Configuration file</b>: cfg_kbd.h
  *
- * \version $Id$
+ * <b>HAL files</b>: hw_kbd.h, kbd_map.h
  * \author Bernie Innocenti <bernie@codewiz.org>
  * \author Stefano Fedrigo <aleph@develer.com>
  * \author Francesco Sacchi <batt@develer.com>
+ *
+ * $WIZ$ module_name = "kbd"
+ * $WIZ$ module_depends = "timer"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_kbd.h"
+ * $WIZ$ module_hw = "bertos/hw/hw_kbd.h", "bertos/hw/kbd_map.h"
  */
 
 #ifndef DRV_KBD_H
@@ -75,7 +85,9 @@ typedef struct KbdHandler
 
 void kbd_init(void);
 keymask_t kbd_peek(void);
+keymask_t kbd_peekMask(keymask_t mask);
 keymask_t kbd_get(void);
+keymask_t kbd_getMask(keymask_t mask);
 keymask_t kbd_get_timeout(mtime_t timeout);
 void kbd_addHandler(struct KbdHandler *handler);
 void kbd_remHandler(struct KbdHandler *handler);
@@ -94,4 +106,5 @@ keymask_t kbd_setRepeatMask(keymask_t mask);
        };
 #endif
 
+/** \} */ //defgroup kbd
 #endif /* DRV_KBD_H */