drivers/input/serio/i8042.c

   1 /*
   2  *  i8042 keyboard and mouse controller driver for Linux
   3  *
   4  *  Copyright (c) 1999-2004 Vojtech Pavlik
   5  */
   6
   7 /*
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License version 2 as published by
  10  * the Free Software Foundation.
  11  */
  12
  13 #include <linux/types.h>
  14 #include <linux/delay.h>
  15 #include <linux/module.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/ioport.h>
  18 #include <linux/init.h>
  19 #include <linux/serio.h>
  20 #include <linux/err.h>
  21 #include <linux/rcupdate.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/i8042.h>
  24
  25 #include <asm/io.h>
  26
  27 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
  28 MODULE_DESCRIPTION("i8042 keyboard and mouse controller driver");
  29 MODULE_LICENSE("GPL");
  30
  31 static bool i8042_nokbd;
  32 module_param_named(nokbd, i8042_nokbd, bool, 0);
  33 MODULE_PARM_DESC(nokbd, "Do not probe or use KBD port.");
  34
  35 static bool i8042_noaux;
  36 module_param_named(noaux, i8042_noaux, bool, 0);
  37 MODULE_PARM_DESC(noaux, "Do not probe or use AUX (mouse) port.");
  38
  39 static bool i8042_nomux;
  40 module_param_named(nomux, i8042_nomux, bool, 0);
  41 MODULE_PARM_DESC(nomux, "Do not check whether an active multiplexing conrtoller is present.");
  42
  43 static bool i8042_unlock;
  44 module_param_named(unlock, i8042_unlock, bool, 0);
  45 MODULE_PARM_DESC(unlock, "Ignore keyboard lock.");
  46
  47 static bool i8042_reset;
  48 module_param_named(reset, i8042_reset, bool, 0);
  49 MODULE_PARM_DESC(reset, "Reset controller during init and cleanup.");
  50
  51 static bool i8042_direct;
  52 module_param_named(direct, i8042_direct, bool, 0);
  53 MODULE_PARM_DESC(direct, "Put keyboard port into non-translated mode.");
  54
  55 static bool i8042_dumbkbd;
  56 module_param_named(dumbkbd, i8042_dumbkbd, bool, 0);
  57 MODULE_PARM_DESC(dumbkbd, "Pretend that controller can only read data from keyboard");
  58
  59 static bool i8042_noloop;
  60 module_param_named(noloop, i8042_noloop, bool, 0);
  61 MODULE_PARM_DESC(noloop, "Disable the AUX Loopback command while probing for the AUX port");
  62
  63 static unsigned int i8042_blink_frequency = 500;
  64 module_param_named(panicblink, i8042_blink_frequency, uint, 0600);
  65 MODULE_PARM_DESC(panicblink, "Frequency with which keyboard LEDs should blink when kernel panics");
  66
  67 #ifdef CONFIG_X86
  68 static bool i8042_dritek;
  69 module_param_named(dritek, i8042_dritek, bool, 0);
  70 MODULE_PARM_DESC(dritek, "Force enable the Dritek keyboard extension");
  71 #endif
  72
  73 #ifdef CONFIG_PNP
  74 static bool i8042_nopnp;
  75 module_param_named(nopnp, i8042_nopnp, bool, 0);
  76 MODULE_PARM_DESC(nopnp, "Do not use PNP to detect controller settings");
  77 #endif
  78
  79 #define DEBUG
  80 #ifdef DEBUG
  81 static bool i8042_debug;
  82 module_param_named(debug, i8042_debug, bool, 0600);
  83 MODULE_PARM_DESC(debug, "Turn i8042 debugging mode on and off");
  84 #endif
  85
  86 static bool i8042_bypass_aux_irq_test;
  87
  88 #include "i8042.h"
  89
  90 /*
  91  * i8042_lock protects serialization between i8042_command and
  92  * the interrupt handler.
  93  */
  94 static DEFINE_SPINLOCK(i8042_lock);
  95
  96 /*
  97  * Writers to AUX and KBD ports as well as users issuing i8042_command
  98  * directly should acquire i8042_mutex (by means of calling
  99  * i8042_lock_chip() and i8042_unlock_ship() helpers) to ensure that
 100  * they do not disturb each other (unfortunately in many i8042
 101  * implementations write to one of the ports will immediately abort
 102  * command that is being processed by another port).
 103  */
 104 static DEFINE_MUTEX(i8042_mutex);
 105
 106 struct i8042_port {
 107         struct serio *serio;
 108         int irq;
 109         bool exists;
 110         signed char mux;
 111 };
 112
 113 #define I8042_KBD_PORT_NO       0
 114 #define I8042_AUX_PORT_NO       1
 115 #define I8042_MUX_PORT_NO       2
 116 #define I8042_NUM_PORTS         (I8042_NUM_MUX_PORTS + 2)
 117
 118 static struct i8042_port i8042_ports[I8042_NUM_PORTS];
 119
 120 static unsigned char i8042_initial_ctr;
 121 static unsigned char i8042_ctr;
 122 static bool i8042_mux_present;
 123 static bool i8042_kbd_irq_registered;
 124 static bool i8042_aux_irq_registered;
 125 static unsigned char i8042_suppress_kbd_ack;
 126 static struct platform_device *i8042_platform_device;
 127
 128 static irqreturn_t i8042_interrupt(int irq, void *dev_id);
 129
 130 void i8042_lock_chip(void)
 131 {
 132         mutex_lock(&i8042_mutex);
 133 }
 134 EXPORT_SYMBOL(i8042_lock_chip);
 135
 136 void i8042_unlock_chip(void)
 137 {
 138         mutex_unlock(&i8042_mutex);
 139 }
 140 EXPORT_SYMBOL(i8042_unlock_chip);
 141
 142 /*
 143  * The i8042_wait_read() and i8042_wait_write functions wait for the i8042 to
 144  * be ready for reading values from it / writing values to it.
 145  * Called always with i8042_lock held.
 146  */
 147
 148 static int i8042_wait_read(void)
 149 {
 150         int i = 0;
 151
 152         while ((~i8042_read_status() & I8042_STR_OBF) && (i < I8042_CTL_TIMEOUT)) {
 153                 udelay(50);
 154                 i++;
 155         }
 156         return -(i == I8042_CTL_TIMEOUT);
 157 }
 158
 159 static int i8042_wait_write(void)
 160 {
 161         int i = 0;
 162
 163         while ((i8042_read_status() & I8042_STR_IBF) && (i < I8042_CTL_TIMEOUT)) {
 164                 udelay(50);
 165                 i++;
 166         }
 167         return -(i == I8042_CTL_TIMEOUT);
 168 }
 169
 170 /*
 171  * i8042_flush() flushes all data that may be in the keyboard and mouse buffers
 172  * of the i8042 down the toilet.
 173  */
 174
 175 static int i8042_flush(void)
 176 {
 177         unsigned long flags;
 178         unsigned char data, str;
 179         int i = 0;
 180
 181         spin_lock_irqsave(&i8042_lock, flags);
 182
 183         while (((str = i8042_read_status()) & I8042_STR_OBF) && (i < I8042_BUFFER_SIZE)) {
 184                 udelay(50);
 185                 data = i8042_read_data();
 186                 i++;
 187                 dbg("%02x <- i8042 (flush, %s)", data,
 188                         str & I8042_STR_AUXDATA ? "aux" : "kbd");
 189         }
 190
 191         spin_unlock_irqrestore(&i8042_lock, flags);
 192
 193         return i;
 194 }
 195
 196 /*
 197  * i8042_command() executes a command on the i8042. It also sends the input
 198  * parameter(s) of the commands to it, and receives the output value(s). The
 199  * parameters are to be stored in the param array, and the output is placed
 200  * into the same array. The number of the parameters and output values is
 201  * encoded in bits 8-11 of the command number.
 202  */
 203
 204 static int __i8042_command(unsigned char *param, int command)
 205 {
 206         int i, error;
 207
 208         if (i8042_noloop && command == I8042_CMD_AUX_LOOP)
 209                 return -1;
 210
 211         error = i8042_wait_write();
 212         if (error)
 213                 return error;
 214
 215         dbg("%02x -> i8042 (command)", command & 0xff);
 216         i8042_write_command(command & 0xff);
 217
 218         for (i = 0; i < ((command >> 12) & 0xf); i++) {
 219                 error = i8042_wait_write();
 220                 if (error)
 221                         return error;
 222                 dbg("%02x -> i8042 (parameter)", param[i]);
 223                 i8042_write_data(param[i]);
 224         }
 225
 226         for (i = 0; i < ((command >> 8) & 0xf); i++) {
 227                 error = i8042_wait_read();
 228                 if (error) {
 229                         dbg("     -- i8042 (timeout)");
 230                         return error;
 231                 }
 232
 233                 if (command == I8042_CMD_AUX_LOOP &&
 234                     !(i8042_read_status() & I8042_STR_AUXDATA)) {
 235                         dbg("     -- i8042 (auxerr)");
 236                         return -1;
 237                 }
 238
 239                 param[i] = i8042_read_data();
 240                 dbg("%02x <- i8042 (return)", param[i]);
 241         }
 242
 243         return 0;
 244 }
 245
 246 int i8042_command(unsigned char *param, int command)
 247 {
 248         unsigned long flags;
 249         int retval;
 250
 251         spin_lock_irqsave(&i8042_lock, flags);
 252         retval = __i8042_command(param, command);
 253         spin_unlock_irqrestore(&i8042_lock, flags);
 254
 255         return retval;
 256 }
 257 EXPORT_SYMBOL(i8042_command);
 258
 259 /*
 260  * i8042_kbd_write() sends a byte out through the keyboard interface.
 261  */
 262
 263 static int i8042_kbd_write(struct serio *port, unsigned char c)
 264 {
 265         unsigned long flags;
 266         int retval = 0;
 267
 268         spin_lock_irqsave(&i8042_lock, flags);
 269
 270         if (!(retval = i8042_wait_write())) {
 271                 dbg("%02x -> i8042 (kbd-data)", c);
 272                 i8042_write_data(c);
 273         }
 274
 275         spin_unlock_irqrestore(&i8042_lock, flags);
 276
 277         return retval;
 278 }
 279
 280 /*
 281  * i8042_aux_write() sends a byte out through the aux interface.
 282  */
 283
 284 static int i8042_aux_write(struct serio *serio, unsigned char c)
 285 {
 286         struct i8042_port *port = serio->port_data;
 287
 288         return i8042_command(&c, port->mux == -1 ?
 289                                         I8042_CMD_AUX_SEND :
 290                                         I8042_CMD_MUX_SEND + port->mux);
 291 }
 292
 293
 294 /*
 295  * i8042_aux_close attempts to clear AUX or KBD port state by disabling
 296  * and then re-enabling it.
 297  */
 298
 299 static void i8042_port_close(struct serio *serio)
 300 {
 301         int irq_bit;
 302         int disable_bit;
 303         const char *port_name;
 304
 305         if (serio == i8042_ports[I8042_AUX_PORT_NO].serio) {
 306                 irq_bit = I8042_CTR_AUXINT;
 307                 disable_bit = I8042_CTR_AUXDIS;
 308                 port_name = "AUX";
 309         } else {
 310                 irq_bit = I8042_CTR_KBDINT;
 311                 disable_bit = I8042_CTR_KBDDIS;
 312                 port_name = "KBD";
 313         }
 314
 315         i8042_ctr &= ~irq_bit;
 316         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
 317                 printk(KERN_WARNING
 318                         "i8042.c: Can't write CTR while closing %s port.\n",
 319                         port_name);
 320
 321         udelay(50);
 322
 323         i8042_ctr &= ~disable_bit;
 324         i8042_ctr |= irq_bit;
 325         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
 326                 printk(KERN_ERR "i8042.c: Can't reactivate %s port.\n",
 327                         port_name);
 328
 329         /*
 330          * See if there is any data appeared while we were messing with
 331          * port state.
 332          */
 333         i8042_interrupt(0, NULL);
 334 }
 335
 336 /*
 337  * i8042_start() is called by serio core when port is about to finish
 338  * registering. It will mark port as existing so i8042_interrupt can
 339  * start sending data through it.
 340  */
 341 static int i8042_start(struct serio *serio)
 342 {
 343         struct i8042_port *port = serio->port_data;
 344
 345         port->exists = true;
 346         mb();
 347         return 0;
 348 }
 349
 350 /*
 351  * i8042_stop() marks serio port as non-existing so i8042_interrupt
 352  * will not try to send data to the port that is about to go away.
 353  * The function is called by serio core as part of unregister procedure.
 354  */
 355 static void i8042_stop(struct serio *serio)
 356 {
 357         struct i8042_port *port = serio->port_data;
 358
 359         port->exists = false;
 360
 361         /*
 362          * We synchronize with both AUX and KBD IRQs because there is
 363          * a (very unlikely) chance that AUX IRQ is raised for KBD port
 364          * and vice versa.
 365          */
 366         synchronize_irq(I8042_AUX_IRQ);
 367         synchronize_irq(I8042_KBD_IRQ);
 368         port->serio = NULL;
 369 }
 370
 371 /*
 372  * i8042_interrupt() is the most important function in this driver -
 373  * it handles the interrupts from the i8042, and sends incoming bytes
 374  * to the upper layers.
 375  */
 376
 377 static irqreturn_t i8042_interrupt(int irq, void *dev_id)
 378 {
 379         struct i8042_port *port;
 380         unsigned long flags;
 381         unsigned char str, data;
 382         unsigned int dfl;
 383         unsigned int port_no;
 384         int ret = 1;
 385
 386         spin_lock_irqsave(&i8042_lock, flags);
 387         str = i8042_read_status();
 388         if (unlikely(~str & I8042_STR_OBF)) {
 389                 spin_unlock_irqrestore(&i8042_lock, flags);
 390                 if (irq) dbg("Interrupt %d, without any data", irq);
 391                 ret = 0;
 392                 goto out;
 393         }
 394         data = i8042_read_data();
 395         spin_unlock_irqrestore(&i8042_lock, flags);
 396
 397         if (i8042_mux_present && (str & I8042_STR_AUXDATA)) {
 398                 static unsigned long last_transmit;
 399                 static unsigned char last_str;
 400
 401                 dfl = 0;
 402                 if (str & I8042_STR_MUXERR) {
 403                         dbg("MUX error, status is %02x, data is %02x", str, data);
 404 /*
 405  * When MUXERR condition is signalled the data register can only contain
 406  * 0xfd, 0xfe or 0xff if implementation follows the spec. Unfortunately
 407  * it is not always the case. Some KBCs also report 0xfc when there is
 408  * nothing connected to the port while others sometimes get confused which
 409  * port the data came from and signal error leaving the data intact. They
 410  * _do not_ revert to legacy mode (actually I've never seen KBC reverting
 411  * to legacy mode yet, when we see one we'll add proper handling).
 412  * Anyway, we process 0xfc, 0xfd, 0xfe and 0xff as timeouts, and for the
 413  * rest assume that the data came from the same serio last byte
 414  * was transmitted (if transmission happened not too long ago).
 415  */
 416
 417                         switch (data) {
 418                                 default:
 419                                         if (time_before(jiffies, last_transmit + HZ/10)) {
 420                                                 str = last_str;
 421                                                 break;
 422                                         }
 423                                         /* fall through - report timeout */
 424                                 case 0xfc:
 425                                 case 0xfd:
 426                                 case 0xfe: dfl = SERIO_TIMEOUT; data = 0xfe; break;
 427                                 case 0xff: dfl = SERIO_PARITY;  data = 0xfe; break;
 428                         }
 429                 }
 430
 431                 port_no = I8042_MUX_PORT_NO + ((str >> 6) & 3);
 432                 last_str = str;
 433                 last_transmit = jiffies;
 434         } else {
 435
 436                 dfl = ((str & I8042_STR_PARITY) ? SERIO_PARITY : 0) |
 437                       ((str & I8042_STR_TIMEOUT) ? SERIO_TIMEOUT : 0);
 438
 439                 port_no = (str & I8042_STR_AUXDATA) ?
 440                                 I8042_AUX_PORT_NO : I8042_KBD_PORT_NO;
 441         }
 442
 443         port = &i8042_ports[port_no];
 444
 445         dbg("%02x <- i8042 (interrupt, %d, %d%s%s)",
 446             data, port_no, irq,
 447             dfl & SERIO_PARITY ? ", bad parity" : "",
 448             dfl & SERIO_TIMEOUT ? ", timeout" : "");
 449
 450         if (unlikely(i8042_suppress_kbd_ack))
 451                 if (port_no == I8042_KBD_PORT_NO &&
 452                     (data == 0xfa || data == 0xfe)) {
 453                         i8042_suppress_kbd_ack--;
 454                         goto out;
 455                 }
 456
 457         if (likely(port->exists))
 458                 serio_interrupt(port->serio, data, dfl);
 459
 460  out:
 461         return IRQ_RETVAL(ret);
 462 }
 463
 464 /*
 465  * i8042_enable_kbd_port enables keyboard port on chip
 466  */
 467
 468 static int i8042_enable_kbd_port(void)
 469 {
 470         i8042_ctr &= ~I8042_CTR_KBDDIS;
 471         i8042_ctr |= I8042_CTR_KBDINT;
 472
 473         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 474                 i8042_ctr &= ~I8042_CTR_KBDINT;
 475                 i8042_ctr |= I8042_CTR_KBDDIS;
 476                 printk(KERN_ERR "i8042.c: Failed to enable KBD port.\n");
 477                 return -EIO;
 478         }
 479
 480         return 0;
 481 }
 482
 483 /*
 484  * i8042_enable_aux_port enables AUX (mouse) port on chip
 485  */
 486
 487 static int i8042_enable_aux_port(void)
 488 {
 489         i8042_ctr &= ~I8042_CTR_AUXDIS;
 490         i8042_ctr |= I8042_CTR_AUXINT;
 491
 492         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 493                 i8042_ctr &= ~I8042_CTR_AUXINT;
 494                 i8042_ctr |= I8042_CTR_AUXDIS;
 495                 printk(KERN_ERR "i8042.c: Failed to enable AUX port.\n");
 496                 return -EIO;
 497         }
 498
 499         return 0;
 500 }
 501
 502 /*
 503  * i8042_enable_mux_ports enables 4 individual AUX ports after
 504  * the controller has been switched into Multiplexed mode
 505  */
 506
 507 static int i8042_enable_mux_ports(void)
 508 {
 509         unsigned char param;
 510         int i;
 511
 512         for (i = 0; i < I8042_NUM_MUX_PORTS; i++) {
 513                 i8042_command(&param, I8042_CMD_MUX_PFX + i);
 514                 i8042_command(&param, I8042_CMD_AUX_ENABLE);
 515         }
 516
 517         return i8042_enable_aux_port();
 518 }
 519
 520 /*
 521  * i8042_set_mux_mode checks whether the controller has an
 522  * active multiplexor and puts the chip into Multiplexed (true)
 523  * or Legacy (false) mode.
 524  */
 525
 526 static int i8042_set_mux_mode(bool multiplex, unsigned char *mux_version)
 527 {
 528
 529         unsigned char param, val;
 530 /*
 531  * Get rid of bytes in the queue.
 532  */
 533
 534         i8042_flush();
 535
 536 /*
 537  * Internal loopback test - send three bytes, they should come back from the
 538  * mouse interface, the last should be version.
 539  */
 540
 541         param = val = 0xf0;
 542         if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != val)
 543                 return -1;
 544         param = val = multiplex ? 0x56 : 0xf6;
 545         if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != val)
 546                 return -1;
 547         param = val = multiplex ? 0xa4 : 0xa5;
 548         if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param == val)
 549                 return -1;
 550
 551 /*
 552  * Workaround for interference with USB Legacy emulation
 553  * that causes a v10.12 MUX to be found.
 554  */
 555         if (param == 0xac)
 556                 return -1;
 557
 558         if (mux_version)
 559                 *mux_version = param;
 560
 561         return 0;
 562 }
 563
 564 /*
 565  * i8042_check_mux() checks whether the controller supports the PS/2 Active
 566  * Multiplexing specification by Synaptics, Phoenix, Insyde and
 567  * LCS/Telegraphics.
 568  */
 569
 570 static int __init i8042_check_mux(void)
 571 {
 572         unsigned char mux_version;
 573
 574         if (i8042_set_mux_mode(true, &mux_version))
 575                 return -1;
 576
 577         printk(KERN_INFO "i8042.c: Detected active multiplexing controller, rev %d.%d.\n",
 578                 (mux_version >> 4) & 0xf, mux_version & 0xf);
 579
 580 /*
 581  * Disable all muxed ports by disabling AUX.
 582  */
 583         i8042_ctr |= I8042_CTR_AUXDIS;
 584         i8042_ctr &= ~I8042_CTR_AUXINT;
 585
 586         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 587                 printk(KERN_ERR "i8042.c: Failed to disable AUX port, can't use MUX.\n");
 588                 return -EIO;
 589         }
 590
 591         i8042_mux_present = true;
 592
 593         return 0;
 594 }
 595
 596 /*
 597  * The following is used to test AUX IRQ delivery.
 598  */
 599 static struct completion i8042_aux_irq_delivered __initdata;
 600 static bool i8042_irq_being_tested __initdata;
 601
 602 static irqreturn_t __init i8042_aux_test_irq(int irq, void *dev_id)
 603 {
 604         unsigned long flags;
 605         unsigned char str, data;
 606         int ret = 0;
 607
 608         spin_lock_irqsave(&i8042_lock, flags);
 609         str = i8042_read_status();
 610         if (str & I8042_STR_OBF) {
 611                 data = i8042_read_data();
 612                 dbg("%02x <- i8042 (aux_test_irq, %s)",
 613                         data, str & I8042_STR_AUXDATA ? "aux" : "kbd");
 614                 if (i8042_irq_being_tested &&
 615                     data == 0xa5 && (str & I8042_STR_AUXDATA))
 616                         complete(&i8042_aux_irq_delivered);
 617                 ret = 1;
 618         }
 619         spin_unlock_irqrestore(&i8042_lock, flags);
 620
 621         return IRQ_RETVAL(ret);
 622 }
 623
 624 /*
 625  * i8042_toggle_aux - enables or disables AUX port on i8042 via command and
 626  * verifies success by readinng CTR. Used when testing for presence of AUX
 627  * port.
 628  */
 629 static int __init i8042_toggle_aux(bool on)
 630 {
 631         unsigned char param;
 632         int i;
 633
 634         if (i8042_command(&param,
 635                         on ? I8042_CMD_AUX_ENABLE : I8042_CMD_AUX_DISABLE))
 636                 return -1;
 637
 638         /* some chips need some time to set the I8042_CTR_AUXDIS bit */
 639         for (i = 0; i < 100; i++) {
 640                 udelay(50);
 641
 642                 if (i8042_command(&param, I8042_CMD_CTL_RCTR))
 643                         return -1;
 644
 645                 if (!(param & I8042_CTR_AUXDIS) == on)
 646                         return 0;
 647         }
 648
 649         return -1;
 650 }
 651
 652 /*
 653  * i8042_check_aux() applies as much paranoia as it can at detecting
 654  * the presence of an AUX interface.
 655  */
 656
 657 static int __init i8042_check_aux(void)
 658 {
 659         int retval = -1;
 660         bool irq_registered = false;
 661         bool aux_loop_broken = false;
 662         unsigned long flags;
 663         unsigned char param;
 664
 665 /*
 666  * Get rid of bytes in the queue.
 667  */
 668
 669         i8042_flush();
 670
 671 /*
 672  * Internal loopback test - filters out AT-type i8042's. Unfortunately
 673  * SiS screwed up and their 5597 doesn't support the LOOP command even
 674  * though it has an AUX port.
 675  */
 676
 677         param = 0x5a;
 678         retval = i8042_command(&param, I8042_CMD_AUX_LOOP);
 679         if (retval || param != 0x5a) {
 680
 681 /*
 682  * External connection test - filters out AT-soldered PS/2 i8042's
 683  * 0x00 - no error, 0x01-0x03 - clock/data stuck, 0xff - general error
 684  * 0xfa - no error on some notebooks which ignore the spec
 685  * Because it's common for chipsets to return error on perfectly functioning
 686  * AUX ports, we test for this only when the LOOP command failed.
 687  */
 688
 689                 if (i8042_command(&param, I8042_CMD_AUX_TEST) ||
 690                     (param && param != 0xfa && param != 0xff))
 691                         return -1;
 692
 693 /*
 694  * If AUX_LOOP completed without error but returned unexpected data
 695  * mark it as broken
 696  */
 697                 if (!retval)
 698                         aux_loop_broken = true;
 699         }
 700
 701 /*
 702  * Bit assignment test - filters out PS/2 i8042's in AT mode
 703  */
 704
 705         if (i8042_toggle_aux(false)) {
 706                 printk(KERN_WARNING "Failed to disable AUX port, but continuing anyway... Is this a SiS?\n");
 707                 printk(KERN_WARNING "If AUX port is really absent please use the 'i8042.noaux' option.\n");
 708         }
 709
 710         if (i8042_toggle_aux(true))
 711                 return -1;
 712
 713 /*
 714  * Test AUX IRQ delivery to make sure BIOS did not grab the IRQ and
 715  * used it for a PCI card or somethig else.
 716  */
 717
 718         if (i8042_noloop || i8042_bypass_aux_irq_test || aux_loop_broken) {
 719 /*
 720  * Without LOOP command we can't test AUX IRQ delivery. Assume the port
 721  * is working and hope we are right.
 722  */
 723                 retval = 0;
 724                 goto out;
 725         }
 726
 727         if (request_irq(I8042_AUX_IRQ, i8042_aux_test_irq, IRQF_SHARED,
 728                         "i8042", i8042_platform_device))
 729                 goto out;
 730
 731         irq_registered = true;
 732
 733         if (i8042_enable_aux_port())
 734                 goto out;
 735
 736         spin_lock_irqsave(&i8042_lock, flags);
 737
 738         init_completion(&i8042_aux_irq_delivered);
 739         i8042_irq_being_tested = true;
 740
 741         param = 0xa5;
 742         retval = __i8042_command(&param, I8042_CMD_AUX_LOOP & 0xf0ff);
 743
 744         spin_unlock_irqrestore(&i8042_lock, flags);
 745
 746         if (retval)
 747                 goto out;
 748
 749         if (wait_for_completion_timeout(&i8042_aux_irq_delivered,
 750                                         msecs_to_jiffies(250)) == 0) {
 751 /*
 752  * AUX IRQ was never delivered so we need to flush the controller to
 753  * get rid of the byte we put there; otherwise keyboard may not work.
 754  */
 755                 dbg("     -- i8042 (aux irq test timeout)");
 756                 i8042_flush();
 757                 retval = -1;
 758         }
 759
 760  out:
 761
 762 /*
 763  * Disable the interface.
 764  */
 765
 766         i8042_ctr |= I8042_CTR_AUXDIS;
 767         i8042_ctr &= ~I8042_CTR_AUXINT;
 768
 769         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
 770                 retval = -1;
 771
 772         if (irq_registered)
 773                 free_irq(I8042_AUX_IRQ, i8042_platform_device);
 774
 775         return retval;
 776 }
 777
 778 static int i8042_controller_check(void)
 779 {
 780         if (i8042_flush() == I8042_BUFFER_SIZE) {
 781                 printk(KERN_ERR "i8042.c: No controller found.\n");
 782                 return -ENODEV;
 783         }
 784
 785         return 0;
 786 }
 787
 788 static int i8042_controller_selftest(void)
 789 {
 790         unsigned char param;
 791         int i = 0;
 792
 793         if (!i8042_reset)
 794                 return 0;
 795
 796         /*
 797          * We try this 5 times; on some really fragile systems this does not
 798          * take the first time...
 799          */
 800         do {
 801
 802                 if (i8042_command(&param, I8042_CMD_CTL_TEST)) {
 803                         printk(KERN_ERR "i8042.c: i8042 controller self test timeout.\n");
 804                         return -ENODEV;
 805                 }
 806
 807                 if (param == I8042_RET_CTL_TEST)
 808                         return 0;
 809
 810                 printk(KERN_ERR "i8042.c: i8042 controller selftest failed. (%#x != %#x)\n",
 811                         param, I8042_RET_CTL_TEST);
 812                 msleep(50);
 813         } while (i++ < 5);
 814
 815 #ifdef CONFIG_X86
 816         /*
 817          * On x86, we don't fail entire i8042 initialization if controller
 818          * reset fails in hopes that keyboard port will still be functional
 819          * and user will still get a working keyboard. This is especially
 820          * important on netbooks. On other arches we trust hardware more.
 821          */
 822         printk(KERN_INFO
 823                 "i8042: giving up on controller selftest, continuing anyway...\n");
 824         return 0;
 825 #else
 826         return -EIO;
 827 #endif
 828 }
 829
 830 /*
 831  * i8042_controller init initializes the i8042 controller, and,
 832  * most importantly, sets it into non-xlated mode if that's
 833  * desired.
 834  */
 835
 836 static int i8042_controller_init(void)
 837 {
 838         unsigned long flags;
 839         int n = 0;
 840         unsigned char ctr[2];
 841
 842 /*
 843  * Save the CTR for restore on unload / reboot.
 844  */
 845
 846         do {
 847                 if (n >= 10) {
 848                         printk(KERN_ERR
 849                                 "i8042.c: Unable to get stable CTR read.\n");
 850                         return -EIO;
 851                 }
 852
 853                 if (n != 0)
 854                         udelay(50);
 855
 856                 if (i8042_command(&ctr[n++ % 2], I8042_CMD_CTL_RCTR)) {
 857                         printk(KERN_ERR
 858                                 "i8042.c: Can't read CTR while initializing i8042.\n");
 859                         return -EIO;
 860                 }
 861
 862         } while (n < 2 || ctr[0] != ctr[1]);
 863
 864         i8042_initial_ctr = i8042_ctr = ctr[0];
 865
 866 /*
 867  * Disable the keyboard interface and interrupt.
 868  */
 869
 870         i8042_ctr |= I8042_CTR_KBDDIS;
 871         i8042_ctr &= ~I8042_CTR_KBDINT;
 872
 873 /*
 874  * Handle keylock.
 875  */
 876
 877         spin_lock_irqsave(&i8042_lock, flags);
 878         if (~i8042_read_status() & I8042_STR_KEYLOCK) {
 879                 if (i8042_unlock)
 880                         i8042_ctr |= I8042_CTR_IGNKEYLOCK;
 881                 else
 882                         printk(KERN_WARNING "i8042.c: Warning: Keylock active.\n");
 883         }
 884         spin_unlock_irqrestore(&i8042_lock, flags);
 885
 886 /*
 887  * If the chip is configured into nontranslated mode by the BIOS, don't
 888  * bother enabling translating and be happy.
 889  */
 890
 891         if (~i8042_ctr & I8042_CTR_XLATE)
 892                 i8042_direct = true;
 893
 894 /*
 895  * Set nontranslated mode for the kbd interface if requested by an option.
 896  * After this the kbd interface becomes a simple serial in/out, like the aux
 897  * interface is. We don't do this by default, since it can confuse notebook
 898  * BIOSes.
 899  */
 900
 901         if (i8042_direct)
 902                 i8042_ctr &= ~I8042_CTR_XLATE;
 903
 904 /*
 905  * Write CTR back.
 906  */
 907
 908         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 909                 printk(KERN_ERR "i8042.c: Can't write CTR while initializing i8042.\n");
 910                 return -EIO;
 911         }
 912
 913 /*
 914  * Flush whatever accumulated while we were disabling keyboard port.
 915  */
 916
 917         i8042_flush();
 918
 919         return 0;
 920 }
 921
 922
 923 /*
 924  * Reset the controller and reset CRT to the original value set by BIOS.
 925  */
 926
 927 static void i8042_controller_reset(void)
 928 {
 929         i8042_flush();
 930
 931 /*
 932  * Disable both KBD and AUX interfaces so they don't get in the way
 933  */
 934
 935         i8042_ctr |= I8042_CTR_KBDDIS | I8042_CTR_AUXDIS;
 936         i8042_ctr &= ~(I8042_CTR_KBDINT | I8042_CTR_AUXINT);
 937
 938         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
 939                 printk(KERN_WARNING "i8042.c: Can't write CTR while resetting.\n");
 940
 941 /*
 942  * Disable MUX mode if present.
 943  */
 944
 945         if (i8042_mux_present)
 946                 i8042_set_mux_mode(false, NULL);
 947
 948 /*
 949  * Reset the controller if requested.
 950  */
 951
 952         i8042_controller_selftest();
 953
 954 /*
 955  * Restore the original control register setting.
 956  */
 957
 958         if (i8042_command(&i8042_initial_ctr, I8042_CMD_CTL_WCTR))
 959                 printk(KERN_WARNING "i8042.c: Can't restore CTR.\n");
 960 }
 961
 962
 963 /*
 964  * i8042_panic_blink() will flash the keyboard LEDs and is called when
 965  * kernel panics. Flashing LEDs is useful for users running X who may
 966  * not see the console and will help distingushing panics from "real"
 967  * lockups.
 968  *
 969  * Note that DELAY has a limit of 10ms so we will not get stuck here
 970  * waiting for KBC to free up even if KBD interrupt is off
 971  */
 972
 973 #define DELAY do { mdelay(1); if (++delay > 10) return delay; } while(0)
 974
 975 static long i8042_panic_blink(long count)
 976 {
 977         long delay = 0;
 978         static long last_blink;
 979         static char led;
 980
 981         /*
 982          * We expect frequency to be about 1/2s. KDB uses about 1s.
 983          * Make sure they are different.
 984          */
 985         if (!i8042_blink_frequency)
 986                 return 0;
 987         if (count - last_blink < i8042_blink_frequency)
 988                 return 0;
 989
 990         led ^= 0x01 | 0x04;
 991         while (i8042_read_status() & I8042_STR_IBF)
 992                 DELAY;
 993         dbg("%02x -> i8042 (panic blink)", 0xed);
 994         i8042_suppress_kbd_ack = 2;
 995         i8042_write_data(0xed); /* set leds */
 996         DELAY;
 997         while (i8042_read_status() & I8042_STR_IBF)
 998                 DELAY;
 999         DELAY;
1000         dbg("%02x -> i8042 (panic blink)", led);
1001         i8042_write_data(led);
1002         DELAY;
1003         last_blink = count;
1004         return delay;
1005 }
1006
1007 #undef DELAY
1008
1009 #ifdef CONFIG_X86
1010 static void i8042_dritek_enable(void)
1011 {
1012         char param = 0x90;
1013         int error;
1014
1015         error = i8042_command(&param, 0x1059);
1016         if (error)
1017                 printk(KERN_WARNING
1018                         "Failed to enable DRITEK extension: %d\n",
1019                         error);
1020 }
1021 #endif
1022
1023 #ifdef CONFIG_PM
1024
1025 /*
1026  * Here we try to restore the original BIOS settings to avoid
1027  * upsetting it.
1028  */
1029
1030 static int i8042_pm_reset(struct device *dev)
1031 {
1032         i8042_controller_reset();
1033
1034         return 0;
1035 }
1036
1037 /*
1038  * Here we try to reset everything back to a state we had
1039  * before suspending.
1040  */
1041
1042 static int i8042_pm_restore(struct device *dev)
1043 {
1044         int error;
1045
1046         error = i8042_controller_check();
1047         if (error)
1048                 return error;
1049
1050         error = i8042_controller_selftest();
1051         if (error)
1052                 return error;
1053
1054 /*
1055  * Restore original CTR value and disable all ports
1056  */
1057
1058         i8042_ctr = i8042_initial_ctr;
1059         if (i8042_direct)
1060                 i8042_ctr &= ~I8042_CTR_XLATE;
1061         i8042_ctr |= I8042_CTR_AUXDIS | I8042_CTR_KBDDIS;
1062         i8042_ctr &= ~(I8042_CTR_AUXINT | I8042_CTR_KBDINT);
1063         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
1064                 printk(KERN_WARNING "i8042: Can't write CTR to resume, retrying...\n");
1065                 msleep(50);
1066                 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
1067                         printk(KERN_ERR "i8042: CTR write retry failed\n");
1068                         return -EIO;
1069                 }
1070         }
1071
1072
1073 #ifdef CONFIG_X86
1074         if (i8042_dritek)
1075                 i8042_dritek_enable();
1076 #endif
1077
1078         if (i8042_mux_present) {
1079                 if (i8042_set_mux_mode(true, NULL) || i8042_enable_mux_ports())
1080                         printk(KERN_WARNING
1081                                 "i8042: failed to resume active multiplexor, "
1082                                 "mouse won't work.\n");
1083         } else if (i8042_ports[I8042_AUX_PORT_NO].serio)
1084                 i8042_enable_aux_port();
1085
1086         if (i8042_ports[I8042_KBD_PORT_NO].serio)
1087                 i8042_enable_kbd_port();
1088
1089         i8042_interrupt(0, NULL);
1090
1091         return 0;
1092 }
1093
1094 static const struct dev_pm_ops i8042_pm_ops = {
1095         .suspend        = i8042_pm_reset,
1096         .resume         = i8042_pm_restore,
1097         .poweroff       = i8042_pm_reset,
1098         .restore        = i8042_pm_restore,
1099 };
1100
1101 #endif /* CONFIG_PM */
1102
1103 /*
1104  * We need to reset the 8042 back to original mode on system shutdown,
1105  * because otherwise BIOSes will be confused.
1106  */
1107
1108 static void i8042_shutdown(struct platform_device *dev)
1109 {
1110         i8042_controller_reset();
1111 }
1112
1113 static int __init i8042_create_kbd_port(void)
1114 {
1115         struct serio *serio;
1116         struct i8042_port *port = &i8042_ports[I8042_KBD_PORT_NO];
1117
1118         serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
1119         if (!serio)
1120                 return -ENOMEM;
1121
1122         serio->id.type          = i8042_direct ? SERIO_8042 : SERIO_8042_XL;
1123         serio->write            = i8042_dumbkbd ? NULL : i8042_kbd_write;
1124         serio->start            = i8042_start;
1125         serio->stop             = i8042_stop;
1126         serio->close            = i8042_port_close;
1127         serio->port_data        = port;
1128         serio->dev.parent       = &i8042_platform_device->dev;
1129         strlcpy(serio->name, "i8042 KBD port", sizeof(serio->name));
1130         strlcpy(serio->phys, I8042_KBD_PHYS_DESC, sizeof(serio->phys));
1131
1132         port->serio = serio;
1133         port->irq = I8042_KBD_IRQ;
1134
1135         return 0;
1136 }
1137
1138 static int __init i8042_create_aux_port(int idx)
1139 {
1140         struct serio *serio;
1141         int port_no = idx < 0 ? I8042_AUX_PORT_NO : I8042_MUX_PORT_NO + idx;
1142         struct i8042_port *port = &i8042_ports[port_no];
1143
1144         serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
1145         if (!serio)
1146                 return -ENOMEM;
1147
1148         serio->id.type          = SERIO_8042;
1149         serio->write            = i8042_aux_write;
1150         serio->start            = i8042_start;
1151         serio->stop             = i8042_stop;
1152         serio->port_data        = port;
1153         serio->dev.parent       = &i8042_platform_device->dev;
1154         if (idx < 0) {
1155                 strlcpy(serio->name, "i8042 AUX port", sizeof(serio->name));
1156                 strlcpy(serio->phys, I8042_AUX_PHYS_DESC, sizeof(serio->phys));
1157                 serio->close = i8042_port_close;
1158         } else {
1159                 snprintf(serio->name, sizeof(serio->name), "i8042 AUX%d port", idx);
1160                 snprintf(serio->phys, sizeof(serio->phys), I8042_MUX_PHYS_DESC, idx + 1);
1161         }
1162
1163         port->serio = serio;
1164         port->mux = idx;
1165         port->irq = I8042_AUX_IRQ;
1166
1167         return 0;
1168 }
1169
1170 static void __init i8042_free_kbd_port(void)
1171 {
1172         kfree(i8042_ports[I8042_KBD_PORT_NO].serio);
1173         i8042_ports[I8042_KBD_PORT_NO].serio = NULL;
1174 }
1175
1176 static void __init i8042_free_aux_ports(void)
1177 {
1178         int i;
1179
1180         for (i = I8042_AUX_PORT_NO; i < I8042_NUM_PORTS; i++) {
1181                 kfree(i8042_ports[i].serio);
1182                 i8042_ports[i].serio = NULL;
1183         }
1184 }
1185
1186 static void __init i8042_register_ports(void)
1187 {
1188         int i;
1189
1190         for (i = 0; i < I8042_NUM_PORTS; i++) {
1191                 if (i8042_ports[i].serio) {
1192                         printk(KERN_INFO "serio: %s at %#lx,%#lx irq %d\n",
1193                                 i8042_ports[i].serio->name,
1194                                 (unsigned long) I8042_DATA_REG,
1195                                 (unsigned long) I8042_COMMAND_REG,
1196                                 i8042_ports[i].irq);
1197                         serio_register_port(i8042_ports[i].serio);
1198                 }
1199         }
1200 }
1201
1202 static void __devexit i8042_unregister_ports(void)
1203 {
1204         int i;
1205
1206         for (i = 0; i < I8042_NUM_PORTS; i++) {
1207                 if (i8042_ports[i].serio) {
1208                         serio_unregister_port(i8042_ports[i].serio);
1209                         i8042_ports[i].serio = NULL;
1210                 }
1211         }
1212 }
1213
1214 /*
1215  * Checks whether port belongs to i8042 controller.
1216  */
1217 bool i8042_check_port_owner(const struct serio *port)
1218 {
1219         int i;
1220
1221         for (i = 0; i < I8042_NUM_PORTS; i++)
1222                 if (i8042_ports[i].serio == port)
1223                         return true;
1224
1225         return false;
1226 }
1227 EXPORT_SYMBOL(i8042_check_port_owner);
1228
1229 static void i8042_free_irqs(void)
1230 {
1231         if (i8042_aux_irq_registered)
1232                 free_irq(I8042_AUX_IRQ, i8042_platform_device);
1233         if (i8042_kbd_irq_registered)
1234                 free_irq(I8042_KBD_IRQ, i8042_platform_device);
1235
1236         i8042_aux_irq_registered = i8042_kbd_irq_registered = false;
1237 }
1238
1239 static int __init i8042_setup_aux(void)
1240 {
1241         int (*aux_enable)(void);
1242         int error;
1243         int i;
1244
1245         if (i8042_check_aux())
1246                 return -ENODEV;
1247
1248         if (i8042_nomux || i8042_check_mux()) {
1249                 error = i8042_create_aux_port(-1);
1250                 if (error)
1251                         goto err_free_ports;
1252                 aux_enable = i8042_enable_aux_port;
1253         } else {
1254                 for (i = 0; i < I8042_NUM_MUX_PORTS; i++) {
1255                         error = i8042_create_aux_port(i);
1256                         if (error)
1257                                 goto err_free_ports;
1258                 }
1259                 aux_enable = i8042_enable_mux_ports;
1260         }
1261
1262         error = request_irq(I8042_AUX_IRQ, i8042_interrupt, IRQF_SHARED,
1263                             "i8042", i8042_platform_device);
1264         if (error)
1265                 goto err_free_ports;
1266
1267         if (aux_enable())
1268                 goto err_free_irq;
1269
1270         i8042_aux_irq_registered = true;
1271         return 0;
1272
1273  err_free_irq:
1274         free_irq(I8042_AUX_IRQ, i8042_platform_device);
1275  err_free_ports:
1276         i8042_free_aux_ports();
1277         return error;
1278 }
1279
1280 static int __init i8042_setup_kbd(void)
1281 {
1282         int error;
1283
1284         error = i8042_create_kbd_port();
1285         if (error)
1286                 return error;
1287
1288         error = request_irq(I8042_KBD_IRQ, i8042_interrupt, IRQF_SHARED,
1289                             "i8042", i8042_platform_device);
1290         if (error)
1291                 goto err_free_port;
1292
1293         error = i8042_enable_kbd_port();
1294         if (error)
1295                 goto err_free_irq;
1296
1297         i8042_kbd_irq_registered = true;
1298         return 0;
1299
1300  err_free_irq:
1301         free_irq(I8042_KBD_IRQ, i8042_platform_device);
1302  err_free_port:
1303         i8042_free_kbd_port();
1304         return error;
1305 }
1306
1307 static int __init i8042_probe(struct platform_device *dev)
1308 {
1309         int error;
1310
1311         error = i8042_controller_selftest();
1312         if (error)
1313                 return error;
1314
1315         error = i8042_controller_init();
1316         if (error)
1317                 return error;
1318
1319 #ifdef CONFIG_X86
1320         if (i8042_dritek)
1321                 i8042_dritek_enable();
1322 #endif
1323
1324         if (!i8042_noaux) {
1325                 error = i8042_setup_aux();
1326                 if (error && error != -ENODEV && error != -EBUSY)
1327                         goto out_fail;
1328         }
1329
1330         if (!i8042_nokbd) {
1331                 error = i8042_setup_kbd();
1332                 if (error)
1333                         goto out_fail;
1334         }
1335 /*
1336  * Ok, everything is ready, let's register all serio ports
1337  */
1338         i8042_register_ports();
1339
1340         return 0;
1341
1342  out_fail:
1343         i8042_free_aux_ports(); /* in case KBD failed but AUX not */
1344         i8042_free_irqs();
1345         i8042_controller_reset();
1346
1347         return error;
1348 }
1349
1350 static int __devexit i8042_remove(struct platform_device *dev)
1351 {
1352         i8042_unregister_ports();
1353         i8042_free_irqs();
1354         i8042_controller_reset();
1355
1356         return 0;
1357 }
1358
1359 static struct platform_driver i8042_driver = {
1360         .driver         = {
1361                 .name   = "i8042",
1362                 .owner  = THIS_MODULE,
1363 #ifdef CONFIG_PM
1364                 .pm     = &i8042_pm_ops,
1365 #endif
1366         },
1367         .remove         = __devexit_p(i8042_remove),
1368         .shutdown       = i8042_shutdown,
1369 };
1370
1371 static int __init i8042_init(void)
1372 {
1373         int err;
1374
1375         dbg_init();
1376
1377         err = i8042_platform_init();
1378         if (err)
1379                 return err;
1380
1381         err = i8042_controller_check();
1382         if (err)
1383                 goto err_platform_exit;
1384
1385         i8042_platform_device = platform_device_alloc("i8042", -1);
1386         if (!i8042_platform_device) {
1387                 err = -ENOMEM;
1388                 goto err_platform_exit;
1389         }
1390
1391         err = platform_device_add(i8042_platform_device);
1392         if (err)
1393                 goto err_free_device;
1394
1395         err = platform_driver_probe(&i8042_driver, i8042_probe);
1396         if (err)
1397                 goto err_del_device;
1398
1399         panic_blink = i8042_panic_blink;
1400
1401         return 0;
1402
1403  err_del_device:
1404         platform_device_del(i8042_platform_device);
1405  err_free_device:
1406         platform_device_put(i8042_platform_device);
1407  err_platform_exit:
1408         i8042_platform_exit();
1409
1410         return err;
1411 }
1412
1413 static void __exit i8042_exit(void)
1414 {
1415         platform_driver_unregister(&i8042_driver);
1416         platform_device_unregister(i8042_platform_device);
1417         i8042_platform_exit();
1418
1419         panic_blink = NULL;
1420 }
1421
1422 module_init(i8042_init);
1423 module_exit(i8042_exit);