Rework the keyboard driver

* use readable macro names rather than numbers.
* Factor out some commonly used code

Signed-off-by: Stefan Reinauer <stepan@coresystems.de>
Acked-by: Myles Watson <mylesgw@gmail.com>


git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4842 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

1 files changed, 91 insertions, 44 deletions

diff --git a/src/pc80/keyboard.c b/src/pc80/keyboard.c
index 1b6aa4b837..c025c889fb 100644
--- a/src/pc80/keyboard.c
+++ b/src/pc80/keyboard.c
@@ -26,13 +26,47 @@
 #include <arch/io.h>
 #include <delay.h>
 
+#define KBD_DATA	0x60
+#define KBD_COMMAND	0x64
+#define KBD_STATUS	0x64
+#define   KBD_IBF	(1 << 1) // 1: input buffer full (data ready for ec)
+#define   KBD_OBF	(1 << 0) // 1: output buffer full (data ready for host)
+
+// Keyboard Controller Commands
+#define KBC_CMD_READ_COMMAND	0x20 // Read command byte
+#define KBC_CMD_WRITE_COMMAND	0x60 // Write command byte
+#define KBC_CMD_SELF_TEST	0xAA // Controller self-test
+
+/* The Keyboard controller command byte
+ *  BIT	| Description
+ *  ----+-------------------------------------------------------
+ *   7  | reserved, must be zero
+ *   6  | XT Translation, (1 = on, 0 = off)
+ *   5  | Disable Mouse Port (1 = disable, 0 = enable)
+ *   4  | Disable Keyboard Port (1 = disable, 0 = enable)
+ *   3  | reserved, must be zero
+ *   2  | System Flag (1 = self-test passed. DO NOT SET TO ZERO)
+ *   1  | Mouse Port Interrupts (1 = enable, 0 = disable)
+ *   0  | Keyboard Port Interrupts (1 = enable, 0 = disable)
+ */
+
+// Keyboard Controller Replies
+#define KBC_REPLY_SELFTEST_OK	0x55 // controller self-test succeeded
+
+//
+// Keyboard Replies
+//
+#define KBD_REPLY_POR		0xAA    // Power on reset
+#define KBD_REPLY_ACK		0xFA    // Command ACK
+#define KBD_REPLY_RESEND	0xFE    // Command NACK, send command again
+
 /* Wait 200ms for keyboard controller answers */
 #define KBC_TIMEOUT_IN_MS 200
 
 static int kbc_input_buffer_empty(void)
 {
 	u32 timeout;
-	for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(0x64) & 0x02); timeout--) {
+	for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & KBD_IBF); timeout--) {
 		mdelay(1);
 	}
 
@@ -46,7 +80,7 @@ static int kbc_input_buffer_empty(void)
 static int kbc_output_buffer_full(void)
 {
 	u32 timeout;
-	for(timeout = KBC_TIMEOUT_IN_MS; timeout && ((inb(0x64) & 0x01) == 0); timeout--) {
+	for(timeout = KBC_TIMEOUT_IN_MS; timeout && ((inb(KBD_STATUS) & KBD_OBF) == 0); timeout--) {
 		mdelay(1);
 	}
 
@@ -60,18 +94,50 @@ static int kbc_output_buffer_full(void)
 static int kbc_cleanup_buffers(void)
 {
 	u32 timeout;
-	for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(0x64) & 0x03); timeout--) {
+	for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & (KBD_OBF | KBD_IBF)); timeout--) {
 		mdelay(1);
-		inb(0x60);
+		inb(KBD_DATA);
 	}
 
 	if (!timeout) {
 		printk_err("Couldn't cleanup the keyboard controller buffers\n");
-		printk_err("0x64: 0x%x, 0x60: 0x%x\n", inb(0x64), inb(0x60));
+		printk_err("Status (0x%x): 0x%x, Buffer (0x%x): 0x%x\n",
+				KBD_STATUS, inb(KBD_STATUS), KBD_DATA, inb(KBD_DATA));
 	}
+
 	return !!timeout;
 }
 
+static int kbc_self_test(void)
+{
+	u8 self_test;
+
+	/* Clean up any junk that might have been in the KBC.
+	 * Both input and output buffers must be empty.
+	 */
+	if (!kbc_cleanup_buffers())
+		return 0;
+
+	/* reset/self test 8042 - send cmd 0xAA */
+	outb(KBC_CMD_SELF_TEST, KBD_COMMAND);
+
+	if (!kbc_output_buffer_full()) {
+		/* There probably is no keyboard controller. */
+		printk_err("Could not reset keyboard controller.\n");
+		return 0;
+	}
+
+	/* read self-test result, 0x55 is returned in the output buffer */
+	self_test = inb(KBD_DATA);
+
+	if (self_test != 0x55) {
+		printk_err("Keyboard Controller self-test failed: 0x%x\n",
+				self_test);
+		return 0;
+	}
+
+	return 1;
+}
 
 static u8 send_keyboard(u8 command)
 {
@@ -80,47 +146,33 @@ static u8 send_keyboard(u8 command)
 
 	do {
 		if (!kbc_input_buffer_empty()) return 0;
-		outb(command, 0x60);
+		outb(command, KBD_DATA);
 		if (!kbc_output_buffer_full()) {
 			printk_err("Could not send keyboard command %02x\n",
 					command);
 			return 0;
 		}
-		regval = inb(0x60);
+		regval = inb(KBD_DATA);
 		--resend;
 	} while (regval == 0xFE && resend > 0);
 
 	return regval;
 }
 
