doc: Add clarifications for doxygen generated documentation
[bertos.git] / boards / triface / hw / kbd_map.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
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.
10  *
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.
15  *
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
19  *
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.
28  *
29  * Copyright 2003, 2004, 2005, 2006, 2008 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000 Bernie Innocenti
31  * All Rights Reserved.
32  * -->
33  *
34  * \brief Keyboard map definitions.
35  *
36  *
37  * \author Francesco Sacchi <batt@develer.com>
38  * \author Stefano Fedrigo <a@develer.com>
39  */
40
41 #ifndef HW_KBD_MAP_H
42 #define HW_KBD_MAP_H
43
44 #include <cfg/macros.h>
45
46 #warning TODO:This is an example implentation, you must implement it!
47
48
49 /**
50  * Type for keyboard mask.
51  */
52 typedef uint16_t keymask_t;
53
54 /**
55  * \name Keycodes.
56  */
57 /*@{*/
58 #define K_UP       BV(0)
59 #define K_DOWN     BV(1)
60 #define K_OK       BV(2)
61 #define K_CANCEL   BV(3)
62
63 #define K_REPEAT   BV(13) /**< This is a repeated keyevent. */
64 #define K_TIMEOUT  BV(14) /**< Fake key event for timeouts. */
65 #define K_LONG     BV(15)
66 /*@}*/
67
68 #define K_LNG_MASK 0
69
70 #endif /* HW_KBD_MAP_H */