X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fkbd.c;h=83483f4eb317408d98600b8025fa12ea98e714d0;hb=f4c89bc436e098ec88d46c1cf57f134814f35ee3;hp=d078418cf1dceae5218413e96cb37d3d23ca489e;hpb=25909cdf6e3cb243846a002cf704af8357d0ec4c;p=bertos.git

diff --git a/drv/kbd.c b/drv/kbd.c
index d078418c..83483f4e 100755
--- a/drv/kbd.c
+++ b/drv/kbd.c
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
@@ -17,6 +17,30 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.9  2006/09/13 18:25:45  bernie
+ *#* Merge CONFIG_KBD_LONGPRESS.
+ *#*
+ *#* Revision 1.8  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.7  2006/06/03 13:57:36  bernie
+ *#* Make keyboard repeat mask run-time configurable.
+ *#*
+ *#* Revision 1.6  2006/03/20 17:50:17  bernie
+ *#* Add FreeRTOS and Observers support.
+ *#*
+ *#* Revision 1.5  2006/02/27 22:39:45  bernie
+ *#* Misc build and doc fixes from project_grl.
+ *#*
+ *#* Revision 1.4  2006/02/24 00:27:14  bernie
+ *#* Use new naming convention for list macros.
+ *#*
+ *#* Revision 1.3  2006/02/17 21:15:42  bernie
+ *#* Add MOD_CHECK() checks.
+ *#*
+ *#* Revision 1.2  2006/02/10 12:36:20  bernie
+ *#* Add preliminary FreeRTOS support; Enforce CONFIG_* definitions.
+ *#*
  *#* Revision 1.1  2005/06/27 21:28:45  bernie
  *#* Import generic keyboard driver.
  *#*
@@ -26,59 +50,89 @@
 
 #include <drv/timer.h>
 #include <drv/kbd.h>
-#include <drv/buzzer.h>
 
 #include <cfg/debug.h>
+#include <cfg/module.h>
+#include <appconfig.h>
 
+/* Configuration sanity checks */
+#if !defined(CONFIG_KBD_POLL) || (CONFIG_KBD_POLL != KBD_POLL_SOFTINT && CONFIG_KBD_POLL != CONFIG_POLL_FREERTOS)
+	#error CONFIG_KBD_POLL must be defined to either KBD_POLL_SOFTINT or CONFIG_POLL_FREERTOS
+#endif
+#if !defined(CONFIG_KBD_BEEP) || (CONFIG_KBD_BEEP != 0 && CONFIG_KBD_BEEP != 1)
+	#error CONFIG_KBD_BEEP must be defined to either 0 or 1
+#endif
+#if !defined(CONFIG_KBD_OBSERVER) || (CONFIG_KBD_OBSERVER != 0 && CONFIG_KBD_OBSERVER != 1)
+	#error CONFIG_KBD_OBSERVER must be defined to either 0 or 1
+#endif
+#if !defined(CONFIG_KBD_LONGPRESS) || (CONFIG_KBD_LONGPRESS != 0 && CONFIG_KBD_LONGPRESS != 1)
+	#error CONFIG_KBD_LONGPRESS must be defined to either 0 or 1
+#endif
 
+#if CONFIG_KBD_BEEP
+	#include <drv/buzzer.h>
+#endif
 
+#define KBD_CHECK_INTERVAL  10  /**< (ms) Timing for kbd softint */
+#define KBD_DEBOUNCE_TIME   30  /**< (ms) Debounce time */
+#define KBD_BEEP_TIME        5  /**< (ms) Duration of keybeep */
 
-#define KBD_CHECK_INTERVAL  10  /*!< (ms) Timing for kbd softint */
-#define KBD_DEBOUNCE_TIME   30  /*!< (ms) Debounce time */
-#define KBD_BEEP_TIME        5  /*!< (ms) Duration of keybeep */
-
-#define KBD_REPEAT_DELAY   400  /*!< (ms) Keyboard repeat delay for first character */
-#define KBD_REPEAT_RATE    100  /*!< (ms) Initial interchar delay for keyboard repeat */
-#define KBD_REPEAT_MAXRATE  20  /*!< (ms) Minimum delay for keyboard repeat */
-#define KBD_REPEAT_ACCEL     5  /*!< (ms) Keyboard repeat speed increase */
+#define KBD_REPEAT_DELAY   400  /**< (ms) Keyboard repeat delay for first character */
+#define KBD_REPEAT_RATE    100  /**< (ms) Initial interchar delay for keyboard repeat */
+#define KBD_REPEAT_MAXRATE  20  /**< (ms) Minimum delay for keyboard repeat */
+#define KBD_REPEAT_ACCEL     5  /**< (ms) Keyboard repeat speed increase */
 
