Spacing fix

[bertos.git] / drv / kbd.h

diff --git a/drv/kbd.h b/drv/kbd.h
old mode 100755 (executable)
new mode 100644 (file)
index ab02447..c190471
--- a/drv/kbd.h
+++ b/drv/kbd.h
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  * Copyright 1999, 2003 Bernardo Innocenti
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Keyboard driver (interface)
@@ -14,40 +39,58 @@
  * \author Francesco Sacchi <batt@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.1  2005/06/27 21:28:45  bernie
- *#* Import generic keyboard driver.
- *#*
- *#*/
 #ifndef DRV_KBD_H
 #define DRV_KBD_H
 
 #include <kbd_map.h>
 #include <cfg/compiler.h>
-#include <arch_config.h>
 #include <mware/list.h>
+#include <appconfig.h> // CONFIG_KBD_OBSERVER
 
+/**
+ * \name Keyboard polling modes.
+ *
+ * Define CONFIG_KBD_POLL to one of these.
+ *
+ * \{
+ */
+#define KBD_POLL_SOFTINT  1
+#define KBD_POLL_FREERTOS 2
+/* \} */
 
-/*!
+/**
  * Keyboard handler descriptor
  */
 typedef struct KbdHandler
 {
        Node link;
-       keymask_t (*hook)(keymask_t);   /*!< Hook function */
-       int8_t pri;                     /*!< Priority in input queue */
-       uint8_t flags;                  /*!< See below for definitions */
+       keymask_t (*hook)(keymask_t);   /**< Hook function */
+       int8_t pri;                     /**< Priority in input queue */
+       uint8_t flags;                  /**< See below for definitions */
 } KbdHandler;
 
-#define KHF_RAWKEYS    BV(0)           /*!< Handler gets raw key events */
+#define KHF_RAWKEYS    BV(0)           /**< Handler gets raw key events */
+
+
+void kbd_init(void);
+keymask_t kbd_peek(void);
+keymask_t kbd_get(void);
+keymask_t kbd_get_timeout(mtime_t timeout);
+void kbd_addHandler(struct KbdHandler *handler);
+void kbd_remHandler(struct KbdHandler *handler);
+keymask_t kbd_setRepeatMask(keymask_t mask);
+
+#if CONFIG_KBD_OBSERVER
+       struct Subject;
 
+       /** Subject structure for keyboard observers. */
+       extern struct Subject kbd_subject;
 
-extern void kbd_init(void);
-extern keymask_t kbd_peek(void);
-extern keymask_t kbd_get(void);
-extern keymask_t kbd_get_timeout(mtime_t timeout);
-extern void kbd_addHandler(struct KbdHandler *handler);
-extern void kbd_remHandler(struct KbdHandler *handler);
+       enum
+       {
+               /* Event for key presses. */
+               KBD_EVENT_KEY = 0x100
+       };
+#endif
 
 #endif /* DRV_KBD_H */