drv/kbd.c

   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  * \version $Id$
  10  *
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  * \author Stefano Fedrigo <aleph@develer.com>
  13  * \author Francesco Sacchi <batt@develer.com>
  14  *
  15  * \brief Keyboard driver (implementation)
  16  */
  17
  18 /*#*
  19  *#* $Log$
  20  *#* Revision 1.2  2006/02/10 12:36:20  bernie
  21  *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
  22  *#*
  23  *#* Revision 1.1  2005/06/27 21:28:45  bernie
  24  *#* Import generic keyboard driver.
  25  *#*
  26  *#*/
  27
  28 #include <hw_kbd.h>
  29
  30 #include <drv/timer.h>
  31 #include <drv/kbd.h>
  32 #include <drv/buzzer.h>
  33
  34 #include <cfg/debug.h>
  35
  36 /* Configuration sanity checks */
  37 #if !defined(CONFIG_KBD_POLL) || (CONFIG_KBD_POLL != KBD_POLL_SOFTINT && CONFIG_KBD_POLL != CONFIG_POLL_FREERTOS)
  38         #error CONFIG_KBD_POLL must be defined to either KBD_POLL_SOFTINT or CONFIG_POLL_FREERTOS
  39 #endif
  40
  41
  42 #define KBD_CHECK_INTERVAL  10  /*!< (ms) Timing for kbd softint */
  43 #define KBD_DEBOUNCE_TIME   30  /*!< (ms) Debounce time */
  44 #define KBD_BEEP_TIME        5  /*!< (ms) Duration of keybeep */
  45
  46 #define KBD_REPEAT_DELAY   400  /*!< (ms) Keyboard repeat delay for first character */
  47 #define KBD_REPEAT_RATE    100  /*!< (ms) Initial interchar delay for keyboard repeat */
  48 #define KBD_REPEAT_MAXRATE  20  /*!< (ms) Minimum delay for keyboard repeat */
  49 #define KBD_REPEAT_ACCEL     5  /*!< (ms) Keyboard repeat speed increase */
  50
  51 #define KBD_LNG_DELAY     1000  /*!< (ms) Keyboard long pression keys delay */
  52
  53
  54 /*! Status for keyboard repeat state machine */
  55 static enum { KS_IDLE, KS_REPDELAY, KS_REPEAT } kbd_rptStatus;
  56
  57
  58 static volatile keymask_t kbd_buf; /*!< Single entry keyboard buffer */
  59 static volatile keymask_t kbd_cnt; /*!< Number of keypress events in \c kbd_buf */
  60
  61 static Timer kbd_timer;            /*!< Keyboard softtimer */
  62
  63 static List kbd_rawHandlers;       /*!< Raw keyboard handlers */
  64 static List kbd_handlers;          /*!< Cooked keyboard handlers */
  65
  66 static KbdHandler kbd_defHandler;  /*!< The default keyboard handler */
  67 static KbdHandler kbd_debHandler;  /*!< The debounce keyboard handler */
  68 static KbdHandler kbd_rptHandler;  /*!< Auto-repeat keyboard handler */
  69 #ifdef  K_LNG_MASK
  70 static KbdHandler kbd_lngHandler;  /*!< Long pression keys handler */
  71 #endif
  72
  73
  74
  75 /*!
  76  * Poll keyboard and dispatch keys to handlers.
  77  *
  78  * Read the key states and invoke all keyboard
  79  * handlers to process the new state.
  80  *
  81  * Call this function periodically using a software
  82  * timer, an interrupt or a process.
  83  */
  84 static void kbd_poll(void)
  85 {
  86         /*! Currently depressed key */
  87         static keymask_t current_key;
  88
  89         struct KbdHandler *handler;
  90         keymask_t key = kbd_readkeys();
  91
  92         /* Call raw input handlers */
  93         FOREACHNODE(handler, &kbd_rawHandlers)
  94                 key = handler->hook(key);
  95
  96         /* If this key was not previously pressed */
  97         if (key != current_key)
  98         {
  99                 /* Remember last key */
 100                 current_key = key;
 101
 102                 /* Call cooked input handlers */
 103                 FOREACHNODE(handler, &kbd_handlers)
 104                         key = handler->hook(key);
 105         }
 106 }
 107
 108 #if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
 109
 110 /*!
 111  * Keyboard soft-irq handler.
 112  */
 113 static void kbd_softint(UNUSED_ARG(iptr_t, arg))
 114 {
 115         kbd_poll();
 116         timer_add(&kbd_timer);
 117 }
 118
 119 #elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
 120
 121 #include "FreeRTOS.h"
 122 #include "task.h"
 123
 124 static portTASK_FUNCTION(kbd_poll, arg)
 125 {
 126         for (;;)
 127         {
 128                 kbd_poll(0);
 129                 timer_delay(KBD_CHECK_INTERVAL);
 130         }
 131 }
 132
 133 #endif /* CONFIG_KBD_POLL */
 134
 135 /*!
 136  * \brief Read a key from the keyboard buffer.
 137  *
 138  * When a key is kept depressed between calls of this function a value
 139  * is returned only after the time specified with KBD_REPAT_DELAY to
 140  * avoid too fast keyboard repeat.
 141  *
 142  * \note This function is \b not interrupt safe!
 143  *
 144  * \return The mask of depressed keys or 0 if no keys are depressed.
 145  *
 146  */
 147 keymask_t kbd_peek(void)
 148 {
 149         keymask_t key = 0;
 150
 151 // FIXME
 152         extern void schedule(void);
 153         schedule();
 154
 155         /* Extract an event from the keyboard buffer */
 156         IRQ_DISABLE;
 157         if (kbd_cnt)
 158         {
 159                 --kbd_cnt;
 160                 key = kbd_buf;
 161         }
 162         IRQ_ENABLE;
 163
 164         return key;
 165 }
 166
 167
 168 /*!
 169  * Wait for a keypress and return the mask of depressed keys.
 170  *
 171  * \note This function is \b not interrupt safe!
 172  */
 173 keymask_t kbd_get(void)
 174 {
 175         keymask_t key;
 176
 177         while (!(key = kbd_peek())) {}
 178         return key;
 179 }
 180
 181
 182 /*!
 183  * Wait up to \c timeout ms for a keypress
 184  * and return the mask of depressed keys, or K_TIMEOUT
 185  * if the timeout was reacked.
 186  */
 187 keymask_t kbd_get_timeout(mtime_t timeout)
 188 {
 189         keymask_t key;
 190
 191         ticks_t start = timer_clock();
 192         ticks_t stop  = ms_to_ticks(timeout);
 193         do
 194         {
 195                 if ((key = kbd_peek()))
 196                         return key;
 197         }
 198         while (timer_clock() - start < stop);
 199
 200         return K_TIMEOUT;
 201 }
 202
 203
 204 void kbd_addHandler(struct KbdHandler *handler)
 205 {
 206         KbdHandler *node;
 207         List *list;
 208
 209         cpuflags_t flags;
 210         IRQ_SAVE_DISABLE(flags);
 211
 212         /* Choose between raw and coocked handlers list */
 213         list = (handler->flags & KHF_RAWKEYS) ?
 214                 &kbd_rawHandlers : &kbd_handlers;
 215
 216         /*
 217          * Search for the first node whose priority
 218          * is lower than the timer we want to add.
 219          */
 220         FOREACHNODE(node,list)
 221                 if (node->pri < handler->pri)
 222                         break;
 223
 224         /* Enqueue handler in the handlers chain */
 225         INSERTBEFORE(&handler->link, &node->link);
 226
 227         IRQ_RESTORE(flags);
 228 }
 229
 230
 231 void kbd_remHandler(struct KbdHandler *handler)
 232 {
 233         /* Remove the handler */
 234         ATOMIC(REMOVE(&handler->link));
 235 }
 236
 237
 238 /*!
 239  * This is the default key handler, called after
 240  * all other handlers have had their chance to
 241  * do their special processing. This handler
 242  * pushes all input in the keyboard FIFO buffer.
 243  */
 244 static keymask_t kbd_defHandlerFunc(keymask_t key)
 245 {
 246         if (key)
 247         {
 248                 /* Force a single event in kbd buffer */
 249                 kbd_buf = key;
 250                 kbd_cnt = 1;
 251
 252 #if KBD_BEEP_TIME
 253                 if (!(key & K_REPEAT))
 254                         buz_beep(KBD_BEEP_TIME);
 255 #endif
 256         }
 257
 258         /* Eat all input */
 259         return 0;
 260 }
 261
 262 /*!
 263  * Handle keyboard debounce
 264  */
 265 static keymask_t kbd_debHandlerFunc(keymask_t key)
 266 {
 267         /*! Buffer for debounce */
 268         static keymask_t debounce_key;
 269
 270         /*! Timer for keyboard debounce */
 271         static ticks_t debounce_time;
 272
 273         /*! Key aquired after debounce */
 274         static keymask_t new_key;
 275
 276
 277         ticks_t now = timer_clock();
 278
 279         if (key != debounce_key)
 280         {
 281                 /* Reset debounce timer */
 282                 debounce_key = key;
 283                 debounce_time = now;
 284         }
 285         else if ((new_key != debounce_key)
 286                 && (now - debounce_time > ms_to_ticks(KBD_DEBOUNCE_TIME)))
 287         {
 288                 new_key = debounce_key;
 289                 debounce_time = now;
 290         }
 291
 292         return new_key;
 293 }
 294
 295 #ifdef  K_LNG_MASK
 296 /*!
 297  * Handle long pression keys
 298  */
 299 static keymask_t kbd_lngHandlerFunc(keymask_t key)
 300 {
 301         static ticks_t stop;
 302         ticks_t now = timer_clock();
 303
 304         if (key & K_LNG_MASK)
 305         {
 306                 if (now - stop > 0)
 307                         key &= K_LNG_MASK;
 308                 else
 309                         key &= ~K_LNG_MASK;
 310         }
 311         else
 312                 stop = now + ms_to_ticks(KBD_LNG_DELAY);
 313         return key;
 314 }
 315 #endif
 316
 317 /*!
 318  * Handle keyboard repeat
 319  */
 320 static keymask_t kbd_rptHandlerFunc(keymask_t key)
 321 {
 322         /*! Timer for keyboard repeat events */
 323         static ticks_t repeat_time;
 324
 325         static ticks_t repeat_rate; /*! Current repeat rate (for acceleration) */
 326
 327         ticks_t now = timer_clock();
 328
 329         switch (kbd_rptStatus)
 330         {
 331                 case KS_IDLE:
 332                         if (key & K_RPT_MASK)
 333                         {
 334                                 repeat_time = now;
 335                                 kbd_rptStatus = KS_REPDELAY;
 336                         }
 337                         break;
 338
 339                 case KS_REPDELAY:
 340                         if (key & K_RPT_MASK)
 341                         {
 342                                 if (now - repeat_time > ms_to_ticks(KBD_REPEAT_DELAY))
 343                                 {
 344                                         key = (key & K_RPT_MASK) | K_REPEAT;
 345                                         repeat_time = now;
 346                                         repeat_rate = ms_to_ticks(KBD_REPEAT_RATE);
 347                                         kbd_rptStatus = KS_REPEAT;
 348                                 }
 349                                 else
 350                                         key = 0;
 351                         }
 352                         else
 353                                 kbd_rptStatus = KS_IDLE;
 354                         break;
 355
 356                 case KS_REPEAT:
 357                         if (key & K_RPT_MASK)
 358                         {
 359                                 if (now - repeat_time > repeat_rate)
 360                                 {
 361                                         /* Enqueue a new event in the buffer */
 362                                         key = (key & K_RPT_MASK) | K_REPEAT;
 363                                         repeat_time = now;
 364
 365                                         /* Repeat rate acceleration */
 366                                         if (repeat_rate > ms_to_ticks(KBD_REPEAT_MAXRATE))
 367                                                 repeat_rate -= ms_to_ticks(KBD_REPEAT_ACCEL);
 368                                 }
 369                                 else
 370                                         key = 0;
 371                         }
 372                         else
 373                                 kbd_rptStatus = KS_IDLE;
 374
 375                         break;
 376         }
 377
 378         return key;
 379 }
 380
 381
 382
 383 /*!
 384  * Initialize keyboard ports and softtimer
 385  */
 386 void kbd_init(void)
 387 {
 388         KBD_HW_INIT;
 389
 390         /* Init handlers lists */
 391         LIST_INIT(&kbd_handlers);
 392         LIST_INIT(&kbd_rawHandlers);
 393
 394         /* Add debounce keyboard handler */
 395         kbd_debHandler.hook = kbd_debHandlerFunc;
 396         kbd_debHandler.pri = 100; /* high priority */
 397         kbd_debHandler.flags = KHF_RAWKEYS;
 398         kbd_addHandler(&kbd_debHandler);
 399
 400         #ifdef  K_LNG_MASK
 401         /* Add long pression keyboard handler */
 402         kbd_lngHandler.hook = kbd_lngHandlerFunc;
 403         kbd_lngHandler.pri = 90; /* high priority */
 404         kbd_lngHandler.flags = KHF_RAWKEYS;
 405         kbd_addHandler(&kbd_lngHandler);
 406         #endif
 407
 408
 409         /* Add repeat keyboard handler */
 410         kbd_rptHandler.hook = kbd_rptHandlerFunc;
 411         kbd_rptHandler.pri = 80; /* high priority */
 412         kbd_rptHandler.flags = KHF_RAWKEYS;
 413         kbd_addHandler(&kbd_rptHandler);
 414
 415
 416         /* Add default keyboard handler */
 417         kbd_defHandler.hook = kbd_defHandlerFunc;
 418         kbd_defHandler.pri = -128; /* lowest priority */
 419         kbd_addHandler(&kbd_defHandler);
 420
 421 #if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
 422         /* Add kbd handler to soft timers list */
 423         event_initSoftInt(&kbd_timer.expire, kbd_softint, 0);
 424         timer_setDelay(&kbd_timer, ms_to_ticks(KBD_CHECK_INTERVAL));
 425         timer_add(&kbd_timer);
 426 #elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
 427         /* Create a timer specific thread */
 428         xTaskCreate(kbd_poll, "kbd_poll", CONFIG_STACK_KBD,
 429                         NULL, CONFIG_PRI_KBD, NULL);
 430 #else
 431         #error "Define keyboard poll method"
 432 #endif
 433 }