bertos/drv/kbd.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 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2003 Bernie Innocenti
  31  *
  32  * -->
  33  *
  34  * \defgroup kbd Keyboard handling driver
  35  * \ingroup drivers
  36  * \{
  37  * \brief Keyboard driver.
  38  *
  39  * <b>Configuration file</b>: cfg_kbd.h
  40  *
  41  * <b>HAL files</b>: hw_kbd.h, kbd_map.h
  42  * \author Bernie Innocenti <bernie@codewiz.org>
  43  * \author Stefano Fedrigo <aleph@develer.com>
  44  * \author Francesco Sacchi <batt@develer.com>
  45  *
  46  * $WIZ$ module_name = "kbd"
  47  * $WIZ$ module_depends = "timer"
  48  * $WIZ$ module_configuration = "bertos/cfg/cfg_kbd.h"
  49  * $WIZ$ module_hw = "bertos/hw/hw_kbd.h", "bertos/hw/kbd_map.h"
  50  */
  51
  52 #ifndef DRV_KBD_H
  53 #define DRV_KBD_H
  54
  55 #include "hw/kbd_map.h"
  56
  57 #include "cfg/cfg_kbd.h" // CONFIG_KBD_OBSERVER
  58 #include <cfg/compiler.h>
  59
  60 #include <struct/list.h>
  61
  62 /**
  63  * \name Keyboard polling modes.
  64  *
  65  * Define CONFIG_KBD_POLL to one of these.
  66  *
  67  * \{
  68  */
  69 #define KBD_POLL_SOFTINT  1
  70 /* \} */
  71
  72 /**
  73  * Keyboard handler descriptor
  74  */
  75 typedef struct KbdHandler
  76 {
  77         Node link;
  78         keymask_t (*hook)(keymask_t);   /**< Hook function */
  79         int8_t pri;                     /**< Priority in input queue */
  80         uint8_t flags;                  /**< See below for definitions */
  81 } KbdHandler;
  82
  83 #define KHF_RAWKEYS     BV(0)           /**< Handler gets raw key events */
  84
  85
  86 void kbd_init(void);
  87 keymask_t kbd_peek(void);
  88 keymask_t kbd_peekMask(keymask_t mask);
  89 keymask_t kbd_get(void);
  90 keymask_t kbd_getMask(keymask_t mask);
  91 keymask_t kbd_get_timeout(mtime_t timeout);
  92 void kbd_addHandler(struct KbdHandler *handler);
  93 void kbd_remHandler(struct KbdHandler *handler);
  94 keymask_t kbd_setRepeatMask(keymask_t mask);
  95
  96 #if CONFIG_KBD_OBSERVER
  97         struct Subject;
  98
  99         /** Subject structure for keyboard observers. */
 100         extern struct Subject kbd_subject;
 101
 102         enum
 103         {
 104                 /* Event for key presses. */
 105                 KBD_EVENT_KEY = 0x100
 106         };
 107 #endif
 108
 109 /** \} */ //defgroup kbd
 110 #endif /* DRV_KBD_H */