1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
|
/* visorhid.c
*
* Copyright (C) 2011 - 2015 UNISYS CORPORATION
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License,
* version 2, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
* NON INFRINGEMENT. See the GNU General Public License for more
* details.
*/
/* This driver lives in a generic guest Linux partition, and registers to
* receive keyboard and mouse channels from the visorbus driver. It reads
* inputs from such channels, and delivers it to the Linux OS in the
* standard way the Linux expects for input drivers.
*/
#include <linux/buffer_head.h>
#include <linux/fb.h>
#include <linux/fs.h>
#include <linux/input.h>
#include <linux/uaccess.h>
#include "keyboardchannel.h"
#include "mousechannel.h"
#include "version.h"
#include "visorbus.h"
#define PIXELS_ACROSS_DEFAULT 800
#define PIXELS_DOWN_DEFAULT 600
static const uuid_le spar_keyboard_channel_protocol_uuid =
SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID;
static const uuid_le spar_mouse_channel_protocol_uuid =
SPAR_MOUSE_CHANNEL_PROTOCOL_UUID;
static int visorhid_probe(struct visor_device *dev);
static void visorhid_remove(struct visor_device *dev);
static void visorhid_channel_interrupt(struct visor_device *dev);
static int visorhid_pause(struct visor_device *dev,
visorbus_state_complete_func complete_func);
static int visorhid_resume(struct visor_device *dev,
visorbus_state_complete_func complete_func);
static struct input_dev *register_client_keyboard(void);
static struct input_dev *register_client_mouse(void);
static void unregister_client_input(struct input_dev *visorinput_dev);
/* GUIDS for all channel types supported by this driver. */
static struct visor_channeltype_descriptor visorhid_channel_types[] = {
{ SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID, "keyboard"},
{ SPAR_MOUSE_CHANNEL_PROTOCOL_UUID, "mouse"},
{ NULL_UUID_LE, NULL }
};
MODULE_DEVICE_TABLE(visorbus, visorhid_channel_types);
MODULE_ALIAS("visorbus:" SPAR_MOUSE_CHANNEL_PROTOCOL_UUID_STR);
MODULE_ALIAS("visorbus:" SPAR_KEYBOARD_CHANNEL_PROTOCOL_UUID_STR);
/** This is used to tell the visor bus driver which types of visor devices
* we support, and what functions to call when a visor device that we support
* is attached or removed.
*/
static struct visor_driver visorhid_driver = {
.name = "visorhid",
.vertag = NULL,
.owner = THIS_MODULE,
.channel_types = visorhid_channel_types,
.probe = visorhid_probe,
.remove = visorhid_remove,
.channel_interrupt = visorhid_channel_interrupt,
.pause = visorhid_pause,
.resume = visorhid_resume,
};
enum visorhid_device_type {
visorhid_keyboard,
visorhid_mouse,
};
/* This is the private data that we store for each device.
* A pointer to this struct is maintained via
* dev_get_drvdata() / dev_set_drvdata() for each struct device.
*/
struct visorhid_devdata {
struct visor_device *dev;
/** lock for dev */
struct rw_semaphore lock_visor_dev;
struct input_dev *visorinput_dev;
bool paused;
};
/* Borrowed from drivers/input/keyboard/atakbd.c */
/* This maps 1-byte scancodes to keycodes. */
static unsigned char visorkbd_keycode[256] = { /* American layout */
[0] = KEY_GRAVE,
[1] = KEY_ESC,
[2] = KEY_1,
[3] = KEY_2,
[4] = KEY_3,
[5] = KEY_4,
[6] = KEY_5,
[7] = KEY_6,
[8] = KEY_7,
[9] = KEY_8,
[10] = KEY_9,
[11] = KEY_0,
[12] = KEY_MINUS,
[13] = KEY_EQUAL,
[14] = KEY_BACKSPACE,
[15] = KEY_TAB,
[16] = KEY_Q,
[17] = KEY_W,
[18] = KEY_E,
[19] = KEY_R,
[20] = KEY_T,
[21] = KEY_Y,
[22] = KEY_U,
[23] = KEY_I,
[24] = KEY_O,
[25] = KEY_P,
[26] = KEY_LEFTBRACE,
[27] = KEY_RIGHTBRACE,
[28] = KEY_ENTER,
[29] = KEY_LEFTCTRL,
[30] = KEY_A,
[31] = KEY_S,
[32] = KEY_D,
[33] = KEY_F,
[34] = KEY_G,
[35] = KEY_H,
[36] = KEY_J,
[37] = KEY_K,
[38] = KEY_L,
[39] = KEY_SEMICOLON,
[40] = KEY_APOSTROPHE,
[41] = KEY_GRAVE, /* FIXME, '#' */
[42] = KEY_LEFTSHIFT,
[43] = KEY_BACKSLASH, /* FIXME, '~' */
[44] = KEY_Z,
[45] = KEY_X,
[46] = KEY_C,
[47] = KEY_V,
[48] = KEY_B,
[49] = KEY_N,
[50] = KEY_M,
[51] = KEY_COMMA,
[52] = KEY_DOT,
[53] = KEY_SLASH,
[54] = KEY_RIGHTSHIFT,
[55] = KEY_KPASTERISK,
[56] = KEY_LEFTALT,
[57] = KEY_SPACE,
[58] = KEY_CAPSLOCK,
[59] = KEY_F1,
[60] = KEY_F2,
[61] = KEY_F3,
[62] = KEY_F4,
[63] = KEY_F5,
[64] = KEY_F6,
[65] = KEY_F7,
[66] = KEY_F8,
[67] = KEY_F9,
[68] = KEY_F10,
[69] = KEY_NUMLOCK,
[70] = KEY_SCROLLLOCK,
[71] = KEY_KP7,
[72] = KEY_KP8,
[73] = KEY_KP9,
[74] = KEY_KPMINUS,
[75] = KEY_KP4,
[76] = KEY_KP5,
[77] = KEY_KP6,
[78] = KEY_KPPLUS,
[79] = KEY_KP1,
[80] = KEY_KP2,
[81] = KEY_KP3,
[82] = KEY_KP0,
[83] = KEY_KPDOT,
[86] = KEY_102ND, /* enables UK backslash+pipe key,
* and FR lessthan+greaterthan key */
[87] = KEY_F11,
[88] = KEY_F12,
[90] = KEY_KPLEFTPAREN,
[91] = KEY_KPRIGHTPAREN,
[92] = KEY_KPASTERISK, /* FIXME */
[93] = KEY_KPASTERISK,
[94] = KEY_KPPLUS,
[95] = KEY_HELP,
[96] = KEY_KPENTER,
[97] = KEY_RIGHTCTRL,
[98] = KEY_KPSLASH,
[99] = KEY_KPLEFTPAREN,
[100] = KEY_KPRIGHTPAREN,
[101] = KEY_KPSLASH,
[102] = KEY_HOME,
[103] = KEY_UP,
[104] = KEY_PAGEUP,
[105] = KEY_LEFT,
[106] = KEY_RIGHT,
[107] = KEY_END,
[108] = KEY_DOWN,
[109] = KEY_PAGEDOWN,
[110] = KEY_INSERT,
[111] = KEY_DELETE,
[112] = KEY_MACRO,
[113] = KEY_MUTE
};
/* This maps the <xx> in extended scancodes of the form "0xE0 <xx>" into
* keycodes.
*/
static unsigned char visorkbd_ext_keycode[256] = {
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00 */
0, 0, 0, 0, 0, 0, 0, 0, /* 0x10 */
0, 0, 0, 0, KEY_KPENTER, KEY_RIGHTCTRL, 0, 0, /* 0x18 */
0, 0, 0, 0, 0, 0, 0, 0, /* 0x20 */
KEY_RIGHTALT, 0, 0, 0, 0, 0, 0, 0, /* 0x28 */
0, 0, 0, 0, 0, 0, 0, 0, /* 0x30 */
KEY_RIGHTALT /* AltGr */, 0, 0, 0, 0, 0, 0, 0, /* 0x38 */
0, 0, 0, 0, 0, 0, 0, KEY_HOME, /* 0x40 */
KEY_UP, KEY_PAGEUP, 0, KEY_LEFT, 0, KEY_RIGHT, 0, KEY_END, /* 0x48 */
KEY_DOWN, KEY_PAGEDOWN, KEY_INSERT, KEY_DELETE, 0, 0, 0, 0, /* 0x50 */
0, 0, 0, 0, 0, 0, 0, 0, /* 0x58 */
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x60 */
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x70 */
};
static struct visorhid_devdata *
devdata_create(struct visor_device *dev, enum visorhid_device_type devtype)
{
struct visorhid_devdata *devdata = NULL;
devdata = kzalloc(sizeof(*devdata), GFP_KERNEL);
if (!devdata)
return NULL;
devdata->dev = dev;
/* This is an input device in a client guest partition,
* so we need to create whatever gizmos are necessary to
* deliver our inputs to the guest OS.
*/
switch (devtype) {
case visorhid_keyboard:
devdata->visorinput_dev = register_client_keyboard();
if (!devdata->visorinput_dev)
goto cleanups_register;
break;
case visorhid_mouse:
devdata->visorinput_dev = register_client_mouse();
if (!devdata->visorinput_dev)
goto cleanups_register;
break;
}
init_rwsem(&devdata->lock_visor_dev);
return devdata;
cleanups_register:
kfree(devdata);
return NULL;
}
static int
visorhid_probe(struct visor_device *dev)
{
struct visorhid_devdata *devdata = NULL;
uuid_le guid;
enum visorhid_device_type devtype;
guid = visorchannel_get_uuid(dev->visorchannel);
if (uuid_le_cmp(guid, spar_mouse_channel_protocol_uuid) == 0)
devtype = visorhid_mouse;
else if (uuid_le_cmp(guid, spar_keyboard_channel_protocol_uuid) == 0)
devtype = visorhid_keyboard;
else
return -ENODEV;
devdata = devdata_create(dev, devtype);
if (!devdata)
return -ENOMEM;
dev_set_drvdata(&dev->device, devdata);
visorbus_enable_channel_interrupts(dev);
return 0;
}
static void
visorhid_remove(struct visor_device *dev)
{
struct visorhid_devdata *devdata = dev_get_drvdata(&dev->device);
if (!devdata)
return;
visorbus_disable_channel_interrupts(dev);
/* due to above, at this time no thread of execution will be
* in visorhid_channel_interrupt()
*/
down_write(&devdata->lock_visor_dev);
dev_set_drvdata(&dev->device, NULL);
unregister_client_input(devdata->visorinput_dev);
up_write(&devdata->lock_visor_dev);
kfree(devdata);
}
static void
unregister_client_input(struct input_dev *visorinput_dev)
{
if (visorinput_dev)
input_unregister_device(visorinput_dev);
}
/* register_client_keyboard() initializes and returns a Linux gizmo that we
* can use to deliver keyboard inputs to Linux. We of course do this when
* we see keyboard inputs coming in on a keyboard channel.
*/
static struct input_dev *
register_client_keyboard(void)
{
int i, error;
struct input_dev *visorinput_dev = NULL;
visorinput_dev = input_allocate_device();
if (!visorinput_dev)
return NULL;
visorinput_dev->name = "visor Keyboard";
visorinput_dev->phys = "visorkbd:input0";
visorinput_dev->id.bustype = BUS_HOST;
visorinput_dev->id.vendor = 0x0001;
visorinput_dev->id.product = 0x0001;
visorinput_dev->id.version = 0x0100;
visorinput_dev->evbit[0] = BIT_MASK(EV_KEY) |
BIT_MASK(EV_REP) |
BIT_MASK(EV_LED);
visorinput_dev->ledbit[0] = BIT_MASK(LED_CAPSL) |
BIT_MASK(LED_SCROLLL) |
BIT_MASK(LED_NUML);
visorinput_dev->keycode = visorkbd_keycode;
visorinput_dev->keycodesize = sizeof(unsigned char);
visorinput_dev->keycodemax = ARRAY_SIZE(visorkbd_keycode);
for (i = 1; i < ARRAY_SIZE(visorkbd_keycode); i++)
set_bit(visorkbd_keycode[i], visorinput_dev->keybit);
for (i = 1; i < ARRAY_SIZE(visorkbd_ext_keycode); i++)
set_bit(visorkbd_ext_keycode[i], visorinput_dev->keybit);
error = input_register_device(visorinput_dev);
if (error) {
input_free_device(visorinput_dev);
return NULL;
}
return visorinput_dev;
}
static struct input_dev *
register_client_mouse(void)
{
int error;
struct input_dev *visorinput_dev = NULL;
int xres, yres;
struct fb_info *fb0;
visorinput_dev = input_allocate_device();
if (!visorinput_dev)
return NULL;
visorinput_dev->name = "visor Mouse";
visorinput_dev->phys = "visormou:input0";
visorinput_dev->id.bustype = BUS_HOST;
visorinput_dev->id.vendor = 0x0001;
visorinput_dev->id.product = 0x0002;
visorinput_dev->id.version = 0x0100;
visorinput_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
set_bit(BTN_LEFT, visorinput_dev->keybit);
set_bit(BTN_RIGHT, visorinput_dev->keybit);
set_bit(BTN_MIDDLE, visorinput_dev->keybit);
if (registered_fb[0]) {
fb0 = registered_fb[0];
xres = fb0->var.xres_virtual;
yres = fb0->var.yres_virtual;
} else {
xres = PIXELS_ACROSS_DEFAULT;
yres = PIXELS_DOWN_DEFAULT;
}
input_set_abs_params(visorinput_dev, ABS_X, 0, xres, 0, 0);
input_set_abs_params(visorinput_dev, ABS_Y, 0, yres, 0, 0);
error = input_register_device(visorinput_dev);
if (error) {
input_free_device(visorinput_dev);
return NULL;
}
/* Sending top-left and bottom-right positions is ABSOLUTELY
* REQUIRED if we want X to move the mouse to the exact points
* we tell it. I have NO IDEA why.
*/
input_report_abs(visorinput_dev, ABS_X, 0);
input_report_abs(visorinput_dev, ABS_Y, 0);
input_sync(visorinput_dev);
input_report_abs(visorinput_dev, ABS_X, xres - 1);
input_report_abs(visorinput_dev, ABS_Y, yres - 1);
input_sync(visorinput_dev);
input_set_capability(visorinput_dev, EV_REL, REL_WHEEL);
return visorinput_dev;
}
static void
do_key(struct input_dev *inpt, int keycode, int down)
{
input_report_key(inpt, keycode, down);
}
/* Make it so the current locking state of the locking key indicated by
* <keycode> is as indicated by <desired_state> (1=locked, 0=unlocked).
*/
static void
handle_locking_key(struct input_dev *visorinput_dev,
int keycode, int desired_state)
{
int led;
char *sled;
switch (keycode) {
case KEY_CAPSLOCK:
led = LED_CAPSL;
sled = "CAP";
break;
case KEY_SCROLLLOCK:
led = LED_SCROLLL;
sled = "SCR";
break;
case KEY_NUMLOCK:
led = LED_NUML;
sled = "NUM";
break;
default:
led = -1;
break;
}
if (led >= 0) {
int old_state = (test_bit(led, visorinput_dev->led) != 0);
if (old_state != desired_state) {
do_key(visorinput_dev, keycode, 1);
input_sync(visorinput_dev);
do_key(visorinput_dev, keycode, 0);
input_sync(visorinput_dev);
__change_bit(led, visorinput_dev->led);
}
}
}
/* <scancode> is either a 1-byte scancode, or an extended 16-bit scancode
* with 0xE0 in the low byte and the extended scancode value in the next
* higher byte.
*/
static int
scancode_to_keycode(int scancode)
{
int keycode;
if (scancode > 0xff)
keycode = visorkbd_ext_keycode[(scancode >> 8) & 0xff];
else
keycode = visorkbd_keycode[scancode];
return keycode;
}
static int
calc_button(int x)
{
switch (x) {
case 1:
return BTN_LEFT;
case 2:
return BTN_MIDDLE;
case 3:
return BTN_RIGHT;
default:
return -1;
}
}
/* This is used only when this driver is active as an input driver in the
* client guest partition. It is called periodically so we can obtain inputs
* from the channel, and deliver them to the guest OS.
*/
static void
visorhid_channel_interrupt(struct visor_device *dev)
{
struct ultra_inputreport r;
int scancode, keycode;
struct input_dev *visorinput_dev;
int xmotion, ymotion, zmotion, button;
int i;
struct visorhid_devdata *devdata = dev_get_drvdata(&dev->device);
if (!devdata)
return;
down_write(&devdata->lock_visor_dev);
if (devdata->paused) /* don't touch device/channel when paused */
goto out_locked;
visorinput_dev = devdata->visorinput_dev;
if (!visorinput_dev)
goto out_locked;
while (visorchannel_signalremove(dev->visorchannel, 0, &r)) {
scancode = r.activity.arg1;
keycode = scancode_to_keycode(scancode);
switch (r.activity.action) {
case inputaction_key_down:
do_key(visorinput_dev, keycode, 1);
input_sync(visorinput_dev);
break;
case inputaction_key_up:
do_key(visorinput_dev, keycode, 0);
input_sync(visorinput_dev);
break;
case inputaction_key_down_up:
do_key(visorinput_dev, keycode, 1);
input_sync(visorinput_dev);
do_key(visorinput_dev, keycode, 0);
input_sync(visorinput_dev);
break;
case inputaction_set_locking_key_state:
handle_locking_key(visorinput_dev, keycode,
r.activity.arg2);
break;
case inputaction_xy_motion:
xmotion = r.activity.arg1;
ymotion = r.activity.arg2;
input_report_abs(visorinput_dev, ABS_X, xmotion);
input_report_abs(visorinput_dev, ABS_Y, ymotion);
input_sync(visorinput_dev);
break;
case inputaction_mouse_button_down:
button = calc_button(r.activity.arg1);
if (button < 0)
break;
input_report_key(visorinput_dev, button, 1);
input_sync(visorinput_dev);
break;
case inputaction_mouse_button_up:
button = calc_button(r.activity.arg1);
if (button < 0)
break;
input_report_key(visorinput_dev, button, 0);
input_sync(visorinput_dev);
break;
case inputaction_mouse_button_click:
button = calc_button(r.activity.arg1);
if (button < 0)
break;
input_report_key(visorinput_dev, button, 1);
input_sync(visorinput_dev);
input_report_key(visorinput_dev, button, 0);
input_sync(visorinput_dev);
break;
case inputaction_mouse_button_dclick:
button = calc_button(r.activity.arg1);
if (button < 0)
break;
for (i = 0; i < 2; i++) {
input_report_key(visorinput_dev, button, 1);
input_sync(visorinput_dev);
input_report_key(visorinput_dev, button, 0);
input_sync(visorinput_dev);
}
break;
case inputaction_wheel_rotate_away:
zmotion = r.activity.arg1;
input_report_rel(visorinput_dev, REL_WHEEL, 1);
input_sync(visorinput_dev);
break;
case inputaction_wheel_rotate_toward:
zmotion = r.activity.arg1;
input_report_rel(visorinput_dev, REL_WHEEL, -1);
input_sync(visorinput_dev);
break;
}
}
out_locked:
up_write(&devdata->lock_visor_dev);
}
static int
visorhid_pause(struct visor_device *dev,
visorbus_state_complete_func complete_func)
{
int rc;
struct visorhid_devdata *devdata = dev_get_drvdata(&dev->device);
if (!devdata) {
rc = -ENODEV;
goto out;
}
down_write(&devdata->lock_visor_dev);
if (devdata->paused) {
rc = -EBUSY;
goto out_locked;
}
devdata->paused = true;
complete_func(dev, 0);
rc = 0;
out_locked:
up_write(&devdata->lock_visor_dev);
out:
return rc;
}
static int
visorhid_resume(struct visor_device *dev,
visorbus_state_complete_func complete_func)
{
int rc;
struct visorhid_devdata *devdata = dev_get_drvdata(&dev->device);
if (!devdata) {
rc = -ENODEV;
goto out;
}
down_write(&devdata->lock_visor_dev);
if (!devdata->paused) {
rc = -EBUSY;
goto out_locked;
}
devdata->paused = false;
complete_func(dev, 0);
rc = 0;
out_locked:
up_write(&devdata->lock_visor_dev);
out:
return rc;
}
static int
visorhid_init(void)
{
return visorbus_register_visor_driver(&visorhid_driver);
}
static void
visorhid_cleanup(void)
{
visorbus_unregister_visor_driver(&visorhid_driver);
}
module_init(visorhid_init);
module_exit(visorhid_cleanup);
MODULE_AUTHOR("Unisys");
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("s-Par human input driver for guest Linux");
MODULE_VERSION(VERSION);
|