Subversion Repositories shark

/*

 *  i8042 keyboard and mouse controller driver for Linux

 *

 *  Copyright (c) 1999-2002 Vojtech Pavlik

 */

/*

 * This program is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 as published by

 * the Free Software Foundation.

 */

#include <linuxcomp.h>

#include <linux/delay.h>

#include <linux/module.h>

#include <linux/interrupt.h>

#include <linux/ioport.h>

#include <linux/config.h>

#include <linux/reboot.h>

#include <linux/init.h>

#include <linux/serio.h>

#include <asm/io.h>

MODULE_AUTHOR("Vojtech Pavlik <vojtech@suse.cz>");

MODULE_DESCRIPTION("i8042 keyboard and mouse controller driver");

MODULE_LICENSE("GPL");

MODULE_PARM(i8042_noaux, "1i");

MODULE_PARM(i8042_nomux, "1i");

MODULE_PARM(i8042_unlock, "1i");

MODULE_PARM(i8042_reset, "1i");

MODULE_PARM(i8042_direct, "1i");

MODULE_PARM(i8042_dumbkbd, "1i");

static int i8042_reset;

static int i8042_noaux;

static int i8042_nomux;

static int i8042_unlock;

static int i8042_direct;

static int i8042_dumbkbd;

#undef DEBUG

#include "i8042.h"

spinlock_t i8042_lock = SPIN_LOCK_UNLOCKED;

struct i8042_values {

        int irq;

        unsigned char disable;

        unsigned char irqen;

        unsigned char exists;

        signed char mux;

        unsigned char *name;

        unsigned char *phys;

};

static struct serio i8042_kbd_port;

static struct serio i8042_aux_port;

static unsigned char i8042_initial_ctr;

static unsigned char i8042_ctr;

static unsigned char i8042_mux_open;

struct timer_list i8042_timer;

/*

 * Shared IRQ's require a device pointer, but this driver doesn't support

 * multiple devices

 */

#define i8042_request_irq_cookie (&i8042_timer)

static irqreturn_t i8042_interrupt(int irq, void *dev_id, struct pt_regs *regs);

/*

 * The i8042_wait_read() and i8042_wait_write functions wait for the i8042 to

 * be ready for reading values from it / writing values to it.

 */

static int i8042_wait_read(void)

{

        int i = 0;

        while ((~i8042_read_status() & I8042_STR_OBF) && (i < I8042_CTL_TIMEOUT)) {

                udelay(50);

                i++;

        }

        return -(i == I8042_CTL_TIMEOUT);

}

static int i8042_wait_write(void)

{

        int i = 0;

        while ((i8042_read_status() & I8042_STR_IBF) && (i < I8042_CTL_TIMEOUT)) {

                udelay(50);

                i++;

        }

        return -(i == I8042_CTL_TIMEOUT);

}

/*

 * i8042_flush() flushes all data that may be in the keyboard and mouse buffers

 * of the i8042 down the toilet.

 */

static int i8042_flush(void)

{

        unsigned long flags;

        unsigned char data;

        int i = 0;

        spin_lock_irqsave(&i8042_lock, flags);

        while ((i8042_read_status() & I8042_STR_OBF) && (i++ < I8042_BUFFER_SIZE)) {

                data = i8042_read_data();

                dbg("%02x <- i8042 (flush, %s)", data,

                        i8042_read_status() & I8042_STR_AUXDATA ? "aux" : "kbd");

        }

        spin_unlock_irqrestore(&i8042_lock, flags);

        return i;

}

/*

 * i8042_command() executes a command on the i8042. It also sends the input

 * parameter(s) of the commands to it, and receives the output value(s). The

 * parameters are to be stored in the param array, and the output is placed

 * into the same array. The number of the parameters and output values is

 * encoded in bits 8-11 of the command number.

 */

static int i8042_command(unsigned char *param, int command)

