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