1 // Support for handling the PS/2 mouse/keyboard ports.
3 // Copyright (C) 2008 Kevin O'Connor <kevin@koconnor.net>
4 // Several ideas taken from code Copyright (c) 1999-2004 Vojtech Pavlik
6 // This file may be distributed under the terms of the GNU LGPLv3 license.
8 #include "ioport.h" // inb
9 #include "util.h" // dprintf
10 #include "biosvar.h" // GET_EBDA
11 #include "ps2port.h" // ps2_kbd_command
12 #include "pic.h" // eoi_pic1
15 /****************************************************************
16 * Low level i8042 commands.
17 ****************************************************************/
20 #define I8042_CTL_TIMEOUT 10000
22 #define I8042_BUFFER_SIZE 16
27 dprintf(7, "i8042_wait_read\n");
29 for (i=0; i<I8042_CTL_TIMEOUT; i++) {
30 u8 status = inb(PORT_PS2_STATUS);
31 if (status & I8042_STR_OBF)
40 i8042_wait_write(void)
42 dprintf(7, "i8042_wait_write\n");
44 for (i=0; i<I8042_CTL_TIMEOUT; i++) {
45 u8 status = inb(PORT_PS2_STATUS);
46 if (! (status & I8042_STR_IBF))
57 dprintf(7, "i8042_flush\n");
59 for (i=0; i<I8042_BUFFER_SIZE; i++) {
60 u8 status = inb(PORT_PS2_STATUS);
61 if (! (status & I8042_STR_OBF))
64 u8 data = inb(PORT_PS2_DATA);
65 dprintf(7, "i8042 flushed %x (status=%x)\n", data, status);
73 __i8042_command(int command, u8 *param)
75 int receive = (command >> 8) & 0xf;
76 int send = (command >> 12) & 0xf;
79 int ret = i8042_wait_write();
82 outb(command, PORT_PS2_STATUS);
84 // Send parameters (if any).
86 for (i = 0; i < send; i++) {
87 ret = i8042_wait_write();
90 outb(param[i], PORT_PS2_DATA);
93 // Receive parameters (if any).
94 for (i = 0; i < receive; i++) {
95 ret = i8042_wait_read();
98 param[i] = inb(PORT_PS2_DATA);
99 dprintf(7, "i8042 param=%x\n", param[i]);
106 i8042_command(int command, u8 *param)
108 dprintf(7, "i8042_command cmd=%x\n", command);
109 int ret = __i8042_command(command, param);
111 dprintf(2, "i8042 command %x failed\n", command);
116 i8042_kbd_write(u8 c)
118 dprintf(7, "i8042_kbd_write c=%d\n", c);
119 int ret = i8042_wait_write();
121 outb(c, PORT_PS2_DATA);
126 i8042_aux_write(u8 c)
128 return i8042_command(I8042_CMD_AUX_SEND, &c);
132 /****************************************************************
134 ****************************************************************/
136 #define PS2_RET_ACK 0xfa
137 #define PS2_RET_NAK 0xfe
140 ps2_recvbyte(int aux, int needack, int timeout)
142 u64 end = calc_future_tsc(timeout);
144 u8 status = inb(PORT_PS2_STATUS);
145 if (status & I8042_STR_OBF) {
146 u8 data = inb(PORT_PS2_DATA);
147 dprintf(7, "ps2 read %x\n", data);
149 if (!!(status & I8042_STR_AUXDATA) == aux) {
152 if (data == PS2_RET_ACK)
154 if (data == PS2_RET_NAK) {
155 dprintf(1, "Got ps2 nak (status=%x)\n", status);
160 // This data not part of command - just discard it.
161 dprintf(1, "Discarding ps2 data %02x (status=%02x)\n", data, status);
164 if (check_tsc(end)) {
165 // Don't warn on second byte of a reset
175 ps2_sendbyte(int aux, u8 command, int timeout)
177 dprintf(7, "ps2_sendbyte aux=%d cmd=%x\n", aux, command);
180 ret = i8042_aux_write(command);
182 ret = i8042_kbd_write(command);
187 ret = ps2_recvbyte(aux, 1, timeout);
190 if (ret != PS2_RET_ACK)
197 __ps2_command(int aux, int command, u8 *param)
200 int receive = (command >> 8) & 0xf;
201 int send = (command >> 12) & 0xf;
203 // Disable interrupts and keyboard/mouse.
204 u8 ps2ctr = GET_EBDA(ps2ctr);
205 u8 newctr = ((ps2ctr | I8042_CTR_AUXDIS | I8042_CTR_KBDDIS)
206 & ~(I8042_CTR_KBDINT|I8042_CTR_AUXINT));
207 dprintf(6, "i8042 ctr old=%x new=%x\n", ps2ctr, newctr);
208 int ret = i8042_command(I8042_CMD_CTL_WCTR, &newctr);
212 // Flush any interrupts already pending.
215 // Enable port command is being sent to.
217 newctr &= ~I8042_CTR_AUXDIS;
219 newctr &= ~I8042_CTR_KBDDIS;
220 ret = i8042_command(I8042_CMD_CTL_WCTR, &newctr);
224 if (command == ATKBD_CMD_RESET_BAT) {
225 // Reset is special wrt timeouts and bytes received.
228 ret = ps2_sendbyte(aux, command, 1000);
232 // Receive parameters.
233 ret = ps2_recvbyte(aux, 0, 4000);
237 ret = ps2_recvbyte(aux, 0, 100);
239 // Some devices only respond with one byte on reset.
242 } else if (command == ATKBD_CMD_GETID) {
243 // Getid is special wrt bytes received.
246 ret = ps2_sendbyte(aux, command, 200);
250 // Receive parameters.
251 ret = ps2_recvbyte(aux, 0, 500);
255 if (ret == 0xab || ret == 0xac || ret == 0x2b || ret == 0x5d
256 || ret == 0x60 || ret == 0x47) {
257 // These ids (keyboards) return two bytes.
258 ret = ps2_recvbyte(aux, 0, 500);
267 ret = ps2_sendbyte(aux, command, 200);
271 // Send parameters (if any).
273 for (i = 0; i < send; i++) {
274 ret = ps2_sendbyte(aux, param[i], 200);
279 // Receive parameters (if any).
280 for (i = 0; i < receive; i++) {
281 ret = ps2_recvbyte(aux, 0, 500);
291 // Restore interrupts and keyboard/mouse.
292 ret2 = i8042_command(I8042_CMD_CTL_WCTR, &ps2ctr);
300 ps2_command(int aux, int command, u8 *param)
302 dprintf(7, "ps2_command aux=%d cmd=%x\n", aux, command);
303 int ret = __ps2_command(aux, command, param);
305 dprintf(2, "ps2 command %x failed (aux=%d)\n", command, aux);
310 ps2_kbd_command(int command, u8 *param)
312 return ps2_command(0, command, param);
316 ps2_mouse_command(int command, u8 *param)
318 return ps2_command(1, command, param);
322 /****************************************************************
324 ****************************************************************/
326 // INT74h : PS/2 mouse hardware interrupt
330 if (! CONFIG_PS2PORT)
333 debug_isr(DEBUG_ISR_74);
335 u8 v = inb(PORT_PS2_STATUS);
336 if ((v & (I8042_STR_OBF|I8042_STR_AUXDATA))
337 != (I8042_STR_OBF|I8042_STR_AUXDATA)) {
338 dprintf(1, "ps2 mouse irq but no mouse data.\n");
341 v = inb(PORT_PS2_DATA);
343 if (!(GET_EBDA(ps2ctr) & I8042_CTR_AUXINT))
344 // Interrupts not enabled.
353 // INT09h : Keyboard Hardware Service Entry Point
357 if (! CONFIG_PS2PORT)
360 debug_isr(DEBUG_ISR_09);
362 // read key from keyboard controller
363 u8 v = inb(PORT_PS2_STATUS);
364 if (v & I8042_STR_AUXDATA) {
365 dprintf(1, "ps2 keyboard irq but found mouse data?!\n");
368 v = inb(PORT_PS2_DATA);
370 if (!(GET_EBDA(ps2ctr) & I8042_CTR_KBDINT))
371 // Interrupts not enabled.
381 /****************************************************************
383 ****************************************************************/
386 keyboard_init(void *data)
388 /* flush incoming keys */
389 int ret = i8042_flush();
393 // Controller self-test.
395 ret = i8042_command(I8042_CMD_CTL_TEST, param);
398 if (param[0] != 0x55) {
399 dprintf(1, "i8042 self test failed (got %x not 0x55)\n", param[0]);
403 // Controller keyboard test.
404 ret = i8042_command(I8042_CMD_KBD_TEST, param);
407 if (param[0] != 0x00) {
408 dprintf(1, "i8042 keyboard test failed (got %x not 0x00)\n", param[0]);
412 // Disable keyboard and mouse events.
413 SET_EBDA(ps2ctr, I8042_CTR_KBDDIS | I8042_CTR_AUXDIS);
416 /* ------------------- keyboard side ------------------------*/
417 /* reset keyboard and self test (keyboard side) */
418 ret = ps2_kbd_command(ATKBD_CMD_RESET_BAT, param);
421 if (param[0] != 0xaa) {
422 dprintf(1, "keyboard self test failed (got %x not 0xaa)\n", param[0]);
426 /* Disable keyboard */
427 ret = ps2_kbd_command(ATKBD_CMD_RESET_DIS, NULL);
431 // Set scancode command (mode 2)
433 ret = ps2_kbd_command(ATKBD_CMD_SSCANSET, param);
437 // Keyboard Mode: disable mouse, scan code convert, enable kbd IRQ
438 SET_EBDA(ps2ctr, I8042_CTR_AUXDIS | I8042_CTR_XLATE | I8042_CTR_KBDINT);
440 /* Enable keyboard */
441 ret = ps2_kbd_command(ATKBD_CMD_ENABLE, NULL);
445 dprintf(1, "PS2 keyboard initialized\n");
452 if (! CONFIG_PS2PORT)
454 dprintf(3, "init ps2port\n");
456 enable_hwirq(1, FUNC16(entry_09));
457 enable_hwirq(12, FUNC16(entry_74));
459 run_thread(keyboard_init, NULL);