2 * Joystick device driver for the input driver suite.
4 * Copyright (c) 1999-2002 Vojtech Pavlik
5 * Copyright (c) 1999 Colin Van Dyke
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
14 #include <asm/system.h>
15 #include <linux/delay.h>
16 #include <linux/errno.h>
17 #include <linux/joystick.h>
18 #include <linux/input.h>
19 #include <linux/kernel.h>
20 #include <linux/major.h>
21 #include <linux/slab.h>
23 #include <linux/miscdevice.h>
24 #include <linux/module.h>
25 #include <linux/poll.h>
26 #include <linux/init.h>
27 #include <linux/device.h>
29 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
30 MODULE_DESCRIPTION("Joystick device interfaces");
31 MODULE_SUPPORTED_DEVICE("input/js");
32 MODULE_LICENSE("GPL");
34 #define JOYDEV_MINOR_BASE 0
35 #define JOYDEV_MINORS 16
36 #define JOYDEV_BUFFER_SIZE 64
43 struct input_handle handle;
44 wait_queue_head_t wait;
45 struct list_head client_list;
46 spinlock_t client_lock; /* protects client_list */
50 struct js_corr corr[ABS_MAX + 1];
51 struct JS_DATA_SAVE_TYPE glue;
54 __u16 keymap[KEY_MAX - BTN_MISC + 1];
55 __u16 keypam[KEY_MAX - BTN_MISC + 1];
56 __u8 absmap[ABS_MAX + 1];
57 __u8 abspam[ABS_MAX + 1];
58 __s16 abs[ABS_MAX + 1];
61 struct joydev_client {
62 struct js_event buffer[JOYDEV_BUFFER_SIZE];
66 spinlock_t buffer_lock; /* protects access to buffer, head and tail */
67 struct fasync_struct *fasync;
68 struct joydev *joydev;
69 struct list_head node;
72 static struct joydev *joydev_table[JOYDEV_MINORS];
73 static DEFINE_MUTEX(joydev_table_mutex);
75 static int joydev_correct(int value, struct js_corr *corr)
83 value = value > corr->coef[0] ? (value < corr->coef[1] ? 0 :
84 ((corr->coef[3] * (value - corr->coef[1])) >> 14)) :
85 ((corr->coef[2] * (value - corr->coef[0])) >> 14);
92 return value < -32767 ? -32767 : (value > 32767 ? 32767 : value);
95 static void joydev_pass_event(struct joydev_client *client,
96 struct js_event *event)
98 struct joydev *joydev = client->joydev;
101 * IRQs already disabled, just acquire the lock
103 spin_lock(&client->buffer_lock);
105 client->buffer[client->head] = *event;
107 if (client->startup == joydev->nabs + joydev->nkey) {
109 client->head &= JOYDEV_BUFFER_SIZE - 1;
110 if (client->tail == client->head)
114 spin_unlock(&client->buffer_lock);
116 kill_fasync(&client->fasync, SIGIO, POLL_IN);
119 static void joydev_event(struct input_handle *handle,
120 unsigned int type, unsigned int code, int value)
122 struct joydev *joydev = handle->private;
123 struct joydev_client *client;
124 struct js_event event;
129 if (code < BTN_MISC || value == 2)
131 event.type = JS_EVENT_BUTTON;
132 event.number = joydev->keymap[code - BTN_MISC];
137 event.type = JS_EVENT_AXIS;
138 event.number = joydev->absmap[code];
139 event.value = joydev_correct(value,
140 &joydev->corr[event.number]);
141 if (event.value == joydev->abs[event.number])
143 joydev->abs[event.number] = event.value;
150 event.time = jiffies_to_msecs(jiffies);
153 list_for_each_entry_rcu(client, &joydev->client_list, node)
154 joydev_pass_event(client, &event);
157 wake_up_interruptible(&joydev->wait);
160 static int joydev_fasync(int fd, struct file *file, int on)
162 struct joydev_client *client = file->private_data;
164 return fasync_helper(fd, file, on, &client->fasync);
167 static void joydev_free(struct device *dev)
169 struct joydev *joydev = container_of(dev, struct joydev, dev);
171 input_put_device(joydev->handle.dev);
175 static void joydev_attach_client(struct joydev *joydev,
176 struct joydev_client *client)
178 spin_lock(&joydev->client_lock);
179 list_add_tail_rcu(&client->node, &joydev->client_list);
180 spin_unlock(&joydev->client_lock);
184 static void joydev_detach_client(struct joydev *joydev,
185 struct joydev_client *client)
187 spin_lock(&joydev->client_lock);
188 list_del_rcu(&client->node);
189 spin_unlock(&joydev->client_lock);
193 static int joydev_open_device(struct joydev *joydev)
197 retval = mutex_lock_interruptible(&joydev->mutex);
203 else if (!joydev->open++) {
204 retval = input_open_device(&joydev->handle);
209 mutex_unlock(&joydev->mutex);
213 static void joydev_close_device(struct joydev *joydev)
215 mutex_lock(&joydev->mutex);
217 if (joydev->exist && !--joydev->open)
218 input_close_device(&joydev->handle);
220 mutex_unlock(&joydev->mutex);
224 * Wake up users waiting for IO so they can disconnect from
227 static void joydev_hangup(struct joydev *joydev)
229 struct joydev_client *client;
231 spin_lock(&joydev->client_lock);
232 list_for_each_entry(client, &joydev->client_list, node)
233 kill_fasync(&client->fasync, SIGIO, POLL_HUP);
234 spin_unlock(&joydev->client_lock);
236 wake_up_interruptible(&joydev->wait);
239 static int joydev_release(struct inode *inode, struct file *file)
241 struct joydev_client *client = file->private_data;
242 struct joydev *joydev = client->joydev;
244 joydev_detach_client(joydev, client);
247 joydev_close_device(joydev);
248 put_device(&joydev->dev);
253 static int joydev_open(struct inode *inode, struct file *file)
255 struct joydev_client *client;
256 struct joydev *joydev;
257 int i = iminor(inode) - JOYDEV_MINOR_BASE;
260 if (i >= JOYDEV_MINORS)
263 error = mutex_lock_interruptible(&joydev_table_mutex);
266 joydev = joydev_table[i];
268 get_device(&joydev->dev);
269 mutex_unlock(&joydev_table_mutex);
274 client = kzalloc(sizeof(struct joydev_client), GFP_KERNEL);
280 spin_lock_init(&client->buffer_lock);
281 client->joydev = joydev;
282 joydev_attach_client(joydev, client);
284 error = joydev_open_device(joydev);
286 goto err_free_client;
288 file->private_data = client;
292 joydev_detach_client(joydev, client);
295 put_device(&joydev->dev);
299 static int joydev_generate_startup_event(struct joydev_client *client,
300 struct input_dev *input,
301 struct js_event *event)
303 struct joydev *joydev = client->joydev;
306 spin_lock_irq(&client->buffer_lock);
308 have_event = client->startup < joydev->nabs + joydev->nkey;
312 event->time = jiffies_to_msecs(jiffies);
313 if (client->startup < joydev->nkey) {
314 event->type = JS_EVENT_BUTTON | JS_EVENT_INIT;
315 event->number = client->startup;
316 event->value = !!test_bit(joydev->keypam[event->number],
319 event->type = JS_EVENT_AXIS | JS_EVENT_INIT;
320 event->number = client->startup - joydev->nkey;
321 event->value = joydev->abs[event->number];
326 spin_unlock_irq(&client->buffer_lock);
331 static int joydev_fetch_next_event(struct joydev_client *client,
332 struct js_event *event)
336 spin_lock_irq(&client->buffer_lock);
338 have_event = client->head != client->tail;
340 *event = client->buffer[client->tail++];
341 client->tail &= JOYDEV_BUFFER_SIZE - 1;
344 spin_unlock_irq(&client->buffer_lock);
350 * Old joystick interface
352 static ssize_t joydev_0x_read(struct joydev_client *client,
353 struct input_dev *input,
356 struct joydev *joydev = client->joydev;
357 struct JS_DATA_TYPE data;
360 spin_lock_irq(&input->event_lock);
365 for (data.buttons = i = 0; i < 32 && i < joydev->nkey; i++)
367 test_bit(joydev->keypam[i], input->key) ? (1 << i) : 0;
368 data.x = (joydev->abs[0] / 256 + 128) >> joydev->glue.JS_CORR.x;
369 data.y = (joydev->abs[1] / 256 + 128) >> joydev->glue.JS_CORR.y;
372 * Reset reader's event queue
374 spin_lock(&client->buffer_lock);
376 client->tail = client->head;
377 spin_unlock(&client->buffer_lock);
379 spin_unlock_irq(&input->event_lock);
381 if (copy_to_user(buf, &data, sizeof(struct JS_DATA_TYPE)))
384 return sizeof(struct JS_DATA_TYPE);
387 static inline int joydev_data_pending(struct joydev_client *client)
389 struct joydev *joydev = client->joydev;
391 return client->startup < joydev->nabs + joydev->nkey ||
392 client->head != client->tail;
395 static ssize_t joydev_read(struct file *file, char __user *buf,
396 size_t count, loff_t *ppos)
398 struct joydev_client *client = file->private_data;
399 struct joydev *joydev = client->joydev;
400 struct input_dev *input = joydev->handle.dev;
401 struct js_event event;
407 if (count < sizeof(struct js_event))
410 if (count == sizeof(struct JS_DATA_TYPE))
411 return joydev_0x_read(client, input, buf);
413 if (!joydev_data_pending(client) && (file->f_flags & O_NONBLOCK))
416 retval = wait_event_interruptible(joydev->wait,
417 !joydev->exist || joydev_data_pending(client));
424 while (retval + sizeof(struct js_event) <= count &&
425 joydev_generate_startup_event(client, input, &event)) {
427 if (copy_to_user(buf + retval, &event, sizeof(struct js_event)))
430 retval += sizeof(struct js_event);
433 while (retval + sizeof(struct js_event) <= count &&
434 joydev_fetch_next_event(client, &event)) {
436 if (copy_to_user(buf + retval, &event, sizeof(struct js_event)))
439 retval += sizeof(struct js_event);
445 /* No kernel lock - fine */
446 static unsigned int joydev_poll(struct file *file, poll_table *wait)
448 struct joydev_client *client = file->private_data;
449 struct joydev *joydev = client->joydev;
451 poll_wait(file, &joydev->wait, wait);
452 return (joydev_data_pending(client) ? (POLLIN | POLLRDNORM) : 0) |
453 (joydev->exist ? 0 : (POLLHUP | POLLERR));
456 static int joydev_ioctl_common(struct joydev *joydev,
457 unsigned int cmd, void __user *argp)
459 struct input_dev *dev = joydev->handle.dev;
465 return copy_from_user(&joydev->glue.JS_CORR, argp,
466 sizeof(joydev->glue.JS_CORR)) ? -EFAULT : 0;
469 return copy_to_user(argp, &joydev->glue.JS_CORR,
470 sizeof(joydev->glue.JS_CORR)) ? -EFAULT : 0;
473 return get_user(joydev->glue.JS_TIMEOUT, (s32 __user *) argp);
476 return put_user(joydev->glue.JS_TIMEOUT, (s32 __user *) argp);
479 return put_user(JS_VERSION, (__u32 __user *) argp);
482 return put_user(joydev->nabs, (__u8 __user *) argp);
485 return put_user(joydev->nkey, (__u8 __user *) argp);
488 if (copy_from_user(joydev->corr, argp,
489 sizeof(joydev->corr[0]) * joydev->nabs))
492 for (i = 0; i < joydev->nabs; i++) {
493 j = joydev->abspam[i];
494 joydev->abs[i] = joydev_correct(dev->abs[j],
500 return copy_to_user(argp, joydev->corr,
501 sizeof(joydev->corr[0]) * joydev->nabs) ? -EFAULT : 0;
504 if (copy_from_user(joydev->abspam, argp,
505 sizeof(__u8) * (ABS_MAX + 1)))
508 for (i = 0; i < joydev->nabs; i++) {
509 if (joydev->abspam[i] > ABS_MAX)
511 joydev->absmap[joydev->abspam[i]] = i;
516 return copy_to_user(argp, joydev->abspam,
517 sizeof(__u8) * (ABS_MAX + 1)) ? -EFAULT : 0;
520 if (copy_from_user(joydev->keypam, argp,
521 sizeof(__u16) * (KEY_MAX - BTN_MISC + 1)))
524 for (i = 0; i < joydev->nkey; i++) {
525 if (joydev->keypam[i] > KEY_MAX ||
526 joydev->keypam[i] < BTN_MISC)
528 joydev->keymap[joydev->keypam[i] - BTN_MISC] = i;
534 return copy_to_user(argp, joydev->keypam,
535 sizeof(__u16) * (KEY_MAX - BTN_MISC + 1)) ? -EFAULT : 0;
538 if ((cmd & ~IOCSIZE_MASK) == JSIOCGNAME(0)) {
542 len = strlen(dev->name) + 1;
543 if (len > _IOC_SIZE(cmd))
544 len = _IOC_SIZE(cmd);
545 if (copy_to_user(argp, dev->name, len))
554 static long joydev_compat_ioctl(struct file *file,
555 unsigned int cmd, unsigned long arg)
557 struct joydev_client *client = file->private_data;
558 struct joydev *joydev = client->joydev;
559 void __user *argp = (void __user *)arg;
561 struct JS_DATA_SAVE_TYPE_32 ds32;
564 retval = mutex_lock_interruptible(&joydev->mutex);
568 if (!joydev->exist) {
575 case JS_SET_TIMELIMIT:
576 retval = get_user(tmp32, (s32 __user *) arg);
578 joydev->glue.JS_TIMELIMIT = tmp32;
581 case JS_GET_TIMELIMIT:
582 tmp32 = joydev->glue.JS_TIMELIMIT;
583 retval = put_user(tmp32, (s32 __user *) arg);
587 retval = copy_from_user(&ds32, argp,
588 sizeof(ds32)) ? -EFAULT : 0;
590 joydev->glue.JS_TIMEOUT = ds32.JS_TIMEOUT;
591 joydev->glue.BUSY = ds32.BUSY;
592 joydev->glue.JS_EXPIRETIME = ds32.JS_EXPIRETIME;
593 joydev->glue.JS_TIMELIMIT = ds32.JS_TIMELIMIT;
594 joydev->glue.JS_SAVE = ds32.JS_SAVE;
595 joydev->glue.JS_CORR = ds32.JS_CORR;
600 ds32.JS_TIMEOUT = joydev->glue.JS_TIMEOUT;
601 ds32.BUSY = joydev->glue.BUSY;
602 ds32.JS_EXPIRETIME = joydev->glue.JS_EXPIRETIME;
603 ds32.JS_TIMELIMIT = joydev->glue.JS_TIMELIMIT;
604 ds32.JS_SAVE = joydev->glue.JS_SAVE;
605 ds32.JS_CORR = joydev->glue.JS_CORR;
607 retval = copy_to_user(argp, &ds32, sizeof(ds32)) ? -EFAULT : 0;
611 retval = joydev_ioctl_common(joydev, cmd, argp);
616 mutex_unlock(&joydev->mutex);
619 #endif /* CONFIG_COMPAT */
621 static long joydev_ioctl(struct file *file,
622 unsigned int cmd, unsigned long arg)
624 struct joydev_client *client = file->private_data;
625 struct joydev *joydev = client->joydev;
626 void __user *argp = (void __user *)arg;
629 retval = mutex_lock_interruptible(&joydev->mutex);
633 if (!joydev->exist) {
640 case JS_SET_TIMELIMIT:
641 retval = get_user(joydev->glue.JS_TIMELIMIT,
642 (long __user *) arg);
645 case JS_GET_TIMELIMIT:
646 retval = put_user(joydev->glue.JS_TIMELIMIT,
647 (long __user *) arg);
651 retval = copy_from_user(&joydev->glue, argp,
652 sizeof(joydev->glue)) ? -EFAULT: 0;
656 retval = copy_to_user(argp, &joydev->glue,
657 sizeof(joydev->glue)) ? -EFAULT : 0;
661 retval = joydev_ioctl_common(joydev, cmd, argp);
665 mutex_unlock(&joydev->mutex);
669 static const struct file_operations joydev_fops = {
670 .owner = THIS_MODULE,
674 .release = joydev_release,
675 .unlocked_ioctl = joydev_ioctl,
677 .compat_ioctl = joydev_compat_ioctl,
679 .fasync = joydev_fasync,
682 static int joydev_install_chrdev(struct joydev *joydev)
684 joydev_table[joydev->minor] = joydev;
688 static void joydev_remove_chrdev(struct joydev *joydev)
690 mutex_lock(&joydev_table_mutex);
691 joydev_table[joydev->minor] = NULL;
692 mutex_unlock(&joydev_table_mutex);
696 * Mark device non-existant. This disables writes, ioctls and
697 * prevents new users from opening the device. Already posted
698 * blocking reads will stay, however new ones will fail.
700 static void joydev_mark_dead(struct joydev *joydev)
702 mutex_lock(&joydev->mutex);
704 mutex_unlock(&joydev->mutex);
707 static void joydev_cleanup(struct joydev *joydev)
709 struct input_handle *handle = &joydev->handle;
711 joydev_mark_dead(joydev);
712 joydev_hangup(joydev);
713 joydev_remove_chrdev(joydev);
715 /* joydev is marked dead so noone else accesses joydev->open */
717 input_close_device(handle);
720 static int joydev_connect(struct input_handler *handler, struct input_dev *dev,
721 const struct input_device_id *id)
723 struct joydev *joydev;
727 for (minor = 0; minor < JOYDEV_MINORS; minor++)
728 if (!joydev_table[minor])
731 if (minor == JOYDEV_MINORS) {
732 printk(KERN_ERR "joydev: no more free joydev devices\n");
736 joydev = kzalloc(sizeof(struct joydev), GFP_KERNEL);
740 INIT_LIST_HEAD(&joydev->client_list);
741 spin_lock_init(&joydev->client_lock);
742 mutex_init(&joydev->mutex);
743 init_waitqueue_head(&joydev->wait);
745 snprintf(joydev->name, sizeof(joydev->name), "js%d", minor);
747 joydev->minor = minor;
750 joydev->handle.dev = input_get_device(dev);
751 joydev->handle.name = joydev->name;
752 joydev->handle.handler = handler;
753 joydev->handle.private = joydev;
755 for (i = 0; i < ABS_MAX + 1; i++)
756 if (test_bit(i, dev->absbit)) {
757 joydev->absmap[i] = joydev->nabs;
758 joydev->abspam[joydev->nabs] = i;
762 for (i = BTN_JOYSTICK - BTN_MISC; i < KEY_MAX - BTN_MISC + 1; i++)
763 if (test_bit(i + BTN_MISC, dev->keybit)) {
764 joydev->keymap[i] = joydev->nkey;
765 joydev->keypam[joydev->nkey] = i + BTN_MISC;
769 for (i = 0; i < BTN_JOYSTICK - BTN_MISC; i++)
770 if (test_bit(i + BTN_MISC, dev->keybit)) {
771 joydev->keymap[i] = joydev->nkey;
772 joydev->keypam[joydev->nkey] = i + BTN_MISC;
776 for (i = 0; i < joydev->nabs; i++) {
777 j = joydev->abspam[i];
778 if (dev->absmax[j] == dev->absmin[j]) {
779 joydev->corr[i].type = JS_CORR_NONE;
780 joydev->abs[i] = dev->abs[j];
783 joydev->corr[i].type = JS_CORR_BROKEN;
784 joydev->corr[i].prec = dev->absfuzz[j];
785 joydev->corr[i].coef[0] =
786 (dev->absmax[j] + dev->absmin[j]) / 2 - dev->absflat[j];
787 joydev->corr[i].coef[1] =
788 (dev->absmax[j] + dev->absmin[j]) / 2 + dev->absflat[j];
790 t = (dev->absmax[j] - dev->absmin[j]) / 2 - 2 * dev->absflat[j];
792 joydev->corr[i].coef[2] = (1 << 29) / t;
793 joydev->corr[i].coef[3] = (1 << 29) / t;
795 joydev->abs[i] = joydev_correct(dev->abs[j],
800 dev_set_name(&joydev->dev, joydev->name);
801 joydev->dev.devt = MKDEV(INPUT_MAJOR, JOYDEV_MINOR_BASE + minor);
802 joydev->dev.class = &input_class;
803 joydev->dev.parent = &dev->dev;
804 joydev->dev.release = joydev_free;
805 device_initialize(&joydev->dev);
807 error = input_register_handle(&joydev->handle);
809 goto err_free_joydev;
811 error = joydev_install_chrdev(joydev);
813 goto err_unregister_handle;
815 error = device_add(&joydev->dev);
817 goto err_cleanup_joydev;
822 joydev_cleanup(joydev);
823 err_unregister_handle:
824 input_unregister_handle(&joydev->handle);
826 put_device(&joydev->dev);
830 static void joydev_disconnect(struct input_handle *handle)
832 struct joydev *joydev = handle->private;
834 device_del(&joydev->dev);
835 joydev_cleanup(joydev);
836 input_unregister_handle(handle);
837 put_device(&joydev->dev);
840 static const struct input_device_id joydev_blacklist[] = {
842 .flags = INPUT_DEVICE_ID_MATCH_EVBIT |
843 INPUT_DEVICE_ID_MATCH_KEYBIT,
844 .evbit = { BIT_MASK(EV_KEY) },
845 .keybit = { [BIT_WORD(BTN_TOUCH)] = BIT_MASK(BTN_TOUCH) },
846 }, /* Avoid itouchpads, touchscreens and tablets */
847 { } /* Terminating entry */
850 static const struct input_device_id joydev_ids[] = {
852 .flags = INPUT_DEVICE_ID_MATCH_EVBIT |
853 INPUT_DEVICE_ID_MATCH_ABSBIT,
854 .evbit = { BIT_MASK(EV_ABS) },
855 .absbit = { BIT_MASK(ABS_X) },
858 .flags = INPUT_DEVICE_ID_MATCH_EVBIT |
859 INPUT_DEVICE_ID_MATCH_ABSBIT,
860 .evbit = { BIT_MASK(EV_ABS) },
861 .absbit = { BIT_MASK(ABS_WHEEL) },
864 .flags = INPUT_DEVICE_ID_MATCH_EVBIT |
865 INPUT_DEVICE_ID_MATCH_ABSBIT,
866 .evbit = { BIT_MASK(EV_ABS) },
867 .absbit = { BIT_MASK(ABS_THROTTLE) },
869 { } /* Terminating entry */
872 MODULE_DEVICE_TABLE(input, joydev_ids);
874 static struct input_handler joydev_handler = {
875 .event = joydev_event,
876 .connect = joydev_connect,
877 .disconnect = joydev_disconnect,
878 .fops = &joydev_fops,
879 .minor = JOYDEV_MINOR_BASE,
881 .id_table = joydev_ids,
882 .blacklist = joydev_blacklist,
885 static int __init joydev_init(void)
887 return input_register_handler(&joydev_handler);
890 static void __exit joydev_exit(void)
892 input_unregister_handler(&joydev_handler);
895 module_init(joydev_init);
896 module_exit(joydev_exit);