drivers/input/keyboard/hilkbd.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  linux/drivers/hil/hilkbd.c
   4  *
   5  *  Copyright (C) 1998 Philip Blundell <[email protected]>
   6  *  Copyright (C) 1999 Matthew Wilcox <[email protected]>
   7  *  Copyright (C) 1999-2007 Helge Deller <[email protected]>
   8  *
   9  *  Very basic HP Human Interface Loop (HIL) driver.
  10  *  This driver handles the keyboard on HP300 (m68k) and on some
  11  *  HP700 (parisc) series machines.
  12  */
  13
  14 #include <linux/pci_ids.h>
  15 #include <linux/ioport.h>
  16 #include <linux/module.h>
  17 #include <linux/errno.h>
  18 #include <linux/input.h>
  19 #include <linux/init.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/hil.h>
  22 #include <linux/io.h>
  23 #include <linux/sched.h>
  24 #include <linux/spinlock.h>
  25 #include <asm/irq.h>
  26 #ifdef CONFIG_HP300
  27 #include <asm/hwtest.h>
  28 #endif
  29
  30
  31 MODULE_AUTHOR("Philip Blundell, Matthew Wilcox, Helge Deller");
  32 MODULE_DESCRIPTION("HIL keyboard driver (basic functionality)");
  33 MODULE_LICENSE("GPL v2");
  34
  35
  36 #if defined(CONFIG_PARISC)
  37
  38  #include <asm/io.h>
  39  #include <asm/hardware.h>
  40  #include <asm/parisc-device.h>
  41  static unsigned long hil_base; /* HPA for the HIL device */
  42  static unsigned int hil_irq;
  43  #define HILBASE                hil_base /* HPPA (parisc) port address */
  44  #define HIL_DATA               0x800
  45  #define HIL_CMD                0x801
  46  #define HIL_IRQ                hil_irq
  47  #define hil_readb(p)           gsc_readb(p)
  48  #define hil_writeb(v,p)        gsc_writeb((v),(p))
  49
  50 #elif defined(CONFIG_HP300)
  51
  52  #define HILBASE                0xf0428000UL /* HP300 (m68k) port address */
  53  #define HIL_DATA               0x1
  54  #define HIL_CMD                0x3
  55  #define HIL_IRQ                2
  56  #define hil_readb(p)           readb((const volatile void __iomem *)(p))
  57  #define hil_writeb(v, p)       writeb((v), (volatile void __iomem *)(p))
  58
  59 #else
  60 #error "HIL is not supported on this platform"
  61 #endif
  62
  63
  64
  65 /* HIL helper functions */
  66
  67 #define hil_busy()              (hil_readb(HILBASE + HIL_CMD) & HIL_BUSY)
  68 #define hil_data_available()    (hil_readb(HILBASE + HIL_CMD) & HIL_DATA_RDY)
  69 #define hil_status()            (hil_readb(HILBASE + HIL_CMD))
  70 #define hil_command(x)          do { hil_writeb((x), HILBASE + HIL_CMD); } while (0)
  71 #define hil_read_data()         (hil_readb(HILBASE + HIL_DATA))
  72 #define hil_write_data(x)       do { hil_writeb((x), HILBASE + HIL_DATA); } while (0)
  73
  74 /* HIL constants */
  75
  76 #define HIL_BUSY                0x02
  77 #define HIL_DATA_RDY            0x01
  78
  79 #define HIL_SETARD              0xA0            /* set auto-repeat delay */
  80 #define HIL_SETARR              0xA2            /* set auto-repeat rate */
  81 #define HIL_SETTONE             0xA3            /* set tone generator */
  82 #define HIL_CNMT                0xB2            /* clear nmi */
  83 #define HIL_INTON               0x5C            /* Turn on interrupts. */
  84 #define HIL_INTOFF              0x5D            /* Turn off interrupts. */
  85
  86 #define HIL_READKBDSADR         0xF9
  87 #define HIL_WRITEKBDSADR        0xE9
  88
  89 static unsigned int hphilkeyb_keycode[HIL_KEYCODES_SET1_TBLSIZE] __read_mostly =
  90         { HIL_KEYCODES_SET1 };
  91
  92 /* HIL structure */
  93 static struct {
  94         struct input_dev *dev;
  95
  96         unsigned int curdev;
  97
  98         unsigned char s;
  99         unsigned char c;
 100         int valid;
 101
 102         unsigned char data[16];
 103         unsigned int ptr;
 104         spinlock_t lock;
 105
 106         void *dev_id;   /* native bus device */
 107 } hil_dev;
 108
 109
 110 static void poll_finished(void)
 111 {
 112         int down;
 113         int key;
 114         unsigned char scode;
 115
 116         switch (hil_dev.data[0]) {
 117         case 0x40:
 118                 down = (hil_dev.data[1] & 1) == 0;
 119                 scode = hil_dev.data[1] >> 1;
 120                 key = hphilkeyb_keycode[scode];
 121                 input_report_key(hil_dev.dev, key, down);
 122                 break;
 123         }
 124         hil_dev.curdev = 0;
 125 }
 126
 127
 128 static inline void handle_status(unsigned char s, unsigned char c)
 129 {
 130         if (c & 0x8) {
 131                 /* End of block */
 132                 if (c & 0x10)
 133                         poll_finished();
 134         } else {
 135                 if (c & 0x10) {
 136                         if (hil_dev.curdev)
 137                                 poll_finished();  /* just in case */
 138                         hil_dev.curdev = c & 7;
 139                         hil_dev.ptr = 0;
 140                 }
 141         }
 142 }
 143
 144
 145 static inline void handle_data(unsigned char s, unsigned char c)
 146 {
 147         if (hil_dev.curdev) {
 148                 hil_dev.data[hil_dev.ptr++] = c;
 149                 hil_dev.ptr &= 15;
 150         }
 151 }
 152
 153
 154 /* handle HIL interrupts */
 155 static irqreturn_t hil_interrupt(int irq, void *handle)
 156 {
 157         unsigned char s, c;
 158
 159         s = hil_status();
 160         c = hil_read_data();
 161
 162         switch (s >> 4) {
 163         case 0x5:
 164                 handle_status(s, c);
 165                 break;
 166         case 0x6:
 167                 handle_data(s, c);
 168                 break;
 169         case 0x4:
 170                 hil_dev.s = s;
 171                 hil_dev.c = c;
 172                 mb();
 173                 hil_dev.valid = 1;
 174                 break;
 175         }
 176         return IRQ_HANDLED;
 177 }
 178
 179
 180 /* send a command to the HIL */
 181 static void hil_do(unsigned char cmd, unsigned char *data, unsigned int len)
 182 {
 183         guard(spinlock_irqsave)(&hil_dev.lock);
 184
 185         while (hil_busy())
 186                 /* wait */;
 187         hil_command(cmd);
 188         while (len--) {
 189                 while (hil_busy())
 190                         /* wait */;
 191                 hil_write_data(*(data++));
 192         }
 193 }
 194
 195
 196 /* initialize HIL */
 197 static int hil_keyb_init(void)
 198 {
 199         unsigned char c;
 200         unsigned int i, kbid;
 201         wait_queue_head_t hil_wait;
 202         int err;
 203
 204         if (hil_dev.dev)
 205                 return -ENODEV; /* already initialized */
 206
 207         init_waitqueue_head(&hil_wait);
 208         spin_lock_init(&hil_dev.lock);
 209
 210         hil_dev.dev = input_allocate_device();
 211         if (!hil_dev.dev)
 212                 return -ENOMEM;
 213
 214         err = request_irq(HIL_IRQ, hil_interrupt, 0, "hil", hil_dev.dev_id);
 215         if (err) {
 216                 printk(KERN_ERR "HIL: Can't get IRQ\n");
 217                 goto err1;
 218         }
 219
 220         /* Turn on interrupts */
 221         hil_do(HIL_INTON, NULL, 0);
 222
 223         /* Look for keyboards */
 224         hil_dev.valid = 0;      /* clear any pending data */
 225         hil_do(HIL_READKBDSADR, NULL, 0);
 226
 227         wait_event_interruptible_timeout(hil_wait, hil_dev.valid, 3 * HZ);
 228         if (!hil_dev.valid)
 229                 printk(KERN_WARNING "HIL: timed out, assuming no keyboard present\n");
 230
 231         c = hil_dev.c;
 232         hil_dev.valid = 0;
 233         if (c == 0) {
 234                 kbid = -1;
 235                 printk(KERN_WARNING "HIL: no keyboard present\n");
 236         } else {
 237                 kbid = ffz(~c);
 238                 printk(KERN_INFO "HIL: keyboard found at id %d\n", kbid);
 239         }
 240
 241         /* set it to raw mode */
 242         c = 0;
 243         hil_do(HIL_WRITEKBDSADR, &c, 1);
 244
 245         for (i = 0; i < HIL_KEYCODES_SET1_TBLSIZE; i++)
 246                 if (hphilkeyb_keycode[i] != KEY_RESERVED)
 247                         __set_bit(hphilkeyb_keycode[i], hil_dev.dev->keybit);
 248
 249         hil_dev.dev->evbit[0]   = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
 250         hil_dev.dev->ledbit[0]  = BIT_MASK(LED_NUML) | BIT_MASK(LED_CAPSL) |
 251                 BIT_MASK(LED_SCROLLL);
 252         hil_dev.dev->keycodemax = HIL_KEYCODES_SET1_TBLSIZE;
 253         hil_dev.dev->keycodesize= sizeof(hphilkeyb_keycode[0]);
 254         hil_dev.dev->keycode    = hphilkeyb_keycode;
 255         hil_dev.dev->name       = "HIL keyboard";
 256         hil_dev.dev->phys       = "hpkbd/input0";
 257
 258         hil_dev.dev->id.bustype = BUS_HIL;
 259         hil_dev.dev->id.vendor  = PCI_VENDOR_ID_HP;
 260         hil_dev.dev->id.product = 0x0001;
 261         hil_dev.dev->id.version = 0x0010;
 262
 263         err = input_register_device(hil_dev.dev);
 264         if (err) {
 265                 printk(KERN_ERR "HIL: Can't register device\n");
 266                 goto err2;
 267         }
 268
 269         printk(KERN_INFO "input: %s, ID %d at 0x%08lx (irq %d) found and attached\n",
 270                hil_dev.dev->name, kbid, HILBASE, HIL_IRQ);
 271
 272         return 0;
 273
 274 err2:
 275         hil_do(HIL_INTOFF, NULL, 0);
 276         free_irq(HIL_IRQ, hil_dev.dev_id);
 277 err1:
 278         input_free_device(hil_dev.dev);
 279         hil_dev.dev = NULL;
 280         return err;
 281 }
 282
 283 static void hil_keyb_exit(void)
 284 {
 285         if (HIL_IRQ)
 286                 free_irq(HIL_IRQ, hil_dev.dev_id);
 287
 288         /* Turn off interrupts */
 289         hil_do(HIL_INTOFF, NULL, 0);
 290
 291         input_unregister_device(hil_dev.dev);
 292         hil_dev.dev = NULL;
 293 }
 294
 295 #if defined(CONFIG_PARISC)
 296 static int __init hil_probe_chip(struct parisc_device *dev)
 297 {
 298         /* Only allow one HIL keyboard */
 299         if (hil_dev.dev)
 300                 return -ENODEV;
 301
 302         if (!dev->irq) {
 303                 printk(KERN_WARNING "HIL: IRQ not found for HIL bus at 0x%p\n",
 304                         (void *)dev->hpa.start);
 305                 return -ENODEV;
 306         }
 307
 308         hil_base = dev->hpa.start;
 309         hil_irq  = dev->irq;
 310         hil_dev.dev_id = dev;
 311
 312         printk(KERN_INFO "Found HIL bus at 0x%08lx, IRQ %d\n", hil_base, hil_irq);
 313
 314         return hil_keyb_init();
 315 }
 316
 317 static void __exit hil_remove_chip(struct parisc_device *dev)
 318 {
 319         hil_keyb_exit();
 320 }
 321
 322 static const struct parisc_device_id hil_tbl[] __initconst = {
 323         { HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x00073 },
 324         { 0, }
 325 };
 326
 327 #if 0
 328 /* Disabled to avoid conflicts with the HP SDC HIL drivers */
 329 MODULE_DEVICE_TABLE(parisc, hil_tbl);
 330 #endif
 331
 332 static struct parisc_driver hil_driver __refdata = {
 333         .name           = "hil",
 334         .id_table       = hil_tbl,
 335         .probe          = hil_probe_chip,
 336         .remove         = __exit_p(hil_remove_chip),
 337 };
 338
 339 static int __init hil_init(void)
 340 {
 341         return register_parisc_driver(&hil_driver);
 342 }
 343
 344 static void __exit hil_exit(void)
 345 {
 346         unregister_parisc_driver(&hil_driver);
 347 }
 348
 349 #else /* !CONFIG_PARISC */
 350
 351 static int __init hil_init(void)
 352 {
 353         int error;
 354
 355         /* Only allow one HIL keyboard */
 356         if (hil_dev.dev)
 357                 return -EBUSY;
 358
 359         if (!MACH_IS_HP300)
 360                 return -ENODEV;
 361
 362         if (!hwreg_present((void *)(HILBASE + HIL_DATA))) {
 363                 printk(KERN_ERR "HIL: hardware register was not found\n");
 364                 return -ENODEV;
 365         }
 366
 367         if (!request_region(HILBASE + HIL_DATA, 2, "hil")) {
 368                 printk(KERN_ERR "HIL: IOPORT region already used\n");
 369                 return -EIO;
 370         }
 371
 372         error = hil_keyb_init();
 373         if (error) {
 374                 release_region(HILBASE + HIL_DATA, 2);
 375                 return error;
 376         }
 377
 378         return 0;
 379 }
 380
 381 static void __exit hil_exit(void)
 382 {
 383         hil_keyb_exit();
 384         release_region(HILBASE + HIL_DATA, 2);
 385 }
 386
 387 #endif /* CONFIG_PARISC */
 388
 389 module_init(hil_init);
 390 module_exit(hil_exit);