Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
[bertos.git] / drv / kbd.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 1999, 2003 Bernardo Innocenti
6  * This file is part of DevLib - See README.devlib for information.
7  * -->
8  *
9  * \brief Keyboard driver (interface)
10  *
11  * \version $Id$
12  * \author Bernardo Innocenti <bernie@develer.com>
13  * \author Stefano Fedrigo <aleph@develer.com>
14  * \author Francesco Sacchi <batt@develer.com>
15  */
16
17 /*#*
18  *#* $Log$
19  *#* Revision 1.2  2006/02/10 12:38:16  bernie
20  *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
21  *#*
22  *#* Revision 1.1  2005/06/27 21:28:45  bernie
23  *#* Import generic keyboard driver.
24  *#*
25  *#*/
26 #ifndef DRV_KBD_H
27 #define DRV_KBD_H
28
29 #include <kbd_map.h>
30 #include <cfg/compiler.h>
31 #include <mware/list.h>
32
33 #define KBD_POLL_SOFTINT  1
34 #define KBD_POLL_FREERTOS 2
35
36 /*!
37  * Keyboard handler descriptor
38  */
39 typedef struct KbdHandler
40 {
41         Node link;
42         keymask_t (*hook)(keymask_t);   /*!< Hook function */
43         int8_t pri;                     /*!< Priority in input queue */
44         uint8_t flags;                  /*!< See below for definitions */
45 } KbdHandler;
46
47 #define KHF_RAWKEYS     BV(0)           /*!< Handler gets raw key events */
48
49
50 extern void kbd_init(void);
51 extern keymask_t kbd_peek(void);
52 extern keymask_t kbd_get(void);
53 extern keymask_t kbd_get_timeout(mtime_t timeout);
54 extern void kbd_addHandler(struct KbdHandler *handler);
55 extern void kbd_remHandler(struct KbdHandler *handler);
56
57 #endif /* DRV_KBD_H */