Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 1 | /* |
| 2 | * This file is part of the coreboot project. |
| 3 | * |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 4 | * Copyright (C) 2009 coresystems GmbH |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 5 | * Copyright (C) 2008 Advanced Micro Devices, Inc. |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 6 | * Copyright (C) 2003 Ollie Lo <ollielo@hotmail.com> |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU General Public License as published by |
| 10 | * the Free Software Foundation; version 2 of the License. |
| 11 | * |
| 12 | * This program is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | * GNU General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License |
| 18 | * along with this program; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | |
Eric Biederman | 5cd8173 | 2004-03-11 15:01:31 +0000 | [diff] [blame] | 23 | #include <console/console.h> |
| 24 | #include <pc80/keyboard.h> |
| 25 | #include <device/device.h> |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 26 | #include <arch/io.h> |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 27 | #include <delay.h> |
| 28 | |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 29 | #define KBD_DATA 0x60 |
| 30 | #define KBD_COMMAND 0x64 |
| 31 | #define KBD_STATUS 0x64 |
| 32 | #define KBD_IBF (1 << 1) // 1: input buffer full (data ready for ec) |
| 33 | #define KBD_OBF (1 << 0) // 1: output buffer full (data ready for host) |
| 34 | |
| 35 | // Keyboard Controller Commands |
| 36 | #define KBC_CMD_READ_COMMAND 0x20 // Read command byte |
| 37 | #define KBC_CMD_WRITE_COMMAND 0x60 // Write command byte |
| 38 | #define KBC_CMD_SELF_TEST 0xAA // Controller self-test |
| 39 | |
| 40 | /* The Keyboard controller command byte |
| 41 | * BIT | Description |
| 42 | * ----+------------------------------------------------------- |
| 43 | * 7 | reserved, must be zero |
| 44 | * 6 | XT Translation, (1 = on, 0 = off) |
| 45 | * 5 | Disable Mouse Port (1 = disable, 0 = enable) |
| 46 | * 4 | Disable Keyboard Port (1 = disable, 0 = enable) |
| 47 | * 3 | reserved, must be zero |
| 48 | * 2 | System Flag (1 = self-test passed. DO NOT SET TO ZERO) |
| 49 | * 1 | Mouse Port Interrupts (1 = enable, 0 = disable) |
| 50 | * 0 | Keyboard Port Interrupts (1 = enable, 0 = disable) |
| 51 | */ |
| 52 | |
| 53 | // Keyboard Controller Replies |
| 54 | #define KBC_REPLY_SELFTEST_OK 0x55 // controller self-test succeeded |
| 55 | |
| 56 | // |
| 57 | // Keyboard Replies |
| 58 | // |
| 59 | #define KBD_REPLY_POR 0xAA // Power on reset |
| 60 | #define KBD_REPLY_ACK 0xFA // Command ACK |
| 61 | #define KBD_REPLY_RESEND 0xFE // Command NACK, send command again |
| 62 | |
Stefan Reinauer | d1149d7 | 2010-03-24 21:24:17 +0000 | [diff] [blame] | 63 | /* Wait 400ms for keyboard controller answers */ |
| 64 | #define KBC_TIMEOUT_IN_MS 400 |
Ronald G. Minnich | 430111b | 2003-09-26 16:12:23 +0000 | [diff] [blame] | 65 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 66 | static int kbc_input_buffer_empty(void) |
Eric Biederman | 029517c | 2004-11-11 11:56:00 +0000 | [diff] [blame] | 67 | { |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 68 | u32 timeout; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 69 | for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & KBD_IBF); timeout--) { |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 70 | mdelay(1); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | if (!timeout) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 74 | printk(BIOS_WARNING, "Unexpected Keyboard controller input buffer full\n"); |
Eric Biederman | 029517c | 2004-11-11 11:56:00 +0000 | [diff] [blame] | 75 | } |
| 76 | return !!timeout; |
| 77 | } |
| 78 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 79 | |
| 80 | static int kbc_output_buffer_full(void) |
Eric Biederman | 029517c | 2004-11-11 11:56:00 +0000 | [diff] [blame] | 81 | { |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 82 | u32 timeout; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 83 | for(timeout = KBC_TIMEOUT_IN_MS; timeout && ((inb(KBD_STATUS) & KBD_OBF) == 0); timeout--) { |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 84 | mdelay(1); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | if (!timeout) { |
Stefan Reinauer | d1149d7 | 2010-03-24 21:24:17 +0000 | [diff] [blame] | 88 | printk(BIOS_INFO, "Keyboard controller output buffer result timeout\n"); |
Eric Biederman | 029517c | 2004-11-11 11:56:00 +0000 | [diff] [blame] | 89 | } |
| 90 | return !!timeout; |
| 91 | } |
| 92 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 93 | |
| 94 | static int kbc_cleanup_buffers(void) |
| 95 | { |
| 96 | u32 timeout; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 97 | for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & (KBD_OBF | KBD_IBF)); timeout--) { |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 98 | mdelay(1); |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 99 | inb(KBD_DATA); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | if (!timeout) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 103 | printk(BIOS_ERR, "Couldn't cleanup the keyboard controller buffers\n"); |
| 104 | printk(BIOS_ERR, "Status (0x%x): 0x%x, Buffer (0x%x): 0x%x\n", |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 105 | KBD_STATUS, inb(KBD_STATUS), KBD_DATA, inb(KBD_DATA)); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 106 | } |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 107 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 108 | return !!timeout; |
| 109 | } |
| 110 | |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 111 | static int kbc_self_test(void) |
| 112 | { |
| 113 | u8 self_test; |
| 114 | |
| 115 | /* Clean up any junk that might have been in the KBC. |
| 116 | * Both input and output buffers must be empty. |
| 117 | */ |
| 118 | if (!kbc_cleanup_buffers()) |
| 119 | return 0; |
| 120 | |
| 121 | /* reset/self test 8042 - send cmd 0xAA */ |
| 122 | outb(KBC_CMD_SELF_TEST, KBD_COMMAND); |
| 123 | |
| 124 | if (!kbc_output_buffer_full()) { |
| 125 | /* There probably is no keyboard controller. */ |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 126 | printk(BIOS_ERR, "Could not reset keyboard controller.\n"); |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 127 | return 0; |
| 128 | } |
| 129 | |
| 130 | /* read self-test result, 0x55 is returned in the output buffer */ |
| 131 | self_test = inb(KBD_DATA); |
| 132 | |
| 133 | if (self_test != 0x55) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 134 | printk(BIOS_ERR, "Keyboard Controller self-test failed: 0x%x\n", |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 135 | self_test); |
| 136 | return 0; |
| 137 | } |
| 138 | |
| 139 | return 1; |
| 140 | } |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 141 | |
| 142 | static u8 send_keyboard(u8 command) |
| 143 | { |
| 144 | u8 regval = 0; |
| 145 | u8 resend = 10; |
| 146 | |
| 147 | do { |
| 148 | if (!kbc_input_buffer_empty()) return 0; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 149 | outb(command, KBD_DATA); |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 150 | if (!kbc_output_buffer_full()) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 151 | printk(BIOS_ERR, "Could not send keyboard command %02x\n", |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 152 | command); |
| 153 | return 0; |
| 154 | } |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 155 | regval = inb(KBD_DATA); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 156 | --resend; |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 157 | } while (regval == KBD_REPLY_RESEND && resend > 0); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 158 | |
| 159 | return regval; |
| 160 | } |
| 161 | |
Stefan Reinauer | 740b587 | 2010-02-23 20:31:37 +0000 | [diff] [blame] | 162 | void pc_keyboard_init(struct pc_keyboard *keyboard) |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 163 | { |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 164 | u8 regval; |
Kevin O'Connor | 9c35c84 | 2010-09-09 08:34:02 +0000 | [diff] [blame] | 165 | if (!CONFIG_DRIVERS_PS2_KEYBOARD) |
| 166 | return; |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 167 | printk(BIOS_DEBUG, "Keyboard init...\n"); |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 168 | |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 169 | /* Run a keyboard controller self-test */ |
| 170 | if (!kbc_self_test()) |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 171 | return; |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 172 | |
| 173 | /* Enable keyboard interface - No IRQ */ |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 174 | if (!kbc_input_buffer_empty()) return; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 175 | outb(0x60, KBD_COMMAND); |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 176 | if (!kbc_input_buffer_empty()) return; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 177 | outb(0x20, KBD_DATA); /* send cmd: enable keyboard */ |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 178 | if (!kbc_input_buffer_empty()) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 179 | printk(BIOS_INFO, "Timeout while enabling keyboard\n"); |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 180 | return; |
| 181 | } |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 182 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 183 | /* clean up any junk that might have been in the keyboard */ |
| 184 | if (!kbc_cleanup_buffers()) return; |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 185 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 186 | /* reset keyboard and self test (keyboard side) */ |
| 187 | regval = send_keyboard(0xFF); |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 188 | if (regval == KBD_REPLY_RESEND) { |
| 189 | /* keeps sending RESENDs, probably no keyboard. */ |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 190 | printk(BIOS_INFO, "No PS/2 keyboard detected.\n"); |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 191 | return; |
| 192 | } |
| 193 | |
| 194 | if (regval != KBD_REPLY_ACK) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 195 | printk(BIOS_ERR, "Keyboard selftest failed ACK: 0x%x\n", regval); |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 196 | return; |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 197 | } |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 198 | |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 199 | if (!kbc_output_buffer_full()) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 200 | printk(BIOS_ERR, "Timeout waiting for keyboard after reset.\n"); |
Stefan Reinauer | 094198c | 2009-07-21 21:24:22 +0000 | [diff] [blame] | 201 | return; |
| 202 | } |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 203 | |
| 204 | regval = inb(KBD_DATA); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 205 | if (regval != 0xAA) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 206 | printk(BIOS_ERR, "Keyboard selftest failed: 0x%x\n", regval); |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 207 | return; |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | /* |
| 211 | * The following set scancode stuff is what normal BIOS do. It could be |
| 212 | * argued that coreboot shouldn't set the scan code..... |
| 213 | */ |
| 214 | |
| 215 | /* disable the keyboard */ |
| 216 | regval = send_keyboard(0xF5); |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 217 | if (regval != KBD_REPLY_ACK) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 218 | printk(BIOS_ERR, "Keyboard disable failed ACK: 0x%x\n", regval); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 219 | return; |
| 220 | } |
| 221 | |
| 222 | /* Set scancode command */ |
| 223 | regval = send_keyboard(0xF0); |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 224 | if (regval != KBD_REPLY_ACK) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 225 | printk(BIOS_ERR, "Keyboard set scancode cmd failed ACK: 0x%x\n", regval); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 226 | return; |
| 227 | } |
| 228 | /* Set scancode mode 2 */ |
| 229 | regval = send_keyboard(0x02); |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 230 | if (regval != KBD_REPLY_ACK) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 231 | printk(BIOS_ERR, "Keyboard set scancode mode failed ACK: 0x%x\n", regval); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 232 | return; |
| 233 | } |
| 234 | |
| 235 | /* enable the keyboard */ |
| 236 | regval = send_keyboard(0xF4); |
Stefan Reinauer | 9c3e8b5 | 2010-02-28 19:12:37 +0000 | [diff] [blame] | 237 | if (regval != KBD_REPLY_ACK) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 238 | printk(BIOS_ERR, "Keyboard enable failed ACK: 0x%x\n", regval); |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 239 | return; |
| 240 | } |
| 241 | |
| 242 | /* All is well - enable keyboard interface */ |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 243 | if (!kbc_input_buffer_empty()) return; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 244 | outb(0x60, KBD_COMMAND); |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 245 | if (!kbc_input_buffer_empty()) return; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 246 | outb(0x61, KBD_DATA); /* send cmd: enable keyboard and IRQ 1 */ |
Scott Duplichan | 9c934d1 | 2010-09-09 20:37:00 +0000 | [diff] [blame^] | 247 | if (!kbc_input_buffer_empty()) { |
Stefan Reinauer | c02b4fc | 2010-03-22 11:42:32 +0000 | [diff] [blame] | 248 | printk(BIOS_ERR, "Timeout during final keyboard enable\n"); |
Marc Jones | e59f2e1 | 2009-09-29 19:12:23 +0000 | [diff] [blame] | 249 | return; |
| 250 | } |
Ronald G. Minnich | ef5f218 | 2003-09-26 15:24:54 +0000 | [diff] [blame] | 251 | } |
| 252 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 253 | /* |
| 254 | * Support PS/2 mode - oddball SIOs(KBC) need this setup |
| 255 | * Not well documented. Google - 0xcb keyboard controller |
| 256 | * This is called before pc_keyboard_init(). |
| 257 | */ |
Stefan Reinauer | bbe29ee | 2009-05-23 22:02:31 +0000 | [diff] [blame] | 258 | void set_kbc_ps2_mode(void) |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 259 | { |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 260 | /* Run a keyboard controller self-test */ |
| 261 | if (!kbc_self_test()) |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 262 | return; |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 263 | |
| 264 | /* Support PS/2 mode */ |
| 265 | if (!kbc_input_buffer_empty()) return; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 266 | outb(0xcb, KBD_COMMAND); |
| 267 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 268 | if (!kbc_input_buffer_empty()) return; |
Stefan Reinauer | dd3e82a | 2009-10-24 18:15:07 +0000 | [diff] [blame] | 269 | outb(0x01, KBD_DATA); |
| 270 | |
Marc Jones | ecd176f | 2008-09-26 19:15:38 +0000 | [diff] [blame] | 271 | kbc_cleanup_buffers(); |
| 272 | } |