{

        unsigned long flags;

        int retval = 0, i = 0;

        spin_lock_irqsave(&i8042_lock, flags);

        retval = i8042_wait_write();

        if (!retval) {

                dbg("%02x -> i8042 (command)", command & 0xff);

                i8042_write_command(command & 0xff);

        }

        if (!retval)

                for (i = 0; i < ((command >> 12) & 0xf); i++) {

                        if ((retval = i8042_wait_write())) break;

                        dbg("%02x -> i8042 (parameter)", param[i]);

                        i8042_write_data(param[i]);

                }

        if (!retval)

                for (i = 0; i < ((command >> 8) & 0xf); i++) {

                        if ((retval = i8042_wait_read())) break;

                        if (i8042_read_status() & I8042_STR_AUXDATA)

                                param[i] = ~i8042_read_data();

                        else

                                param[i] = i8042_read_data();

                        dbg("%02x <- i8042 (return)", param[i]);

                }

        spin_unlock_irqrestore(&i8042_lock, flags);

        if (retval)

                dbg("     -- i8042 (timeout)");

        return retval;

}

/*

 * i8042_kbd_write() sends a byte out through the keyboard interface.

 */

static int i8042_kbd_write(struct serio *port, unsigned char c)

{

        unsigned long flags;

        int retval = 0;

        spin_lock_irqsave(&i8042_lock, flags);

        if(!(retval = i8042_wait_write())) {

                dbg("%02x -> i8042 (kbd-data)", c);

                i8042_write_data(c);

        }

        spin_unlock_irqrestore(&i8042_lock, flags);

        return retval;

}

/*

 * i8042_aux_write() sends a byte out through the aux interface.

 */

static int i8042_aux_write(struct serio *port, unsigned char c)

{

        struct i8042_values *values = port->driver;

        int retval;

/*

 * Send the byte out.

 */

        if (values->mux == -1)

                retval = i8042_command(&c, I8042_CMD_AUX_SEND);

        else

                retval = i8042_command(&c, I8042_CMD_MUX_SEND + values->mux);

/*

 * Make sure the interrupt happens and the character is received even

 * in the case the IRQ isn't wired, so that we can receive further

 * characters later.

 */

        i8042_interrupt(0, NULL, NULL);

        return retval;

}

/*

 * i8042_open() is called when a port is open by the higher layer.

 * It allocates the interrupt and enables it in the chip.

 */

static int i8042_open(struct serio *port)

{

        struct i8042_values *values = port->driver;

        i8042_flush();

        if (values->mux != -1)

                if (i8042_mux_open++)

                        return 0;

        if (request_irq(values->irq, i8042_interrupt,

                        SA_SHIRQ, "i8042", i8042_request_irq_cookie)) {

                printk(KERN_ERR "i8042.c: Can't get irq %d for %s, unregistering the port.\n", values->irq, values->name);

                values->exists = 0;

                serio_unregister_port(port);

                return -1;

        }

        i8042_ctr |= values->irqen;

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {

                printk(KERN_ERR "i8042.c: Can't write CTR while opening %s.\n", values->name);

                return -1;

        }

        i8042_interrupt(0, NULL, NULL);

        return 0;

}

/*

 * i8042_close() frees the interrupt, so that it can possibly be used

 * by another driver. We never know - if the user doesn't have a mouse,

 * the BIOS could have used the AUX interrupt for PCI.

 */

static void i8042_close(struct serio *port)

{

        struct i8042_values *values = port->driver;

        if (values->mux != -1)

                if (--i8042_mux_open)

                        return;

        i8042_ctr &= ~values->irqen;

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {

                printk(KERN_ERR "i8042.c: Can't write CTR while closing %s.\n", values->name);

                return;

        }

        free_irq(values->irq, i8042_request_irq_cookie);

        i8042_flush();

}

/*

 * Structures for registering the devices in the serio.c module.

 */

static struct i8042_values i8042_kbd_values = {

        .irqen =        I8042_CTR_KBDINT,

