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.5 2006/02/27 22:39:45 bernie
21 *#* Misc build and doc fixes from project_grl.
23 *#* Revision 1.4 2006/02/24 00:27:14 bernie
24 *#* Use new naming convention for list macros.
26 *#* Revision 1.3 2006/02/17 21:15:42 bernie
27 *#* Add MOD_CHECK() checks.
29 *#* Revision 1.2 2006/02/10 12:36:20 bernie
30 *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
32 *#* Revision 1.1 2005/06/27 21:28:45 bernie
33 *#* Import generic keyboard driver.
39 #include <drv/timer.h>
41 #include <drv/buzzer.h>
43 #include <cfg/debug.h>
44 #include <cfg/module.h>
45 #include <appconfig.h>
47 /* Configuration sanity checks */
48 #if !defined(CONFIG_KBD_POLL) || (CONFIG_KBD_POLL != KBD_POLL_SOFTINT && CONFIG_KBD_POLL != CONFIG_POLL_FREERTOS)
49 #error CONFIG_KBD_POLL must be defined to either KBD_POLL_SOFTINT or CONFIG_POLL_FREERTOS
53 #define KBD_CHECK_INTERVAL 10 /*!< (ms) Timing for kbd softint */
54 #define KBD_DEBOUNCE_TIME 30 /*!< (ms) Debounce time */
55 #define KBD_BEEP_TIME 5 /*!< (ms) Duration of keybeep */
57 #define KBD_REPEAT_DELAY 400 /*!< (ms) Keyboard repeat delay for first character */
58 #define KBD_REPEAT_RATE 100 /*!< (ms) Initial interchar delay for keyboard repeat */
59 #define KBD_REPEAT_MAXRATE 20 /*!< (ms) Minimum delay for keyboard repeat */
60 #define KBD_REPEAT_ACCEL 5 /*!< (ms) Keyboard repeat speed increase */
62 #define KBD_LNG_DELAY 1000 /*!< (ms) Keyboard long pression keys delay */
65 /*! Status for keyboard repeat state machine */
66 static enum { KS_IDLE, KS_REPDELAY, KS_REPEAT } kbd_rptStatus;
69 static volatile keymask_t kbd_buf; /*!< Single entry keyboard buffer */
70 static volatile keymask_t kbd_cnt; /*!< Number of keypress events in \c kbd_buf */
72 #if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
73 static Timer kbd_timer; /*!< Keyboard softtimer */
76 static List kbd_rawHandlers; /*!< Raw keyboard handlers */
77 static List kbd_handlers; /*!< Cooked keyboard handlers */
79 static KbdHandler kbd_defHandler; /*!< The default keyboard handler */
80 static KbdHandler kbd_debHandler; /*!< The debounce keyboard handler */
81 static KbdHandler kbd_rptHandler; /*!< Auto-repeat keyboard handler */
83 static KbdHandler kbd_lngHandler; /*!< Long pression keys handler */
89 * Poll keyboard and dispatch keys to handlers.
91 * Read the key states and invoke all keyboard
92 * handlers to process the new state.
94 * Call this function periodically using a software
95 * timer, an interrupt or a process.
97 static void kbd_poll(void)
99 /*! Currently depressed key */
100 static keymask_t current_key;
102 struct KbdHandler *handler;
103 keymask_t key = kbd_readkeys();
105 /* Call raw input handlers */
106 FOREACH_NODE(handler, &kbd_rawHandlers)
107 key = handler->hook(key);
109 /* If this key was not previously pressed */
110 if (key != current_key)
112 /* Remember last key */
115 /* Call cooked input handlers */
116 FOREACH_NODE(handler, &kbd_handlers)
117 key = handler->hook(key);
121 #if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
124 * Keyboard soft-irq handler.
126 static void kbd_softint(UNUSED_ARG(iptr_t, arg))
129 timer_add(&kbd_timer);
132 #elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
134 #include "FreeRTOS.h"
137 static portTASK_FUNCTION(kbd_task, arg)
142 timer_delay(KBD_CHECK_INTERVAL);
146 #endif /* CONFIG_KBD_POLL */
149 * \brief Read a key from the keyboard buffer.
151 * When a key is kept depressed between calls of this function a value
152 * is returned only after the time specified with KBD_REPAT_DELAY to
153 * avoid too fast keyboard repeat.
155 * \note This function is \b not interrupt safe!
157 * \return The mask of depressed keys or 0 if no keys are depressed.
160 keymask_t kbd_peek(void)
165 extern void schedule(void);
168 /* Extract an event from the keyboard buffer */
182 * Wait for a keypress and return the mask of depressed keys.
184 * \note This function is \b not interrupt safe!
186 keymask_t kbd_get(void)
190 while (!(key = kbd_peek())) {}
196 * Wait up to \c timeout ms for a keypress
197 * and return the mask of depressed keys, or K_TIMEOUT
198 * if the timeout was reacked.
200 keymask_t kbd_get_timeout(mtime_t timeout)
204 ticks_t start = timer_clock();
205 ticks_t stop = ms_to_ticks(timeout);
208 if ((key = kbd_peek()))
211 while (timer_clock() - start < stop);
217 void kbd_addHandler(struct KbdHandler *handler)
223 IRQ_SAVE_DISABLE(flags);
225 /* Choose between raw and coocked handlers list */
226 list = (handler->flags & KHF_RAWKEYS) ?
227 &kbd_rawHandlers : &kbd_handlers;
230 * Search for the first node whose priority
231 * is lower than the timer we want to add.
233 FOREACH_NODE(node,list)
234 if (node->pri < handler->pri)
237 /* Enqueue handler in the handlers chain */
238 INSERT_BEFORE(&handler->link, &node->link);
244 void kbd_remHandler(struct KbdHandler *handler)
246 /* Remove the handler */
247 ATOMIC(REMOVE(&handler->link));
252 * This is the default key handler, called after
253 * all other handlers have had their chance to
254 * do their special processing. This handler
255 * pushes all input in the keyboard FIFO buffer.
257 static keymask_t kbd_defHandlerFunc(keymask_t key)
261 /* Force a single event in kbd buffer */
266 if (!(key & K_REPEAT))
267 buz_beep(KBD_BEEP_TIME);
276 * Handle keyboard debounce
278 static keymask_t kbd_debHandlerFunc(keymask_t key)
280 /*! Buffer for debounce */
281 static keymask_t debounce_key;
283 /*! Timer for keyboard debounce */
284 static ticks_t debounce_time;
286 /*! Key aquired after debounce */
287 static keymask_t new_key;
290 ticks_t now = timer_clock();
292 if (key != debounce_key)
294 /* Reset debounce timer */
298 else if ((new_key != debounce_key)
299 && (now - debounce_time > ms_to_ticks(KBD_DEBOUNCE_TIME)))
301 new_key = debounce_key;
310 * Handle long pression keys
312 static keymask_t kbd_lngHandlerFunc(keymask_t key)
315 ticks_t now = timer_clock();
317 if (key & K_LNG_MASK)
325 stop = now + ms_to_ticks(KBD_LNG_DELAY);
331 * Handle keyboard repeat
333 static keymask_t kbd_rptHandlerFunc(keymask_t key)
335 /*! Timer for keyboard repeat events */
336 static ticks_t repeat_time;
338 static ticks_t repeat_rate; /*! Current repeat rate (for acceleration) */
340 ticks_t now = timer_clock();
342 switch (kbd_rptStatus)
345 if (key & K_RPT_MASK)
348 kbd_rptStatus = KS_REPDELAY;
353 if (key & K_RPT_MASK)
355 if (now - repeat_time > ms_to_ticks(KBD_REPEAT_DELAY))
357 key = (key & K_RPT_MASK) | K_REPEAT;
359 repeat_rate = ms_to_ticks(KBD_REPEAT_RATE);
360 kbd_rptStatus = KS_REPEAT;
366 kbd_rptStatus = KS_IDLE;
370 if (key & K_RPT_MASK)
372 if (now - repeat_time > repeat_rate)
374 /* Enqueue a new event in the buffer */
375 key = (key & K_RPT_MASK) | K_REPEAT;
378 /* Repeat rate acceleration */
379 if (repeat_rate > ms_to_ticks(KBD_REPEAT_MAXRATE))
380 repeat_rate -= ms_to_ticks(KBD_REPEAT_ACCEL);
386 kbd_rptStatus = KS_IDLE;
398 * Initialize keyboard ports and softtimer
406 /* Init handlers lists */
407 LIST_INIT(&kbd_handlers);
408 LIST_INIT(&kbd_rawHandlers);
410 /* Add debounce keyboard handler */
411 kbd_debHandler.hook = kbd_debHandlerFunc;
412 kbd_debHandler.pri = 100; /* high priority */
413 kbd_debHandler.flags = KHF_RAWKEYS;
414 kbd_addHandler(&kbd_debHandler);
417 /* Add long pression keyboard handler */
418 kbd_lngHandler.hook = kbd_lngHandlerFunc;
419 kbd_lngHandler.pri = 90; /* high priority */
420 kbd_lngHandler.flags = KHF_RAWKEYS;
421 kbd_addHandler(&kbd_lngHandler);
424 /* Add repeat keyboard handler */
425 kbd_rptHandler.hook = kbd_rptHandlerFunc;
426 kbd_rptHandler.pri = 80; /* high priority */
427 kbd_rptHandler.flags = KHF_RAWKEYS;
428 kbd_addHandler(&kbd_rptHandler);
430 /* Add default keyboard handler */
431 kbd_defHandler.hook = kbd_defHandlerFunc;
432 kbd_defHandler.pri = -128; /* lowest priority */
433 kbd_addHandler(&kbd_defHandler);
435 #if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
439 /* Add kbd handler to soft timers list */
440 event_initSoftInt(&kbd_timer.expire, kbd_softint, 0);
441 timer_setDelay(&kbd_timer, ms_to_ticks(KBD_CHECK_INTERVAL));
442 timer_add(&kbd_timer);
444 #elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
446 /* Create a timer specific thread */
447 xTaskCreate(kbd_task, "kbd", CONFIG_STACK_KBD,
448 NULL, CONFIG_PRI_KBD, NULL);
451 #error "Define keyboard poll method"