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