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