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