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