        .disable =      I8042_CTR_KBDDIS,

        .name =         "KBD",

        .mux =          -1,

};

static struct serio i8042_kbd_port =

{

        .type =         SERIO_8042_XL,

        .write =        i8042_kbd_write,

        .open =         i8042_open,

        .close =        i8042_close,

        .driver =       &i8042_kbd_values,

        .name =         "i8042 Kbd Port",

        .phys =         I8042_KBD_PHYS_DESC,

};

static struct i8042_values i8042_aux_values = {

        .irqen =        I8042_CTR_AUXINT,

        .disable =      I8042_CTR_AUXDIS,

        .name =         "AUX",

        .mux =          -1,

};

static struct serio i8042_aux_port =

{

        .type =         SERIO_8042,

        .write =        i8042_aux_write,

        .open =         i8042_open,

        .close =        i8042_close,

        .driver =       &i8042_aux_values,

        .name =         "i8042 Aux Port",

        .phys =         I8042_AUX_PHYS_DESC,

};

static struct i8042_values i8042_mux_values[4];

static struct serio i8042_mux_port[4];

static char i8042_mux_names[4][32];

static char i8042_mux_short[4][16];

static char i8042_mux_phys[4][32];

/*

 * i8042_interrupt() is the most important function in this driver -

 * it handles the interrupts from the i8042, and sends incoming bytes

 * to the upper layers.

 */

static irqreturn_t i8042_interrupt(int irq, void *dev_id, struct pt_regs *regs)

{

        unsigned long flags;

        unsigned char str, data;

        unsigned int dfl;

        struct {

                int data;

                int str;

        } buffer[I8042_BUFFER_SIZE];

        int i, j = 0;

        spin_lock_irqsave(&i8042_lock, flags);

        while (j < I8042_BUFFER_SIZE &&

            (buffer[j].str = i8042_read_status()) & I8042_STR_OBF)

                buffer[j++].data = i8042_read_data();

        spin_unlock_irqrestore(&i8042_lock, flags);

        for (i = 0; i < j; i++) {

                str = buffer[i].str;

                data = buffer[i].data;

                dfl = ((str & I8042_STR_PARITY) ? SERIO_PARITY : 0) |

                      ((str & I8042_STR_TIMEOUT) ? SERIO_TIMEOUT : 0);

                if (i8042_mux_values[0].exists && (str & I8042_STR_AUXDATA)) {

                        if (str & I8042_STR_MUXERR) {

                                switch (data) {

                                        case 0xfd:

                                        case 0xfe: dfl = SERIO_TIMEOUT; break;

                                        case 0xff: dfl = SERIO_PARITY; break;

                                }

                                data = 0xfe;

                        } else dfl = 0;

                        dbg("%02x <- i8042 (interrupt, aux%d, %d%s%s)",

                                data, (str >> 6), irq,

                                dfl & SERIO_PARITY ? ", bad parity" : "",

                                dfl & SERIO_TIMEOUT ? ", timeout" : "");

                        serio_interrupt(i8042_mux_port + ((str >> 6) & 3), data, dfl, regs);

                        continue;

                }

                dbg("%02x <- i8042 (interrupt, %s, %d%s%s)",

                        data, (str & I8042_STR_AUXDATA) ? "aux" : "kbd", irq,

                        dfl & SERIO_PARITY ? ", bad parity" : "",

                        dfl & SERIO_TIMEOUT ? ", timeout" : "");

                if (i8042_aux_values.exists && (str & I8042_STR_AUXDATA)) {

                        serio_interrupt(&i8042_aux_port, data, dfl, regs);

                        continue;

                }

                if (!i8042_kbd_values.exists)

                        continue;

                serio_interrupt(&i8042_kbd_port, data, dfl, regs);

        }

        return IRQ_RETVAL(j);

}

/*

 * i8042_controller init initializes the i8042 controller, and,

 * most importantly, sets it into non-xlated mode if that's

 * desired.

 */

