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.3  2006/02/27 22:39:45  bernie
  20  *#* Misc build and doc fixes from project_grl.
  21  *#*
  22  *#* Revision 1.2  2006/02/10 12:38:16  bernie
  23  *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
  24  *#*
  25  *#* Revision 1.1  2005/06/27 21:28:45  bernie
  26  *#* Import generic keyboard driver.
  27  *#*
  28  *#*/
  29 #ifndef DRV_KBD_H
  30 #define DRV_KBD_H
  31
  32 #include <kbd_map.h>
  33 #include <cfg/compiler.h>
  34 #include <mware/list.h>
  35
  36 /**
  37  * \name Keyboard polling modes.
  38  *
  39  * Define CONFIG_KBD_POLL to one of these.
  40  *
  41  * \{
  42  */
  43 #define KBD_POLL_SOFTINT  1
  44 #define KBD_POLL_FREERTOS 2
  45 /* \} */
  46
  47 /*!
  48  * Keyboard handler descriptor
  49  */
  50 typedef struct KbdHandler
  51 {
  52         Node link;
  53         keymask_t (*hook)(keymask_t);   /*!< Hook function */
  54         int8_t pri;                     /*!< Priority in input queue */
  55         uint8_t flags;                  /*!< See below for definitions */
  56 } KbdHandler;
  57
  58 #define KHF_RAWKEYS     BV(0)           /*!< Handler gets raw key events */
  59
  60
  61 extern void kbd_init(void);
  62 extern keymask_t kbd_peek(void);
  63 extern keymask_t kbd_get(void);
  64 extern keymask_t kbd_get_timeout(mtime_t timeout);
  65 extern void kbd_addHandler(struct KbdHandler *handler);
  66 extern void kbd_remHandler(struct KbdHandler *handler);
  67
  68 #endif /* DRV_KBD_H */