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