1 /* SPDX-License-Identifier: GPL-2.0 */
3 * vboxguest linux pci driver, char-dev and input-device code,
5 * Copyright (C) 2006-2016 Oracle Corporation
8 #include <linux/input.h>
9 #include <linux/kernel.h>
10 #include <linux/miscdevice.h>
11 #include <linux/module.h>
12 #include <linux/pci.h>
13 #include <linux/poll.h>
14 #include <linux/vbox_utils.h>
15 #include "vboxguest_core.h"
17 /** The device name. */
18 #define DEVICE_NAME "vboxguest"
19 /** The device name for the device node open to everyone. */
20 #define DEVICE_NAME_USER "vboxuser"
21 /** VirtualBox PCI vendor ID. */
22 #define VBOX_VENDORID 0x80ee
23 /** VMMDev PCI card product ID. */
24 #define VMMDEV_DEVICEID 0xcafe
26 /** Mutex protecting the global vbg_gdev pointer used by vbg_get/put_gdev. */
27 static DEFINE_MUTEX(vbg_gdev_mutex);
28 /** Global vbg_gdev pointer used by vbg_get/put_gdev. */
29 static struct vbg_dev *vbg_gdev;
31 static int vbg_misc_device_open(struct inode *inode, struct file *filp)
33 struct vbg_session *session;
36 /* misc_open sets filp->private_data to our misc device */
37 gdev = container_of(filp->private_data, struct vbg_dev, misc_device);
39 session = vbg_core_open_session(gdev, false);
41 return PTR_ERR(session);
43 filp->private_data = session;
47 static int vbg_misc_device_user_open(struct inode *inode, struct file *filp)
49 struct vbg_session *session;
52 /* misc_open sets filp->private_data to our misc device */
53 gdev = container_of(filp->private_data, struct vbg_dev,
56 session = vbg_core_open_session(gdev, false);
58 return PTR_ERR(session);
60 filp->private_data = session;
66 * Return: 0 on success, negated errno on failure.
67 * @inode: Pointer to inode info structure.
68 * @filp: Associated file pointer.
70 static int vbg_misc_device_close(struct inode *inode, struct file *filp)
72 vbg_core_close_session(filp->private_data);
73 filp->private_data = NULL;
78 * Device I/O Control entry point.
79 * Return: 0 on success, negated errno on failure.
80 * @filp: Associated file pointer.
81 * @req: The request specified to ioctl().
82 * @arg: The argument specified to ioctl().
84 static long vbg_misc_device_ioctl(struct file *filp, unsigned int req,
87 struct vbg_session *session = filp->private_data;
88 size_t returned_size, size;
89 struct vbg_ioctl_hdr hdr;
94 if (copy_from_user(&hdr, (void *)arg, sizeof(hdr)))
97 if (hdr.version != VBG_IOCTL_HDR_VERSION)
100 if (hdr.size_in < sizeof(hdr) ||
101 (hdr.size_out && hdr.size_out < sizeof(hdr)))
104 size = max(hdr.size_in, hdr.size_out);
105 if (_IOC_SIZE(req) && _IOC_SIZE(req) != size)
111 * IOCTL_VMMDEV_REQUEST needs the buffer to be below 4G to avoid
112 * the need for a bounce-buffer and another copy later on.
114 is_vmmdev_req = (req & ~IOCSIZE_MASK) == VBG_IOCTL_VMMDEV_REQUEST(0) ||
115 req == VBG_IOCTL_VMMDEV_REQUEST_BIG ||
116 req == VBG_IOCTL_VMMDEV_REQUEST_BIG_ALT;
119 buf = vbg_req_alloc(size, VBG_IOCTL_HDR_TYPE_DEFAULT);
121 buf = kmalloc(size, GFP_KERNEL);
125 *((struct vbg_ioctl_hdr *)buf) = hdr;
126 if (copy_from_user(buf + sizeof(hdr), (void *)arg + sizeof(hdr),
127 hdr.size_in - sizeof(hdr))) {
131 if (hdr.size_in < size)
132 memset(buf + hdr.size_in, 0, size - hdr.size_in);
134 ret = vbg_core_ioctl(session, req, buf);
138 returned_size = ((struct vbg_ioctl_hdr *)buf)->size_out;
139 if (returned_size > size) {
140 vbg_debug("%s: too much output data %zu > %zu\n",
141 __func__, returned_size, size);
142 returned_size = size;
144 if (copy_to_user((void *)arg, buf, returned_size) != 0)
149 vbg_req_free(buf, size);
156 /** The file_operations structures. */
157 static const struct file_operations vbg_misc_device_fops = {
158 .owner = THIS_MODULE,
159 .open = vbg_misc_device_open,
160 .release = vbg_misc_device_close,
161 .unlocked_ioctl = vbg_misc_device_ioctl,
163 .compat_ioctl = vbg_misc_device_ioctl,
166 static const struct file_operations vbg_misc_device_user_fops = {
167 .owner = THIS_MODULE,
168 .open = vbg_misc_device_user_open,
169 .release = vbg_misc_device_close,
170 .unlocked_ioctl = vbg_misc_device_ioctl,
172 .compat_ioctl = vbg_misc_device_ioctl,
177 * Called when the input device is first opened.
179 * Sets up absolute mouse reporting.
181 static int vbg_input_open(struct input_dev *input)
183 struct vbg_dev *gdev = input_get_drvdata(input);
184 u32 feat = VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE | VMMDEV_MOUSE_NEW_PROTOCOL;
187 ret = vbg_core_set_mouse_status(gdev, feat);
195 * Called if all open handles to the input device are closed.
197 * Disables absolute reporting.
199 static void vbg_input_close(struct input_dev *input)
201 struct vbg_dev *gdev = input_get_drvdata(input);
203 vbg_core_set_mouse_status(gdev, 0);
207 * Creates the kernel input device.
209 * Return: 0 on success, negated errno on failure.
211 static int vbg_create_input_device(struct vbg_dev *gdev)
213 struct input_dev *input;
215 input = devm_input_allocate_device(gdev->dev);
219 input->id.bustype = BUS_PCI;
220 input->id.vendor = VBOX_VENDORID;
221 input->id.product = VMMDEV_DEVICEID;
222 input->open = vbg_input_open;
223 input->close = vbg_input_close;
224 input->dev.parent = gdev->dev;
225 input->name = "VirtualBox mouse integration";
227 input_set_abs_params(input, ABS_X, VMMDEV_MOUSE_RANGE_MIN,
228 VMMDEV_MOUSE_RANGE_MAX, 0, 0);
229 input_set_abs_params(input, ABS_Y, VMMDEV_MOUSE_RANGE_MIN,
230 VMMDEV_MOUSE_RANGE_MAX, 0, 0);
231 input_set_capability(input, EV_KEY, BTN_MOUSE);
232 input_set_drvdata(input, gdev);
236 return input_register_device(gdev->input);
239 static ssize_t host_version_show(struct device *dev,
240 struct device_attribute *attr, char *buf)
242 struct vbg_dev *gdev = dev_get_drvdata(dev);
244 return sprintf(buf, "%s\n", gdev->host_version);
247 static ssize_t host_features_show(struct device *dev,
248 struct device_attribute *attr, char *buf)
250 struct vbg_dev *gdev = dev_get_drvdata(dev);
252 return sprintf(buf, "%#x\n", gdev->host_features);
255 static DEVICE_ATTR_RO(host_version);
256 static DEVICE_ATTR_RO(host_features);
259 * Does the PCI detection and init of the device.
261 * Return: 0 on success, negated errno on failure.
263 static int vbg_pci_probe(struct pci_dev *pci, const struct pci_device_id *id)
265 struct device *dev = &pci->dev;
266 resource_size_t io, io_len, mmio, mmio_len;
267 struct vmmdev_memory *vmmdev;
268 struct vbg_dev *gdev;
271 gdev = devm_kzalloc(dev, sizeof(*gdev), GFP_KERNEL);
275 ret = pci_enable_device(pci);
277 vbg_err("vboxguest: Error enabling device: %d\n", ret);
283 io = pci_resource_start(pci, 0);
284 io_len = pci_resource_len(pci, 0);
285 if (!io || !io_len) {
286 vbg_err("vboxguest: Error IO-port resource (0) is missing\n");
287 goto err_disable_pcidev;
289 if (devm_request_region(dev, io, io_len, DEVICE_NAME) == NULL) {
290 vbg_err("vboxguest: Error could not claim IO resource\n");
292 goto err_disable_pcidev;
295 mmio = pci_resource_start(pci, 1);
296 mmio_len = pci_resource_len(pci, 1);
297 if (!mmio || !mmio_len) {
298 vbg_err("vboxguest: Error MMIO resource (1) is missing\n");
299 goto err_disable_pcidev;
302 if (devm_request_mem_region(dev, mmio, mmio_len, DEVICE_NAME) == NULL) {
303 vbg_err("vboxguest: Error could not claim MMIO resource\n");
305 goto err_disable_pcidev;
308 vmmdev = devm_ioremap(dev, mmio, mmio_len);
310 vbg_err("vboxguest: Error ioremap failed; MMIO addr=%pap size=%pap\n",
312 goto err_disable_pcidev;
315 /* Validate MMIO region version and size. */
316 if (vmmdev->version != VMMDEV_MEMORY_VERSION ||
317 vmmdev->size < 32 || vmmdev->size > mmio_len) {
318 vbg_err("vboxguest: Bogus VMMDev memory; version=%08x (expected %08x) size=%d (expected <= %d)\n",
319 vmmdev->version, VMMDEV_MEMORY_VERSION,
320 vmmdev->size, (int)mmio_len);
321 goto err_disable_pcidev;
327 gdev->misc_device.minor = MISC_DYNAMIC_MINOR;
328 gdev->misc_device.name = DEVICE_NAME;
329 gdev->misc_device.fops = &vbg_misc_device_fops;
330 gdev->misc_device_user.minor = MISC_DYNAMIC_MINOR;
331 gdev->misc_device_user.name = DEVICE_NAME_USER;
332 gdev->misc_device_user.fops = &vbg_misc_device_user_fops;
334 ret = vbg_core_init(gdev, VMMDEV_EVENT_MOUSE_POSITION_CHANGED);
336 goto err_disable_pcidev;
338 ret = vbg_create_input_device(gdev);
340 vbg_err("vboxguest: Error creating input device: %d\n", ret);
341 goto err_vbg_core_exit;
344 ret = request_irq(pci->irq, vbg_core_isr, IRQF_SHARED, DEVICE_NAME,
347 vbg_err("vboxguest: Error requesting irq: %d\n", ret);
348 goto err_vbg_core_exit;
351 ret = misc_register(&gdev->misc_device);
353 vbg_err("vboxguest: Error misc_register %s failed: %d\n",
358 ret = misc_register(&gdev->misc_device_user);
360 vbg_err("vboxguest: Error misc_register %s failed: %d\n",
361 DEVICE_NAME_USER, ret);
362 goto err_unregister_misc_device;
365 mutex_lock(&vbg_gdev_mutex);
370 mutex_unlock(&vbg_gdev_mutex);
373 vbg_err("vboxguest: Error more then 1 vbox guest pci device\n");
374 goto err_unregister_misc_device_user;
377 pci_set_drvdata(pci, gdev);
378 device_create_file(dev, &dev_attr_host_version);
379 device_create_file(dev, &dev_attr_host_features);
381 vbg_info("vboxguest: misc device minor %d, IRQ %d, I/O port %x, MMIO at %pap (size %pap)\n",
382 gdev->misc_device.minor, pci->irq, gdev->io_port,
387 err_unregister_misc_device_user:
388 misc_deregister(&gdev->misc_device_user);
389 err_unregister_misc_device:
390 misc_deregister(&gdev->misc_device);
392 free_irq(pci->irq, gdev);
396 pci_disable_device(pci);
401 static void vbg_pci_remove(struct pci_dev *pci)
403 struct vbg_dev *gdev = pci_get_drvdata(pci);
405 mutex_lock(&vbg_gdev_mutex);
407 mutex_unlock(&vbg_gdev_mutex);
409 free_irq(pci->irq, gdev);
410 device_remove_file(gdev->dev, &dev_attr_host_features);
411 device_remove_file(gdev->dev, &dev_attr_host_version);
412 misc_deregister(&gdev->misc_device_user);
413 misc_deregister(&gdev->misc_device);
415 pci_disable_device(pci);
418 struct vbg_dev *vbg_get_gdev(void)
420 mutex_lock(&vbg_gdev_mutex);
423 * Note on success we keep the mutex locked until vbg_put_gdev(),
424 * this stops vbg_pci_remove from removing the device from underneath
425 * vboxsf. vboxsf will only hold a reference for a short while.
430 mutex_unlock(&vbg_gdev_mutex);
431 return ERR_PTR(-ENODEV);
433 EXPORT_SYMBOL(vbg_get_gdev);
435 void vbg_put_gdev(struct vbg_dev *gdev)
437 WARN_ON(gdev != vbg_gdev);
438 mutex_unlock(&vbg_gdev_mutex);
440 EXPORT_SYMBOL(vbg_put_gdev);
443 * Callback for mouse events.
445 * This is called at the end of the ISR, after leaving the event spinlock, if
446 * VMMDEV_EVENT_MOUSE_POSITION_CHANGED was raised by the host.
448 * @gdev: The device extension.
450 void vbg_linux_mouse_event(struct vbg_dev *gdev)
454 /* Report events to the kernel input device */
455 gdev->mouse_status_req->mouse_features = 0;
456 gdev->mouse_status_req->pointer_pos_x = 0;
457 gdev->mouse_status_req->pointer_pos_y = 0;
458 rc = vbg_req_perform(gdev, gdev->mouse_status_req);
460 input_report_abs(gdev->input, ABS_X,
461 gdev->mouse_status_req->pointer_pos_x);
462 input_report_abs(gdev->input, ABS_Y,
463 gdev->mouse_status_req->pointer_pos_y);
464 input_sync(gdev->input);
468 static const struct pci_device_id vbg_pci_ids[] = {
469 { .vendor = VBOX_VENDORID, .device = VMMDEV_DEVICEID },
472 MODULE_DEVICE_TABLE(pci, vbg_pci_ids);
474 static struct pci_driver vbg_pci_driver = {
476 .id_table = vbg_pci_ids,
477 .probe = vbg_pci_probe,
478 .remove = vbg_pci_remove,
481 module_pci_driver(vbg_pci_driver);
483 MODULE_AUTHOR("Oracle Corporation");
484 MODULE_DESCRIPTION("Oracle VM VirtualBox Guest Additions for Linux Module");
485 MODULE_LICENSE("GPL");