drivers/input/keyboard/maple_keyb.c

   1 /*
   2  * SEGA Dreamcast keyboard driver
   3  * Based on drivers/usb/usbkbd.c
   4  * Copyright YAEGASHI Takeshi, 2001
   5  * Porting to 2.6 Copyright Adrian McMenamin, 2007
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see the file COPYING, or write
  19  * to the Free Software Foundation, Inc.,
  20  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #include <linux/kernel.h>
  24 #include <linux/slab.h>
  25 #include <linux/input.h>
  26 #include <linux/module.h>
  27 #include <linux/init.h>
  28 #include <linux/timer.h>
  29 #include <linux/maple.h>
  30
  31 /* Very simple mutex to ensure proper cleanup */
  32 static DEFINE_MUTEX(maple_keyb_mutex);
  33
  34 #define NR_SCANCODES 256
  35
  36 MODULE_AUTHOR("YAEGASHI Takeshi, Adrian McMenamin");
  37 MODULE_DESCRIPTION("SEGA Dreamcast keyboard driver");
  38 MODULE_LICENSE("GPL");
  39
  40 struct dc_kbd {
  41         struct input_dev *dev;
  42         unsigned short keycode[NR_SCANCODES];
  43         unsigned char new[8];
  44         unsigned char old[8];
  45 };
  46
  47 static const unsigned short dc_kbd_keycode[NR_SCANCODES] = {
  48         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_A, KEY_B, KEY_C, KEY_D,
  49         KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, KEY_L,
  50         KEY_M, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T,
  51         KEY_U, KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z, KEY_1, KEY_2,
  52         KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_0,
  53         KEY_ENTER, KEY_ESC, KEY_BACKSPACE, KEY_TAB, KEY_SPACE, KEY_MINUS, KEY_EQUAL, KEY_LEFTBRACE,
  54         KEY_RIGHTBRACE, KEY_BACKSLASH, KEY_BACKSLASH, KEY_SEMICOLON, KEY_APOSTROPHE, KEY_GRAVE, KEY_COMMA,
  55         KEY_DOT, KEY_SLASH, KEY_CAPSLOCK, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6,
  56         KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12, KEY_SYSRQ,
  57         KEY_SCROLLLOCK, KEY_PAUSE, KEY_INSERT, KEY_HOME, KEY_PAGEUP, KEY_DELETE,
  58         KEY_END, KEY_PAGEDOWN, KEY_RIGHT, KEY_LEFT, KEY_DOWN, KEY_UP,
  59         KEY_NUMLOCK, KEY_KPSLASH, KEY_KPASTERISK, KEY_KPMINUS, KEY_KPPLUS, KEY_KPENTER, KEY_KP1, KEY_KP2,
  60         KEY_KP3, KEY_KP4, KEY_KP5, KEY_KP6, KEY_KP7, KEY_KP8, KEY_KP9, KEY_KP0, KEY_KPDOT,
  61         KEY_102ND, KEY_COMPOSE, KEY_POWER, KEY_KPEQUAL, KEY_F13, KEY_F14, KEY_F15,
  62         KEY_F16, KEY_F17, KEY_F18, KEY_F19, KEY_F20,
  63         KEY_F21, KEY_F22, KEY_F23, KEY_F24, KEY_OPEN, KEY_HELP, KEY_PROPS, KEY_FRONT,
  64         KEY_STOP, KEY_AGAIN, KEY_UNDO, KEY_CUT, KEY_COPY, KEY_PASTE, KEY_FIND, KEY_MUTE,
  65         KEY_VOLUMEUP, KEY_VOLUMEDOWN, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_KPCOMMA, KEY_RESERVED, KEY_RO, KEY_KATAKANAHIRAGANA , KEY_YEN,
  66         KEY_HENKAN, KEY_MUHENKAN, KEY_KPJPCOMMA, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  67         KEY_HANGEUL, KEY_HANJA, KEY_KATAKANA, KEY_HIRAGANA, KEY_ZENKAKUHANKAKU, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  68         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  69         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  70         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  71         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  72         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  73         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  74         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  75         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  76         KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
  77         KEY_LEFTCTRL, KEY_LEFTSHIFT, KEY_LEFTALT, KEY_LEFTMETA, KEY_RIGHTCTRL, KEY_RIGHTSHIFT, KEY_RIGHTALT, KEY_RIGHTMETA,
  78         KEY_PLAYPAUSE, KEY_STOPCD, KEY_PREVIOUSSONG, KEY_NEXTSONG, KEY_EJECTCD, KEY_VOLUMEUP, KEY_VOLUMEDOWN, KEY_MUTE,
  79         KEY_WWW, KEY_BACK, KEY_FORWARD, KEY_STOP, KEY_FIND, KEY_SCROLLUP, KEY_SCROLLDOWN, KEY_EDIT, KEY_SLEEP,
  80         KEY_SCREENLOCK, KEY_REFRESH, KEY_CALC, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED
  81 };
  82
  83 static void dc_scan_kbd(struct dc_kbd *kbd)
  84 {
  85         struct input_dev *dev = kbd->dev;
  86         void *ptr;
  87         int code, keycode;
  88         int i;
  89
  90         for (i = 0; i < 8; i++) {
  91                 code = i + 224;
  92                 keycode = kbd->keycode[code];
  93                 input_event(dev, EV_MSC, MSC_SCAN, code);
  94                 input_report_key(dev, keycode, (kbd->new[0] >> i) & 1);
  95         }
  96
  97         for (i = 2; i < 8; i++) {
  98                 ptr = memchr(kbd->new + 2, kbd->old[i], 6);
  99                 code = kbd->old[i];
 100                 if (code > 3 && ptr == NULL) {
 101                         keycode = kbd->keycode[code];
 102                         if (keycode) {
 103                                 input_event(dev, EV_MSC, MSC_SCAN, code);
 104                                 input_report_key(dev, keycode, 0);
 105                         } else
 106                                 printk(KERN_DEBUG "maple_keyb: "
 107                                         "Unknown key (scancode %#x) released.",
 108                                         code);
 109                 }
 110                 ptr = memchr(kbd->old + 2, kbd->new[i], 6);
 111                 code = kbd->new[i];
 112                 if (code > 3 && ptr) {
 113                         keycode = kbd->keycode[code];
 114                         if (keycode) {
 115                                 input_event(dev, EV_MSC, MSC_SCAN, code);
 116                                 input_report_key(dev, keycode, 1);
 117                         } else
 118                                 printk(KERN_DEBUG "maple_keyb: "
 119                                         "Unknown key (scancode %#x) pressed.",
 120                                         code);
 121                 }
 122         }
 123         input_sync(dev);
 124         memcpy(kbd->old, kbd->new, 8);
 125 }
 126
 127 static void dc_kbd_callback(struct mapleq *mq)
 128 {
 129         struct maple_device *mapledev = mq->dev;
 130         struct dc_kbd *kbd = mapledev->private_data;
 131         unsigned long *buf = mq->recvbuf;
 132
 133         /*
 134          * We should always be getting the lock because the only
 135          * time it may be locked if driver is in cleanup phase.
 136          */
 137         if (likely(mutex_trylock(&maple_keyb_mutex))) {
 138
 139                 if (buf[1] == mapledev->function) {
 140                         memcpy(kbd->new, buf + 2, 8);
 141                         dc_scan_kbd(kbd);
 142                 }
 143
 144                 mutex_unlock(&maple_keyb_mutex);
 145         }
 146 }
 147
 148 static int dc_kbd_connect(struct maple_device *mdev)
 149 {
 150         int i, error;
 151         struct dc_kbd *kbd;
 152         struct input_dev *dev;
 153
 154         if (!(mdev->function & MAPLE_FUNC_KEYBOARD))
 155                 return -EINVAL;
 156
 157         kbd = kzalloc(sizeof(struct dc_kbd), GFP_KERNEL);
 158         dev = input_allocate_device();
 159         if (!kbd || !dev) {
 160                 error = -ENOMEM;
 161                 goto fail;
 162         }
 163
 164         mdev->private_data = kbd;
 165
 166         kbd->dev = dev;
 167         memcpy(kbd->keycode, dc_kbd_keycode, sizeof(kbd->keycode));
 168
 169         dev->name = mdev->product_name;
 170         dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP);
 171         dev->keycode = kbd->keycode;
 172         dev->keycodesize = sizeof (unsigned short);
 173         dev->keycodemax = ARRAY_SIZE(kbd->keycode);
 174         dev->id.bustype = BUS_HOST;
 175         dev->dev.parent = &mdev->dev;
 176
 177         for (i = 0; i < NR_SCANCODES; i++)
 178                 __set_bit(dc_kbd_keycode[i], dev->keybit);
 179         __clear_bit(KEY_RESERVED, dev->keybit);
 180
 181         input_set_capability(dev, EV_MSC, MSC_SCAN);
 182         input_set_drvdata(dev, kbd);
 183
 184         error = input_register_device(dev);
 185         if (error)
 186                 goto fail;
 187
 188         /* Maple polling is locked to VBLANK - which may be just 50/s */
 189         maple_getcond_callback(mdev, dc_kbd_callback, HZ/50, MAPLE_FUNC_KEYBOARD);
 190         return 0;
 191
 192  fail:
 193         input_free_device(dev);
 194         kfree(kbd);
 195         mdev->private_data = NULL;
 196         return error;
 197 }
 198
 199 static void dc_kbd_disconnect(struct maple_device *mdev)
 200 {
 201         struct dc_kbd *kbd;
 202
 203         mutex_lock(&maple_keyb_mutex);
 204
 205         kbd = mdev->private_data;
 206         mdev->private_data = NULL;
 207         input_unregister_device(kbd->dev);
 208         kfree(kbd);
 209
 210         mutex_unlock(&maple_keyb_mutex);
 211 }
 212
 213 /* allow the keyboard to be used */
 214 static int probe_maple_kbd(struct device *dev)
 215 {
 216         struct maple_device *mdev = to_maple_dev(dev);
 217         struct maple_driver *mdrv = to_maple_driver(dev->driver);
 218         int error;
 219
 220         error = dc_kbd_connect(mdev);
 221         if (error)
 222                 return error;
 223
 224         mdev->driver = mdrv;
 225         mdev->registered = 1;
 226
 227         return 0;
 228 }
 229
 230 static struct maple_driver dc_kbd_driver = {
 231         .function = MAPLE_FUNC_KEYBOARD,
 232         .connect = dc_kbd_connect,
 233         .disconnect = dc_kbd_disconnect,
 234         .drv = {
 235                 .name = "Dreamcast_keyboard",
 236                 .probe = probe_maple_kbd,
 237        },
 238 };
 239
 240 static int __init dc_kbd_init(void)
 241 {
 242         return maple_driver_register(&dc_kbd_driver.drv);
 243 }
 244
 245 static void __exit dc_kbd_exit(void)
 246 {
 247         driver_unregister(&dc_kbd_driver.drv);
 248 }
 249
 250 module_init(dc_kbd_init);
 251 module_exit(dc_kbd_exit);