-
 static void pc_keyboard_init(struct pc_keyboard *keyboard)
 {
 	u8 regval;
 	printk_debug("Keyboard init...\n");
 
-	/* clean up any junk that might have been in the kbc */
-	if (!kbc_cleanup_buffers()) return;
-
-	/* reset/self test 8042 - send cmd 0xAA */
-	if (!kbc_input_buffer_empty()) return;
-	outb(0xAA, 0x64);
-	if (!kbc_output_buffer_full()) {
-		printk_err("Could not reset keyboard controller.\n");
+	/* Run a keyboard controller self-test */
+	if (!kbc_self_test())
 		return;
-	}
-
-	/* read self-test result, 0x55 is returned in the output buffer (0x60) */
-	if ((regval = inb(0x60) != 0x55)) {
-		printk_err("Keyboard Controller self-test failed: 0x%x\n", regval);
-		return;
-	}
 
 	/* Enable keyboard interface - No IRQ */
 	if (!kbc_input_buffer_empty()) return;
-	outb(0x60, 0x64);
+	outb(0x60, KBD_COMMAND);
 	if (!kbc_input_buffer_empty()) return;
-	outb(0x20, 0x60);	/* send cmd: enable keyboard */
+	outb(0x20, KBD_DATA);	/* send cmd: enable keyboard */
 	if (!kbc_input_buffer_empty()) {
 		printk_info("Timeout while enabling keyboard\n");
 		return;
@@ -135,12 +187,13 @@ static void pc_keyboard_init(struct pc_keyboard *keyboard)
 		printk_err("Keyboard selftest failed ACK: 0x%x\n", regval);
 		return;
 	}
+
 	if (!kbc_output_buffer_full()) {
 		printk_err("Timeout waiting for keyboard after reset.\n");
 		return;
 	}
-		
-	regval = inb(0x60);
+
+	regval = inb(KBD_DATA);
 	if (regval != 0xAA) {
 		printk_err("Keyboard selftest failed: 0x%x\n", regval);
 		return;
@@ -180,10 +233,10 @@ static void pc_keyboard_init(struct pc_keyboard *keyboard)
 
 	/* All is well - enable keyboard interface */
 	if (!kbc_input_buffer_empty()) return;
-	outb(0x60, 0x64);
+	outb(0x60, KBD_COMMAND);
 	if (!kbc_input_buffer_empty()) return;
-	outb(0x61, 0x60);	/* send cmd: enable keyboard and IRQ 1 */
-	if (!kbc_input_buffer_empty()) {
+	outb(0x61, KBD_DATA);	/* send cmd: enable keyboard and IRQ 1 */
+	if (kbc_output_buffer_full()) {
 		printk_err("Timeout during final keyboard enable\n");
 		return;
 	}
@@ -194,6 +247,8 @@ void init_pc_keyboard(unsigned port0, unsigned port1, struct pc_keyboard *kbd)
 {
 	if ((port0 == 0x60) && (port1 == 0x64)) {
 		pc_keyboard_init(kbd);
+	} else {
+		printk_warning("Unsupported keyboard controller.\n");
 	}
 }
 
@@ -204,24 +259,16 @@ void init_pc_keyboard(unsigned port0, unsigned port1, struct pc_keyboard *kbd)
  */
 void set_kbc_ps2_mode(void)
 {
-	/* clean up any junk that might have been in the kbc */
-	if (!kbc_cleanup_buffers()) return;
-
-	/* reset/self test 8042 before we can do anything */
-	if (!kbc_input_buffer_empty()) return;
-	outb(0xAA, 0x64);
-	if (!kbc_output_buffer_full()) return;
-
-	/* read self-test result, 0x55 is returned in the output buffer (0x60) */
-	if ((inb(0x60) != 0x55)) {
-		printk_err("Keyboard Controller selftest failed\n");
+	/* Run a keyboard controller self-test */
+	if (!kbc_self_test())
 		return;
-	}
 
 	/* Support PS/2 mode */
 	if (!kbc_input_buffer_empty()) return;
-	outb(0xcb, 0x64);
+	outb(0xcb, KBD_COMMAND);
+
 	if (!kbc_input_buffer_empty()) return;
-	outb(0x01, 0x60);
+	outb(0x01, KBD_DATA);
+
 	kbc_cleanup_buffers();
 }