2 * i8042 keyboard and mouse controller driver for Linux
4 * Copyright (c) 1999-2004 Vojtech Pavlik
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.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
30 MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");
31 MODULE_DESCRIPTION("i8042 keyboard and mouse controller driver");
32 MODULE_LICENSE("GPL");
34 static bool i8042_nokbd;
35 module_param_named(nokbd, i8042_nokbd, bool, 0);
36 MODULE_PARM_DESC(nokbd, "Do not probe or use KBD port.");
38 static bool i8042_noaux;
39 module_param_named(noaux, i8042_noaux, bool, 0);
40 MODULE_PARM_DESC(noaux, "Do not probe or use AUX (mouse) port.");
42 static bool i8042_nomux;
43 module_param_named(nomux, i8042_nomux, bool, 0);
44 MODULE_PARM_DESC(nomux, "Do not check whether an active multiplexing controller is present.");
46 static bool i8042_unlock;
47 module_param_named(unlock, i8042_unlock, bool, 0);
48 MODULE_PARM_DESC(unlock, "Ignore keyboard lock.");
50 static bool i8042_reset;
51 module_param_named(reset, i8042_reset, bool, 0);
52 MODULE_PARM_DESC(reset, "Reset controller during init and cleanup.");
54 static bool i8042_direct;
55 module_param_named(direct, i8042_direct, bool, 0);
56 MODULE_PARM_DESC(direct, "Put keyboard port into non-translated mode.");
58 static bool i8042_dumbkbd;
59 module_param_named(dumbkbd, i8042_dumbkbd, bool, 0);
60 MODULE_PARM_DESC(dumbkbd, "Pretend that controller can only read data from keyboard");
62 static bool i8042_noloop;
63 module_param_named(noloop, i8042_noloop, bool, 0);
64 MODULE_PARM_DESC(noloop, "Disable the AUX Loopback command while probing for the AUX port");
66 static bool i8042_notimeout;
67 module_param_named(notimeout, i8042_notimeout, bool, 0);
68 MODULE_PARM_DESC(notimeout, "Ignore timeouts signalled by i8042");
71 static bool i8042_dritek;
72 module_param_named(dritek, i8042_dritek, bool, 0);
73 MODULE_PARM_DESC(dritek, "Force enable the Dritek keyboard extension");
77 static bool i8042_nopnp;
78 module_param_named(nopnp, i8042_nopnp, bool, 0);
79 MODULE_PARM_DESC(nopnp, "Do not use PNP to detect controller settings");
84 static bool i8042_debug;
85 module_param_named(debug, i8042_debug, bool, 0600);
86 MODULE_PARM_DESC(debug, "Turn i8042 debugging mode on and off");
89 static bool i8042_bypass_aux_irq_test;
94 * i8042_lock protects serialization between i8042_command and
95 * the interrupt handler.
97 static DEFINE_SPINLOCK(i8042_lock);
100 * Writers to AUX and KBD ports as well as users issuing i8042_command
101 * directly should acquire i8042_mutex (by means of calling
102 * i8042_lock_chip() and i8042_unlock_ship() helpers) to ensure that
103 * they do not disturb each other (unfortunately in many i8042
104 * implementations write to one of the ports will immediately abort
105 * command that is being processed by another port).
107 static DEFINE_MUTEX(i8042_mutex);
116 #define I8042_KBD_PORT_NO 0
117 #define I8042_AUX_PORT_NO 1
118 #define I8042_MUX_PORT_NO 2
119 #define I8042_NUM_PORTS (I8042_NUM_MUX_PORTS + 2)
121 static struct i8042_port i8042_ports[I8042_NUM_PORTS];
123 static unsigned char i8042_initial_ctr;
124 static unsigned char i8042_ctr;
125 static bool i8042_mux_present;
126 static bool i8042_kbd_irq_registered;
127 static bool i8042_aux_irq_registered;
128 static unsigned char i8042_suppress_kbd_ack;
129 static struct platform_device *i8042_platform_device;
131 static irqreturn_t i8042_interrupt(int irq, void *dev_id);
132 static bool (*i8042_platform_filter)(unsigned char data, unsigned char str,
133 struct serio *serio);
135 void i8042_lock_chip(void)
137 mutex_lock(&i8042_mutex);
139 EXPORT_SYMBOL(i8042_lock_chip);
141 void i8042_unlock_chip(void)
143 mutex_unlock(&i8042_mutex);
145 EXPORT_SYMBOL(i8042_unlock_chip);
147 int i8042_install_filter(bool (*filter)(unsigned char data, unsigned char str,
148 struct serio *serio))
153 spin_lock_irqsave(&i8042_lock, flags);
155 if (i8042_platform_filter) {
160 i8042_platform_filter = filter;
163 spin_unlock_irqrestore(&i8042_lock, flags);
166 EXPORT_SYMBOL(i8042_install_filter);
168 int i8042_remove_filter(bool (*filter)(unsigned char data, unsigned char str,
174 spin_lock_irqsave(&i8042_lock, flags);
176 if (i8042_platform_filter != filter) {
181 i8042_platform_filter = NULL;
184 spin_unlock_irqrestore(&i8042_lock, flags);
187 EXPORT_SYMBOL(i8042_remove_filter);
190 * The i8042_wait_read() and i8042_wait_write functions wait for the i8042 to
191 * be ready for reading values from it / writing values to it.
192 * Called always with i8042_lock held.
195 static int i8042_wait_read(void)
199 while ((~i8042_read_status() & I8042_STR_OBF) && (i < I8042_CTL_TIMEOUT)) {
203 return -(i == I8042_CTL_TIMEOUT);
206 static int i8042_wait_write(void)
210 while ((i8042_read_status() & I8042_STR_IBF) && (i < I8042_CTL_TIMEOUT)) {
214 return -(i == I8042_CTL_TIMEOUT);
218 * i8042_flush() flushes all data that may be in the keyboard and mouse buffers
219 * of the i8042 down the toilet.
222 static int i8042_flush(void)
225 unsigned char data, str;
229 spin_lock_irqsave(&i8042_lock, flags);
231 while ((str = i8042_read_status()) & I8042_STR_OBF) {
232 if (count++ < I8042_BUFFER_SIZE) {
234 data = i8042_read_data();
235 dbg("%02x <- i8042 (flush, %s)\n",
236 data, str & I8042_STR_AUXDATA ? "aux" : "kbd");
243 spin_unlock_irqrestore(&i8042_lock, flags);
249 * i8042_command() executes a command on the i8042. It also sends the input
250 * parameter(s) of the commands to it, and receives the output value(s). The
251 * parameters are to be stored in the param array, and the output is placed
252 * into the same array. The number of the parameters and output values is
253 * encoded in bits 8-11 of the command number.
256 static int __i8042_command(unsigned char *param, int command)
260 if (i8042_noloop && command == I8042_CMD_AUX_LOOP)
263 error = i8042_wait_write();
267 dbg("%02x -> i8042 (command)\n", command & 0xff);
268 i8042_write_command(command & 0xff);
270 for (i = 0; i < ((command >> 12) & 0xf); i++) {
271 error = i8042_wait_write();
274 dbg("%02x -> i8042 (parameter)\n", param[i]);
275 i8042_write_data(param[i]);
278 for (i = 0; i < ((command >> 8) & 0xf); i++) {
279 error = i8042_wait_read();
281 dbg(" -- i8042 (timeout)\n");
285 if (command == I8042_CMD_AUX_LOOP &&
286 !(i8042_read_status() & I8042_STR_AUXDATA)) {
287 dbg(" -- i8042 (auxerr)\n");
291 param[i] = i8042_read_data();
292 dbg("%02x <- i8042 (return)\n", param[i]);
298 int i8042_command(unsigned char *param, int command)
303 spin_lock_irqsave(&i8042_lock, flags);
304 retval = __i8042_command(param, command);
305 spin_unlock_irqrestore(&i8042_lock, flags);
309 EXPORT_SYMBOL(i8042_command);
312 * i8042_kbd_write() sends a byte out through the keyboard interface.
315 static int i8042_kbd_write(struct serio *port, unsigned char c)
320 spin_lock_irqsave(&i8042_lock, flags);
322 if (!(retval = i8042_wait_write())) {
323 dbg("%02x -> i8042 (kbd-data)\n", c);
327 spin_unlock_irqrestore(&i8042_lock, flags);
333 * i8042_aux_write() sends a byte out through the aux interface.
336 static int i8042_aux_write(struct serio *serio, unsigned char c)
338 struct i8042_port *port = serio->port_data;
340 return i8042_command(&c, port->mux == -1 ?
342 I8042_CMD_MUX_SEND + port->mux);
347 * i8042_aux_close attempts to clear AUX or KBD port state by disabling
348 * and then re-enabling it.
351 static void i8042_port_close(struct serio *serio)
355 const char *port_name;
357 if (serio == i8042_ports[I8042_AUX_PORT_NO].serio) {
358 irq_bit = I8042_CTR_AUXINT;
359 disable_bit = I8042_CTR_AUXDIS;
362 irq_bit = I8042_CTR_KBDINT;
363 disable_bit = I8042_CTR_KBDDIS;
367 i8042_ctr &= ~irq_bit;
368 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
369 pr_warn("Can't write CTR while closing %s port\n", port_name);
373 i8042_ctr &= ~disable_bit;
374 i8042_ctr |= irq_bit;
375 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
376 pr_err("Can't reactivate %s port\n", port_name);
379 * See if there is any data appeared while we were messing with
382 i8042_interrupt(0, NULL);
386 * i8042_start() is called by serio core when port is about to finish
387 * registering. It will mark port as existing so i8042_interrupt can
388 * start sending data through it.
390 static int i8042_start(struct serio *serio)
392 struct i8042_port *port = serio->port_data;
400 * i8042_stop() marks serio port as non-existing so i8042_interrupt
401 * will not try to send data to the port that is about to go away.
402 * The function is called by serio core as part of unregister procedure.
404 static void i8042_stop(struct serio *serio)
406 struct i8042_port *port = serio->port_data;
408 port->exists = false;
411 * We synchronize with both AUX and KBD IRQs because there is
412 * a (very unlikely) chance that AUX IRQ is raised for KBD port
415 synchronize_irq(I8042_AUX_IRQ);
416 synchronize_irq(I8042_KBD_IRQ);
421 * i8042_filter() filters out unwanted bytes from the input data stream.
422 * It is called from i8042_interrupt and thus is running with interrupts
423 * off and i8042_lock held.
425 static bool i8042_filter(unsigned char data, unsigned char str,
428 if (unlikely(i8042_suppress_kbd_ack)) {
429 if ((~str & I8042_STR_AUXDATA) &&
430 (data == 0xfa || data == 0xfe)) {
431 i8042_suppress_kbd_ack--;
432 dbg("Extra keyboard ACK - filtered out\n");
437 if (i8042_platform_filter && i8042_platform_filter(data, str, serio)) {
438 dbg("Filtered out by platform filter\n");
446 * i8042_interrupt() is the most important function in this driver -
447 * it handles the interrupts from the i8042, and sends incoming bytes
448 * to the upper layers.
451 static irqreturn_t i8042_interrupt(int irq, void *dev_id)
453 struct i8042_port *port;
456 unsigned char str, data;
458 unsigned int port_no;
462 spin_lock_irqsave(&i8042_lock, flags);
464 str = i8042_read_status();
465 if (unlikely(~str & I8042_STR_OBF)) {
466 spin_unlock_irqrestore(&i8042_lock, flags);
468 dbg("Interrupt %d, without any data\n", irq);
473 data = i8042_read_data();
475 if (i8042_mux_present && (str & I8042_STR_AUXDATA)) {
476 static unsigned long last_transmit;
477 static unsigned char last_str;
480 if (str & I8042_STR_MUXERR) {
481 dbg("MUX error, status is %02x, data is %02x\n",
484 * When MUXERR condition is signalled the data register can only contain
485 * 0xfd, 0xfe or 0xff if implementation follows the spec. Unfortunately
486 * it is not always the case. Some KBCs also report 0xfc when there is
487 * nothing connected to the port while others sometimes get confused which
488 * port the data came from and signal error leaving the data intact. They
489 * _do not_ revert to legacy mode (actually I've never seen KBC reverting
490 * to legacy mode yet, when we see one we'll add proper handling).
491 * Anyway, we process 0xfc, 0xfd, 0xfe and 0xff as timeouts, and for the
492 * rest assume that the data came from the same serio last byte
493 * was transmitted (if transmission happened not too long ago).
498 if (time_before(jiffies, last_transmit + HZ/10)) {
502 /* fall through - report timeout */
505 case 0xfe: dfl = SERIO_TIMEOUT; data = 0xfe; break;
506 case 0xff: dfl = SERIO_PARITY; data = 0xfe; break;
510 port_no = I8042_MUX_PORT_NO + ((str >> 6) & 3);
512 last_transmit = jiffies;
515 dfl = ((str & I8042_STR_PARITY) ? SERIO_PARITY : 0) |
516 ((str & I8042_STR_TIMEOUT && !i8042_notimeout) ? SERIO_TIMEOUT : 0);
518 port_no = (str & I8042_STR_AUXDATA) ?
519 I8042_AUX_PORT_NO : I8042_KBD_PORT_NO;
522 port = &i8042_ports[port_no];
523 serio = port->exists ? port->serio : NULL;
525 dbg("%02x <- i8042 (interrupt, %d, %d%s%s)\n",
527 dfl & SERIO_PARITY ? ", bad parity" : "",
528 dfl & SERIO_TIMEOUT ? ", timeout" : "");
530 filtered = i8042_filter(data, str, serio);
532 spin_unlock_irqrestore(&i8042_lock, flags);
534 if (likely(port->exists && !filtered))
535 serio_interrupt(serio, data, dfl);
538 return IRQ_RETVAL(ret);
542 * i8042_enable_kbd_port enables keyboard port on chip
545 static int i8042_enable_kbd_port(void)
547 i8042_ctr &= ~I8042_CTR_KBDDIS;
548 i8042_ctr |= I8042_CTR_KBDINT;
550 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
551 i8042_ctr &= ~I8042_CTR_KBDINT;
552 i8042_ctr |= I8042_CTR_KBDDIS;
553 pr_err("Failed to enable KBD port\n");
561 * i8042_enable_aux_port enables AUX (mouse) port on chip
564 static int i8042_enable_aux_port(void)
566 i8042_ctr &= ~I8042_CTR_AUXDIS;
567 i8042_ctr |= I8042_CTR_AUXINT;
569 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
570 i8042_ctr &= ~I8042_CTR_AUXINT;
571 i8042_ctr |= I8042_CTR_AUXDIS;
572 pr_err("Failed to enable AUX port\n");
580 * i8042_enable_mux_ports enables 4 individual AUX ports after
581 * the controller has been switched into Multiplexed mode
584 static int i8042_enable_mux_ports(void)
589 for (i = 0; i < I8042_NUM_MUX_PORTS; i++) {
590 i8042_command(¶m, I8042_CMD_MUX_PFX + i);
591 i8042_command(¶m, I8042_CMD_AUX_ENABLE);
594 return i8042_enable_aux_port();
598 * i8042_set_mux_mode checks whether the controller has an
599 * active multiplexor and puts the chip into Multiplexed (true)
600 * or Legacy (false) mode.
603 static int i8042_set_mux_mode(bool multiplex, unsigned char *mux_version)
606 unsigned char param, val;
608 * Get rid of bytes in the queue.
614 * Internal loopback test - send three bytes, they should come back from the
615 * mouse interface, the last should be version.
619 if (i8042_command(¶m, I8042_CMD_AUX_LOOP) || param != val)
621 param = val = multiplex ? 0x56 : 0xf6;
622 if (i8042_command(¶m, I8042_CMD_AUX_LOOP) || param != val)
624 param = val = multiplex ? 0xa4 : 0xa5;
625 if (i8042_command(¶m, I8042_CMD_AUX_LOOP) || param == val)
629 * Workaround for interference with USB Legacy emulation
630 * that causes a v10.12 MUX to be found.
636 *mux_version = param;
642 * i8042_check_mux() checks whether the controller supports the PS/2 Active
643 * Multiplexing specification by Synaptics, Phoenix, Insyde and
647 static int __init i8042_check_mux(void)
649 unsigned char mux_version;
651 if (i8042_set_mux_mode(true, &mux_version))
654 pr_info("Detected active multiplexing controller, rev %d.%d\n",
655 (mux_version >> 4) & 0xf, mux_version & 0xf);
658 * Disable all muxed ports by disabling AUX.
660 i8042_ctr |= I8042_CTR_AUXDIS;
661 i8042_ctr &= ~I8042_CTR_AUXINT;
663 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
664 pr_err("Failed to disable AUX port, can't use MUX\n");
668 i8042_mux_present = true;
674 * The following is used to test AUX IRQ delivery.
676 static struct completion i8042_aux_irq_delivered __initdata;
677 static bool i8042_irq_being_tested __initdata;
679 static irqreturn_t __init i8042_aux_test_irq(int irq, void *dev_id)
682 unsigned char str, data;
685 spin_lock_irqsave(&i8042_lock, flags);
686 str = i8042_read_status();
687 if (str & I8042_STR_OBF) {
688 data = i8042_read_data();
689 dbg("%02x <- i8042 (aux_test_irq, %s)\n",
690 data, str & I8042_STR_AUXDATA ? "aux" : "kbd");
691 if (i8042_irq_being_tested &&
692 data == 0xa5 && (str & I8042_STR_AUXDATA))
693 complete(&i8042_aux_irq_delivered);
696 spin_unlock_irqrestore(&i8042_lock, flags);
698 return IRQ_RETVAL(ret);
702 * i8042_toggle_aux - enables or disables AUX port on i8042 via command and
703 * verifies success by readinng CTR. Used when testing for presence of AUX
706 static int __init i8042_toggle_aux(bool on)
711 if (i8042_command(¶m,
712 on ? I8042_CMD_AUX_ENABLE : I8042_CMD_AUX_DISABLE))
715 /* some chips need some time to set the I8042_CTR_AUXDIS bit */
716 for (i = 0; i < 100; i++) {
719 if (i8042_command(¶m, I8042_CMD_CTL_RCTR))
722 if (!(param & I8042_CTR_AUXDIS) == on)
730 * i8042_check_aux() applies as much paranoia as it can at detecting
731 * the presence of an AUX interface.
734 static int __init i8042_check_aux(void)
737 bool irq_registered = false;
738 bool aux_loop_broken = false;
743 * Get rid of bytes in the queue.
749 * Internal loopback test - filters out AT-type i8042's. Unfortunately
750 * SiS screwed up and their 5597 doesn't support the LOOP command even
751 * though it has an AUX port.
755 retval = i8042_command(¶m, I8042_CMD_AUX_LOOP);
756 if (retval || param != 0x5a) {
759 * External connection test - filters out AT-soldered PS/2 i8042's
760 * 0x00 - no error, 0x01-0x03 - clock/data stuck, 0xff - general error
761 * 0xfa - no error on some notebooks which ignore the spec
762 * Because it's common for chipsets to return error on perfectly functioning
763 * AUX ports, we test for this only when the LOOP command failed.
766 if (i8042_command(¶m, I8042_CMD_AUX_TEST) ||
767 (param && param != 0xfa && param != 0xff))
771 * If AUX_LOOP completed without error but returned unexpected data
775 aux_loop_broken = true;
779 * Bit assignment test - filters out PS/2 i8042's in AT mode
782 if (i8042_toggle_aux(false)) {
783 pr_warn("Failed to disable AUX port, but continuing anyway... Is this a SiS?\n");
784 pr_warn("If AUX port is really absent please use the 'i8042.noaux' option\n");
787 if (i8042_toggle_aux(true))
791 * Test AUX IRQ delivery to make sure BIOS did not grab the IRQ and
792 * used it for a PCI card or somethig else.
795 if (i8042_noloop || i8042_bypass_aux_irq_test || aux_loop_broken) {
797 * Without LOOP command we can't test AUX IRQ delivery. Assume the port
798 * is working and hope we are right.
804 if (request_irq(I8042_AUX_IRQ, i8042_aux_test_irq, IRQF_SHARED,
805 "i8042", i8042_platform_device))
808 irq_registered = true;
810 if (i8042_enable_aux_port())
813 spin_lock_irqsave(&i8042_lock, flags);
815 init_completion(&i8042_aux_irq_delivered);
816 i8042_irq_being_tested = true;
819 retval = __i8042_command(¶m, I8042_CMD_AUX_LOOP & 0xf0ff);
821 spin_unlock_irqrestore(&i8042_lock, flags);
826 if (wait_for_completion_timeout(&i8042_aux_irq_delivered,
827 msecs_to_jiffies(250)) == 0) {
829 * AUX IRQ was never delivered so we need to flush the controller to
830 * get rid of the byte we put there; otherwise keyboard may not work.
832 dbg(" -- i8042 (aux irq test timeout)\n");
840 * Disable the interface.
843 i8042_ctr |= I8042_CTR_AUXDIS;
844 i8042_ctr &= ~I8042_CTR_AUXINT;
846 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
850 free_irq(I8042_AUX_IRQ, i8042_platform_device);
855 static int i8042_controller_check(void)
858 pr_err("No controller found\n");
865 static int i8042_controller_selftest(void)
871 * We try this 5 times; on some really fragile systems this does not
872 * take the first time...
876 if (i8042_command(¶m, I8042_CMD_CTL_TEST)) {
877 pr_err("i8042 controller selftest timeout\n");
881 if (param == I8042_RET_CTL_TEST)
884 dbg("i8042 controller selftest: %#x != %#x\n",
885 param, I8042_RET_CTL_TEST);
891 * On x86, we don't fail entire i8042 initialization if controller
892 * reset fails in hopes that keyboard port will still be functional
893 * and user will still get a working keyboard. This is especially
894 * important on netbooks. On other arches we trust hardware more.
896 pr_info("giving up on controller selftest, continuing anyway...\n");
899 pr_err("i8042 controller selftest failed\n");
905 * i8042_controller init initializes the i8042 controller, and,
906 * most importantly, sets it into non-xlated mode if that's
910 static int i8042_controller_init(void)
914 unsigned char ctr[2];
917 * Save the CTR for restore on unload / reboot.
922 pr_err("Unable to get stable CTR read\n");
929 if (i8042_command(&ctr[n++ % 2], I8042_CMD_CTL_RCTR)) {
930 pr_err("Can't read CTR while initializing i8042\n");
934 } while (n < 2 || ctr[0] != ctr[1]);
936 i8042_initial_ctr = i8042_ctr = ctr[0];
939 * Disable the keyboard interface and interrupt.
942 i8042_ctr |= I8042_CTR_KBDDIS;
943 i8042_ctr &= ~I8042_CTR_KBDINT;
949 spin_lock_irqsave(&i8042_lock, flags);
950 if (~i8042_read_status() & I8042_STR_KEYLOCK) {
952 i8042_ctr |= I8042_CTR_IGNKEYLOCK;
954 pr_warn("Warning: Keylock active\n");
956 spin_unlock_irqrestore(&i8042_lock, flags);
959 * If the chip is configured into nontranslated mode by the BIOS, don't
960 * bother enabling translating and be happy.
963 if (~i8042_ctr & I8042_CTR_XLATE)
967 * Set nontranslated mode for the kbd interface if requested by an option.
968 * After this the kbd interface becomes a simple serial in/out, like the aux
969 * interface is. We don't do this by default, since it can confuse notebook
974 i8042_ctr &= ~I8042_CTR_XLATE;
980 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
981 pr_err("Can't write CTR while initializing i8042\n");
986 * Flush whatever accumulated while we were disabling keyboard port.
996 * Reset the controller and reset CRT to the original value set by BIOS.
999 static void i8042_controller_reset(bool force_reset)
1004 * Disable both KBD and AUX interfaces so they don't get in the way
1007 i8042_ctr |= I8042_CTR_KBDDIS | I8042_CTR_AUXDIS;
1008 i8042_ctr &= ~(I8042_CTR_KBDINT | I8042_CTR_AUXINT);
1010 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))
1011 pr_warn("Can't write CTR while resetting\n");
1014 * Disable MUX mode if present.
1017 if (i8042_mux_present)
1018 i8042_set_mux_mode(false, NULL);
1021 * Reset the controller if requested.
1024 if (i8042_reset || force_reset)
1025 i8042_controller_selftest();
1028 * Restore the original control register setting.
1031 if (i8042_command(&i8042_initial_ctr, I8042_CMD_CTL_WCTR))
1032 pr_warn("Can't restore CTR\n");
1037 * i8042_panic_blink() will turn the keyboard LEDs on or off and is called
1038 * when kernel panics. Flashing LEDs is useful for users running X who may
1039 * not see the console and will help distinguishing panics from "real"
1042 * Note that DELAY has a limit of 10ms so we will not get stuck here
1043 * waiting for KBC to free up even if KBD interrupt is off
1046 #define DELAY do { mdelay(1); if (++delay > 10) return delay; } while(0)
1048 static long i8042_panic_blink(int state)
1053 led = (state) ? 0x01 | 0x04 : 0;
1054 while (i8042_read_status() & I8042_STR_IBF)
1056 dbg("%02x -> i8042 (panic blink)\n", 0xed);
1057 i8042_suppress_kbd_ack = 2;
1058 i8042_write_data(0xed); /* set leds */
1060 while (i8042_read_status() & I8042_STR_IBF)
1063 dbg("%02x -> i8042 (panic blink)\n", led);
1064 i8042_write_data(led);
1072 static void i8042_dritek_enable(void)
1074 unsigned char param = 0x90;
1077 error = i8042_command(¶m, 0x1059);
1079 pr_warn("Failed to enable DRITEK extension: %d\n", error);
1086 * Here we try to reset everything back to a state we had
1087 * before suspending.
1090 static int i8042_controller_resume(bool force_reset)
1094 error = i8042_controller_check();
1098 if (i8042_reset || force_reset) {
1099 error = i8042_controller_selftest();
1105 * Restore original CTR value and disable all ports
1108 i8042_ctr = i8042_initial_ctr;
1110 i8042_ctr &= ~I8042_CTR_XLATE;
1111 i8042_ctr |= I8042_CTR_AUXDIS | I8042_CTR_KBDDIS;
1112 i8042_ctr &= ~(I8042_CTR_AUXINT | I8042_CTR_KBDINT);
1113 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
1114 pr_warn("Can't write CTR to resume, retrying...\n");
1116 if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {
1117 pr_err("CTR write retry failed\n");
1125 i8042_dritek_enable();
1128 if (i8042_mux_present) {
1129 if (i8042_set_mux_mode(true, NULL) || i8042_enable_mux_ports())
1130 pr_warn("failed to resume active multiplexor, mouse won't work\n");
1131 } else if (i8042_ports[I8042_AUX_PORT_NO].serio)
1132 i8042_enable_aux_port();
1134 if (i8042_ports[I8042_KBD_PORT_NO].serio)
1135 i8042_enable_kbd_port();
1137 i8042_interrupt(0, NULL);
1143 * Here we try to restore the original BIOS settings to avoid
1147 static int i8042_pm_suspend(struct device *dev)
1149 i8042_controller_reset(true);
1154 static int i8042_pm_resume(struct device *dev)
1157 * On resume from S2R we always try to reset the controller
1158 * to bring it in a sane state. (In case of S2D we expect
1159 * BIOS to reset the controller for us.)
1161 return i8042_controller_resume(true);
1164 static int i8042_pm_thaw(struct device *dev)
1166 i8042_interrupt(0, NULL);
1171 static int i8042_pm_reset(struct device *dev)
1173 i8042_controller_reset(false);
1178 static int i8042_pm_restore(struct device *dev)
1180 return i8042_controller_resume(false);
1183 static const struct dev_pm_ops i8042_pm_ops = {
1184 .suspend = i8042_pm_suspend,
1185 .resume = i8042_pm_resume,
1186 .thaw = i8042_pm_thaw,
1187 .poweroff = i8042_pm_reset,
1188 .restore = i8042_pm_restore,
1191 #endif /* CONFIG_PM */
1194 * We need to reset the 8042 back to original mode on system shutdown,
1195 * because otherwise BIOSes will be confused.
1198 static void i8042_shutdown(struct platform_device *dev)
1200 i8042_controller_reset(false);
1203 static int __init i8042_create_kbd_port(void)
1205 struct serio *serio;
1206 struct i8042_port *port = &i8042_ports[I8042_KBD_PORT_NO];
1208 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
1212 serio->id.type = i8042_direct ? SERIO_8042 : SERIO_8042_XL;
1213 serio->write = i8042_dumbkbd ? NULL : i8042_kbd_write;
1214 serio->start = i8042_start;
1215 serio->stop = i8042_stop;
1216 serio->close = i8042_port_close;
1217 serio->port_data = port;
1218 serio->dev.parent = &i8042_platform_device->dev;
1219 strlcpy(serio->name, "i8042 KBD port", sizeof(serio->name));
1220 strlcpy(serio->phys, I8042_KBD_PHYS_DESC, sizeof(serio->phys));
1222 port->serio = serio;
1223 port->irq = I8042_KBD_IRQ;
1228 static int __init i8042_create_aux_port(int idx)
1230 struct serio *serio;
1231 int port_no = idx < 0 ? I8042_AUX_PORT_NO : I8042_MUX_PORT_NO + idx;
1232 struct i8042_port *port = &i8042_ports[port_no];
1234 serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
1238 serio->id.type = SERIO_8042;
1239 serio->write = i8042_aux_write;
1240 serio->start = i8042_start;
1241 serio->stop = i8042_stop;
1242 serio->port_data = port;
1243 serio->dev.parent = &i8042_platform_device->dev;
1245 strlcpy(serio->name, "i8042 AUX port", sizeof(serio->name));
1246 strlcpy(serio->phys, I8042_AUX_PHYS_DESC, sizeof(serio->phys));
1247 serio->close = i8042_port_close;
1249 snprintf(serio->name, sizeof(serio->name), "i8042 AUX%d port", idx);
1250 snprintf(serio->phys, sizeof(serio->phys), I8042_MUX_PHYS_DESC, idx + 1);
1253 port->serio = serio;
1255 port->irq = I8042_AUX_IRQ;
1260 static void __init i8042_free_kbd_port(void)
1262 kfree(i8042_ports[I8042_KBD_PORT_NO].serio);
1263 i8042_ports[I8042_KBD_PORT_NO].serio = NULL;
1266 static void __init i8042_free_aux_ports(void)
1270 for (i = I8042_AUX_PORT_NO; i < I8042_NUM_PORTS; i++) {
1271 kfree(i8042_ports[i].serio);
1272 i8042_ports[i].serio = NULL;
1276 static void __init i8042_register_ports(void)
1280 for (i = 0; i < I8042_NUM_PORTS; i++) {
1281 if (i8042_ports[i].serio) {
1282 printk(KERN_INFO "serio: %s at %#lx,%#lx irq %d\n",
1283 i8042_ports[i].serio->name,
1284 (unsigned long) I8042_DATA_REG,
1285 (unsigned long) I8042_COMMAND_REG,
1286 i8042_ports[i].irq);
1287 serio_register_port(i8042_ports[i].serio);
1292 static void i8042_unregister_ports(void)
1296 for (i = 0; i < I8042_NUM_PORTS; i++) {
1297 if (i8042_ports[i].serio) {
1298 serio_unregister_port(i8042_ports[i].serio);
1299 i8042_ports[i].serio = NULL;
1305 * Checks whether port belongs to i8042 controller.
1307 bool i8042_check_port_owner(const struct serio *port)
1311 for (i = 0; i < I8042_NUM_PORTS; i++)
1312 if (i8042_ports[i].serio == port)
1317 EXPORT_SYMBOL(i8042_check_port_owner);
1319 static void i8042_free_irqs(void)
1321 if (i8042_aux_irq_registered)
1322 free_irq(I8042_AUX_IRQ, i8042_platform_device);
1323 if (i8042_kbd_irq_registered)
1324 free_irq(I8042_KBD_IRQ, i8042_platform_device);
1326 i8042_aux_irq_registered = i8042_kbd_irq_registered = false;
1329 static int __init i8042_setup_aux(void)
1331 int (*aux_enable)(void);
1335 if (i8042_check_aux())
1338 if (i8042_nomux || i8042_check_mux()) {
1339 error = i8042_create_aux_port(-1);
1341 goto err_free_ports;
1342 aux_enable = i8042_enable_aux_port;
1344 for (i = 0; i < I8042_NUM_MUX_PORTS; i++) {
1345 error = i8042_create_aux_port(i);
1347 goto err_free_ports;
1349 aux_enable = i8042_enable_mux_ports;
1352 error = request_irq(I8042_AUX_IRQ, i8042_interrupt, IRQF_SHARED,
1353 "i8042", i8042_platform_device);
1355 goto err_free_ports;
1360 i8042_aux_irq_registered = true;
1364 free_irq(I8042_AUX_IRQ, i8042_platform_device);
1366 i8042_free_aux_ports();
1370 static int __init i8042_setup_kbd(void)
1374 error = i8042_create_kbd_port();
1378 error = request_irq(I8042_KBD_IRQ, i8042_interrupt, IRQF_SHARED,
1379 "i8042", i8042_platform_device);
1383 error = i8042_enable_kbd_port();
1387 i8042_kbd_irq_registered = true;
1391 free_irq(I8042_KBD_IRQ, i8042_platform_device);
1393 i8042_free_kbd_port();
1397 static int __init i8042_probe(struct platform_device *dev)
1401 i8042_platform_device = dev;
1404 error = i8042_controller_selftest();
1409 error = i8042_controller_init();
1415 i8042_dritek_enable();
1419 error = i8042_setup_aux();
1420 if (error && error != -ENODEV && error != -EBUSY)
1425 error = i8042_setup_kbd();
1430 * Ok, everything is ready, let's register all serio ports
1432 i8042_register_ports();
1437 i8042_free_aux_ports(); /* in case KBD failed but AUX not */
1439 i8042_controller_reset(false);
1440 i8042_platform_device = NULL;
1445 static int i8042_remove(struct platform_device *dev)
1447 i8042_unregister_ports();
1449 i8042_controller_reset(false);
1450 i8042_platform_device = NULL;
1455 static struct platform_driver i8042_driver = {
1458 .owner = THIS_MODULE,
1460 .pm = &i8042_pm_ops,
1463 .remove = i8042_remove,
1464 .shutdown = i8042_shutdown,
1467 static int __init i8042_init(void)
1469 struct platform_device *pdev;
1474 err = i8042_platform_init();
1478 err = i8042_controller_check();
1480 goto err_platform_exit;
1482 pdev = platform_create_bundle(&i8042_driver, i8042_probe, NULL, 0, NULL, 0);
1484 err = PTR_ERR(pdev);
1485 goto err_platform_exit;
1488 panic_blink = i8042_panic_blink;
1493 i8042_platform_exit();
1497 static void __exit i8042_exit(void)
1499 platform_device_unregister(i8042_platform_device);
1500 platform_driver_unregister(&i8042_driver);
1501 i8042_platform_exit();
1506 module_init(i8042_init);
1507 module_exit(i8042_exit);