2 * This file is part of the coreboot project.
4 * Copyright (C) 2009 coresystems GmbH
5 * Copyright (C) 2008 Advanced Micro Devices, Inc.
6 * Copyright (C) 2003 Ollie Lo <ollielo@hotmail.com>
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.
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.
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
23 #include <console/console.h>
24 #include <pc80/keyboard.h>
25 #include <device/device.h>
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)
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
40 /* The Keyboard controller command byte
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)
53 // Keyboard Controller Replies
54 #define KBC_REPLY_SELFTEST_OK 0x55 // controller self-test succeeded
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
63 /* Wait 400ms for keyboard controller answers */
64 #define KBC_TIMEOUT_IN_MS 400
66 static int kbc_input_buffer_empty(void)
69 for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & KBD_IBF); timeout--) {
74 printk(BIOS_WARNING, "Unexpected Keyboard controller input buffer full\n");
80 static int kbc_output_buffer_full(void)
83 for(timeout = KBC_TIMEOUT_IN_MS; timeout && ((inb(KBD_STATUS) & KBD_OBF) == 0); timeout--) {
88 printk(BIOS_INFO, "Keyboard controller output buffer result timeout\n");
94 static int kbc_cleanup_buffers(void)
97 for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & (KBD_OBF | KBD_IBF)); timeout--) {
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",
105 KBD_STATUS, inb(KBD_STATUS), KBD_DATA, inb(KBD_DATA));
111 static int kbc_self_test(void)
115 /* Clean up any junk that might have been in the KBC.
116 * Both input and output buffers must be empty.
118 if (!kbc_cleanup_buffers())
121 /* reset/self test 8042 - send cmd 0xAA */
122 outb(KBC_CMD_SELF_TEST, KBD_COMMAND);
124 if (!kbc_output_buffer_full()) {
125 /* There probably is no keyboard controller. */
126 printk(BIOS_ERR, "Could not reset keyboard controller.\n");
130 /* read self-test result, 0x55 is returned in the output buffer */
131 self_test = inb(KBD_DATA);
133 if (self_test != 0x55) {
134 printk(BIOS_ERR, "Keyboard Controller self-test failed: 0x%x\n",
142 static u8 send_keyboard(u8 command)
148 if (!kbc_input_buffer_empty()) return 0;
149 outb(command, KBD_DATA);
150 if (!kbc_output_buffer_full()) {
151 printk(BIOS_ERR, "Could not send keyboard command %02x\n",
155 regval = inb(KBD_DATA);
157 } while (regval == KBD_REPLY_RESEND && resend > 0);
162 void pc_keyboard_init(struct pc_keyboard *keyboard)
165 if (!CONFIG_DRIVERS_PS2_KEYBOARD)
167 printk(BIOS_DEBUG, "Keyboard init...\n");
169 /* Run a keyboard controller self-test */
170 if (!kbc_self_test())
173 /* Enable keyboard interface - No IRQ */
174 if (!kbc_input_buffer_empty()) return;
175 outb(0x60, KBD_COMMAND);
176 if (!kbc_input_buffer_empty()) return;
177 outb(0x20, KBD_DATA); /* send cmd: enable keyboard */
178 if (!kbc_input_buffer_empty()) {
179 printk(BIOS_INFO, "Timeout while enabling keyboard\n");
183 /* clean up any junk that might have been in the keyboard */
184 if (!kbc_cleanup_buffers()) return;
186 /* reset keyboard and self test (keyboard side) */
187 regval = send_keyboard(0xFF);
188 if (regval == KBD_REPLY_RESEND) {
189 /* keeps sending RESENDs, probably no keyboard. */
190 printk(BIOS_INFO, "No PS/2 keyboard detected.\n");
194 if (regval != KBD_REPLY_ACK) {
195 printk(BIOS_ERR, "Keyboard selftest failed ACK: 0x%x\n", regval);
199 if (!kbc_output_buffer_full()) {
200 printk(BIOS_ERR, "Timeout waiting for keyboard after reset.\n");
204 regval = inb(KBD_DATA);
205 if (regval != 0xAA) {
206 printk(BIOS_ERR, "Keyboard selftest failed: 0x%x\n", regval);
211 * The following set scancode stuff is what normal BIOS do. It could be
212 * argued that coreboot shouldn't set the scan code.....
215 /* disable the keyboard */
216 regval = send_keyboard(0xF5);
217 if (regval != KBD_REPLY_ACK) {
218 printk(BIOS_ERR, "Keyboard disable failed ACK: 0x%x\n", regval);
222 /* Set scancode command */
223 regval = send_keyboard(0xF0);
224 if (regval != KBD_REPLY_ACK) {
225 printk(BIOS_ERR, "Keyboard set scancode cmd failed ACK: 0x%x\n", regval);
228 /* Set scancode mode 2 */
229 regval = send_keyboard(0x02);
230 if (regval != KBD_REPLY_ACK) {
231 printk(BIOS_ERR, "Keyboard set scancode mode failed ACK: 0x%x\n", regval);
235 /* enable the keyboard */
236 regval = send_keyboard(0xF4);
237 if (regval != KBD_REPLY_ACK) {
238 printk(BIOS_ERR, "Keyboard enable failed ACK: 0x%x\n", regval);
242 /* All is well - enable keyboard interface */
243 if (!kbc_input_buffer_empty()) return;
244 outb(0x60, KBD_COMMAND);
245 if (!kbc_input_buffer_empty()) return;
246 outb(0x61, KBD_DATA); /* send cmd: enable keyboard and IRQ 1 */
247 if (kbc_output_buffer_full()) {
248 printk(BIOS_ERR, "Timeout during final keyboard enable\n");
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().
258 void set_kbc_ps2_mode(void)
260 /* Run a keyboard controller self-test */
261 if (!kbc_self_test())
264 /* Support PS/2 mode */
265 if (!kbc_input_buffer_empty()) return;
266 outb(0xcb, KBD_COMMAND);
268 if (!kbc_input_buffer_empty()) return;
269 outb(0x01, KBD_DATA);
271 kbc_cleanup_buffers();