-#define KBD_LNG_DELAY     1000  /*!< (ms) Keyboard long pression keys delay */
+#define KBD_LNG_DELAY     1000  /**< (ms) Keyboard long pression keys delay */
 
 
-/*! Status for keyboard repeat state machine */
+/** Status for keyboard repeat state machine */
 static enum { KS_IDLE, KS_REPDELAY, KS_REPEAT } kbd_rptStatus;
 
 
-static volatile keymask_t kbd_buf; /*!< Single entry keyboard buffer */
-static volatile keymask_t kbd_cnt; /*!< Number of keypress events in \c kbd_buf */
+static volatile keymask_t kbd_buf; /**< Single entry keyboard buffer */
+static volatile keymask_t kbd_cnt; /**< Number of keypress events in \c kbd_buf */
+static keymask_t kbd_rpt_mask;     /**< Mask of repeatable keys. */
+
+#if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
+static Timer kbd_timer;            /**< Keyboard softtimer */
+#endif
 
-static Timer kbd_timer;            /*!< KeyboardKBD_BEEP_TIME softtimer */
+static List kbd_rawHandlers;       /**< Raw keyboard handlers */
+static List kbd_handlers;          /**< Cooked keyboard handlers */
 
-static List kbd_rawHandlers;       /*!< Raw keyboard handlers */
-static List kbd_handlers;          /*!< Cooked keyboard handlers */
+static KbdHandler kbd_defHandler;  /**< The default keyboard handler */
+static KbdHandler kbd_debHandler;  /**< The debounce keyboard handler */
+static KbdHandler kbd_rptHandler;  /**< Auto-repeat keyboard handler */
 
-static KbdHandler kbd_defHandler;  /*!< The default keyboard handler */
-static KbdHandler kbd_debHandler;  /*!< The debounce keyboard handler */
-static KbdHandler kbd_rptHandler;  /*!< Auto-repeat keyboard handler */
-#ifdef  K_LNG_MASK
-static KbdHandler kbd_lngHandler;  /*!< Long pression keys handler */
+#if CONFIG_KBD_LONGPRESS
+static KbdHandler kbd_lngHandler;  /**< Long pression keys handler */
 #endif
 
+#if CONFIG_KBD_OBSERVER
+	#include <mware/observer.h>
+	Subject kbd_subject;
+#endif
 
 
-/*!
- * Keyboard soft-irq handler.
+/**
+ * Poll keyboard and dispatch keys to handlers.
+ *
+ * Read the key states and invoke all keyboard
+ * handlers to process the new state.
+ *
+ * Call this function periodically using a software
+ * timer, an interrupt or a process.
  */
-static void kbd_softint(UNUSED_ARG(iptr_t, arg))
+static void kbd_poll(void)
 {
-	/*! Currently depressed key */
+	/** Currently depressed key */
 	static keymask_t current_key;
 
 	struct KbdHandler *handler;
 	keymask_t key = kbd_readkeys();
 
 	/* Call raw input handlers */
-	FOREACHNODE(handler, &kbd_rawHandlers)
+	FOREACH_NODE(handler, &kbd_rawHandlers)
 		key = handler->hook(key);
 
 	/* If this key was not previously pressed */
@@ -88,21 +142,47 @@ static void kbd_softint(UNUSED_ARG(iptr_t, arg))
 		current_key = key;
 
 		/* Call cooked input handlers */
-		FOREACHNODE(handler, &kbd_handlers)
+		FOREACH_NODE(handler, &kbd_handlers)
 			key = handler->hook(key);
 	}
+}
+
+#if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
 
+/**
+ * Keyboard soft-irq handler.
+ */
+static void kbd_softint(UNUSED_ARG(iptr_t, arg))
+{
+	kbd_poll();
 	timer_add(&kbd_timer);
 }
 
+#elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
+
+#include "FreeRTOS.h"
+#include "task.h"
+
+static portTASK_FUNCTION(kbd_task, arg)
+{
+	for (;;)
+	{
+		kbd_poll();
+		timer_delay(KBD_CHECK_INTERVAL);
+	}
+}
+
+#endif /* CONFIG_KBD_POLL */
 
