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