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 int
 140 ps2_recvbyte(int aux, int needack, int timeout)
 141 {
 142     u64 end = calc_future_tsc(timeout);
 143     for (;;) {
 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);
 148
 149             if (!!(status & I8042_STR_AUXDATA) == aux) {
 150                 if (!needack)
 151                     return data;
 152                 if (data == PS2_RET_ACK)
 153                     return data;
 154                 if (data == PS2_RET_NAK) {
 155                     dprintf(1, "Got ps2 nak (status=%x)\n", status);
 156                     return data;
 157                 }
 158             }
 159
 160             // This data not for us - XXX - just discard it for now.
 161             dprintf(1, "Discarding ps2 data %x (status=%x)\n", data, status);
 162         }
 163
 164         if (check_time(end)) {
 165             // Don't warn on second byte of a reset
 166             if (timeout > 100)
 167                 warn_timeout();
 168             return -1;
 169         }
 170         yield();
 171     }
 172 }
 173
 174 static int
 175 ps2_sendbyte(int aux, u8 command, int timeout)
 176 {
 177     dprintf(7, "ps2_sendbyte aux=%d cmd=%x\n", aux, command);
 178     int ret;
 179     if (aux)
 180         ret = i8042_aux_write(command);
 181     else
 182         ret = i8042_kbd_write(command);
 183     if (ret)
 184         return ret;
 185
 186     // Read ack.
 187     ret = ps2_recvbyte(aux, 1, timeout);
 188     if (ret < 0)
 189         return ret;
 190     if (ret != PS2_RET_ACK)
 191         return -1;
 192
 193     return 0;
 194 }
 195
 196 static int
 197 ps2_command(int aux, int command, u8 *param)
 198 {
 199     int ret2;
 200     int receive = (command >> 8) & 0xf;
 201     int send = (command >> 12) & 0xf;
 202
 203     // Disable interrupts and keyboard/mouse.
 204     u8 ps2ctr = GET_EBDA(ps2ctr);
 205     u8 newctr = ps2ctr;
 206     if (aux)
 207         newctr |= I8042_CTR_KBDDIS;
 208     else
 209         newctr |= I8042_CTR_AUXDIS;
 210     newctr &= ~(I8042_CTR_KBDINT|I8042_CTR_AUXINT);
 211     dprintf(6, "i8042 ctr old=%x new=%x\n", ps2ctr, newctr);
 212     int ret = i8042_command(I8042_CMD_CTL_WCTR, &newctr);
 213     if (ret)
 214         return ret;
 215
 216     // Flush any interrupts already pending.
 217     yield();
 218
 219     if (command == ATKBD_CMD_RESET_BAT) {
 220         // Reset is special wrt timeouts and bytes received.
 221
 222         // Send command.
 223         ret = ps2_sendbyte(aux, command, 1000);
 224         if (ret)
 225             goto fail;
 226
 227         // Receive parameters.
 228         ret = ps2_recvbyte(aux, 0, 4000);
 229         if (ret < 0)
 230             goto fail;
 231         param[0] = ret;
 232         ret = ps2_recvbyte(aux, 0, 100);
 233         if (ret < 0)
 234             // Some devices only respond with one byte on reset.
 235             ret = 0;
 236         param[1] = ret;
 237     } else if (command == ATKBD_CMD_GETID) {
 238         // Getid is special wrt bytes received.
 239
 240         // Send command.
 241         ret = ps2_sendbyte(aux, command, 200);
 242         if (ret)
 243             goto fail;
 244
 245         // Receive parameters.
 246         ret = ps2_recvbyte(aux, 0, 500);
 247         if (ret < 0)
 248             goto fail;
 249         param[0] = ret;
 250         if (ret == 0xab || ret == 0xac || ret == 0x2b || ret == 0x5d
 251             || ret == 0x60 || ret == 0x47) {
 252             // These ids (keyboards) return two bytes.
 253             ret = ps2_recvbyte(aux, 0, 500);
 254             if (ret < 0)
 255                 goto fail;
 256             param[1] = ret;
 257         } else {
 258             param[1] = 0;
 259         }
 260     } else {
 261         // Send command.
 262         ret = ps2_sendbyte(aux, command, 200);
 263         if (ret)
 264             goto fail;
 265
 266         // Send parameters (if any).
 267         int i;
 268         for (i = 0; i < send; i++) {
 269             ret = ps2_sendbyte(aux, param[i], 200);
 270             if (ret)
 271                 goto fail;
 272         }
 273
 274         // Receive parameters (if any).
 275         for (i = 0; i < receive; i++) {
 276             ret = ps2_recvbyte(aux, 0, 500);
 277             if (ret < 0)
 278                 goto fail;
 279             param[i] = ret;
 280         }
 281     }
 282
 283     ret = 0;
 284
 285 fail:
 286     // Restore interrupts and keyboard/mouse.
 287     ret2 = i8042_command(I8042_CMD_CTL_WCTR, &ps2ctr);
 288     if (ret2)
 289         return ret2;
 290
 291     return ret;
 292 }
 293
 294 int
 295 kbd_command(int command, u8 *param)
 296 {
 297     dprintf(7, "kbd_command cmd=%x\n", command);
 298     int ret = ps2_command(0, command, param);
 299     if (ret)
 300         dprintf(2, "keyboard command %x failed\n", command);
 301     return ret;
 302 }
 303
 304 int
 305 aux_command(int command, u8 *param)
 306 {
 307     dprintf(7, "aux_command cmd=%x\n", command);
 308     int ret = ps2_command(1, command, param);
 309     if (ret)
 310         dprintf(2, "mouse command %x failed\n", command);
 311     return ret;
 312 }
 313
 314
 315 /****************************************************************
 316  * IRQ handlers
 317  ****************************************************************/
 318
 319 // INT74h : PS/2 mouse hardware interrupt
 320 void VISIBLE16
 321 handle_74(void)
 322 {
 323     if (! CONFIG_PS2PORT)
 324         return;
 325
 326     debug_isr(DEBUG_ISR_74);
 327
 328     u8 v = inb(PORT_PS2_STATUS);
 329     if ((v & (I8042_STR_OBF|I8042_STR_AUXDATA))
 330         != (I8042_STR_OBF|I8042_STR_AUXDATA)) {
 331         dprintf(1, "mouse irq but no mouse data.\n");
 332         goto done;
 333     }
 334     v = inb(PORT_PS2_DATA);
 335
 336     process_mouse(v);
 337
 338 done:
 339     eoi_pic2();
 340 }
 341
 342 // INT09h : Keyboard Hardware Service Entry Point
 343 void VISIBLE16
 344 handle_09(void)
 345 {
 346     if (! CONFIG_PS2PORT)
 347         return;
 348
 349     debug_isr(DEBUG_ISR_09);
 350
 351     // read key from keyboard controller
 352     u8 v = inb(PORT_PS2_STATUS);
 353     if ((v & (I8042_STR_OBF|I8042_STR_AUXDATA)) != I8042_STR_OBF) {
 354         dprintf(1, "keyboard irq but no keyboard data.\n");
 355         goto done;
 356     }
 357     v = inb(PORT_PS2_DATA);
 358
 359     process_key(v);
 360
 361 done:
 362     eoi_pic1();
 363 }
 364
 365
 366 /****************************************************************
 367  * Setup
 368  ****************************************************************/
 369
 370 static void
 371 keyboard_init(void *data)
 372 {
 373     /* flush incoming keys */
 374     int ret = i8042_flush();
 375     if (ret)
 376         return;
 377
 378     // Controller self-test.
 379     u8 param[2];
 380     ret = i8042_command(I8042_CMD_CTL_TEST, param);
 381     if (ret)
 382         return;
 383     if (param[0] != 0x55) {
 384         dprintf(1, "i8042 self test failed (got %x not 0x55)\n", param[0]);
 385         return;
 386     }
 387
 388     // Controller keyboard test.
 389     ret = i8042_command(I8042_CMD_KBD_TEST, param);
 390     if (ret)
 391         return;
 392     if (param[0] != 0x00) {
 393         dprintf(1, "i8042 keyboard test failed (got %x not 0x00)\n", param[0]);
 394         return;
 395     }
 396
 397     // Enable keyboard and mouse ports.
 398     ret = i8042_command(I8042_CMD_KBD_ENABLE, NULL);
 399     if (ret)
 400         return;
 401     ret = i8042_command(I8042_CMD_AUX_ENABLE, NULL);
 402     if (ret)
 403         return;
 404
 405
 406     /* ------------------- keyboard side ------------------------*/
 407     /* reset keyboard and self test  (keyboard side) */
 408     ret = kbd_command(ATKBD_CMD_RESET_BAT, param);
 409     if (ret)
 410         return;
 411     if (param[0] != 0xaa) {
 412         dprintf(1, "keyboard self test failed (got %x not 0xaa)\n", param[0]);
 413         return;
 414     }
 415
 416     /* Disable keyboard */
 417     ret = kbd_command(ATKBD_CMD_RESET_DIS, NULL);
 418     if (ret)
 419         return;
 420
 421     // Set scancode command (mode 2)
 422     param[0] = 0x02;
 423     ret = kbd_command(ATKBD_CMD_SSCANSET, param);
 424     if (ret)
 425         return;
 426
 427     // Keyboard Mode: scan code convert, disable mouse, enable IRQ 1
 428     SET_EBDA(ps2ctr, I8042_CTR_AUXDIS | I8042_CTR_XLATE | I8042_CTR_KBDINT);
 429
 430     /* Enable keyboard */
 431     ret = kbd_command(ATKBD_CMD_ENABLE, NULL);
 432     if (ret)
 433         return;
 434
 435     dprintf(1, "PS2 keyboard initialized\n");
 436 }
 437
 438 void
 439 ps2port_setup(void)
 440 {
 441     ASSERT32FLAT();
 442     if (! CONFIG_PS2PORT)
 443         return;
 444     dprintf(3, "init ps2port\n");
 445
 446     enable_hwirq(1, entry_09);
 447     enable_hwirq(12, entry_74);
 448
 449     run_thread(keyboard_init, NULL);
 450 }