4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 1999, 2003 Bernardo Innocenti
34 * \brief Keyboard driver (interface)
37 * \author Bernardo Innocenti <bernie@develer.com>
38 * \author Stefano Fedrigo <aleph@develer.com>
39 * \author Francesco Sacchi <batt@develer.com>
44 *#* Revision 1.6 2006/07/19 12:56:25 bernie
45 *#* Convert to new Doxygen style.
47 *#* Revision 1.5 2006/06/03 13:57:36 bernie
48 *#* Make keyboard repeat mask run-time configurable.
50 *#* Revision 1.4 2006/03/20 17:50:17 bernie
51 *#* Add FreeRTOS and Observers support.
53 *#* Revision 1.3 2006/02/27 22:39:45 bernie
54 *#* Misc build and doc fixes from project_grl.
56 *#* Revision 1.2 2006/02/10 12:38:16 bernie
57 *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
59 *#* Revision 1.1 2005/06/27 21:28:45 bernie
60 *#* Import generic keyboard driver.
67 #include <cfg/compiler.h>
68 #include <mware/list.h>
69 #include <appconfig.h> // CONFIG_KBD_OBSERVER
72 * \name Keyboard polling modes.
74 * Define CONFIG_KBD_POLL to one of these.
78 #define KBD_POLL_SOFTINT 1
79 #define KBD_POLL_FREERTOS 2
83 * Keyboard handler descriptor
85 typedef struct KbdHandler
88 keymask_t (*hook)(keymask_t); /**< Hook function */
89 int8_t pri; /**< Priority in input queue */
90 uint8_t flags; /**< See below for definitions */
93 #define KHF_RAWKEYS BV(0) /**< Handler gets raw key events */
97 keymask_t kbd_peek(void);
98 keymask_t kbd_get(void);
99 keymask_t kbd_get_timeout(mtime_t timeout);
100 void kbd_addHandler(struct KbdHandler *handler);
101 void kbd_remHandler(struct KbdHandler *handler);
102 keymask_t kbd_setRepeatMask(keymask_t mask);
104 #if CONFIG_KBD_OBSERVER
107 /** Subject structure for keyboard observers. */
108 extern struct Subject kbd_subject;
112 /* Event for key presses. */
113 KBD_EVENT_KEY = 0x100
117 #endif /* DRV_KBD_H */