blob: 62bae99424e6e436defda3723654816c44be2609 [file] [log] [blame]
Markus Armbruster4ee36dc2008-04-02 10:54:07 -07001/*
2 * Xen para-virtual input device
3 *
4 * Copyright (C) 2005 Anthony Liguori <aliguori@us.ibm.com>
5 * Copyright (C) 2006-2008 Red Hat, Inc., Markus Armbruster <armbru@redhat.com>
6 *
7 * Based on linux/drivers/input/mouse/sermouse.c
8 *
9 * This file is subject to the terms and conditions of the GNU General Public
10 * License. See the file COPYING in the main directory of this archive for
11 * more details.
12 */
13
Joe Perchesda0c4902010-11-29 23:33:07 -080014#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070016#include <linux/kernel.h>
17#include <linux/errno.h>
18#include <linux/module.h>
19#include <linux/input.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Jeremy Fitzhardinge1ccbf532009-10-06 15:11:14 -070021
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070022#include <asm/xen/hypervisor.h>
Jeremy Fitzhardinge1ccbf532009-10-06 15:11:14 -070023
24#include <xen/xen.h>
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070025#include <xen/events.h>
26#include <xen/page.h>
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -070027#include <xen/grant_table.h>
28#include <xen/interface/grant_table.h>
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070029#include <xen/interface/io/fbif.h>
30#include <xen/interface/io/kbdif.h>
31#include <xen/xenbus.h>
32
33struct xenkbd_info {
34 struct input_dev *kbd;
35 struct input_dev *ptr;
36 struct xenkbd_page *page;
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -070037 int gref;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070038 int irq;
39 struct xenbus_device *xbdev;
40 char phys[32];
41};
42
43static int xenkbd_remove(struct xenbus_device *);
44static int xenkbd_connect_backend(struct xenbus_device *, struct xenkbd_info *);
45static void xenkbd_disconnect_backend(struct xenkbd_info *);
46
47/*
48 * Note: if you need to send out events, see xenfb_do_update() for how
49 * to do that.
50 */
51
52static irqreturn_t input_handler(int rq, void *dev_id)
53{
54 struct xenkbd_info *info = dev_id;
55 struct xenkbd_page *page = info->page;
56 __u32 cons, prod;
57
58 prod = page->in_prod;
59 if (prod == page->in_cons)
60 return IRQ_HANDLED;
61 rmb(); /* ensure we see ring contents up to prod */
62 for (cons = page->in_cons; cons != prod; cons++) {
63 union xenkbd_in_event *event;
64 struct input_dev *dev;
65 event = &XENKBD_IN_RING_REF(page, cons);
66
67 dev = info->ptr;
68 switch (event->type) {
69 case XENKBD_TYPE_MOTION:
70 input_report_rel(dev, REL_X, event->motion.rel_x);
71 input_report_rel(dev, REL_Y, event->motion.rel_y);
Markus Armbruster6ba0e7b2008-05-26 23:31:08 +010072 if (event->motion.rel_z)
73 input_report_rel(dev, REL_WHEEL,
74 -event->motion.rel_z);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070075 break;
76 case XENKBD_TYPE_KEY:
77 dev = NULL;
78 if (test_bit(event->key.keycode, info->kbd->keybit))
79 dev = info->kbd;
80 if (test_bit(event->key.keycode, info->ptr->keybit))
81 dev = info->ptr;
82 if (dev)
83 input_report_key(dev, event->key.keycode,
84 event->key.pressed);
85 else
Joe Perchesda0c4902010-11-29 23:33:07 -080086 pr_warning("unhandled keycode 0x%x\n",
87 event->key.keycode);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070088 break;
89 case XENKBD_TYPE_POS:
90 input_report_abs(dev, ABS_X, event->pos.abs_x);
91 input_report_abs(dev, ABS_Y, event->pos.abs_y);
Markus Armbruster6ba0e7b2008-05-26 23:31:08 +010092 if (event->pos.rel_z)
93 input_report_rel(dev, REL_WHEEL,
94 -event->pos.rel_z);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -070095 break;
96 }
97 if (dev)
98 input_sync(dev);
99 }
100 mb(); /* ensure we got ring contents */
101 page->in_cons = cons;
102 notify_remote_via_irq(info->irq);
103
104 return IRQ_HANDLED;
105}
106
107static int __devinit xenkbd_probe(struct xenbus_device *dev,
108 const struct xenbus_device_id *id)
109{
Olaf Hering8c3c2832011-03-16 22:11:46 -0700110 int ret, i, abs;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700111 struct xenkbd_info *info;
112 struct input_dev *kbd, *ptr;
113
114 info = kzalloc(sizeof(*info), GFP_KERNEL);
115 if (!info) {
116 xenbus_dev_fatal(dev, -ENOMEM, "allocating info structure");
117 return -ENOMEM;
118 }
Greg Kroah-Hartman1b713e02009-05-04 12:40:54 -0700119 dev_set_drvdata(&dev->dev, info);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700120 info->xbdev = dev;
121 info->irq = -1;
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700122 info->gref = -1;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700123 snprintf(info->phys, sizeof(info->phys), "xenbus/%s", dev->nodename);
124
125 info->page = (void *)__get_free_page(GFP_KERNEL | __GFP_ZERO);
126 if (!info->page)
127 goto error_nomem;
128
Olaf Hering8c3c2832011-03-16 22:11:46 -0700129 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-abs-pointer", "%d", &abs) < 0)
130 abs = 0;
131 if (abs)
132 xenbus_printf(XBT_NIL, dev->nodename, "request-abs-pointer", "1");
133
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700134 /* keyboard */
135 kbd = input_allocate_device();
136 if (!kbd)
137 goto error_nomem;
138 kbd->name = "Xen Virtual Keyboard";
139 kbd->phys = info->phys;
140 kbd->id.bustype = BUS_PCI;
141 kbd->id.vendor = 0x5853;
142 kbd->id.product = 0xffff;
Olaf Hering8c3c2832011-03-16 22:11:46 -0700143
144 __set_bit(EV_KEY, kbd->evbit);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700145 for (i = KEY_ESC; i < KEY_UNKNOWN; i++)
Olaf Hering8c3c2832011-03-16 22:11:46 -0700146 __set_bit(i, kbd->keybit);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700147 for (i = KEY_OK; i < KEY_MAX; i++)
Olaf Hering8c3c2832011-03-16 22:11:46 -0700148 __set_bit(i, kbd->keybit);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700149
150 ret = input_register_device(kbd);
151 if (ret) {
152 input_free_device(kbd);
153 xenbus_dev_fatal(dev, ret, "input_register_device(kbd)");
154 goto error;
155 }
156 info->kbd = kbd;
157
158 /* pointing device */
159 ptr = input_allocate_device();
160 if (!ptr)
161 goto error_nomem;
162 ptr->name = "Xen Virtual Pointer";
163 ptr->phys = info->phys;
164 ptr->id.bustype = BUS_PCI;
165 ptr->id.vendor = 0x5853;
166 ptr->id.product = 0xfffe;
Olaf Hering8c3c2832011-03-16 22:11:46 -0700167
168 if (abs) {
169 __set_bit(EV_ABS, ptr->evbit);
170 input_set_abs_params(ptr, ABS_X, 0, XENFB_WIDTH, 0, 0);
171 input_set_abs_params(ptr, ABS_Y, 0, XENFB_HEIGHT, 0, 0);
172 } else {
173 input_set_capability(ptr, EV_REL, REL_X);
174 input_set_capability(ptr, EV_REL, REL_Y);
175 }
176 input_set_capability(ptr, EV_REL, REL_WHEEL);
177
178 __set_bit(EV_KEY, ptr->evbit);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700179 for (i = BTN_LEFT; i <= BTN_TASK; i++)
Olaf Hering8c3c2832011-03-16 22:11:46 -0700180 __set_bit(i, ptr->keybit);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700181
182 ret = input_register_device(ptr);
183 if (ret) {
184 input_free_device(ptr);
185 xenbus_dev_fatal(dev, ret, "input_register_device(ptr)");
186 goto error;
187 }
188 info->ptr = ptr;
189
190 ret = xenkbd_connect_backend(dev, info);
191 if (ret < 0)
192 goto error;
193
194 return 0;
195
196 error_nomem:
197 ret = -ENOMEM;
198 xenbus_dev_fatal(dev, ret, "allocating device memory");
199 error:
200 xenkbd_remove(dev);
201 return ret;
202}
203
204static int xenkbd_resume(struct xenbus_device *dev)
205{
Greg Kroah-Hartman1b713e02009-05-04 12:40:54 -0700206 struct xenkbd_info *info = dev_get_drvdata(&dev->dev);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700207
208 xenkbd_disconnect_backend(info);
209 memset(info->page, 0, PAGE_SIZE);
210 return xenkbd_connect_backend(dev, info);
211}
212
213static int xenkbd_remove(struct xenbus_device *dev)
214{
Greg Kroah-Hartman1b713e02009-05-04 12:40:54 -0700215 struct xenkbd_info *info = dev_get_drvdata(&dev->dev);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700216
217 xenkbd_disconnect_backend(info);
218 if (info->kbd)
219 input_unregister_device(info->kbd);
220 if (info->ptr)
221 input_unregister_device(info->ptr);
222 free_page((unsigned long)info->page);
223 kfree(info);
224 return 0;
225}
226
227static int xenkbd_connect_backend(struct xenbus_device *dev,
228 struct xenkbd_info *info)
229{
230 int ret, evtchn;
231 struct xenbus_transaction xbt;
232
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700233 ret = gnttab_grant_foreign_access(dev->otherend_id,
234 virt_to_mfn(info->page), 0);
235 if (ret < 0)
236 return ret;
237 info->gref = ret;
238
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700239 ret = xenbus_alloc_evtchn(dev, &evtchn);
240 if (ret)
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700241 goto error_grant;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700242 ret = bind_evtchn_to_irqhandler(evtchn, input_handler,
243 0, dev->devicetype, info);
244 if (ret < 0) {
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700245 xenbus_dev_fatal(dev, ret, "bind_evtchn_to_irqhandler");
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700246 goto error_evtchan;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700247 }
248 info->irq = ret;
249
250 again:
251 ret = xenbus_transaction_start(&xbt);
252 if (ret) {
253 xenbus_dev_fatal(dev, ret, "starting transaction");
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700254 goto error_irqh;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700255 }
256 ret = xenbus_printf(xbt, dev->nodename, "page-ref", "%lu",
257 virt_to_mfn(info->page));
258 if (ret)
259 goto error_xenbus;
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700260 ret = xenbus_printf(xbt, dev->nodename, "page-gref", "%u", info->gref);
261 if (ret)
262 goto error_xenbus;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700263 ret = xenbus_printf(xbt, dev->nodename, "event-channel", "%u",
264 evtchn);
265 if (ret)
266 goto error_xenbus;
267 ret = xenbus_transaction_end(xbt, 0);
268 if (ret) {
269 if (ret == -EAGAIN)
270 goto again;
271 xenbus_dev_fatal(dev, ret, "completing transaction");
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700272 goto error_irqh;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700273 }
274
275 xenbus_switch_state(dev, XenbusStateInitialised);
276 return 0;
277
278 error_xenbus:
279 xenbus_transaction_end(xbt, 1);
280 xenbus_dev_fatal(dev, ret, "writing xenstore");
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700281 error_irqh:
282 unbind_from_irqhandler(info->irq, info);
283 info->irq = -1;
284 error_evtchan:
285 xenbus_free_evtchn(dev, evtchn);
286 error_grant:
287 gnttab_end_foreign_access_ref(info->gref, 0);
288 info->gref = -1;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700289 return ret;
290}
291
292static void xenkbd_disconnect_backend(struct xenkbd_info *info)
293{
294 if (info->irq >= 0)
295 unbind_from_irqhandler(info->irq, info);
296 info->irq = -1;
Daniel De Graaf0a4dfa52011-03-16 22:52:42 -0700297 if (info->gref >= 0)
298 gnttab_end_foreign_access_ref(info->gref, 0);
299 info->gref = -1;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700300}
301
302static void xenkbd_backend_changed(struct xenbus_device *dev,
303 enum xenbus_state backend_state)
304{
Greg Kroah-Hartman1b713e02009-05-04 12:40:54 -0700305 struct xenkbd_info *info = dev_get_drvdata(&dev->dev);
Igor Mammedovc36b58e2011-04-18 10:17:17 -0700306 int ret, val;
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700307
308 switch (backend_state) {
309 case XenbusStateInitialising:
310 case XenbusStateInitialised:
Noboru Iwamatsub78c9512009-10-13 17:22:29 -0400311 case XenbusStateReconfiguring:
312 case XenbusStateReconfigured:
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700313 case XenbusStateUnknown:
314 case XenbusStateClosed:
315 break;
316
317 case XenbusStateInitWait:
318InitWait:
Igor Mammedovc36b58e2011-04-18 10:17:17 -0700319 ret = xenbus_scanf(XBT_NIL, info->xbdev->otherend,
320 "feature-abs-pointer", "%d", &val);
321 if (ret < 0)
322 val = 0;
323 if (val) {
324 ret = xenbus_printf(XBT_NIL, info->xbdev->nodename,
325 "request-abs-pointer", "1");
326 if (ret)
327 pr_warning("xenkbd: can't request abs-pointer");
328 }
329
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700330 xenbus_switch_state(dev, XenbusStateConnected);
331 break;
332
333 case XenbusStateConnected:
334 /*
335 * Work around xenbus race condition: If backend goes
336 * through InitWait to Connected fast enough, we can
337 * get Connected twice here.
338 */
339 if (dev->state != XenbusStateConnected)
340 goto InitWait; /* no InitWait seen yet, fudge it */
Markus Armbrustere4dcff12008-05-26 23:31:11 +0100341
342 /* Set input abs params to match backend screen res */
343 if (xenbus_scanf(XBT_NIL, info->xbdev->otherend,
344 "width", "%d", &val) > 0)
345 input_set_abs_params(info->ptr, ABS_X, 0, val, 0, 0);
346
347 if (xenbus_scanf(XBT_NIL, info->xbdev->otherend,
348 "height", "%d", &val) > 0)
349 input_set_abs_params(info->ptr, ABS_Y, 0, val, 0, 0);
350
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700351 break;
352
353 case XenbusStateClosing:
354 xenbus_frontend_closed(dev);
355 break;
356 }
357}
358
Márton Némethc6d5709382010-01-09 23:25:44 -0800359static const struct xenbus_device_id xenkbd_ids[] = {
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700360 { "vkbd" },
361 { "" }
362};
363
Al Viroffb78a22008-11-22 17:38:14 +0000364static struct xenbus_driver xenkbd_driver = {
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700365 .name = "vkbd",
366 .owner = THIS_MODULE,
367 .ids = xenkbd_ids,
368 .probe = xenkbd_probe,
369 .remove = xenkbd_remove,
370 .resume = xenkbd_resume,
371 .otherend_changed = xenkbd_backend_changed,
372};
373
374static int __init xenkbd_init(void)
375{
Sheng Yangbee6ab52010-05-14 12:39:33 +0100376 if (!xen_pv_domain())
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700377 return -ENODEV;
378
379 /* Nothing to do if running in dom0. */
Jeremy Fitzhardinge6e833582008-08-19 13:16:17 -0700380 if (xen_initial_domain())
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700381 return -ENODEV;
382
Al Viroffb78a22008-11-22 17:38:14 +0000383 return xenbus_register_frontend(&xenkbd_driver);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700384}
385
386static void __exit xenkbd_cleanup(void)
387{
Al Viroffb78a22008-11-22 17:38:14 +0000388 xenbus_unregister_driver(&xenkbd_driver);
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700389}
390
391module_init(xenkbd_init);
392module_exit(xenkbd_cleanup);
393
Markus Armbruster1e892c92008-05-26 23:31:09 +0100394MODULE_DESCRIPTION("Xen virtual keyboard/pointer device frontend");
Markus Armbruster4ee36dc2008-04-02 10:54:07 -0700395MODULE_LICENSE("GPL");
Markus Armbruster1e892c92008-05-26 23:31:09 +0100396MODULE_ALIAS("xen:vkbd");