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.
11 * \author Bernardo Innocenti <bernie@develer.com>
12 * \author Stefano Fedrigo <aleph@develer.com>
13 * \author Francesco Sacchi <batt@develer.com>
15 * \brief Keyboard driver (implementation)
20 *#* Revision 1.1 2005/06/27 21:28:45 bernie
21 *#* Import generic keyboard driver.
27 #include <drv/timer.h>
29 #include <drv/buzzer.h>
31 #include <cfg/debug.h>
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 */
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 */
45 #define KBD_LNG_DELAY 1000 /*!< (ms) Keyboard long pression keys delay */
48 /*! Status for keyboard repeat state machine */
49 static enum { KS_IDLE, KS_REPDELAY, KS_REPEAT } kbd_rptStatus;
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 */
55 static Timer kbd_timer; /*!< KeyboardKBD_BEEP_TIME softtimer */
57 static List kbd_rawHandlers; /*!< Raw keyboard handlers */
58 static List kbd_handlers; /*!< Cooked keyboard handlers */
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 */
64 static KbdHandler kbd_lngHandler; /*!< Long pression keys handler */
70 * Keyboard soft-irq handler.
72 static void kbd_softint(UNUSED_ARG(iptr_t, arg))
74 /*! Currently depressed key */
75 static keymask_t current_key;
77 struct KbdHandler *handler;
78 keymask_t key = kbd_readkeys();
80 /* Call raw input handlers */
81 FOREACHNODE(handler, &kbd_rawHandlers)
82 key = handler->hook(key);
84 /* If this key was not previously pressed */
85 if (key != current_key)
87 /* Remember last key */
90 /* Call cooked input handlers */
91 FOREACHNODE(handler, &kbd_handlers)
92 key = handler->hook(key);
95 timer_add(&kbd_timer);
100 * \brief Read a key from the keyboard buffer.
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.
106 * \note This function is \b not interrupt safe!
108 * \return The mask of depressed keys or 0 if no keys are depressed.
111 keymask_t kbd_peek(void)
115 /* Extract an event from the keyboard buffer */
129 * Wait for a keypress and return the mask of depressed keys.
131 * \note This function is \b not interrupt safe!
133 keymask_t kbd_get(void)
137 while (!(key = kbd_peek())) {}
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.
147 keymask_t kbd_get_timeout(mtime_t timeout)
151 ticks_t start = timer_clock();
152 ticks_t stop = ms_to_ticks(timeout);
155 if ((key = kbd_peek()))
158 while (timer_clock() - start < stop);
164 void kbd_addHandler(struct KbdHandler *handler)
170 IRQ_SAVE_DISABLE(flags);
172 /* Choose between raw and coocked handlers list */
173 list = (handler->flags & KHF_RAWKEYS) ?
174 &kbd_rawHandlers : &kbd_handlers;
177 * Search for the first node whose priority
178 * is lower than the timer we want to add.
180 FOREACHNODE(node,list)
181 if (node->pri < handler->pri)
184 /* Enqueue handler in the handlers chain */
185 INSERTBEFORE(&handler->link, &node->link);
191 void kbd_remHandler(struct KbdHandler *handler)
193 /* Remove the handler */
194 ATOMIC(REMOVE(&handler->link));
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.
204 static keymask_t kbd_defHandlerFunc(keymask_t key)
208 /* Force a single event in kbd buffer */
212 if (!(key & K_REPEAT))
213 buz_beep(KBD_BEEP_TIME);
221 * Handle keyboard debounce
223 static keymask_t kbd_debHandlerFunc(keymask_t key)
225 /*! Buffer for debounce */
226 static keymask_t debounce_key;
228 /*! Timer for keyboard debounce */
229 static ticks_t debounce_time;
231 /*! Key aquired after debounce */
232 static keymask_t new_key;
235 ticks_t now = timer_clock();
237 if (key != debounce_key)
239 /* Reset debounce timer */
243 else if ((new_key != debounce_key)
244 && (now - debounce_time > ms_to_ticks(KBD_DEBOUNCE_TIME)))
246 new_key = debounce_key;
255 * Handle long pression keys
257 static keymask_t kbd_lngHandlerFunc(keymask_t key)
260 ticks_t now = timer_clock();
262 if (key & K_LNG_MASK)
270 stop = now + ms_to_ticks(KBD_LNG_DELAY);
276 * Handle keyboard repeat
278 static keymask_t kbd_rptHandlerFunc(keymask_t key)
280 /*! Timer for keyboard repeat events */
281 static ticks_t repeat_time;
283 static ticks_t repeat_rate; /*! Current repeat rate (for acceleration) */
285 ticks_t now = timer_clock();
287 switch (kbd_rptStatus)
290 if (key & K_RPT_MASK)
293 kbd_rptStatus = KS_REPDELAY;
298 if (key & K_RPT_MASK)
300 if (now - repeat_time > ms_to_ticks(KBD_REPEAT_DELAY))
302 key = (key & K_RPT_MASK) | K_REPEAT;
304 repeat_rate = ms_to_ticks(KBD_REPEAT_RATE);
305 kbd_rptStatus = KS_REPEAT;
311 kbd_rptStatus = KS_IDLE;
315 if (key & K_RPT_MASK)
317 if (now - repeat_time > repeat_rate)
319 /* Enqueue a new event in the buffer */
320 key = (key & K_RPT_MASK) | K_REPEAT;
323 /* Repeat rate acceleration */
324 if (repeat_rate > ms_to_ticks(KBD_REPEAT_MAXRATE))
325 repeat_rate -= ms_to_ticks(KBD_REPEAT_ACCEL);
331 kbd_rptStatus = KS_IDLE;
342 * Initialize keyboard ports and softtimer
348 IRQ_SAVE_DISABLE(flags);
354 /* Init handlers lists */
355 LIST_INIT(&kbd_handlers);
356 LIST_INIT(&kbd_rawHandlers);
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);
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);
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);
380 /* Add default keyboard handler */
381 kbd_defHandler.hook = kbd_defHandlerFunc;
382 kbd_defHandler.pri = -128; /* lowest priority */
383 kbd_addHandler(&kbd_defHandler);
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);