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
39 #define KBC_CMD_KBD_TEST 0xAB // Keyboard Interface test
41 /* The Keyboard controller command byte
43 * ----+-------------------------------------------------------
44 * 7 | reserved, must be zero
45 * 6 | XT Translation, (1 = on, 0 = off)
46 * 5 | Disable Mouse Port (1 = disable, 0 = enable)
47 * 4 | Disable Keyboard Port (1 = disable, 0 = enable)
48 * 3 | reserved, must be zero
49 * 2 | System Flag (1 = self-test passed. DO NOT SET TO ZERO)
50 * 1 | Mouse Port Interrupts (1 = enable, 0 = disable)
51 * 0 | Keyboard Port Interrupts (1 = enable, 0 = disable)
54 // Keyboard Controller Replies
55 #define KBC_REPLY_SELFTEST_OK 0x55 // controller self-test succeeded
60 #define KBD_REPLY_POR 0xAA // Power on reset
61 #define KBD_REPLY_ACK 0xFA // Command ACK
62 #define KBD_REPLY_RESEND 0xFE // Command NACK, send command again
64 /* Wait 400ms for keyboard controller answers */
65 #define KBC_TIMEOUT_IN_MS 400
67 static int kbc_input_buffer_empty(void)
70 for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & KBD_IBF); timeout--) {
75 printk(BIOS_WARNING, "Unexpected Keyboard controller input buffer full\n");
81 static int kbc_output_buffer_full(void)
84 for(timeout = KBC_TIMEOUT_IN_MS; timeout && ((inb(KBD_STATUS) & KBD_OBF) == 0); timeout--) {
89 printk(BIOS_INFO, "Keyboard controller output buffer result timeout\n");
95 static int kbc_cleanup_buffers(void)
98 for(timeout = KBC_TIMEOUT_IN_MS; timeout && (inb(KBD_STATUS) & (KBD_OBF | KBD_IBF)); timeout--) {
104 printk(BIOS_ERR, "Couldn't cleanup the keyboard controller buffers\n");
105 printk(BIOS_ERR, "Status (0x%x): 0x%x, Buffer (0x%x): 0x%x\n",
106 KBD_STATUS, inb(KBD_STATUS), KBD_DATA, inb(KBD_DATA));
112 static int kbc_self_test(void)
116 /* Clean up any junk that might have been in the KBC.
117 * Both input and output buffers must be empty.
119 if (!kbc_cleanup_buffers())
122 /* reset/self test 8042 - send cmd 0xAA */
123 outb(KBC_CMD_SELF_TEST, KBD_COMMAND);
125 if (!kbc_output_buffer_full()) {
126 /* There probably is no keyboard controller. */
127 printk(BIOS_ERR, "Could not reset keyboard controller.\n");
131 /* read self-test result, 0x55 is returned in the output buffer */
132 self_test = inb(KBD_DATA);
134 if (self_test != 0x55) {
135 printk(BIOS_ERR, "Keyboard Controller self-test failed: 0x%x\n",
140 /* ensure the buffers are empty */
141 kbc_cleanup_buffers();
143 /* keyboard interface test */
144 outb(KBC_CMD_KBD_TEST, KBD_COMMAND);
146 if (!kbc_output_buffer_full()) {
147 printk(BIOS_ERR, "Keyboard Interface test timed out.\n");
151 /* read test result, 0x00 should be returned in case of no failures */
152 self_test = inb(KBD_DATA);
154 if (self_test != 0x00) {
155 printk(BIOS_ERR, "Keyboard Interface test failed: 0x%x\n",
163 static u8 send_keyboard(u8 command)
169 if (!kbc_input_buffer_empty()) return 0;
170 outb(command, KBD_DATA);
171 /* the reset command takes much longer then normal commands and
172 * even worse, some keyboards do send the ACK _after_ doing the
174 if (command == 0xFF) {
176 for (retries = 9; retries && !kbc_output_buffer_full(); retries--)
179 if (!kbc_output_buffer_full()) {
180 printk(BIOS_ERR, "Could not send keyboard command %02x\n",
184 regval = inb(KBD_DATA);
186 } while (regval == KBD_REPLY_RESEND && resend > 0);
191 void pc_keyboard_init(struct pc_keyboard *keyboard)
195 if (!CONFIG_DRIVERS_PS2_KEYBOARD)
197 printk(BIOS_DEBUG, "Keyboard init...\n");
199 /* Run a keyboard controller self-test */
200 if (!kbc_self_test())
203 /* Enable keyboard interface - No IRQ */
204 if (!kbc_input_buffer_empty()) return;
205 outb(0x60, KBD_COMMAND);
206 if (!kbc_input_buffer_empty()) return;
207 outb(0x20, KBD_DATA); /* send cmd: enable keyboard */
208 if (!kbc_input_buffer_empty()) {
209 printk(BIOS_INFO, "Timeout while enabling keyboard\n");
213 /* clean up any junk that might have been in the keyboard */
214 if (!kbc_cleanup_buffers()) return;
216 /* reset keyboard and self test (keyboard side) */
217 regval = send_keyboard(0xFF);
218 if (regval == KBD_REPLY_RESEND) {
219 /* keeps sending RESENDs, probably no keyboard. */
220 printk(BIOS_INFO, "No PS/2 keyboard detected.\n");
224 if (regval != KBD_REPLY_ACK) {
225 printk(BIOS_ERR, "Keyboard reset failed ACK: 0x%x\n", regval);
229 /* the reset command takes some time, so wait a little longer */
230 for (retries = 9; retries && !kbc_output_buffer_full(); retries--)
233 if (!kbc_output_buffer_full()) {
234 printk(BIOS_ERR, "Timeout waiting for keyboard after reset.\n");
238 regval = inb(KBD_DATA);
239 if (regval != 0xAA) {
240 printk(BIOS_ERR, "Keyboard reset selftest failed: 0x%x\n", regval);
245 * The following set scancode stuff is what normal BIOS do. It could be
246 * argued that coreboot shouldn't set the scan code.....
249 /* disable the keyboard */
250 regval = send_keyboard(0xF5);
251 if (regval != KBD_REPLY_ACK) {
252 printk(BIOS_ERR, "Keyboard disable failed ACK: 0x%x\n", regval);
256 /* Set scancode command */
257 regval = send_keyboard(0xF0);
258 if (regval != KBD_REPLY_ACK) {
259 printk(BIOS_ERR, "Keyboard set scancode cmd failed ACK: 0x%x\n", regval);
262 /* Set scancode mode 2 */
263 regval = send_keyboard(0x02);
264 if (regval != KBD_REPLY_ACK) {
265 printk(BIOS_ERR, "Keyboard set scancode mode failed ACK: 0x%x\n", regval);
269 /* All is well - enable keyboard interface */
270 if (!kbc_input_buffer_empty()) return;
271 outb(0x60, KBD_COMMAND);
272 if (!kbc_input_buffer_empty()) return;
273 outb(0x65, KBD_DATA); /* send cmd: enable keyboard and IRQ 1 */
274 if (!kbc_input_buffer_empty()) {
275 printk(BIOS_ERR, "Timeout during keyboard enable\n");
279 /* enable the keyboard */
280 regval = send_keyboard(0xF4);
281 if (regval != KBD_REPLY_ACK) {
282 printk(BIOS_ERR, "Keyboard enable failed ACK: 0x%x\n", regval);
288 * Support PS/2 mode - oddball SIOs(KBC) need this setup
289 * Not well documented. Google - 0xcb keyboard controller
290 * This is called before pc_keyboard_init().
292 void set_kbc_ps2_mode(void)
294 /* Run a keyboard controller self-test */
295 if (!kbc_self_test())
298 /* Support PS/2 mode */
299 if (!kbc_input_buffer_empty()) return;
300 outb(0xcb, KBD_COMMAND);
302 if (!kbc_input_buffer_empty()) return;
303 outb(0x01, KBD_DATA);
305 kbc_cleanup_buffers();