-/*!
+/**
  * \brief Read a key from the keyboard buffer.
  *
  * When a key is kept depressed between calls of this function a value
  * is returned only after the time specified with KBD_REPAT_DELAY to
  * avoid too fast keyboard repeat.
  *
+ * \note Calls \c schedule() internally.
+ *
  * \note This function is \b not interrupt safe!
  *
  * \return The mask of depressed keys or 0 if no keys are depressed.
@@ -112,6 +192,11 @@ keymask_t kbd_peek(void)
 {
 	keymask_t key = 0;
 
+// FIXME: make it optional
+	/* Let other tasks run for a while */
+	extern void schedule(void);
+	schedule();
+
 	/* Extract an event from the keyboard buffer */
 	IRQ_DISABLE;
 	if (kbd_cnt)
@@ -124,8 +209,7 @@ keymask_t kbd_peek(void)
 	return key;
 }
 
-
-/*!
+/**
  * Wait for a keypress and return the mask of depressed keys.
  *
  * \note This function is \b not interrupt safe!
@@ -135,11 +219,12 @@ keymask_t kbd_get(void)
 	keymask_t key;
 
 	while (!(key = kbd_peek())) {}
+
 	return key;
 }
 
 
-/*!
+/**
  * Wait up to \c timeout ms for a keypress
  * and return the mask of depressed keys, or K_TIMEOUT
  * if the timeout was reacked.
@@ -177,12 +262,12 @@ void kbd_addHandler(struct KbdHandler *handler)
 	 * Search for the first node whose priority
 	 * is lower than the timer we want to add.
 	 */
-	FOREACHNODE(node,list)
+	FOREACH_NODE(node,list)
 		if (node->pri < handler->pri)
 			break;
 
 	/* Enqueue handler in the handlers chain */
-	INSERTBEFORE(&handler->link, &node->link);
+	INSERT_BEFORE(&handler->link, &node->link);
 
 	IRQ_RESTORE(flags);
 }
@@ -195,7 +280,7 @@ void kbd_remHandler(struct KbdHandler *handler)
 }
 
 
-/*!
+/**
  * This is the default key handler, called after
  * all other handlers have had their chance to
  * do their special processing. This handler
@@ -209,26 +294,32 @@ static keymask_t kbd_defHandlerFunc(keymask_t key)
 		kbd_buf = key;
 		kbd_cnt = 1;
 
-		if (!(key & K_REPEAT))
-			buz_beep(KBD_BEEP_TIME);
+		#if CONFIG_KBD_OBSERVER
+			observer_notify(&kbd_subject, KBD_EVENT_KEY, &key);
+		#endif
+
+		#if CONFIG_KBD_BEEP
+			if (!(key & K_REPEAT))
+				buz_beep(KBD_BEEP_TIME);
+		#endif
 	}
 
 	/* Eat all input */
 	return 0;
 }
 
-/*!
+/**
  * Handle keyboard debounce
  */
 static keymask_t kbd_debHandlerFunc(keymask_t key)
 {
-	/*! Buffer for debounce */
+	/** Buffer for debounce */
 	static keymask_t debounce_key;
 
-	/*! Timer for keyboard debounce */
+	/** Timer for keyboard debounce */
 	static ticks_t debounce_time;
 
-	/*! Key aquired after debounce */
+	/** Key aquired after debounce */
 	static keymask_t new_key;
 
 
@@ -250,44 +341,53 @@ static keymask_t kbd_debHandlerFunc(keymask_t key)
 	return new_key;
 }
 
-#ifdef  K_LNG_MASK
-/*!
- * Handle long pression keys
+#if CONFIG_KBD_LONGPRESS
+/**
+ * Handle long pression keys.
  */
 static keymask_t kbd_lngHandlerFunc(keymask_t key)
 {
-	static ticks_t stop;
+	static ticks_t start;
 	ticks_t now = timer_clock();
 
 	if (key & K_LNG_MASK)
 	{
-		if (now - stop > 0)
-			key &= K_LNG_MASK;
-		else
-			key &= ~K_LNG_MASK;
+		if (now - start > ms_to_ticks(KBD_LNG_DELAY))
+			key |= K_LONG;
 	}
 	else
-		stop = now + ms_to_ticks(KBD_LNG_DELAY);
+		start = now;
 	return key;
 }
 #endif
 
