2 * Copyright (c) 2009, Citrix Systems, Inc.
3 * Copyright (c) 2010, Microsoft Corporation.
4 * Copyright (c) 2011, Novell Inc.
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 it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/device.h>
18 #include <linux/completion.h>
19 #include <linux/input.h>
20 #include <linux/hid.h>
21 #include <linux/hiddev.h>
22 #include <linux/hyperv.h>
25 struct hv_input_dev_info {
27 unsigned short vendor;
28 unsigned short product;
29 unsigned short version;
30 unsigned short reserved[11];
33 /* The maximum size of a synthetic input message. */
34 #define SYNTHHID_MAX_INPUT_REPORT_SIZE 16
40 * Beta, RC < 2008/1/22 1,0
43 #define SYNTHHID_INPUT_VERSION_MAJOR 2
44 #define SYNTHHID_INPUT_VERSION_MINOR 0
45 #define SYNTHHID_INPUT_VERSION (SYNTHHID_INPUT_VERSION_MINOR | \
46 (SYNTHHID_INPUT_VERSION_MAJOR << 16))
51 * Message types in the synthetic input protocol
53 enum synthhid_msg_type {
54 SYNTH_HID_PROTOCOL_REQUEST,
55 SYNTH_HID_PROTOCOL_RESPONSE,
56 SYNTH_HID_INITIAL_DEVICE_INFO,
57 SYNTH_HID_INITIAL_DEVICE_INFO_ACK,
58 SYNTH_HID_INPUT_REPORT,
63 * Basic message structures.
65 struct synthhid_msg_hdr {
66 enum synthhid_msg_type type;
71 struct synthhid_msg_hdr header;
72 char data[1]; /* Enclosed message */
75 union synthhid_version {
86 struct synthhid_protocol_request {
87 struct synthhid_msg_hdr header;
88 union synthhid_version version_requested;
91 struct synthhid_protocol_response {
92 struct synthhid_msg_hdr header;
93 union synthhid_version version_requested;
94 unsigned char approved;
97 struct synthhid_device_info {
98 struct synthhid_msg_hdr header;
99 struct hv_input_dev_info hid_dev_info;
100 struct hid_descriptor hid_descriptor;
103 struct synthhid_device_info_ack {
104 struct synthhid_msg_hdr header;
105 unsigned char reserved;
108 struct synthhid_input_report {
109 struct synthhid_msg_hdr header;
115 #define INPUTVSC_SEND_RING_BUFFER_SIZE (10*PAGE_SIZE)
116 #define INPUTVSC_RECV_RING_BUFFER_SIZE (10*PAGE_SIZE)
119 enum pipe_prot_msg_type {
120 PIPE_MESSAGE_INVALID,
126 struct pipe_prt_msg {
127 enum pipe_prot_msg_type type;
132 struct mousevsc_prt_msg {
133 enum pipe_prot_msg_type type;
136 struct synthhid_protocol_request request;
137 struct synthhid_protocol_response response;
138 struct synthhid_device_info_ack ack;
143 * Represents an mousevsc device
145 struct mousevsc_dev {
146 struct hv_device *device;
149 struct mousevsc_prt_msg protocol_req;
150 struct mousevsc_prt_msg protocol_resp;
151 /* Synchronize the request/response if needed */
152 struct completion wait_event;
155 struct hid_descriptor *hid_desc;
156 unsigned char *report_desc;
157 u32 report_desc_size;
158 struct hv_input_dev_info hid_dev_info;
159 struct hid_device *hid_device;
163 static struct mousevsc_dev *mousevsc_alloc_device(struct hv_device *device)
165 struct mousevsc_dev *input_dev;
167 input_dev = kzalloc(sizeof(struct mousevsc_dev), GFP_KERNEL);
172 input_dev->device = device;
173 hv_set_drvdata(device, input_dev);
174 init_completion(&input_dev->wait_event);
175 input_dev->init_complete = false;
180 static void mousevsc_free_device(struct mousevsc_dev *device)
182 kfree(device->hid_desc);
183 kfree(device->report_desc);
184 hv_set_drvdata(device->device, NULL);
188 static void mousevsc_on_receive_device_info(struct mousevsc_dev *input_device,
189 struct synthhid_device_info *device_info)
192 struct hid_descriptor *desc;
193 struct mousevsc_prt_msg ack;
195 input_device->dev_info_status = -ENOMEM;
197 input_device->hid_dev_info = device_info->hid_dev_info;
198 desc = &device_info->hid_descriptor;
199 if (desc->bLength == 0)
202 input_device->hid_desc = kmemdup(desc, desc->bLength, GFP_ATOMIC);
204 if (!input_device->hid_desc)
207 input_device->report_desc_size = desc->desc[0].wDescriptorLength;
208 if (input_device->report_desc_size == 0) {
209 input_device->dev_info_status = -EINVAL;
213 input_device->report_desc = kzalloc(input_device->report_desc_size,
216 if (!input_device->report_desc) {
217 input_device->dev_info_status = -ENOMEM;
221 memcpy(input_device->report_desc,
222 ((unsigned char *)desc) + desc->bLength,
223 desc->desc[0].wDescriptorLength);
226 memset(&ack, 0, sizeof(struct mousevsc_prt_msg));
228 ack.type = PIPE_MESSAGE_DATA;
229 ack.size = sizeof(struct synthhid_device_info_ack);
231 ack.ack.header.type = SYNTH_HID_INITIAL_DEVICE_INFO_ACK;
232 ack.ack.header.size = 1;
233 ack.ack.reserved = 0;
235 ret = vmbus_sendpacket(input_device->device->channel,
237 sizeof(struct pipe_prt_msg) - sizeof(unsigned char) +
238 sizeof(struct synthhid_device_info_ack),
241 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
244 input_device->dev_info_status = 0;
247 complete(&input_device->wait_event);
252 static void mousevsc_on_receive(struct hv_device *device,
253 struct vmpacket_descriptor *packet)
255 struct pipe_prt_msg *pipe_msg;
256 struct synthhid_msg *hid_msg;
257 struct mousevsc_dev *input_dev = hv_get_drvdata(device);
258 struct synthhid_input_report *input_report;
260 pipe_msg = (struct pipe_prt_msg *)((unsigned long)packet +
261 (packet->offset8 << 3));
263 if (pipe_msg->type != PIPE_MESSAGE_DATA)
266 hid_msg = (struct synthhid_msg *)pipe_msg->data;
268 switch (hid_msg->header.type) {
269 case SYNTH_HID_PROTOCOL_RESPONSE:
271 * While it will be impossible for us to protect against
272 * malicious/buggy hypervisor/host, add a check here to
273 * ensure we don't corrupt memory.
275 if ((pipe_msg->size + sizeof(struct pipe_prt_msg)
276 - sizeof(unsigned char))
277 > sizeof(struct mousevsc_prt_msg)) {
282 memcpy(&input_dev->protocol_resp, pipe_msg,
283 pipe_msg->size + sizeof(struct pipe_prt_msg) -
284 sizeof(unsigned char));
285 complete(&input_dev->wait_event);
288 case SYNTH_HID_INITIAL_DEVICE_INFO:
289 WARN_ON(pipe_msg->size < sizeof(struct hv_input_dev_info));
292 * Parse out the device info into device attr,
293 * hid desc and report desc
295 mousevsc_on_receive_device_info(input_dev,
296 (struct synthhid_device_info *)pipe_msg->data);
298 case SYNTH_HID_INPUT_REPORT:
300 (struct synthhid_input_report *)pipe_msg->data;
301 if (!input_dev->init_complete)
303 hid_input_report(input_dev->hid_device,
304 HID_INPUT_REPORT, input_report->buffer,
305 input_report->header.size, 1);
308 pr_err("unsupported hid msg type - type %d len %d",
309 hid_msg->header.type, hid_msg->header.size);
315 static void mousevsc_on_channel_callback(void *context)
317 const int packet_size = 0x100;
319 struct hv_device *device = context;
322 struct vmpacket_descriptor *desc;
323 unsigned char *buffer;
324 int bufferlen = packet_size;
326 buffer = kmalloc(bufferlen, GFP_ATOMIC);
331 ret = vmbus_recvpacket_raw(device->channel, buffer,
332 bufferlen, &bytes_recvd, &req_id);
336 if (bytes_recvd <= 0) {
340 desc = (struct vmpacket_descriptor *)buffer;
342 switch (desc->type) {
346 case VM_PKT_DATA_INBAND:
347 mousevsc_on_receive(device, desc);
351 pr_err("unhandled packet type %d, tid %llx len %d\n",
352 desc->type, req_id, bytes_recvd);
360 /* Handle large packet */
361 bufferlen = bytes_recvd;
362 buffer = kmalloc(bytes_recvd, GFP_ATOMIC);
373 static int mousevsc_connect_to_vsp(struct hv_device *device)
377 struct mousevsc_dev *input_dev = hv_get_drvdata(device);
378 struct mousevsc_prt_msg *request;
379 struct mousevsc_prt_msg *response;
381 request = &input_dev->protocol_req;
382 memset(request, 0, sizeof(struct mousevsc_prt_msg));
384 request->type = PIPE_MESSAGE_DATA;
385 request->size = sizeof(struct synthhid_protocol_request);
386 request->request.header.type = SYNTH_HID_PROTOCOL_REQUEST;
387 request->request.header.size = sizeof(unsigned int);
388 request->request.version_requested.version = SYNTHHID_INPUT_VERSION;
390 ret = vmbus_sendpacket(device->channel, request,
391 sizeof(struct pipe_prt_msg) -
392 sizeof(unsigned char) +
393 sizeof(struct synthhid_protocol_request),
394 (unsigned long)request,
396 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
400 t = wait_for_completion_timeout(&input_dev->wait_event, 5*HZ);
406 response = &input_dev->protocol_resp;
408 if (!response->response.approved) {
409 pr_err("synthhid protocol request failed (version %d)\n",
410 SYNTHHID_INPUT_VERSION);
415 t = wait_for_completion_timeout(&input_dev->wait_event, 5*HZ);
422 * We should have gotten the device attr, hid desc and report
425 ret = input_dev->dev_info_status;
431 static int mousevsc_hid_parse(struct hid_device *hid)
433 struct hv_device *dev = hid_get_drvdata(hid);
434 struct mousevsc_dev *input_dev = hv_get_drvdata(dev);
436 return hid_parse_report(hid, input_dev->report_desc,
437 input_dev->report_desc_size);
440 static int mousevsc_hid_open(struct hid_device *hid)
445 static int mousevsc_hid_start(struct hid_device *hid)
450 static void mousevsc_hid_close(struct hid_device *hid)
454 static void mousevsc_hid_stop(struct hid_device *hid)
458 static int mousevsc_hid_raw_request(struct hid_device *hid,
459 unsigned char report_num,
460 __u8 *buf, size_t len,
467 static struct hid_ll_driver mousevsc_ll_driver = {
468 .parse = mousevsc_hid_parse,
469 .open = mousevsc_hid_open,
470 .close = mousevsc_hid_close,
471 .start = mousevsc_hid_start,
472 .stop = mousevsc_hid_stop,
473 .raw_request = mousevsc_hid_raw_request,
476 static struct hid_driver mousevsc_hid_driver;
478 static int mousevsc_probe(struct hv_device *device,
479 const struct hv_vmbus_device_id *dev_id)
482 struct mousevsc_dev *input_dev;
483 struct hid_device *hid_dev;
485 input_dev = mousevsc_alloc_device(device);
490 ret = vmbus_open(device->channel,
491 INPUTVSC_SEND_RING_BUFFER_SIZE,
492 INPUTVSC_RECV_RING_BUFFER_SIZE,
495 mousevsc_on_channel_callback,
502 ret = mousevsc_connect_to_vsp(device);
507 /* workaround SA-167 */
508 if (input_dev->report_desc[14] == 0x25)
509 input_dev->report_desc[14] = 0x29;
511 hid_dev = hid_allocate_device();
512 if (IS_ERR(hid_dev)) {
513 ret = PTR_ERR(hid_dev);
517 hid_dev->ll_driver = &mousevsc_ll_driver;
518 hid_dev->driver = &mousevsc_hid_driver;
519 hid_dev->bus = BUS_VIRTUAL;
520 hid_dev->vendor = input_dev->hid_dev_info.vendor;
521 hid_dev->product = input_dev->hid_dev_info.product;
522 hid_dev->version = input_dev->hid_dev_info.version;
523 input_dev->hid_device = hid_dev;
525 sprintf(hid_dev->name, "%s", "Microsoft Vmbus HID-compliant Mouse");
527 hid_set_drvdata(hid_dev, device);
529 ret = hid_add_device(hid_dev);
534 ret = hid_parse(hid_dev);
536 hid_err(hid_dev, "parse failed\n");
540 ret = hid_hw_start(hid_dev, HID_CONNECT_HIDINPUT | HID_CONNECT_HIDDEV);
543 hid_err(hid_dev, "hw start failed\n");
547 input_dev->connected = true;
548 input_dev->init_complete = true;
553 hid_destroy_device(hid_dev);
556 vmbus_close(device->channel);
559 mousevsc_free_device(input_dev);
565 static int mousevsc_remove(struct hv_device *dev)
567 struct mousevsc_dev *input_dev = hv_get_drvdata(dev);
569 vmbus_close(dev->channel);
570 hid_hw_stop(input_dev->hid_device);
571 hid_destroy_device(input_dev->hid_device);
572 mousevsc_free_device(input_dev);
577 static const struct hv_vmbus_device_id id_table[] = {
583 MODULE_DEVICE_TABLE(vmbus, id_table);
585 static struct hv_driver mousevsc_drv = {
586 .name = KBUILD_MODNAME,
587 .id_table = id_table,
588 .probe = mousevsc_probe,
589 .remove = mousevsc_remove,
592 static int __init mousevsc_init(void)
594 return vmbus_driver_register(&mousevsc_drv);
597 static void __exit mousevsc_exit(void)
599 vmbus_driver_unregister(&mousevsc_drv);
602 MODULE_LICENSE("GPL");
603 module_init(mousevsc_init);
604 module_exit(mousevsc_exit);