3 * Copyright (C) 2011 - 2015 UNISYS CORPORATION
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
13 * NON INFRINGEMENT. See the GNU General Public License for more
18 * This driver lives in a generic guest Linux partition, and registers to
19 * receive keyboard and mouse channels from the visorbus driver. It reads
20 * inputs from such channels, and delivers it to the Linux OS in the
21 * standard way the Linux expects for input drivers.
24 #include <linux/buffer_head.h>
27 #include <linux/input.h>
28 #include <linux/uaccess.h>
29 #include <linux/kernel.h>
30 #include <linux/uuid.h>
35 #include "ultrainputreport.h"
37 /* Keyboard channel {c73416d0-b0b8-44af-b304-9d2ae99f1b3d} */
38 #define SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID \
39 UUID_LE(0xc73416d0, 0xb0b8, 0x44af, \
40 0xb3, 0x4, 0x9d, 0x2a, 0xe9, 0x9f, 0x1b, 0x3d)
41 #define SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID_STR "c73416d0-b0b8-44af-b304-9d2ae99f1b3d"
43 /* Mouse channel {addf07d4-94a9-46e2-81c3-61abcdbdbd87} */
44 #define SPAR_MOUSE_CHANNEL_PROTOCOL_UUID \
45 UUID_LE(0xaddf07d4, 0x94a9, 0x46e2, \
46 0x81, 0xc3, 0x61, 0xab, 0xcd, 0xbd, 0xbd, 0x87)
47 #define SPAR_MOUSE_CHANNEL_PROTOCOL_UUID_STR \
48 "addf07d4-94a9-46e2-81c3-61abcdbdbd87"
50 #define PIXELS_ACROSS_DEFAULT 800
51 #define PIXELS_DOWN_DEFAULT 600
52 #define KEYCODE_TABLE_BYTES 256
54 enum visorinput_device_type {
60 * This is the private data that we store for each device.
61 * A pointer to this struct is maintained via
62 * dev_get_drvdata() / dev_set_drvdata() for each struct device.
64 struct visorinput_devdata {
65 struct visor_device *dev;
66 struct rw_semaphore lock_visor_dev; /* lock for dev */
67 struct input_dev *visorinput_dev;
69 unsigned int keycode_table_bytes; /* size of following array */
70 /* for keyboard devices: visorkbd_keycode[] + visorkbd_ext_keycode[] */
71 unsigned char keycode_table[0];
74 static const uuid_le spar_keyboard_channel_protocol_uuid =
75 SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID;
76 static const uuid_le spar_mouse_channel_protocol_uuid =
77 SPAR_MOUSE_CHANNEL_PROTOCOL_UUID;
80 * Borrowed from drivers/input/keyboard/atakbd.c
81 * This maps 1-byte scancodes to keycodes.
83 static const unsigned char visorkbd_keycode[KEYCODE_TABLE_BYTES] = {
111 [26] = KEY_LEFTBRACE,
112 [27] = KEY_RIGHTBRACE,
124 [39] = KEY_SEMICOLON,
125 [40] = KEY_APOSTROPHE,
126 [41] = KEY_GRAVE, /* FIXME, '#' */
127 [42] = KEY_LEFTSHIFT,
128 [43] = KEY_BACKSLASH, /* FIXME, '~' */
139 [54] = KEY_RIGHTSHIFT,
140 [55] = KEY_KPASTERISK,
155 [70] = KEY_SCROLLLOCK,
169 [86] = KEY_102ND, /* enables UK backslash+pipe key,
170 * and FR lessthan+greaterthan key
174 [90] = KEY_KPLEFTPAREN,
175 [91] = KEY_KPRIGHTPAREN,
176 [92] = KEY_KPASTERISK, /* FIXME */
177 [93] = KEY_KPASTERISK,
181 [97] = KEY_RIGHTCTRL,
183 [99] = KEY_KPLEFTPAREN,
184 [100] = KEY_KPRIGHTPAREN,
193 [109] = KEY_PAGEDOWN,
201 * This maps the <xx> in extended scancodes of the form "0xE0 <xx>" into
204 static const unsigned char visorkbd_ext_keycode[KEYCODE_TABLE_BYTES] = {
205 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00 */
206 0, 0, 0, 0, 0, 0, 0, 0, /* 0x10 */
207 0, 0, 0, 0, KEY_KPENTER, KEY_RIGHTCTRL, 0, 0, /* 0x18 */
208 0, 0, 0, 0, 0, 0, 0, 0, /* 0x20 */
209 KEY_RIGHTALT, 0, 0, 0, 0, 0, 0, 0, /* 0x28 */
210 0, 0, 0, 0, 0, 0, 0, 0, /* 0x30 */
211 KEY_RIGHTALT /* AltGr */, 0, 0, 0, 0, 0, 0, 0, /* 0x38 */
212 0, 0, 0, 0, 0, 0, 0, KEY_HOME, /* 0x40 */
213 KEY_UP, KEY_PAGEUP, 0, KEY_LEFT, 0, KEY_RIGHT, 0, KEY_END, /* 0x48 */
214 KEY_DOWN, KEY_PAGEDOWN, KEY_INSERT, KEY_DELETE, 0, 0, 0, 0, /* 0x50 */
215 0, 0, 0, 0, 0, 0, 0, 0, /* 0x58 */
216 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x60 */
217 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x70 */
220 static int visorinput_open(struct input_dev *visorinput_dev)
222 struct visorinput_devdata *devdata = input_get_drvdata(visorinput_dev);
225 pr_err("%s input_get_drvdata(%p) returned NULL\n",
226 __func__, visorinput_dev);
229 dev_dbg(&visorinput_dev->dev, "%s opened\n", __func__);
230 visorbus_enable_channel_interrupts(devdata->dev);
234 static void visorinput_close(struct input_dev *visorinput_dev)
236 struct visorinput_devdata *devdata = input_get_drvdata(visorinput_dev);
239 pr_err("%s input_get_drvdata(%p) returned NULL\n",
240 __func__, visorinput_dev);
243 dev_dbg(&visorinput_dev->dev, "%s closed\n", __func__);
244 visorbus_disable_channel_interrupts(devdata->dev);
248 * register_client_keyboard() initializes and returns a Linux input node that
249 * we can use to deliver keyboard inputs to Linux. We of course do this when
250 * we see keyboard inputs coming in on a keyboard channel.
252 static struct input_dev *
253 register_client_keyboard(void *devdata, /* opaque on purpose */
254 unsigned char *keycode_table)
258 struct input_dev *visorinput_dev;
260 visorinput_dev = input_allocate_device();
264 visorinput_dev->name = "visor Keyboard";
265 visorinput_dev->phys = "visorkbd:input0";
266 visorinput_dev->id.bustype = BUS_VIRTUAL;
267 visorinput_dev->id.vendor = 0x0001;
268 visorinput_dev->id.product = 0x0001;
269 visorinput_dev->id.version = 0x0100;
271 visorinput_dev->evbit[0] = BIT_MASK(EV_KEY) |
274 visorinput_dev->ledbit[0] = BIT_MASK(LED_CAPSL) |
275 BIT_MASK(LED_SCROLLL) |
277 visorinput_dev->keycode = keycode_table;
278 visorinput_dev->keycodesize = 1; /* sizeof(unsigned char) */
279 visorinput_dev->keycodemax = KEYCODE_TABLE_BYTES;
281 for (i = 1; i < visorinput_dev->keycodemax; i++)
282 set_bit(keycode_table[i], visorinput_dev->keybit);
283 for (i = 1; i < visorinput_dev->keycodemax; i++)
284 set_bit(keycode_table[i + KEYCODE_TABLE_BYTES],
285 visorinput_dev->keybit);
287 visorinput_dev->open = visorinput_open;
288 visorinput_dev->close = visorinput_close;
289 input_set_drvdata(visorinput_dev, devdata); /* pre input_register! */
291 error = input_register_device(visorinput_dev);
293 input_free_device(visorinput_dev);
296 return visorinput_dev;
299 static struct input_dev *
300 register_client_mouse(void *devdata /* opaque on purpose */)
303 struct input_dev *visorinput_dev = NULL;
307 visorinput_dev = input_allocate_device();
311 visorinput_dev->name = "visor Mouse";
312 visorinput_dev->phys = "visormou:input0";
313 visorinput_dev->id.bustype = BUS_VIRTUAL;
314 visorinput_dev->id.vendor = 0x0001;
315 visorinput_dev->id.product = 0x0002;
316 visorinput_dev->id.version = 0x0100;
318 visorinput_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
319 set_bit(BTN_LEFT, visorinput_dev->keybit);
320 set_bit(BTN_RIGHT, visorinput_dev->keybit);
321 set_bit(BTN_MIDDLE, visorinput_dev->keybit);
323 if (registered_fb[0]) {
324 fb0 = registered_fb[0];
325 xres = fb0->var.xres_virtual;
326 yres = fb0->var.yres_virtual;
328 xres = PIXELS_ACROSS_DEFAULT;
329 yres = PIXELS_DOWN_DEFAULT;
331 input_set_abs_params(visorinput_dev, ABS_X, 0, xres, 0, 0);
332 input_set_abs_params(visorinput_dev, ABS_Y, 0, yres, 0, 0);
334 visorinput_dev->open = visorinput_open;
335 visorinput_dev->close = visorinput_close;
336 input_set_drvdata(visorinput_dev, devdata); /* pre input_register! */
338 error = input_register_device(visorinput_dev);
340 input_free_device(visorinput_dev);
344 input_set_capability(visorinput_dev, EV_REL, REL_WHEEL);
346 return visorinput_dev;
349 static struct visorinput_devdata *
350 devdata_create(struct visor_device *dev, enum visorinput_device_type devtype)
352 struct visorinput_devdata *devdata = NULL;
353 unsigned int extra_bytes = 0;
355 if (devtype == visorinput_keyboard)
356 /* allocate room for devdata->keycode_table, filled in below */
357 extra_bytes = KEYCODE_TABLE_BYTES * 2;
358 devdata = kzalloc(sizeof(*devdata) + extra_bytes, GFP_KERNEL);
364 * This is an input device in a client guest partition,
365 * so we need to create whatever input nodes are necessary to
366 * deliver our inputs to the guest OS.
369 case visorinput_keyboard:
370 devdata->keycode_table_bytes = extra_bytes;
371 memcpy(devdata->keycode_table, visorkbd_keycode,
372 KEYCODE_TABLE_BYTES);
373 memcpy(devdata->keycode_table + KEYCODE_TABLE_BYTES,
374 visorkbd_ext_keycode, KEYCODE_TABLE_BYTES);
375 devdata->visorinput_dev = register_client_keyboard
376 (devdata, devdata->keycode_table);
377 if (!devdata->visorinput_dev)
378 goto cleanups_register;
380 case visorinput_mouse:
381 devdata->visorinput_dev = register_client_mouse(devdata);
382 if (!devdata->visorinput_dev)
383 goto cleanups_register;
387 init_rwsem(&devdata->lock_visor_dev);
397 visorinput_probe(struct visor_device *dev)
399 struct visorinput_devdata *devdata = NULL;
401 enum visorinput_device_type devtype;
403 guid = visorchannel_get_uuid(dev->visorchannel);
404 if (uuid_le_cmp(guid, spar_mouse_channel_protocol_uuid) == 0)
405 devtype = visorinput_mouse;
406 else if (uuid_le_cmp(guid, spar_keyboard_channel_protocol_uuid) == 0)
407 devtype = visorinput_keyboard;
410 devdata = devdata_create(dev, devtype);
413 dev_set_drvdata(&dev->device, devdata);
418 unregister_client_input(struct input_dev *visorinput_dev)
421 input_unregister_device(visorinput_dev);
425 visorinput_remove(struct visor_device *dev)
427 struct visorinput_devdata *devdata = dev_get_drvdata(&dev->device);
432 visorbus_disable_channel_interrupts(dev);
435 * due to above, at this time no thread of execution will be
436 * in visorinput_channel_interrupt()
439 down_write(&devdata->lock_visor_dev);
440 dev_set_drvdata(&dev->device, NULL);
441 unregister_client_input(devdata->visorinput_dev);
442 up_write(&devdata->lock_visor_dev);
447 * Make it so the current locking state of the locking key indicated by
448 * <keycode> is as indicated by <desired_state> (1=locked, 0=unlocked).
451 handle_locking_key(struct input_dev *visorinput_dev,
452 int keycode, int desired_state)
471 int old_state = (test_bit(led, visorinput_dev->led) != 0);
473 if (old_state != desired_state) {
474 input_report_key(visorinput_dev, keycode, 1);
475 input_sync(visorinput_dev);
476 input_report_key(visorinput_dev, keycode, 0);
477 input_sync(visorinput_dev);
478 __change_bit(led, visorinput_dev->led);
484 * <scancode> is either a 1-byte scancode, or an extended 16-bit scancode
485 * with 0xE0 in the low byte and the extended scancode value in the next
489 scancode_to_keycode(int scancode)
494 keycode = visorkbd_ext_keycode[(scancode >> 8) & 0xff];
496 keycode = visorkbd_keycode[scancode];
516 * This is used only when this driver is active as an input driver in the
517 * client guest partition. It is called periodically so we can obtain inputs
518 * from the channel, and deliver them to the guest OS.
521 visorinput_channel_interrupt(struct visor_device *dev)
523 struct ultra_inputreport r;
524 int scancode, keycode;
525 struct input_dev *visorinput_dev;
526 int xmotion, ymotion, zmotion, button;
529 struct visorinput_devdata *devdata = dev_get_drvdata(&dev->device);
534 down_write(&devdata->lock_visor_dev);
535 if (devdata->paused) /* don't touch device/channel when paused */
538 visorinput_dev = devdata->visorinput_dev;
542 while (visorchannel_signalremove(dev->visorchannel, 0, &r)) {
543 scancode = r.activity.arg1;
544 keycode = scancode_to_keycode(scancode);
545 switch (r.activity.action) {
546 case inputaction_key_down:
547 input_report_key(visorinput_dev, keycode, 1);
548 input_sync(visorinput_dev);
550 case inputaction_key_up:
551 input_report_key(visorinput_dev, keycode, 0);
552 input_sync(visorinput_dev);
554 case inputaction_key_down_up:
555 input_report_key(visorinput_dev, keycode, 1);
556 input_sync(visorinput_dev);
557 input_report_key(visorinput_dev, keycode, 0);
558 input_sync(visorinput_dev);
560 case inputaction_set_locking_key_state:
561 handle_locking_key(visorinput_dev, keycode,
564 case inputaction_xy_motion:
565 xmotion = r.activity.arg1;
566 ymotion = r.activity.arg2;
567 input_report_abs(visorinput_dev, ABS_X, xmotion);
568 input_report_abs(visorinput_dev, ABS_Y, ymotion);
569 input_sync(visorinput_dev);
571 case inputaction_mouse_button_down:
572 button = calc_button(r.activity.arg1);
575 input_report_key(visorinput_dev, button, 1);
576 input_sync(visorinput_dev);
578 case inputaction_mouse_button_up:
579 button = calc_button(r.activity.arg1);
582 input_report_key(visorinput_dev, button, 0);
583 input_sync(visorinput_dev);
585 case inputaction_mouse_button_click:
586 button = calc_button(r.activity.arg1);
589 input_report_key(visorinput_dev, button, 1);
591 input_sync(visorinput_dev);
592 input_report_key(visorinput_dev, button, 0);
593 input_sync(visorinput_dev);
595 case inputaction_mouse_button_dclick:
596 button = calc_button(r.activity.arg1);
599 for (i = 0; i < 2; i++) {
600 input_report_key(visorinput_dev, button, 1);
601 input_sync(visorinput_dev);
602 input_report_key(visorinput_dev, button, 0);
603 input_sync(visorinput_dev);
606 case inputaction_wheel_rotate_away:
607 zmotion = r.activity.arg1;
608 input_report_rel(visorinput_dev, REL_WHEEL, 1);
609 input_sync(visorinput_dev);
611 case inputaction_wheel_rotate_toward:
612 zmotion = r.activity.arg1;
613 input_report_rel(visorinput_dev, REL_WHEEL, -1);
614 input_sync(visorinput_dev);
619 up_write(&devdata->lock_visor_dev);
623 visorinput_pause(struct visor_device *dev,
624 visorbus_state_complete_func complete_func)
627 struct visorinput_devdata *devdata = dev_get_drvdata(&dev->device);
634 down_write(&devdata->lock_visor_dev);
635 if (devdata->paused) {
639 devdata->paused = true;
640 complete_func(dev, 0);
643 up_write(&devdata->lock_visor_dev);
649 visorinput_resume(struct visor_device *dev,
650 visorbus_state_complete_func complete_func)
653 struct visorinput_devdata *devdata = dev_get_drvdata(&dev->device);
659 down_write(&devdata->lock_visor_dev);
660 if (!devdata->paused) {
664 devdata->paused = false;
665 complete_func(dev, 0);
668 up_write(&devdata->lock_visor_dev);
673 /* GUIDS for all channel types supported by this driver. */
674 static struct visor_channeltype_descriptor visorinput_channel_types[] = {
675 { SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID, "keyboard"},
676 { SPAR_MOUSE_CHANNEL_PROTOCOL_UUID, "mouse"},
677 { NULL_UUID_LE, NULL }
680 static struct visor_driver visorinput_driver = {
681 .name = "visorinput",
683 .owner = THIS_MODULE,
684 .channel_types = visorinput_channel_types,
685 .probe = visorinput_probe,
686 .remove = visorinput_remove,
687 .channel_interrupt = visorinput_channel_interrupt,
688 .pause = visorinput_pause,
689 .resume = visorinput_resume,
693 visorinput_init(void)
695 return visorbus_register_visor_driver(&visorinput_driver);
699 visorinput_cleanup(void)
701 visorbus_unregister_visor_driver(&visorinput_driver);
704 module_init(visorinput_init);
705 module_exit(visorinput_cleanup);
707 MODULE_DEVICE_TABLE(visorbus, visorinput_channel_types);
709 MODULE_AUTHOR("Unisys");
710 MODULE_LICENSE("GPL");
711 MODULE_DESCRIPTION("s-Par human input driver for guest Linux");
712 MODULE_VERSION(VERSION);
714 MODULE_ALIAS("visorbus:" SPAR_MOUSE_CHANNEL_PROTOCOL_UUID_STR);
715 MODULE_ALIAS("visorbus:" SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID_STR);