static int __init i8042_controller_init(void)

{

/*

 * Test the i8042. We need to know if it thinks it's working correctly

 * before doing anything else.

 */

        i8042_flush();

        if (i8042_reset) {

                unsigned char param;

                if (i8042_command(&param, I8042_CMD_CTL_TEST)) {

                        printk(KERN_ERR "i8042.c: i8042 controller self test timeout.\n");

                        return -1;

                }

                if (param != I8042_RET_CTL_TEST) {

                        printk(KERN_ERR "i8042.c: i8042 controller selftest failed. (%#x != %#x)\n",

                                 param, I8042_RET_CTL_TEST);

                        return -1;

                }

        }

/*

 * Save the CTR for restoral on unload / reboot.

 */

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_RCTR)) {

                printk(KERN_ERR "i8042.c: Can't read CTR while initializing i8042.\n");

                return -1;

        }

        i8042_initial_ctr = i8042_ctr;

/*

 * Disable the keyboard interface and interrupt.

 */

        i8042_ctr |= I8042_CTR_KBDDIS;

        i8042_ctr &= ~I8042_CTR_KBDINT;

/*

 * Handle keylock.

 */

        if (~i8042_read_status() & I8042_STR_KEYLOCK) {

                if (i8042_unlock)

                        i8042_ctr |= I8042_CTR_IGNKEYLOCK;

                 else

                        printk(KERN_WARNING "i8042.c: Warning: Keylock active.\n");

        }

/*

 * If the chip is configured into nontranslated mode by the BIOS, don't

 * bother enabling translating and be happy.

 */

        if (~i8042_ctr & I8042_CTR_XLATE)

                i8042_direct = 1;

/*

 * Set nontranslated mode for the kbd interface if requested by an option.

 * After this the kbd interface becomes a simple serial in/out, like the aux

 * interface is. We don't do this by default, since it can confuse notebook

 * BIOSes.

 */

        if (i8042_direct) {

                i8042_ctr &= ~I8042_CTR_XLATE;

                i8042_kbd_port.type = SERIO_8042;

        }

/*

 * Write CTR back.

 */

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {

                printk(KERN_ERR "i8042.c: Can't write CTR while initializing i8042.\n");

                return -1;

        }

        return 0;

}

/*

 * Here we try to reset everything back to a state in which the BIOS will be

 * able to talk to the hardware when rebooting.

 */

void i8042_controller_cleanup(void)

{

        int i;

        i8042_flush();

/*

 * Reset anything that is connected to the ports.

 */

        if (i8042_kbd_values.exists)

                serio_cleanup(&i8042_kbd_port);

        if (i8042_aux_values.exists)

                serio_cleanup(&i8042_aux_port);

        for (i = 0; i < 4; i++)

                if (i8042_mux_values[i].exists)

                        serio_cleanup(i8042_mux_port + i);

/*

 * Reset the controller.

 */

        if (i8042_reset) {

                unsigned char param;

                if (i8042_command(&param, I8042_CMD_CTL_TEST))

                        printk(KERN_ERR "i8042.c: i8042 controller reset timeout.\n");

        }

/*

 * Restore the original control register setting.

 */

        i8042_ctr = i8042_initial_ctr;

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))

                printk(KERN_WARNING "i8042.c: Can't restore CTR.\n");

}

/*

 * i8042_check_mux() checks whether the controller supports the PS/2 Active

 * Multiplexing specification by Synaptics, Phoenix, Insyde and

 * LCS/Telegraphics.

 */

static int __init i8042_check_mux(struct i8042_values *values)

