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 /*
 326  * When MUXERR condition is signalled the data register can only contain
 327  * 0xfd, 0xfe or 0xff if implementation follows the spec. Unfortunately
 328  * it is not always the case. Some KBCs also report 0xfc when there is
 329  * nothing connected to the port while others sometimes get confused which
 330  * port the data came from and signal error leaving the data intact. They
 331  * _do not_ revert to legacy mode (actually I've never seen KBC reverting
 332  * to legacy mode yet, when we see one we'll add proper handling).
 333  * Anyway, we process 0xfc, 0xfd, 0xfe and 0xff as timeouts, and for the
 334  * rest assume that the data came from the same serio last byte
 335  * was transmitted (if transmission happened not too long ago).
 336  */
 337
 338                         switch (data) {
 339                                 default:
 340                                         if (time_before(jiffies, last_transmit + HZ/10)) {
 341                                                 str = last_str;
 342                                                 break;
 343                                         }
 344                                         /* fall through - report timeout */
 345                                 case 0xfc:
 346                                 case 0xfd:
 347                                 case 0xfe: dfl = SERIO_TIMEOUT; data = 0xfe; break;
 348                                 case 0xff: dfl = SERIO_PARITY;  data = 0xfe; break;
 349                         }
 350                 }
 351
 352                 port_no = I8042_MUX_PORT_NO + ((str >> 6) & 3);
 353                 last_str = str;
 354                 last_transmit = jiffies;
 355         } else {
 356
 357                 dfl = ((str & I8042_STR_PARITY) ? SERIO_PARITY : 0) |
 358                       ((str & I8042_STR_TIMEOUT) ? SERIO_TIMEOUT : 0);
 359
 360                 port_no = (str & I8042_STR_AUXDATA) ?
 361                                 I8042_AUX_PORT_NO : I8042_KBD_PORT_NO;
 362         }
 363
 364         port = &i8042_ports[port_no];
 365
 366         dbg("%02x <- i8042 (interrupt, %d, %d%s%s)",
 367             data, port_no, irq,
 368             dfl & SERIO_PARITY ? ", bad parity" : "",
 369             dfl & SERIO_TIMEOUT ? ", timeout" : "");
 370
 371         if (unlikely(i8042_suppress_kbd_ack))
 372                 if (port_no == I8042_KBD_PORT_NO &&
 373                     (data == 0xfa || data == 0xfe)) {
 374                         i8042_suppress_kbd_ack--;
 375                         goto out;
 376                 }
 377
 378         if (likely(port->exists))
 379                 serio_interrupt(port->serio, data, dfl);
 380
 381  out:
 382         return IRQ_RETVAL(ret);
 383 }
 384
 385 /*
 386  * i8042_enable_kbd_port enables keybaord port on chip
 387  */
 388
 389 static int i8042_enable_kbd_port(void)
 390 {
 391         i8042_ctr &= ~I8042_CTR_KBDDIS;
 392         i8042_ctr |= I8042_CTR_KBDINT;
 393
 394         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 395                 printk(KERN_ERR "i8042.c: Failed to enable KBD port.\n");
 396                 return -EIO;
 397         }
 398
 399         return 0;
 400 }
 401
 402 /*
 403  * i8042_enable_aux_port enables AUX (mouse) port on chip
 404  */
 405
 406 static int i8042_enable_aux_port(void)
 407 {
 408         i8042_ctr &= ~I8042_CTR_AUXDIS;
 409         i8042_ctr |= I8042_CTR_AUXINT;
 410
 411         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 412                 printk(KERN_ERR "i8042.c: Failed to enable AUX port.\n");
 413                 return -EIO;
 414         }
 415
 416         return 0;
 417 }
 418
 419 /*
 420  * i8042_enable_mux_ports enables 4 individual AUX ports after
 421  * the controller has been switched into Multiplexed mode
 422  */
 423
 424 static int i8042_enable_mux_ports(void)
 425 {
 426         unsigned char param;
 427         int i;
 428
 429         for (i = 0; i < I8042_NUM_MUX_PORTS; i++) {
 430                 i8042_command(&param, I8042_CMD_MUX_PFX + i);
 431                 i8042_command(&param, I8042_CMD_AUX_ENABLE);
 432         }
 433
 434         return i8042_enable_aux_port();
 435 }
 436
 437 /*
 438  * i8042_set_mux_mode checks whether the controller has an active
 439  * multiplexor and puts the chip into Multiplexed (1) or Legacy (0) mode.
 440  */
 441
 442 static int i8042_set_mux_mode(unsigned int mode, unsigned char *mux_version)
 443 {
 444
 445         unsigned char param;
 446 /*
 447  * Get rid of bytes in the queue.
 448  */
 449
 450         i8042_flush();
 451
 452 /*
 453  * Internal loopback test - send three bytes, they should come back from the
 454  * mouse interface, the last should be version.
 455  */
 456
 457         param = 0xf0;
 458         if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != 0xf0)
 459                 return -1;
 460         param = mode ? 0x56 : 0xf6;
 461         if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != (mode ? 0x56 : 0xf6))
 462                 return -1;
 463         param = mode ? 0xa4 : 0xa5;
 464         if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param == (mode ? 0xa4 : 0xa5))
 465                 return -1;
 466
 467         if (mux_version)
 468                 *mux_version = param;
 469
 470         return 0;
 471 }
 472
 473 /*
 474  * i8042_check_mux() checks whether the controller supports the PS/2 Active
 475  * Multiplexing specification by Synaptics, Phoenix, Insyde and
 476  * LCS/Telegraphics.
 477  */
 478
 479 static int __devinit i8042_check_mux(void)
 480 {
 481         unsigned char mux_version;
 482
 483         if (i8042_set_mux_mode(1, &mux_version))
 484                 return -1;
 485
 486 /*
 487  * Workaround for interference with USB Legacy emulation
 488  * that causes a v10.12 MUX to be found.
 489  */
 490         if (mux_version == 0xAC)
 491                 return -1;
 492
 493         printk(KERN_INFO "i8042.c: Detected active multiplexing controller, rev %d.%d.\n",
 494                 (mux_version >> 4) & 0xf, mux_version & 0xf);
 495
 496 /*
 497  * Disable all muxed ports by disabling AUX.
 498  */
 499         i8042_ctr |= I8042_CTR_AUXDIS;
 500         i8042_ctr &= ~I8042_CTR_AUXINT;
 501
 502         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 503                 printk(KERN_ERR "i8042.c: Failed to disable AUX port, can't use MUX.\n");
 504                 return -EIO;
 505         }
 506
 507         i8042_mux_present = 1;
 508
 509         return 0;
 510 }
 511
 512 /*
 513  * The following is used to test AUX IRQ delivery.
 514  */
 515 static struct completion i8042_aux_irq_delivered __devinitdata;
 516 static int i8042_irq_being_tested __devinitdata;
 517
 518 static irqreturn_t __devinit i8042_aux_test_irq(int irq, void *dev_id)
 519 {
 520         unsigned long flags;
 521         unsigned char str, data;
 522
 523         spin_lock_irqsave(&i8042_lock, flags);
 524         str = i8042_read_status();
 525         if (str & I8042_STR_OBF) {
 526                 data = i8042_read_data();
 527                 if (i8042_irq_being_tested &&
 528                     data == 0xa5 && (str & I8042_STR_AUXDATA))
 529                         complete(&i8042_aux_irq_delivered);
 530         }
 531         spin_unlock_irqrestore(&i8042_lock, flags);
 532
 533         return IRQ_HANDLED;
 534 }
 535
 536
 537 /*
 538  * i8042_check_aux() applies as much paranoia as it can at detecting
 539  * the presence of an AUX interface.
 540  */
 541
 542 static int __devinit i8042_check_aux(void)
 543 {
 544         int retval = -1;
 545         int irq_registered = 0;
 546         int aux_loop_broken = 0;
 547         unsigned long flags;
 548         unsigned char param;
 549
 550 /*
 551  * Get rid of bytes in the queue.
 552  */
 553
 554         i8042_flush();
 555
 556 /*
 557  * Internal loopback test - filters out AT-type i8042's. Unfortunately
 558  * SiS screwed up and their 5597 doesn't support the LOOP command even
 559  * though it has an AUX port.
 560  */
 561
 562         param = 0x5a;
 563         retval = i8042_command(&param, I8042_CMD_AUX_LOOP);
 564         if (retval || param != 0x5a) {
 565
 566 /*
 567  * External connection test - filters out AT-soldered PS/2 i8042's
 568  * 0x00 - no error, 0x01-0x03 - clock/data stuck, 0xff - general error
 569  * 0xfa - no error on some notebooks which ignore the spec
 570  * Because it's common for chipsets to return error on perfectly functioning
 571  * AUX ports, we test for this only when the LOOP command failed.
 572  */
 573
 574                 if (i8042_command(&param, I8042_CMD_AUX_TEST) ||
 575                     (param && param != 0xfa && param != 0xff))
 576                         return -1;
 577
 578 /*
 579  * If AUX_LOOP completed without error but returned unexpected data
 580  * mark it as broken
 581  */
 582                 if (!retval)
 583                         aux_loop_broken = 1;
 584         }
 585
 586 /*
 587  * Bit assignment test - filters out PS/2 i8042's in AT mode
 588  */
 589
 590         if (i8042_command(&param, I8042_CMD_AUX_DISABLE))
 591                 return -1;
 592         if (i8042_command(&param, I8042_CMD_CTL_RCTR) || (~param & I8042_CTR_AUXDIS)) {
 593                 printk(KERN_WARNING "Failed to disable AUX port, but continuing anyway... Is this a SiS?\n");
 594                 printk(KERN_WARNING "If AUX port is really absent please use the 'i8042.noaux' option.\n");
 595         }
 596
 597         if (i8042_command(&param, I8042_CMD_AUX_ENABLE))
 598                 return -1;
 599         if (i8042_command(&param, I8042_CMD_CTL_RCTR) || (param & I8042_CTR_AUXDIS))
 600                 return -1;
 601
 602 /*
 603  * Test AUX IRQ delivery to make sure BIOS did not grab the IRQ and
 604  * used it for a PCI card or somethig else.
 605  */
 606
 607         if (i8042_noloop || aux_loop_broken) {
 608 /*
 609  * Without LOOP command we can't test AUX IRQ delivery. Assume the port
 610  * is working and hope we are right.
 611  */
 612                 retval = 0;
 613                 goto out;
 614         }
 615
 616         if (request_irq(I8042_AUX_IRQ, i8042_aux_test_irq, IRQF_SHARED,
 617                         "i8042", i8042_platform_device))
 618                 goto out;
 619
 620         irq_registered = 1;
 621
 622         if (i8042_enable_aux_port())
 623                 goto out;
 624
 625         spin_lock_irqsave(&i8042_lock, flags);
 626
 627         init_completion(&i8042_aux_irq_delivered);
 628         i8042_irq_being_tested = 1;
 629
 630         param = 0xa5;
 631         retval = __i8042_command(&param, I8042_CMD_AUX_LOOP & 0xf0ff);
 632
 633         spin_unlock_irqrestore(&i8042_lock, flags);
 634
 635         if (retval)
 636                 goto out;
 637
 638         if (wait_for_completion_timeout(&i8042_aux_irq_delivered,
 639                                         msecs_to_jiffies(250)) == 0) {
 640 /*
 641  * AUX IRQ was never delivered so we need to flush the controller to
 642  * get rid of the byte we put there; otherwise keyboard may not work.
 643  */
 644                 i8042_flush();
 645                 retval = -1;
 646         }
 647
 648  out:
 649
 650 /*
 651  * Disable the interface.
 652  */
 653
 654         i8042_ctr |= I8042_CTR_AUXDIS;
 655         i8042_ctr &= ~I8042_CTR_AUXINT;
 656
 657         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
 658                 retval = -1;
 659
 660         if (irq_registered)
 661                 free_irq(I8042_AUX_IRQ, i8042_platform_device);
 662
 663         return retval;
 664 }
 665
 666 static int i8042_controller_check(void)
 667 {
 668         if (i8042_flush() == I8042_BUFFER_SIZE) {
 669                 printk(KERN_ERR "i8042.c: No controller found.\n");
 670                 return -ENODEV;
 671         }
 672
 673         return 0;
 674 }
 675
 676 static int i8042_controller_selftest(void)
 677 {
 678         unsigned char param;
 679
 680         if (!i8042_reset)
 681                 return 0;
 682
 683         if (i8042_command(&param, I8042_CMD_CTL_TEST)) {
 684                 printk(KERN_ERR "i8042.c: i8042 controller self test timeout.\n");
 685                 return -ENODEV;
 686         }
 687
 688         if (param != I8042_RET_CTL_TEST) {
 689                 printk(KERN_ERR "i8042.c: i8042 controller selftest failed. (%#x != %#x)\n",
 690                          param, I8042_RET_CTL_TEST);
 691                 return -EIO;
 692         }
 693
 694         return 0;
 695 }
 696
 697 /*
 698  * i8042_controller init initializes the i8042 controller, and,
 699  * most importantly, sets it into non-xlated mode if that's
 700  * desired.
 701  */
 702
 703 static int i8042_controller_init(void)
 704 {
 705         unsigned long flags;
 706
 707 /*
 708  * Save the CTR for restoral on unload / reboot.
 709  */
 710
 711         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_RCTR)) {
 712                 printk(KERN_ERR "i8042.c: Can't read CTR while initializing i8042.\n");
 713                 return -EIO;
 714         }
 715
 716         i8042_initial_ctr = i8042_ctr;
 717
 718 /*
 719  * Disable the keyboard interface and interrupt.
 720  */
 721
 722         i8042_ctr |= I8042_CTR_KBDDIS;
 723         i8042_ctr &= ~I8042_CTR_KBDINT;
 724
 725 /*
 726  * Handle keylock.
 727  */
 728
 729         spin_lock_irqsave(&i8042_lock, flags);
 730         if (~i8042_read_status() & I8042_STR_KEYLOCK) {
 731                 if (i8042_unlock)
 732                         i8042_ctr |= I8042_CTR_IGNKEYLOCK;
 733                  else
 734                         printk(KERN_WARNING "i8042.c: Warning: Keylock active.\n");
 735         }
 736         spin_unlock_irqrestore(&i8042_lock, flags);
 737
 738 /*
 739  * If the chip is configured into nontranslated mode by the BIOS, don't
 740  * bother enabling translating and be happy.
 741  */
 742
 743         if (~i8042_ctr & I8042_CTR_XLATE)
 744                 i8042_direct = 1;
 745
 746 /*
 747  * Set nontranslated mode for the kbd interface if requested by an option.
 748  * After this the kbd interface becomes a simple serial in/out, like the aux
 749  * interface is. We don't do this by default, since it can confuse notebook
 750  * BIOSes.
 751  */
 752
 753         if (i8042_direct)
 754                 i8042_ctr &= ~I8042_CTR_XLATE;
 755
 756 /*
 757  * Write CTR back.
 758  */
 759
 760         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 761                 printk(KERN_ERR "i8042.c: Can't write CTR while initializing i8042.\n");
 762                 return -EIO;
 763         }
 764
 765         return 0;
 766 }
 767
 768
 769 /*
 770  * Reset the controller and reset CRT to the original value set by BIOS.
 771  */
 772
 773 static void i8042_controller_reset(void)
 774 {
 775         i8042_flush();
 776
 777 /*
 778  * Disable MUX mode if present.
 779  */
 780
 781         if (i8042_mux_present)
 782                 i8042_set_mux_mode(0, NULL);
 783
 784 /*
 785  * Reset the controller if requested.
 786  */
 787
 788         i8042_controller_selftest();
 789
 790 /*
 791  * Restore the original control register setting.
 792  */
 793
 794         if (i8042_command(&i8042_initial_ctr, I8042_CMD_CTL_WCTR))
 795                 printk(KERN_WARNING "i8042.c: Can't restore CTR.\n");
 796 }
 797
 798
 799 /*
 800  * Here we try to reset everything back to a state in which the BIOS will be
 801  * able to talk to the hardware when rebooting.
 802  */
 803
 804 static void i8042_controller_cleanup(void)
 805 {
 806         int i;
 807
 808 /*
 809  * Reset anything that is connected to the ports.
 810  */
 811
 812         for (i = 0; i < I8042_NUM_PORTS; i++)
 813                 if (i8042_ports[i].serio)
 814                         serio_cleanup(i8042_ports[i].serio);
 815
 816         i8042_controller_reset();
 817 }
 818
 819
 820 /*
 821  * i8042_panic_blink() will flash the keyboard LEDs and is called when
 822  * kernel panics. Flashing LEDs is useful for users running X who may
 823  * not see the console and will help distingushing panics from "real"
 824  * lockups.
 825  *
 826  * Note that DELAY has a limit of 10ms so we will not get stuck here
 827  * waiting for KBC to free up even if KBD interrupt is off
 828  */
 829
 830 #define DELAY do { mdelay(1); if (++delay > 10) return delay; } while(0)
 831
 832 static long i8042_panic_blink(long count)
 833 {
 834         long delay = 0;
 835         static long last_blink;
 836         static char led;
 837
 838         /*
 839          * We expect frequency to be about 1/2s. KDB uses about 1s.
 840          * Make sure they are different.
 841          */
 842         if (!i8042_blink_frequency)
 843                 return 0;
 844         if (count - last_blink < i8042_blink_frequency)
 845                 return 0;
 846
 847         led ^= 0x01 | 0x04;
 848         while (i8042_read_status() & I8042_STR_IBF)
 849                 DELAY;
 850         dbg("%02x -> i8042 (panic blink)", 0xed);
 851         i8042_suppress_kbd_ack = 2;
 852         i8042_write_data(0xed); /* set leds */
 853         DELAY;
 854         while (i8042_read_status() & I8042_STR_IBF)
 855                 DELAY;
 856         DELAY;
 857         dbg("%02x -> i8042 (panic blink)", led);
 858         i8042_write_data(led);
 859         DELAY;
 860         last_blink = count;
 861         return delay;
 862 }
 863
 864 #undef DELAY
 865
 866 /*
 867  * Here we try to restore the original BIOS settings
 868  */
 869
 870 static int i8042_suspend(struct platform_device *dev, pm_message_t state)
 871 {
 872         i8042_controller_cleanup();
 873
 874         return 0;
 875 }
 876
 877
 878 /*
 879  * Here we try to reset everything back to a state in which suspended
 880  */
 881
 882 static int i8042_resume(struct platform_device *dev)
 883 {
 884         int error;
 885
 886         error = i8042_controller_check();
 887         if (error)
 888                 return error;
 889
 890         error = i8042_controller_selftest();
 891         if (error)
 892                 return error;
 893
 894 /*
 895  * Restore pre-resume CTR value and disable all ports
 896  */
 897
 898         i8042_ctr |= I8042_CTR_AUXDIS | I8042_CTR_KBDDIS;
 899         i8042_ctr &= ~(I8042_CTR_AUXINT | I8042_CTR_KBDINT);
 900         if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
 901                 printk(KERN_ERR "i8042: Can't write CTR to resume\n");
 902                 return -EIO;
 903         }
 904
 905         if (i8042_mux_present) {
 906                 if (i8042_set_mux_mode(1, NULL) || i8042_enable_mux_ports())
 907                         printk(KERN_WARNING
 908                                 "i8042: failed to resume active multiplexor, "
 909                                 "mouse won't work.\n");
 910         } else if (i8042_ports[I8042_AUX_PORT_NO].serio)
 911                 i8042_enable_aux_port();
 912
 913         if (i8042_ports[I8042_KBD_PORT_NO].serio)
 914                 i8042_enable_kbd_port();
 915
 916         i8042_interrupt(0, NULL);
 917
 918         return 0;
 919 }
 920
 921 /*
 922  * We need to reset the 8042 back to original mode on system shutdown,
 923  * because otherwise BIOSes will be confused.
 924  */
 925
 926 static void i8042_shutdown(struct platform_device *dev)
 927 {
 928         i8042_controller_cleanup();
 929 }
 930
 931 static int __devinit i8042_create_kbd_port(void)
 932 {
 933         struct serio *serio;
 934         struct i8042_port *port = &i8042_ports[I8042_KBD_PORT_NO];
 935
 936         serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
 937         if (!serio)
 938                 return -ENOMEM;
 939
 940         serio->id.type          = i8042_direct ? SERIO_8042 : SERIO_8042_XL;
 941         serio->write            = i8042_dumbkbd ? NULL : i8042_kbd_write;
 942         serio->start            = i8042_start;
 943         serio->stop             = i8042_stop;
 944         serio->port_data        = port;
 945         serio->dev.parent       = &i8042_platform_device->dev;
 946         strlcpy(serio->name, "i8042 KBD port", sizeof(serio->name));
 947         strlcpy(serio->phys, I8042_KBD_PHYS_DESC, sizeof(serio->phys));
 948
 949         port->serio = serio;
 950         port->irq = I8042_KBD_IRQ;
 951
 952         return 0;
 953 }
 954
 955 static int __devinit i8042_create_aux_port(int idx)
 956 {
 957         struct serio *serio;
 958         int port_no = idx < 0 ? I8042_AUX_PORT_NO : I8042_MUX_PORT_NO + idx;
 959         struct i8042_port *port = &i8042_ports[port_no];
 960
 961         serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
 962         if (!serio)
 963                 return -ENOMEM;
 964
 965         serio->id.type          = SERIO_8042;
 966         serio->write            = i8042_aux_write;
 967         serio->start            = i8042_start;
 968         serio->stop             = i8042_stop;
 969         serio->port_data        = port;
 970         serio->dev.parent       = &i8042_platform_device->dev;
 971         if (idx < 0) {
 972                 strlcpy(serio->name, "i8042 AUX port", sizeof(serio->name));
 973                 strlcpy(serio->phys, I8042_AUX_PHYS_DESC, sizeof(serio->phys));
 974         } else {
 975                 snprintf(serio->name, sizeof(serio->name), "i8042 AUX%d port", idx);
 976                 snprintf(serio->phys, sizeof(serio->phys), I8042_MUX_PHYS_DESC, idx + 1);
 977         }
 978
 979         port->serio = serio;
 980         port->mux = idx;
 981         port->irq = I8042_AUX_IRQ;
 982
 983         return 0;
 984 }
 985
 986 static void __devinit i8042_free_kbd_port(void)
 987 {
 988         kfree(i8042_ports[I8042_KBD_PORT_NO].serio);
 989         i8042_ports[I8042_KBD_PORT_NO].serio = NULL;
 990 }
 991
 992 static void __devinit i8042_free_aux_ports(void)
 993 {
 994         int i;
 995
 996         for (i = I8042_AUX_PORT_NO; i < I8042_NUM_PORTS; i++) {
 997                 kfree(i8042_ports[i].serio);
 998                 i8042_ports[i].serio = NULL;
 999         }
1000 }
1001
1002 static void __devinit i8042_register_ports(void)
1003 {
1004         int i;
1005
1006         for (i = 0; i < I8042_NUM_PORTS; i++) {
1007                 if (i8042_ports[i].serio) {
1008                         printk(KERN_INFO "serio: %s at %#lx,%#lx irq %d\n",
1009                                 i8042_ports[i].serio->name,
1010                                 (unsigned long) I8042_DATA_REG,
1011                                 (unsigned long) I8042_COMMAND_REG,
1012                                 i8042_ports[i].irq);
1013                         serio_register_port(i8042_ports[i].serio);
1014                 }
1015         }
1016 }
1017
1018 static void __devinit i8042_unregister_ports(void)
1019 {
1020         int i;
1021
1022         for (i = 0; i < I8042_NUM_PORTS; i++) {
1023                 if (i8042_ports[i].serio) {
1024                         serio_unregister_port(i8042_ports[i].serio);
1025                         i8042_ports[i].serio = NULL;
1026                 }
1027         }
1028 }
1029
1030 static void i8042_free_irqs(void)
1031 {
1032         if (i8042_aux_irq_registered)
1033                 free_irq(I8042_AUX_IRQ, i8042_platform_device);
1034         if (i8042_kbd_irq_registered)
1035                 free_irq(I8042_KBD_IRQ, i8042_platform_device);
1036
1037         i8042_aux_irq_registered = i8042_kbd_irq_registered = 0;
1038 }
1039
1040 static int __devinit i8042_setup_aux(void)
1041 {
1042         int (*aux_enable)(void);
1043         int error;
1044         int i;
1045
1046         if (i8042_check_aux())
1047                 return -ENODEV;
1048
1049         if (i8042_nomux || i8042_check_mux()) {
1050                 error = i8042_create_aux_port(-1);
1051                 if (error)
1052                         goto err_free_ports;
1053                 aux_enable = i8042_enable_aux_port;
1054         } else {
1055                 for (i = 0; i < I8042_NUM_MUX_PORTS; i++) {
1056                         error = i8042_create_aux_port(i);
1057                         if (error)
1058                                 goto err_free_ports;
1059                 }
1060                 aux_enable = i8042_enable_mux_ports;
1061         }
1062
1063         error = request_irq(I8042_AUX_IRQ, i8042_interrupt, IRQF_SHARED,
1064                             "i8042", i8042_platform_device);
1065         if (error)
1066                 goto err_free_ports;
1067
1068         if (aux_enable())
1069                 goto err_free_irq;
1070
1071         i8042_aux_irq_registered = 1;
1072         return 0;
1073
1074  err_free_irq:
1075         free_irq(I8042_AUX_IRQ, i8042_platform_device);
1076  err_free_ports:
1077         i8042_free_aux_ports();
1078         return error;
1079 }
1080
1081 static int __devinit i8042_setup_kbd(void)
1082 {
1083         int error;
1084
1085         error = i8042_create_kbd_port();
1086         if (error)
1087                 return error;
1088
1089         error = request_irq(I8042_KBD_IRQ, i8042_interrupt, IRQF_SHARED,
1090                             "i8042", i8042_platform_device);
1091         if (error)
1092                 goto err_free_port;
1093
1094         error = i8042_enable_kbd_port();
1095         if (error)
1096                 goto err_free_irq;
1097
1098         i8042_kbd_irq_registered = 1;
1099         return 0;
1100
1101  err_free_irq:
1102         free_irq(I8042_KBD_IRQ, i8042_platform_device);
1103  err_free_port:
1104         i8042_free_kbd_port();
1105         return error;
1106 }
1107
1108 static int __devinit i8042_probe(struct platform_device *dev)
1109 {
1110         int error;
1111
1112         error = i8042_controller_selftest();
1113         if (error)
1114                 return error;
1115
1116         error = i8042_controller_init();
1117         if (error)
1118                 return error;
1119
1120         if (!i8042_noaux) {
1121                 error = i8042_setup_aux();
1122                 if (error && error != -ENODEV && error != -EBUSY)
1123                         goto out_fail;
1124         }
1125
1126         if (!i8042_nokbd) {
1127                 error = i8042_setup_kbd();
1128                 if (error)
1129                         goto out_fail;
1130         }
1131
1132 /*
1133  * Ok, everything is ready, let's register all serio ports
1134  */
1135         i8042_register_ports();
1136
1137         return 0;
1138
1139  out_fail:
1140         i8042_free_aux_ports(); /* in case KBD failed but AUX not */
1141         i8042_free_irqs();
1142         i8042_controller_reset();
1143
1144         return error;
1145 }
1146
1147 static int __devexit i8042_remove(struct platform_device *dev)
1148 {
1149         i8042_unregister_ports();
1150         i8042_free_irqs();
1151         i8042_controller_reset();
1152
1153         return 0;
1154 }
1155
1156 static struct platform_driver i8042_driver = {
1157         .driver         = {
1158                 .name   = "i8042",
1159                 .owner  = THIS_MODULE,
1160         },
1161         .probe          = i8042_probe,
1162         .remove         = __devexit_p(i8042_remove),
1163         .suspend        = i8042_suspend,
1164         .resume         = i8042_resume,
1165         .shutdown       = i8042_shutdown,
1166 };
1167
1168 static int __init i8042_init(void)
1169 {
1170         int err;
1171
1172         dbg_init();
1173
1174         err = i8042_platform_init();
1175         if (err)
1176                 return err;
1177
1178         err = i8042_controller_check();
1179         if (err)
1180                 goto err_platform_exit;
1181
1182         err = platform_driver_register(&i8042_driver);
1183         if (err)
1184                 goto err_platform_exit;
1185
1186         i8042_platform_device = platform_device_alloc("i8042", -1);
1187         if (!i8042_platform_device) {
1188                 err = -ENOMEM;
1189                 goto err_unregister_driver;
1190         }
1191
1192         err = platform_device_add(i8042_platform_device);
1193         if (err)
1194                 goto err_free_device;
1195
1196         panic_blink = i8042_panic_blink;
1197
1198         return 0;
1199
1200  err_free_device:
1201         platform_device_put(i8042_platform_device);
1202  err_unregister_driver:
1203         platform_driver_unregister(&i8042_driver);
1204  err_platform_exit:
1205         i8042_platform_exit();
1206
1207         return err;
1208 }
1209
1210 static void __exit i8042_exit(void)
1211 {
1212         platform_device_unregister(i8042_platform_device);
1213         platform_driver_unregister(&i8042_driver);
1214         i8042_platform_exit();
1215
1216         panic_blink = NULL;
1217 }
1218
1219 module_init(i8042_init);
1220 module_exit(i8042_exit);