src/ps2port.c

   1 // Support for handling the PS/2 mouse/keyboard ports.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 // Several ideas taken from code Copyright (c) 1999-2004 Vojtech Pavlik
   5 //
   6 // This file may be distributed under the terms of the GNU LGPLv3 license.
   7
   8 #include "ioport.h" // inb
   9 #include "util.h" // dprintf
  10 #include "biosvar.h" // GET_EBDA
  11 #include "ps2port.h" // kbd_command
  12 #include "pic.h" // eoi_pic1
  13
  14
  15 /****************************************************************
  16  * Low level i8042 commands.
  17  ****************************************************************/
  18
  19 // Timeout value.
  20 #define I8042_CTL_TIMEOUT       10000
  21
  22 #define I8042_BUFFER_SIZE       16
  23
  24 static int
  25 i8042_wait_read(void)
  26 {
  27     dprintf(7, "i8042_wait_read\n");
  28     int i;
  29     for (i=0; i<I8042_CTL_TIMEOUT; i++) {
  30         u8 status = inb(PORT_PS2_STATUS);
  31         if (status & I8042_STR_OBF)
  32             return 0;
  33         udelay(50);
  34     }
  35     warn_timeout();
  36     return -1;
  37 }
  38
  39 static int
  40 i8042_wait_write(void)
  41 {
  42     dprintf(7, "i8042_wait_write\n");
  43     int i;
  44     for (i=0; i<I8042_CTL_TIMEOUT; i++) {
  45         u8 status = inb(PORT_PS2_STATUS);
  46         if (! (status & I8042_STR_IBF))
  47             return 0;
  48         udelay(50);
  49     }
  50     warn_timeout();
  51     return -1;
  52 }
  53
  54 int
  55 i8042_flush(void)
  56 {
  57     dprintf(7, "i8042_flush\n");
  58     int i;
  59     for (i=0; i<I8042_BUFFER_SIZE; i++) {
  60         u8 status = inb(PORT_PS2_STATUS);
  61         if (! (status & I8042_STR_OBF))
  62             return 0;
  63         udelay(50);
  64         u8 data = inb(PORT_PS2_DATA);
  65         dprintf(7, "i8042 flushed %x (status=%x)\n", data, status);
  66     }
  67
  68     warn_timeout();
  69     return -1;
  70 }
  71
  72 static int
  73 __i8042_command(int command, u8 *param)
  74 {
  75     int receive = (command >> 8) & 0xf;
  76     int send = (command >> 12) & 0xf;
  77
  78     // Send the command.
  79     int ret = i8042_wait_write();
  80     if (ret)
  81         return ret;
  82     outb(command, PORT_PS2_STATUS);
  83
  84     // Send parameters (if any).
  85     int i;
  86     for (i = 0; i < send; i++) {
  87         ret = i8042_wait_write();
  88         if (ret)
  89             return ret;
  90         outb(param[i], PORT_PS2_DATA);
  91     }
  92
  93     // Receive parameters (if any).
  94     for (i = 0; i < receive; i++) {
  95         ret = i8042_wait_read();
  96         if (ret)
  97             return ret;
  98         param[i] = inb(PORT_PS2_DATA);
  99         dprintf(7, "i8042 param=%x\n", param[i]);
 100     }
 101
 102     return 0;
 103 }
 104
 105 int
 106 i8042_command(int command, u8 *param)
 107 {
 108     dprintf(7, "i8042_command cmd=%x\n", command);
 109     int ret = __i8042_command(command, param);
 110     if (ret)
 111         dprintf(2, "i8042 command %x failed\n", command);
 112     return ret;
 113 }
 114
 115 static int
 116 i8042_kbd_write(u8 c)
 117 {
 118     dprintf(7, "i8042_kbd_write c=%d\n", c);
 119     int ret = i8042_wait_write();
 120     if (! ret)
 121         outb(c, PORT_PS2_DATA);
 122     return ret;
 123 }
 124
 125 static int
 126 i8042_aux_write(u8 c)
 127 {
 128     return i8042_command(I8042_CMD_AUX_SEND, &c);
 129 }
 130
 131
 132 /****************************************************************
 133  * Device commands.
 134  ****************************************************************/
 135
 136 #define PS2_RET_ACK             0xfa
 137 #define PS2_RET_NAK             0xfe
 138
 139 static void
 140 process_ps2byte(u8 status, u8 data)
 141 {
 142     if (!MODE16) {
 143         // Don't pull in all of keyboard/mouse code into 32bit code -
 144         // just discard the data.
 145         dprintf(1, "Discarding ps2 data %x (status=%x)\n", data, status);
 146         return;
 147     }
 148     if (status & I8042_STR_AUXDATA)
 149         process_mouse(data);
 150     else
 151         process_key(data);
 152 }
 153
 154 static int
 155 ps2_recvbyte(int aux, int needack, int timeout)
 156 {
 157     u64 end = calc_future_tsc(timeout);
 158     for (;;) {
 159         u8 status = inb(PORT_PS2_STATUS);
 160         if (status & I8042_STR_OBF) {
 161             u8 data = inb(PORT_PS2_DATA);
 162             dprintf(7, "ps2 read %x\n", data);
 163
 164             if (!!(status & I8042_STR_AUXDATA) == aux) {
 165                 if (!needack)
 166                     return data;
 167                 if (data == PS2_RET_ACK)
 168                     return data;
 169                 if (data == PS2_RET_NAK) {
 170                     dprintf(1, "Got ps2 nak (status=%x)\n", status);
 171                     return data;
 172                 }
 173             }
 174
 175             // Data not part of this command.
 176             process_ps2byte(status, data);
 177         }
 178
 179         if (check_time(end)) {
 180             // Don't warn on second byte of a reset
 181             if (timeout > 100)
 182                 warn_timeout();
 183             return -1;
 184         }
 185         yield();
 186     }
 187 }
 188
 189 static int
 190 ps2_sendbyte(int aux, u8 command, int timeout)
 191 {
 192     dprintf(7, "ps2_sendbyte aux=%d cmd=%x\n", aux, command);
 193     int ret;
 194     if (aux)
 195         ret = i8042_aux_write(command);
 196     else
 197         ret = i8042_kbd_write(command);
 198     if (ret)
 199         return ret;
 200
 201     // Read ack.
 202     ret = ps2_recvbyte(aux, 1, timeout);
 203     if (ret < 0)
 204         return ret;
 205     if (ret != PS2_RET_ACK)
 206         return -1;
 207
 208     return 0;
 209 }
 210
 211 static int
 212 ps2_command(int aux, int command, u8 *param)
 213 {
 214     int ret2;
 215     int receive = (command >> 8) & 0xf;
 216     int send = (command >> 12) & 0xf;
 217
 218     // Disable interrupts and keyboard/mouse.
 219     u8 ps2ctr = GET_EBDA(ps2ctr);
 220     u8 newctr = ps2ctr;
 221     if (aux)
 222         newctr |= I8042_CTR_KBDDIS;
 223     else
 224         newctr |= I8042_CTR_AUXDIS;
 225     newctr &= ~(I8042_CTR_KBDINT|I8042_CTR_AUXINT);
 226     dprintf(6, "i8042 ctr old=%x new=%x\n", ps2ctr, newctr);
 227     int ret = i8042_command(I8042_CMD_CTL_WCTR, &newctr);
 228     if (ret)
 229         return ret;
 230
 231     // Flush any interrupts already pending.
 232     yield();
 233
 234     if (command == ATKBD_CMD_RESET_BAT) {
 235         // Reset is special wrt timeouts.
 236
 237         // Send command.
 238         ret = ps2_sendbyte(aux, command, 1000);
 239         if (ret)
 240             goto fail;
 241
 242         // Receive parameters.
 243         ret = ps2_recvbyte(aux, 0, 4000);
 244         if (ret < 0)
 245             goto fail;
 246         param[0] = ret;
 247         ret = ps2_recvbyte(aux, 0, 100);
 248         if (ret < 0)
 249             // Some devices only respond with one byte on reset.
 250             ret = 0;
 251         param[1] = ret;
 252     } else {
 253         // Send command.
 254         ret = ps2_sendbyte(aux, command, 200);
 255         if (ret)
 256             goto fail;
 257
 258         // Send parameters (if any).
 259         int i;
 260         for (i = 0; i < send; i++) {
 261             ret = ps2_sendbyte(aux, param[i], 200);
 262             if (ret)
 263                 goto fail;
 264         }
 265
 266         // Receive parameters (if any).
 267         for (i = 0; i < receive; i++) {
 268             ret = ps2_recvbyte(aux, 0, 500);
 269             if (ret < 0)
 270                 goto fail;
 271             param[i] = ret;
 272         }
 273     }
 274
 275     ret = 0;
 276
 277 fail:
 278     // Restore interrupts and keyboard/mouse.
 279     ret2 = i8042_command(I8042_CMD_CTL_WCTR, &ps2ctr);
 280     if (ret2)
 281         return ret2;
 282
 283     return ret;
 284 }
 285
 286 int
 287 kbd_command(int command, u8 *param)
 288 {
 289     dprintf(7, "kbd_command cmd=%x\n", command);
 290     int ret = ps2_command(0, command, param);
 291     if (ret)
 292         dprintf(2, "keyboard command %x failed\n", command);
 293     return ret;
 294 }
 295
 296 int
 297 aux_command(int command, u8 *param)
 298 {
 299     dprintf(7, "aux_command cmd=%x\n", command);
 300     int ret = ps2_command(1, command, param);
 301     if (ret)
 302         dprintf(2, "mouse command %x failed\n", command);
 303     return ret;
 304 }
 305
 306
 307 /****************************************************************
 308  * IRQ handlers
 309  ****************************************************************/
 310
 311 static void
 312 process_ps2irq(void)
 313 {
 314     u8 status = inb(PORT_PS2_STATUS);
 315     if (!(status & I8042_STR_OBF)) {
 316         dprintf(1, "ps2 irq but no data.\n");
 317         return;
 318     }
 319     u8 data = inb(PORT_PS2_DATA);
 320
 321     process_ps2byte(status, data);
 322 }
 323
 324 // INT74h : PS/2 mouse hardware interrupt
 325 void VISIBLE16
 326 handle_74(void)
 327 {
 328     if (! CONFIG_PS2PORT)
 329         return;
 330
 331     debug_isr(DEBUG_ISR_74);
 332     process_ps2irq();
 333     eoi_pic2();
 334 }
 335
 336 // INT09h : Keyboard Hardware Service Entry Point
 337 void VISIBLE16
 338 handle_09(void)
 339 {
 340     if (! CONFIG_PS2PORT)
 341         return;
 342
 343     debug_isr(DEBUG_ISR_09);
 344     process_ps2irq();
 345     eoi_pic1();
 346 }
 347
 348
 349 /****************************************************************
 350  * Setup
 351  ****************************************************************/
 352
 353 static void
 354 keyboard_init(void *data)
 355 {
 356     /* flush incoming keys */
 357     int ret = i8042_flush();
 358     if (ret)
 359         return;
 360
 361     // Controller self-test.
 362     u8 param[2];
 363     ret = i8042_command(I8042_CMD_CTL_TEST, param);
 364     if (ret)
 365         return;
 366     if (param[0] != 0x55) {
 367         dprintf(1, "i8042 self test failed (got %x not 0x55)\n", param[0]);
 368         return;
 369     }
 370
 371     // Controller keyboard test.
 372     ret = i8042_command(I8042_CMD_KBD_TEST, param);
 373     if (ret)
 374         return;
 375     if (param[0] != 0x00) {
 376         dprintf(1, "i8042 keyboard test failed (got %x not 0x00)\n", param[0]);
 377         return;
 378     }
 379
 380     // Enable keyboard and mouse ports.
 381     ret = i8042_command(I8042_CMD_KBD_ENABLE, NULL);
 382     if (ret)
 383         return;
 384     ret = i8042_command(I8042_CMD_AUX_ENABLE, NULL);
 385     if (ret)
 386         return;
 387
 388
 389     /* ------------------- keyboard side ------------------------*/
 390     /* reset keyboard and self test  (keyboard side) */
 391     ret = kbd_command(ATKBD_CMD_RESET_BAT, param);
 392     if (ret)
 393         return;
 394     if (param[0] != 0xaa) {
 395         dprintf(1, "keyboard self test failed (got %x not 0xaa)\n", param[0]);
 396         return;
 397     }
 398
 399     /* Disable keyboard */
 400     ret = kbd_command(ATKBD_CMD_RESET_DIS, NULL);
 401     if (ret)
 402         return;
 403
 404     // Set scancode command (mode 2)
 405     param[0] = 0x02;
 406     ret = kbd_command(ATKBD_CMD_SSCANSET, param);
 407     if (ret)
 408         return;
 409
 410     // Keyboard Mode: scan code convert, disable mouse, enable IRQ 1
 411     SET_EBDA(ps2ctr, I8042_CTR_AUXDIS | I8042_CTR_XLATE | I8042_CTR_KBDINT);
 412
 413     /* Enable keyboard */
 414     ret = kbd_command(ATKBD_CMD_ENABLE, NULL);
 415     if (ret)
 416         return;
 417
 418     dprintf(1, "PS2 keyboard initialized\n");
 419 }
 420
 421 void
 422 ps2port_setup(void)
 423 {
 424     ASSERT32FLAT();
 425     if (! CONFIG_PS2PORT)
 426         return;
 427     dprintf(3, "init ps2port\n");
 428
 429     enable_hwirq(1, entry_09);
 430     enable_hwirq(12, entry_74);
 431
 432     run_thread(keyboard_init, NULL);
 433 }