input/keyboard/maple_keyb.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * SEGA Dreamcast keyboard driver
0004  * Based on drivers/usb/usbkbd.c
0005  * Copyright (c) YAEGASHI Takeshi, 2001
0006  * Porting to 2.6 Copyright (c) Adrian McMenamin, 2007 - 2009
0007  */
0008
0009 #include <linux/kernel.h>
0010 #include <linux/slab.h>
0011 #include <linux/input.h>
0012 #include <linux/module.h>
0013 #include <linux/init.h>
0014 #include <linux/timer.h>
0015 #include <linux/maple.h>
0016
0017 /* Very simple mutex to ensure proper cleanup */
0018 static DEFINE_MUTEX(maple_keyb_mutex);
0019
0020 #define NR_SCANCODES 256
0021
0022 MODULE_AUTHOR("Adrian McMenamin <adrian@mcmen.demon.co.uk");
0023 MODULE_DESCRIPTION("SEGA Dreamcast keyboard driver");
0024 MODULE_LICENSE("GPL");
0025
0026 struct dc_kbd {
0027     struct input_dev *dev;
0028     unsigned short keycode[NR_SCANCODES];
0029     unsigned char new[8];
0030     unsigned char old[8];
0031 };
0032
0033 static const unsigned short dc_kbd_keycode[NR_SCANCODES] = {
0034     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_A, KEY_B,
0035     KEY_C, KEY_D, KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, KEY_L,
0036     KEY_M, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T, KEY_U, KEY_V,
0037     KEY_W, KEY_X, KEY_Y, KEY_Z, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6,
0038     KEY_7, KEY_8, KEY_9, KEY_0, KEY_ENTER, KEY_ESC, KEY_BACKSPACE,
0039     KEY_TAB, KEY_SPACE, KEY_MINUS, KEY_EQUAL, KEY_LEFTBRACE,
0040     KEY_RIGHTBRACE, KEY_BACKSLASH, KEY_BACKSLASH, KEY_SEMICOLON,
0041     KEY_APOSTROPHE, KEY_GRAVE, KEY_COMMA, KEY_DOT, KEY_SLASH,
0042     KEY_CAPSLOCK, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6,
0043     KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12, KEY_SYSRQ,
0044     KEY_SCROLLLOCK, KEY_PAUSE, KEY_INSERT, KEY_HOME, KEY_PAGEUP,
0045     KEY_DELETE, KEY_END, KEY_PAGEDOWN, KEY_RIGHT, KEY_LEFT, KEY_DOWN,
0046     KEY_UP, KEY_NUMLOCK, KEY_KPSLASH, KEY_KPASTERISK, KEY_KPMINUS,
0047     KEY_KPPLUS, KEY_KPENTER, KEY_KP1, KEY_KP2, KEY_KP3, KEY_KP4, KEY_KP5,
0048     KEY_KP6, KEY_KP7, KEY_KP8, KEY_KP9, KEY_KP0, KEY_KPDOT, KEY_102ND,
0049     KEY_COMPOSE, KEY_POWER, KEY_KPEQUAL, KEY_F13, KEY_F14, KEY_F15,
0050     KEY_F16, KEY_F17, KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22,
0051     KEY_F23, KEY_F24, KEY_OPEN, KEY_HELP, KEY_PROPS, KEY_FRONT, KEY_STOP,
0052     KEY_AGAIN, KEY_UNDO, KEY_CUT, KEY_COPY, KEY_PASTE, KEY_FIND, KEY_MUTE,
0053     KEY_VOLUMEUP, KEY_VOLUMEDOWN, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0054     KEY_KPCOMMA, KEY_RESERVED, KEY_RO, KEY_KATAKANAHIRAGANA , KEY_YEN,
0055     KEY_HENKAN, KEY_MUHENKAN, KEY_KPJPCOMMA, KEY_RESERVED, KEY_RESERVED,
0056     KEY_RESERVED, KEY_HANGEUL, KEY_HANJA, KEY_KATAKANA, KEY_HIRAGANA,
0057     KEY_ZENKAKUHANKAKU, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0058     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0059     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0060     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0061     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0062     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0063     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0064     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0065     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0066     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0067     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0068     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0069     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0070     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0071     KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED,
0072     KEY_RESERVED, KEY_RESERVED, KEY_LEFTCTRL, KEY_LEFTSHIFT, KEY_LEFTALT,
0073     KEY_LEFTMETA, KEY_RIGHTCTRL, KEY_RIGHTSHIFT, KEY_RIGHTALT,
0074     KEY_RIGHTMETA, KEY_PLAYPAUSE, KEY_STOPCD, KEY_PREVIOUSSONG,
0075     KEY_NEXTSONG, KEY_EJECTCD, KEY_VOLUMEUP, KEY_VOLUMEDOWN, KEY_MUTE,
0076     KEY_WWW, KEY_BACK, KEY_FORWARD, KEY_STOP, KEY_FIND, KEY_SCROLLUP,
0077     KEY_SCROLLDOWN, KEY_EDIT, KEY_SLEEP, KEY_SCREENLOCK, KEY_REFRESH,
0078     KEY_CALC, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED
0079 };
0080
0081 static void dc_scan_kbd(struct dc_kbd *kbd)
0082 {
0083     struct input_dev *dev = kbd->dev;
0084     void *ptr;
0085     int code, keycode;
0086     int i;
0087
0088     for (i = 0; i < 8; i++) {
0089         code = i + 224;
0090         keycode = kbd->keycode[code];
0091         input_event(dev, EV_MSC, MSC_SCAN, code);
0092         input_report_key(dev, keycode, (kbd->new[0] >> i) & 1);
0093     }
0094
0095     for (i = 2; i < 8; i++) {
0096         ptr = memchr(kbd->new + 2, kbd->old[i], 6);
0097         code = kbd->old[i];
0098         if (code > 3 && ptr == NULL) {
0099             keycode = kbd->keycode[code];
0100             if (keycode) {
0101                 input_event(dev, EV_MSC, MSC_SCAN, code);
0102                 input_report_key(dev, keycode, 0);
0103             } else
0104                 dev_dbg(&dev->dev,
0105                     "Unknown key (scancode %#x) released.",
0106                     code);
0107         }
0108         ptr = memchr(kbd->old + 2, kbd->new[i], 6);
0109         code = kbd->new[i];
0110         if (code > 3 && ptr) {
0111             keycode = kbd->keycode[code];
0112             if (keycode) {
0113                 input_event(dev, EV_MSC, MSC_SCAN, code);
0114                 input_report_key(dev, keycode, 1);
0115             } else
0116                 dev_dbg(&dev->dev,
0117                     "Unknown key (scancode %#x) pressed.",
0118                     code);
0119         }
0120     }
0121     input_sync(dev);
0122     memcpy(kbd->old, kbd->new, 8);
0123 }
0124
0125 static void dc_kbd_callback(struct mapleq *mq)
0126 {
0127     struct maple_device *mapledev = mq->dev;
0128     struct dc_kbd *kbd = maple_get_drvdata(mapledev);
0129     unsigned long *buf = (unsigned long *)(mq->recvbuf->buf);
0130
0131     /*
0132      * We should always get the lock because the only
0133      * time it may be locked is if the driver is in the cleanup phase.
0134      */
0135     if (likely(mutex_trylock(&maple_keyb_mutex))) {
0136
0137         if (buf[1] == mapledev->function) {
0138             memcpy(kbd->new, buf + 2, 8);
0139             dc_scan_kbd(kbd);
0140         }
0141
0142         mutex_unlock(&maple_keyb_mutex);
0143     }
0144 }
0145
0146 static int probe_maple_kbd(struct device *dev)
0147 {
0148     struct maple_device *mdev;
0149     struct maple_driver *mdrv;
0150     int i, error;
0151     struct dc_kbd *kbd;
0152     struct input_dev *idev;
0153
0154     mdev = to_maple_dev(dev);
0155     mdrv = to_maple_driver(dev->driver);
0156
0157     kbd = kzalloc(sizeof(struct dc_kbd), GFP_KERNEL);
0158     if (!kbd) {
0159         error = -ENOMEM;
0160         goto fail;
0161     }
0162
0163     idev = input_allocate_device();
0164     if (!idev) {
0165         error = -ENOMEM;
0166         goto fail_idev_alloc;
0167     }
0168
0169     kbd->dev = idev;
0170     memcpy(kbd->keycode, dc_kbd_keycode, sizeof(kbd->keycode));
0171
0172     idev->name = mdev->product_name;
0173     idev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP);
0174     idev->keycode = kbd->keycode;
0175     idev->keycodesize = sizeof(unsigned short);
0176     idev->keycodemax = ARRAY_SIZE(kbd->keycode);
0177     idev->id.bustype = BUS_HOST;
0178     idev->dev.parent = &mdev->dev;
0179
0180     for (i = 0; i < NR_SCANCODES; i++)
0181         __set_bit(dc_kbd_keycode[i], idev->keybit);
0182     __clear_bit(KEY_RESERVED, idev->keybit);
0183
0184     input_set_capability(idev, EV_MSC, MSC_SCAN);
0185
0186     error = input_register_device(idev);
0187     if (error)
0188         goto fail_register;
0189
0190     /* Maple polling is locked to VBLANK - which may be just 50/s */
0191     maple_getcond_callback(mdev, dc_kbd_callback, HZ/50,
0192         MAPLE_FUNC_KEYBOARD);
0193
0194     mdev->driver = mdrv;
0195
0196     maple_set_drvdata(mdev, kbd);
0197
0198     return error;
0199
0200 fail_register:
0201     maple_set_drvdata(mdev, NULL);
0202     input_free_device(idev);
0203 fail_idev_alloc:
0204     kfree(kbd);
0205 fail:
0206     return error;
0207 }
0208
0209 static int remove_maple_kbd(struct device *dev)
0210 {
0211     struct maple_device *mdev = to_maple_dev(dev);
0212     struct dc_kbd *kbd = maple_get_drvdata(mdev);
0213
0214     mutex_lock(&maple_keyb_mutex);
0215
0216     input_unregister_device(kbd->dev);
0217     kfree(kbd);
0218
0219     maple_set_drvdata(mdev, NULL);
0220
0221     mutex_unlock(&maple_keyb_mutex);
0222     return 0;
0223 }
0224
0225 static struct maple_driver dc_kbd_driver = {
0226     .function = MAPLE_FUNC_KEYBOARD,
0227     .drv = {
0228         .name = "Dreamcast_keyboard",
0229         .probe = probe_maple_kbd,
0230         .remove = remove_maple_kbd,
0231     },
0232 };
0233
0234 static int __init dc_kbd_init(void)
0235 {
0236     return maple_driver_register(&dc_kbd_driver);
0237 }
0238
0239 static void __exit dc_kbd_exit(void)
0240 {
0241     maple_driver_unregister(&dc_kbd_driver);
0242 }
0243
0244 module_init(dc_kbd_init);
0245 module_exit(dc_kbd_exit);