{

        unsigned char param;

        static int i8042_check_mux_cookie;

        int i;

/*

 * Check if AUX irq is available.

 */

        if (request_irq(values->irq, i8042_interrupt, SA_SHIRQ,

                                "i8042", &i8042_check_mux_cookie))

                return -1;

        free_irq(values->irq, &i8042_check_mux_cookie);

/*

 * Get rid of bytes in the queue.

 */

        i8042_flush();

/*

 * Internal loopback test - send three bytes, they should come back from the

 * mouse interface, the last should be version. Note that we negate mouseport

 * command responses for the i8042_check_aux() routine.

 */

        param = 0xf0;

        if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != 0x0f)

                return -1;

        param = 0x56;

        if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != 0xa9)

                return -1;

        param = 0xa4;

        if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param == 0x5b)

                return -1;

        printk(KERN_INFO "i8042.c: Detected active multiplexing controller, rev %d.%d.\n",

                (~param >> 4) & 0xf, ~param & 0xf);

/*

 * Disable all muxed ports by disabling AUX.

 */

        i8042_ctr |= I8042_CTR_AUXDIS;

        i8042_ctr &= ~I8042_CTR_AUXINT;

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))

                return -1;

/*

 * Enable all muxed ports.

 */

        for (i = 0; i < 4; i++) {

                i8042_command(&param, I8042_CMD_MUX_PFX + i);

                i8042_command(&param, I8042_CMD_AUX_ENABLE);

        }

        return 0;

}

/*

 * i8042_check_aux() applies as much paranoia as it can at detecting

 * the presence of an AUX interface.

 */

static int __init i8042_check_aux(struct i8042_values *values)

{

        unsigned char param;

        static int i8042_check_aux_cookie;

/*

 * Check if AUX irq is available. If it isn't, then there is no point

 * in trying to detect AUX presence.

 */

        if (request_irq(values->irq, i8042_interrupt, SA_SHIRQ,

                                "i8042", &i8042_check_aux_cookie))

                return -1;

        free_irq(values->irq, &i8042_check_aux_cookie);

/*

 * Get rid of bytes in the queue.

 */

        i8042_flush();

/*

 * Internal loopback test - filters out AT-type i8042's. Unfortunately

 * SiS screwed up and their 5597 doesn't support the LOOP command even

 * though it has an AUX port.

 */

        param = 0x5a;

        if (i8042_command(&param, I8042_CMD_AUX_LOOP) || param != 0xa5) {

/*

 * External connection test - filters out AT-soldered PS/2 i8042's

 * 0x00 - no error, 0x01-0x03 - clock/data stuck, 0xff - general error

 * 0xfa - no error on some notebooks which ignore the spec

 * Because it's common for chipsets to return error on perfectly functioning

 * AUX ports, we test for this only when the LOOP command failed.

 */

                if (i8042_command(&param, I8042_CMD_AUX_TEST)

                        || (param && param != 0xfa && param != 0xff))

                                return -1;

        }

/*

 * Bit assignment test - filters out PS/2 i8042's in AT mode

 */

        if (i8042_command(&param, I8042_CMD_AUX_DISABLE))

                return -1;

        if (i8042_command(&param, I8042_CMD_CTL_RCTR) || (~param & I8042_CTR_AUXDIS))

                return -1;     

        if (i8042_command(&param, I8042_CMD_AUX_ENABLE))

                return -1;

        if (i8042_command(&param, I8042_CMD_CTL_RCTR) || (param & I8042_CTR_AUXDIS))

                return -1;     

/*

 * Disable the interface.

 */

        i8042_ctr |= I8042_CTR_AUXDIS;

        i8042_ctr &= ~I8042_CTR_AUXINT;

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR))

                return -1;

        return 0;

}

/*

 * i8042_port_register() marks the device as existing,

 * registers it, and reports to the user.

 */

static int __init i8042_port_register(struct i8042_values *values, struct serio *port)

{

        values->exists = 1;

        i8042_ctr &= ~values->disable;

        if (i8042_command(&i8042_ctr, I8042_CMD_CTL_WCTR)) {

                printk(KERN_WARNING "i8042.c: Can't write CTR while registering.\n");

                return -1;

        }

        serio_register_port(port);

        printk(KERN_INFO "serio: i8042 %s port at %#lx,%#lx irq %d\n",

               values->name,

               (unsigned long) I8042_DATA_REG,

               (unsigned long) I8042_COMMAND_REG,

               values->irq);

        return 0;

}