-/*!
+/**
+ * Set current mask of repeatable keys.
+ */
+keymask_t kbd_setRepeatMask(keymask_t mask)
+{
+	keymask_t oldmask = kbd_rpt_mask;
+	ATOMIC(kbd_rpt_mask = mask);
+	return oldmask;
+}
+
+/**
  * Handle keyboard repeat
  */
 static keymask_t kbd_rptHandlerFunc(keymask_t key)
 {
-	/*! Timer for keyboard repeat events */
+	/* Timer for keyboard repeat events. */
 	static ticks_t repeat_time;
 
-	static ticks_t repeat_rate; /*! Current repeat rate (for acceleration) */
+	/* Current repeat rate (for acceleration). */
+	static ticks_t repeat_rate; /** Current repeat rate (for acceleration) */
 
 	ticks_t now = timer_clock();
 
 	switch (kbd_rptStatus)
 	{
 		case KS_IDLE:
-			if (key & K_RPT_MASK)
+			if (key & kbd_rpt_mask)
 			{
 				repeat_time = now;
 				kbd_rptStatus = KS_REPDELAY;
@@ -295,11 +395,11 @@ static keymask_t kbd_rptHandlerFunc(keymask_t key)
 			break;
 
 		case KS_REPDELAY:
-			if (key & K_RPT_MASK)
+			if (key & kbd_rpt_mask)
 			{
 				if (now - repeat_time > ms_to_ticks(KBD_REPEAT_DELAY))
 				{
-					key = (key & K_RPT_MASK) | K_REPEAT;
+					key = (key & kbd_rpt_mask) | K_REPEAT;
 					repeat_time = now;
 					repeat_rate = ms_to_ticks(KBD_REPEAT_RATE);
 					kbd_rptStatus = KS_REPEAT;
@@ -312,12 +412,12 @@ static keymask_t kbd_rptHandlerFunc(keymask_t key)
 			break;
 
 		case KS_REPEAT:
-			if (key & K_RPT_MASK)
+			if (key & kbd_rpt_mask)
 			{
 				if (now - repeat_time > repeat_rate)
 				{
 					/* Enqueue a new event in the buffer */
-					key = (key & K_RPT_MASK) | K_REPEAT;
+					key = (key & kbd_rpt_mask) | K_REPEAT;
 					repeat_time = now;
 
 					/* Repeat rate acceleration */
@@ -337,20 +437,19 @@ static keymask_t kbd_rptHandlerFunc(keymask_t key)
 }
 
 
+MOD_DEFINE(kbd)
 
-/*!
+/**
  * Initialize keyboard ports and softtimer
  */
 void kbd_init(void)
 {
-
-	cpuflags_t flags;
-	IRQ_SAVE_DISABLE(flags);
+#if CONFIG_KBD_BEEP
+	MOD_CHECK(buzzer);
+#endif
 
 	KBD_HW_INIT;
 
-	IRQ_RESTORE(flags);
-
 	/* Init handlers lists */
 	LIST_INIT(&kbd_handlers);
 	LIST_INIT(&kbd_rawHandlers);
@@ -361,7 +460,7 @@ void kbd_init(void)
 	kbd_debHandler.flags = KHF_RAWKEYS;
 	kbd_addHandler(&kbd_debHandler);
 
-	#ifdef  K_LNG_MASK
+	#if CONFIG_KBD_LONGPRESS
 	/* Add long pression keyboard handler */
 	kbd_lngHandler.hook = kbd_lngHandlerFunc;
 	kbd_lngHandler.pri = 90; /* high priority */
@@ -369,21 +468,39 @@ void kbd_init(void)
 	kbd_addHandler(&kbd_lngHandler);
 	#endif
 
-
 	/* Add repeat keyboard handler */
 	kbd_rptHandler.hook = kbd_rptHandlerFunc;
 	kbd_rptHandler.pri = 80; /* high priority */
 	kbd_rptHandler.flags = KHF_RAWKEYS;
 	kbd_addHandler(&kbd_rptHandler);
 
-
 	/* Add default keyboard handler */
 	kbd_defHandler.hook = kbd_defHandlerFunc;
 	kbd_defHandler.pri = -128; /* lowest priority */
 	kbd_addHandler(&kbd_defHandler);
 
+#if CONFIG_KBD_OBSERVER
+	observer_InitSubject(&kbd_subject);
+#endif
+
+#if CONFIG_KBD_POLL == KBD_POLL_SOFTINT
+
+	MOD_CHECK(timer);
+
 	/* Add kbd handler to soft timers list */
-	event_initSoftInt(&kbd_timer.expire, kbd_softint, 0);
+	event_initSoftInt(&kbd_timer.expire, kbd_softint, NULL);
 	timer_setDelay(&kbd_timer, ms_to_ticks(KBD_CHECK_INTERVAL));
 	timer_add(&kbd_timer);
+
+#elif CONFIG_KBD_POLL == CONFIG_POLL_FREERTOS
+
+	/* Create a timer specific thread */
+	xTaskCreate(kbd_task, "kbd", CONFIG_STACK_KBD,
+			NULL, CONFIG_PRI_KBD, NULL);
+
+#else
+	#error "Define keyboard poll method"
+#endif
+
+	MOD_INIT(kbd);
 }