2  * linux/drivers/char/ec3104_keyb.c
 
   4  * Copyright (C) 2000 Philipp Rumpf <prumpf@tux.org>
 
   6  * based on linux/drivers/char/pc_keyb.c, which had the following comments:
 
   8  * Separation of the PC low-level part by Geert Uytterhoeven, May 1997
 
   9  * See keyboard.c for the whole history.
 
  11  * Major cleanup by Martin Mares, May 1997
 
  13  * Combined the keyboard and PS/2 mouse handling into one file,
 
  14  * because they share the same hardware.
 
  15  * Johan Myreen <jem@iki.fi> 1998-10-08.
 
  17  * Code fixes to handle mouse ACKs properly.
 
  18  * C. Scott Ananian <cananian@alumni.princeton.edu> 1999-01-29.
 
  21  * This code was written without any documentation about the EC3104 chip.  While
 
  22  * I hope I got most of the basic functionality right, the register names I use
 
  23  * are most likely completely different from those in the chip documentation.
 
  25  * If you have any further information about the EC3104, please tell me
 
  29 #include <linux/config.h>
 
  31 #include <linux/spinlock.h>
 
  32 #include <linux/sched.h>
 
  33 #include <linux/interrupt.h>
 
  34 #include <linux/tty.h>
 
  36 #include <linux/signal.h>
 
  37 #include <linux/init.h>
 
  38 #include <linux/kbd_ll.h>
 
  39 #include <linux/delay.h>
 
  40 #include <linux/random.h>
 
  41 #include <linux/poll.h>
 
  42 #include <linux/miscdevice.h>
 
  43 #include <linux/slab.h>
 
  44 #include <linux/kbd_kern.h>
 
  45 #include <linux/smp_lock.h>
 
  46 #include <linux/bitops.h>
 
  48 #include <asm/keyboard.h>
 
  49 #include <asm/uaccess.h>
 
  51 #include <asm/system.h>
 
  52 #include <asm/ec3104.h>
 
  56 /* Some configuration switches are present in the include file... */
 
  58 #include <linux/pc_keyb.h>
 
  63 #define LSR_BOTH_EMPTY 0x60
 
  65 static struct e5_struct {
 
  74 /* Simple translation table for the SysRq keys */
 
  77 #ifdef CONFIG_MAGIC_SYSRQ
 
  78 unsigned char ec3104_kbd_sysrq_xlate[128] =
 
  79         "\000\0331234567890-=\177\t"                    /* 0x00 - 0x0f */
 
  80         "qwertyuiop[]\r\000as"                          /* 0x10 - 0x1f */
 
  81         "dfghjkl;'`\000\\zxcv"                          /* 0x20 - 0x2f */
 
  82         "bnm,./\000*\000 \000\201\202\203\204\205"      /* 0x30 - 0x3f */
 
  83         "\206\207\210\211\212\000\000789-456+1"         /* 0x40 - 0x4f */
 
  84         "230\177\000\000\213\214\000\000\000\000\000\000\000\000\000\000" /* 0x50 - 0x5f */
 
  85         "\r\000/";                                      /* 0x60 - 0x6f */
 
  88 static void kbd_write_command_w(int data);
 
  89 static void kbd_write_output_w(int data);
 
  91 static void aux_write_ack(int val);
 
  92 static void __aux_write_ack(int val);
 
  95 static DEFINE_SPINLOCK(kbd_controller_lock);
 
  96 static unsigned char handle_kbd_event(void);
 
  98 /* used only by send_data - set by keyboard_interrupt */
 
  99 static volatile unsigned char reply_expected;
 
 100 static volatile unsigned char acknowledge;
 
 101 static volatile unsigned char resend;
 
 104 int ec3104_kbd_setkeycode(unsigned int scancode, unsigned int keycode)
 
 109 int ec3104_kbd_getkeycode(unsigned int scancode)
 
 115 /* yes, it probably would be faster to use an array.  I don't care. */
 
 117 static inline unsigned char ec3104_scan2key(unsigned char scancode)
 
 141         case 52: /* escape */
 
 144         case 54: /* insert/delete (labelled delete) */
 
 145                 /* this should arguably be 110, but I'd like to have ctrl-alt-del
 
 146                  * working with a standard keymap */
 
 161         case 61: /* pgdown */
 
 166         case 79 ... 88: /* f1 - f10 */
 
 167                 return scancode - 20;
 
 169         case 89 ... 90: /* f11 - f12 */
 
 172         case 91: /* left shift */
 
 175         case 92: /* right shift */
 
 178         case 93: /* left alt */
 
 180         case 94: /* right alt */
 
 182         case 95: /* left ctrl */
 
 184         case 96: /* right ctrl */
 
 187         case 97: /* caps lock */
 
 189         case 102: /* left windows */
 
 191         case 103: /* right windows */
 
 203 int ec3104_kbd_translate(unsigned char scancode, unsigned char *keycode,
 
 208         *keycode = ec3104_scan2key(scancode);
 
 213 char ec3104_kbd_unexpected_up(unsigned char keycode)
 
 218 static inline void handle_keyboard_event(unsigned char scancode)
 
 221         handle_scancode(scancode, !(scancode & 0x80));
 
 223         tasklet_schedule(&keyboard_tasklet);
 
 226 void ec3104_kbd_leds(unsigned char leds)
 
 230 static u8 e5_checksum(u8 *packet, int count)
 
 235         for (i=0; i<count; i++)
 
 244 static void e5_wait_for_cts(struct e5_struct *k)
 
 249                 msr = ctrl_inb(EC3104_SER4_MSR);
 
 250         } while (!(msr & MSR_CTS));
 
 254 static void e5_send_byte(u8 byte, struct e5_struct *k)
 
 259                 status = ctrl_inb(EC3104_SER4_LSR);
 
 260         } while ((status & LSR_BOTH_EMPTY) != LSR_BOTH_EMPTY);
 
 262         printk("<%02x>", byte);
 
 264         ctrl_outb(byte, EC3104_SER4_DATA);
 
 267                 status = ctrl_inb(EC3104_SER4_LSR);
 
 268         } while ((status & LSR_BOTH_EMPTY) != LSR_BOTH_EMPTY);
 
 272 static int e5_send_packet(u8 *packet, int count, struct e5_struct *k)
 
 276         disable_irq(EC3104_IRQ_SER4);
 
 278         if (k->cached_mcr & MCR_RTS) {
 
 279                 printk("e5_send_packet: too slow\n");
 
 280                 enable_irq(EC3104_IRQ_SER4);
 
 284         k->cached_mcr |= MCR_RTS;
 
 285         ctrl_outb(k->cached_mcr, EC3104_SER4_MCR);
 
 291         for(i=0; i<count; i++)
 
 292                 e5_send_byte(packet[i], k);
 
 294         e5_send_byte(e5_checksum(packet, count), k);
 
 300         k->cached_mcr &= ~MCR_RTS;
 
 301         ctrl_outb(k->cached_mcr, EC3104_SER4_MCR);
 
 303         set_current_state(TASK_UNINTERRUPTIBLE);
 
 307         enable_irq(EC3104_IRQ_SER4);
 
 315  * E5 packets we know about:
 
 316  * E5->host 0x80 0x05 <checksum> - resend packet
 
 317  * host->E5 0x83 0x43 <contrast> - set LCD contrast
 
 318  * host->E5 0x85 0x41 0x02 <brightness> 0x02 - set LCD backlight
 
 319  * E5->host 0x87 <ps2 packet> 0x00 <checksum> - external PS2 
 
 320  * E5->host 0x88 <scancode> <checksum> - key press
 
 323 static void e5_receive(struct e5_struct *k)
 
 325         k->packet[k->pos++] = ctrl_inb(EC3104_SER4_DATA);
 
 328                 switch(k->packet[0]) {
 
 333                 case 0x87: /* PS2 ext */
 
 337                 case 0x88: /* keyboard */
 
 343                         printk(KERN_WARNING "unknown E5 packet %02x\n",
 
 348         if (k->pos == k->length) {
 
 351                 if (e5_checksum(k->packet, k->length) != 0)
 
 352                         printk(KERN_WARNING "E5: wrong checksum\n");
 
 355                 printk("E5 packet [");
 
 356                 for(i=0; i<k->length; i++) {
 
 357                         printk("%02x ", k->packet[i]);
 
 360                 printk("(%02x)]\n", e5_checksum(k->packet, k->length-1));
 
 363                 switch(k->packet[0]) {
 
 366                         handle_keyboard_event(k->packet[1]);
 
 370                 k->pos = k->length = 0;
 
 374 static void ec3104_keyb_interrupt(int irq, void *data, struct pt_regs *regs)
 
 376         struct e5_struct *k = &ec3104_keyb;
 
 379         msr = ctrl_inb(EC3104_SER4_MSR);
 
 381         if ((msr & MSR_CTS) && !(k->last_msr & MSR_CTS)) {
 
 382                 if (k->cached_mcr & MCR_RTS)
 
 383                         printk("confused: RTS already high\n");
 
 384                 /* CTS went high.  Send RTS. */
 
 385                 k->cached_mcr |= MCR_RTS;
 
 387                 ctrl_outb(k->cached_mcr, EC3104_SER4_MCR);
 
 388         } else if ((!(msr & MSR_CTS)) && (k->last_msr & MSR_CTS)) {
 
 390                 if (!(k->cached_mcr & MCR_RTS))
 
 391                         printk("confused: RTS already low\n");
 
 393                 k->cached_mcr &= ~MCR_RTS;
 
 395                 ctrl_outb(k->cached_mcr, EC3104_SER4_MCR);
 
 400         lsr = ctrl_inb(EC3104_SER4_LSR);
 
 406 static void ec3104_keyb_clear_state(void)
 
 408         struct e5_struct *k = &ec3104_keyb;
 
 411         /* we want CTS to be low */
 
 417                 msr = ctrl_inb(EC3104_SER4_MSR);
 
 419                 lsr = ctrl_inb(EC3104_SER4_LSR);
 
 426                 if ((msr & MSR_CTS) && !(k->last_msr & MSR_CTS)) {
 
 427                         if (k->cached_mcr & MCR_RTS)
 
 428                                 printk("confused: RTS already high\n");
 
 429                         /* CTS went high.  Send RTS. */
 
 430                         k->cached_mcr |= MCR_RTS;
 
 432                         ctrl_outb(k->cached_mcr, EC3104_SER4_MCR);
 
 433                 } else if ((!(msr & MSR_CTS)) && (k->last_msr & MSR_CTS)) {
 
 435                         if (!(k->cached_mcr & MCR_RTS))
 
 436                                 printk("confused: RTS already low\n");
 
 438                         k->cached_mcr &= ~MCR_RTS;
 
 440                         ctrl_outb(k->cached_mcr, EC3104_SER4_MCR);
 
 450 void __init ec3104_kbd_init_hw(void)
 
 452         ec3104_keyb.last_msr = ctrl_inb(EC3104_SER4_MSR);
 
 453         ec3104_keyb.cached_mcr = ctrl_inb(EC3104_SER4_MCR);
 
 455         ec3104_keyb_clear_state();
 
 457         /* Ok, finally allocate the IRQ, and off we go.. */
 
 458         request_irq(EC3104_IRQ_SER4, ec3104_keyb_interrupt, 0, "keyboard", NULL);