static void i8042_timer_func(unsigned long data)

{

        i8042_interrupt(0, NULL, NULL);

        mod_timer(&i8042_timer, jiffies26 + I8042_POLL_PERIOD);

}

#ifndef MODULE

static int __init i8042_setup_reset(char *str)

{

        i8042_reset = 1;

        return 1;

}

static int __init i8042_setup_noaux(char *str)

{

        i8042_noaux = 1;

        i8042_nomux = 1;

        return 1;

}

static int __init i8042_setup_nomux(char *str)

{

        i8042_nomux = 1;

        return 1;

}

static int __init i8042_setup_unlock(char *str)

{

        i8042_unlock = 1;

        return 1;

}

static int __init i8042_setup_direct(char *str)

{

        i8042_direct = 1;

        return 1;

}

static int __init i8042_setup_dumbkbd(char *str)

{

        i8042_dumbkbd = 1;

        return 1;

}

__setup("i8042_reset", i8042_setup_reset);

__setup("i8042_noaux", i8042_setup_noaux);

__setup("i8042_nomux", i8042_setup_nomux);

__setup("i8042_unlock", i8042_setup_unlock);

__setup("i8042_direct", i8042_setup_direct);

__setup("i8042_dumbkbd", i8042_setup_dumbkbd);

#endif

/*

 * We need to reset the 8042 back to original mode on system shutdown,

 * because otherwise BIOSes will be confused.

 */

static int i8042_notify_sys(struct notifier_block *this, unsigned long code,

                            void *unused)

{

        if (code==SYS_DOWN || code==SYS_HALT)

                i8042_controller_cleanup();

        return NOTIFY_DONE;

}

static struct notifier_block i8042_notifier=

{

        i8042_notify_sys,

        NULL,

};

static void __init i8042_init_mux_values(struct i8042_values *values, struct serio *port, int index)

{

        memcpy(port, &i8042_aux_port, sizeof(struct serio));

        memcpy(values, &i8042_aux_values, sizeof(struct i8042_values));

        sprintf26(i8042_mux_names[index], "i8042 Aux-%d Port", index);

        sprintf26(i8042_mux_phys[index], I8042_MUX_PHYS_DESC, index + 1);

        sprintf26(i8042_mux_short[index], "AUX%d", index);

        port->name = i8042_mux_names[index];

        port->phys = i8042_mux_phys[index];

        port->driver = values;

        values->name = i8042_mux_short[index];

        values->mux = index;

}

int __init i8042_init(void)

{

        int i;

        dbg_init();

        if (i8042_platform_init())

                return -EBUSY;

        i8042_aux_values.irq = I8042_AUX_IRQ;

        i8042_kbd_values.irq = I8042_KBD_IRQ;

        if (i8042_controller_init())

                return -ENODEV;

        if (i8042_dumbkbd)

                i8042_kbd_port.write = NULL;

        for (i = 0; i < 4; i++)

                i8042_init_mux_values(i8042_mux_values + i, i8042_mux_port + i, i);

        if (!i8042_nomux && !i8042_check_mux(&i8042_aux_values))

                for (i = 0; i < 4; i++)

                        i8042_port_register(i8042_mux_values + i, i8042_mux_port + i);

        else

                if (!i8042_noaux && !i8042_check_aux(&i8042_aux_values))

                        i8042_port_register(&i8042_aux_values, &i8042_aux_port);

        i8042_port_register(&i8042_kbd_values, &i8042_kbd_port);

        init_timer(&i8042_timer);

        i8042_timer.function = i8042_timer_func;

        mod_timer(&i8042_timer, jiffies26 + I8042_POLL_PERIOD);