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.2 2006/02/10 12:36:20 bernie
21 *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
23 *#* Revision 1.1 2005/06/27 21:28:45 bernie
24 *#* Import generic keyboard driver.
30 #include <drv/timer.h>
32 #include <drv/buzzer.h>
34 #include <cfg/debug.h>
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
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 */
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 */
51 #define KBD_LNG_DELAY 1000 /*!< (ms) Keyboard long pression keys delay */
54 /*! Status for keyboard repeat state machine */
55 static enum { KS_IDLE, KS_REPDELAY, KS_REPEAT } kbd_rptStatus;
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 */
61 static Timer kbd_timer; /*!< Keyboard softtimer */
63 static List kbd_rawHandlers; /*!< Raw keyboard handlers */
64 static List kbd_handlers; /*!< Cooked keyboard handlers */
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 */
70 static KbdHandler kbd_lngHandler; /*!< Long pression keys handler */
76 * Poll keyboard and dispatch keys to handlers.
78 * Read the key states and invoke all keyboard
79 * handlers to process the new state.
81 * Call this function periodically using a software
82 * timer, an interrupt or a process.
84 static void kbd_poll(void)
86 /*! Currently depressed key */
87 static keymask_t current_key;
89 struct KbdHandler *handler;
90 keymask_t key = kbd_readkeys();
92 /* Call raw input handlers */
93 FOREACHNODE(handler, &kbd_rawHandlers)
94 key = handler->hook(key);
96 /* If this key was not previously pressed */
97 if (key != current_key)
99 /* Remember last key */
102 /* Call cooked input handlers */
103 FOREACHNODE(handler, &kbd_handlers)
104 key = handler->hook(key);
108 #if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
111 * Keyboard soft-irq handler.
113 static void kbd_softint(UNUSED_ARG(iptr_t, arg))
116 timer_add(&kbd_timer);
119 #elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
121 #include "FreeRTOS.h"
124 static portTASK_FUNCTION(kbd_poll, arg)
129 timer_delay(KBD_CHECK_INTERVAL);
133 #endif /* CONFIG_KBD_POLL */
136 * \brief Read a key from the keyboard buffer.
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.
142 * \note This function is \b not interrupt safe!
144 * \return The mask of depressed keys or 0 if no keys are depressed.
147 keymask_t kbd_peek(void)
152 extern void schedule(void);
155 /* Extract an event from the keyboard buffer */
169 * Wait for a keypress and return the mask of depressed keys.
171 * \note This function is \b not interrupt safe!
173 keymask_t kbd_get(void)
177 while (!(key = kbd_peek())) {}
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.
187 keymask_t kbd_get_timeout(mtime_t timeout)
191 ticks_t start = timer_clock();
192 ticks_t stop = ms_to_ticks(timeout);
195 if ((key = kbd_peek()))
198 while (timer_clock() - start < stop);
204 void kbd_addHandler(struct KbdHandler *handler)
210 IRQ_SAVE_DISABLE(flags);
212 /* Choose between raw and coocked handlers list */
213 list = (handler->flags & KHF_RAWKEYS) ?
214 &kbd_rawHandlers : &kbd_handlers;
217 * Search for the first node whose priority
218 * is lower than the timer we want to add.
220 FOREACHNODE(node,list)
221 if (node->pri < handler->pri)
224 /* Enqueue handler in the handlers chain */
225 INSERTBEFORE(&handler->link, &node->link);
231 void kbd_remHandler(struct KbdHandler *handler)
233 /* Remove the handler */
234 ATOMIC(REMOVE(&handler->link));
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.
244 static keymask_t kbd_defHandlerFunc(keymask_t key)
248 /* Force a single event in kbd buffer */
253 if (!(key & K_REPEAT))
254 buz_beep(KBD_BEEP_TIME);
263 * Handle keyboard debounce
265 static keymask_t kbd_debHandlerFunc(keymask_t key)
267 /*! Buffer for debounce */
268 static keymask_t debounce_key;
270 /*! Timer for keyboard debounce */
271 static ticks_t debounce_time;
273 /*! Key aquired after debounce */
274 static keymask_t new_key;
277 ticks_t now = timer_clock();
279 if (key != debounce_key)
281 /* Reset debounce timer */
285 else if ((new_key != debounce_key)
286 && (now - debounce_time > ms_to_ticks(KBD_DEBOUNCE_TIME)))
288 new_key = debounce_key;
297 * Handle long pression keys
299 static keymask_t kbd_lngHandlerFunc(keymask_t key)
302 ticks_t now = timer_clock();
304 if (key & K_LNG_MASK)
312 stop = now + ms_to_ticks(KBD_LNG_DELAY);
318 * Handle keyboard repeat
320 static keymask_t kbd_rptHandlerFunc(keymask_t key)
322 /*! Timer for keyboard repeat events */
323 static ticks_t repeat_time;
325 static ticks_t repeat_rate; /*! Current repeat rate (for acceleration) */
327 ticks_t now = timer_clock();
329 switch (kbd_rptStatus)
332 if (key & K_RPT_MASK)
335 kbd_rptStatus = KS_REPDELAY;
340 if (key & K_RPT_MASK)
342 if (now - repeat_time > ms_to_ticks(KBD_REPEAT_DELAY))
344 key = (key & K_RPT_MASK) | K_REPEAT;
346 repeat_rate = ms_to_ticks(KBD_REPEAT_RATE);
347 kbd_rptStatus = KS_REPEAT;
353 kbd_rptStatus = KS_IDLE;
357 if (key & K_RPT_MASK)
359 if (now - repeat_time > repeat_rate)
361 /* Enqueue a new event in the buffer */
362 key = (key & K_RPT_MASK) | K_REPEAT;
365 /* Repeat rate acceleration */
366 if (repeat_rate > ms_to_ticks(KBD_REPEAT_MAXRATE))
367 repeat_rate -= ms_to_ticks(KBD_REPEAT_ACCEL);
373 kbd_rptStatus = KS_IDLE;
384 * Initialize keyboard ports and softtimer
390 /* Init handlers lists */
391 LIST_INIT(&kbd_handlers);
392 LIST_INIT(&kbd_rawHandlers);
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);
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);
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);
416 /* Add default keyboard handler */
417 kbd_defHandler.hook = kbd_defHandlerFunc;
418 kbd_defHandler.pri = -128; /* lowest priority */
419 kbd_addHandler(&kbd_defHandler);
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);
431 #error "Define keyboard poll method"