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