xref: /openbmc/linux/drivers/input/joydev.c (revision 87c2ce3b)
1 /*
2  * Joystick device driver for the input driver suite.
3  *
4  * Copyright (c) 1999-2002 Vojtech Pavlik
5  * Copyright (c) 1999 Colin Van Dyke
6  *
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.
11  */
12 
13 #include <asm/io.h>
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>
22 #include <linux/mm.h>
23 #include <linux/miscdevice.h>
24 #include <linux/module.h>
25 #include <linux/poll.h>
26 #include <linux/init.h>
27 #include <linux/smp_lock.h>
28 #include <linux/device.h>
29 
30 MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
31 MODULE_DESCRIPTION("Joystick device interfaces");
32 MODULE_SUPPORTED_DEVICE("input/js");
33 MODULE_LICENSE("GPL");
34 
35 #define JOYDEV_MINOR_BASE	0
36 #define JOYDEV_MINORS		16
37 #define JOYDEV_BUFFER_SIZE	64
38 
39 struct joydev {
40 	int exist;
41 	int open;
42 	int minor;
43 	char name[16];
44 	struct input_handle handle;
45 	wait_queue_head_t wait;
46 	struct list_head list;
47 	struct js_corr corr[ABS_MAX + 1];
48 	struct JS_DATA_SAVE_TYPE glue;
49 	int nabs;
50 	int nkey;
51 	__u16 keymap[KEY_MAX - BTN_MISC + 1];
52 	__u16 keypam[KEY_MAX - BTN_MISC + 1];
53 	__u8 absmap[ABS_MAX + 1];
54 	__u8 abspam[ABS_MAX + 1];
55 	__s16 abs[ABS_MAX + 1];
56 };
57 
58 struct joydev_list {
59 	struct js_event buffer[JOYDEV_BUFFER_SIZE];
60 	int head;
61 	int tail;
62 	int startup;
63 	struct fasync_struct *fasync;
64 	struct joydev *joydev;
65 	struct list_head node;
66 };
67 
68 static struct joydev *joydev_table[JOYDEV_MINORS];
69 
70 static int joydev_correct(int value, struct js_corr *corr)
71 {
72 	switch (corr->type) {
73 		case JS_CORR_NONE:
74 			break;
75 		case JS_CORR_BROKEN:
76 			value = value > corr->coef[0] ? (value < corr->coef[1] ? 0 :
77 				((corr->coef[3] * (value - corr->coef[1])) >> 14)) :
78 				((corr->coef[2] * (value - corr->coef[0])) >> 14);
79 			break;
80 		default:
81 			return 0;
82 	}
83 
84 	if (value < -32767) return -32767;
85 	if (value >  32767) return  32767;
86 
87 	return value;
88 }
89 
90 static void joydev_event(struct input_handle *handle, unsigned int type, unsigned int code, int value)
91 {
92 	struct joydev *joydev = handle->private;
93 	struct joydev_list *list;
94 	struct js_event event;
95 
96 	switch (type) {
97 
98 		case EV_KEY:
99 			if (code < BTN_MISC || value == 2) return;
100 			event.type = JS_EVENT_BUTTON;
101 			event.number = joydev->keymap[code - BTN_MISC];
102 			event.value = value;
103 			break;
104 
105 		case EV_ABS:
106 			event.type = JS_EVENT_AXIS;
107 			event.number = joydev->absmap[code];
108 			event.value = joydev_correct(value, joydev->corr + event.number);
109 			if (event.value == joydev->abs[event.number]) return;
110 			joydev->abs[event.number] = event.value;
111 			break;
112 
113 		default:
114 			return;
115 	}
116 
117 	event.time = jiffies_to_msecs(jiffies);
118 
119 	list_for_each_entry(list, &joydev->list, node) {
120 
121 		memcpy(list->buffer + list->head, &event, sizeof(struct js_event));
122 
123 		if (list->startup == joydev->nabs + joydev->nkey)
124 			if (list->tail == (list->head = (list->head + 1) & (JOYDEV_BUFFER_SIZE - 1)))
125 				list->startup = 0;
126 
127 		kill_fasync(&list->fasync, SIGIO, POLL_IN);
128 	}
129 
130 	wake_up_interruptible(&joydev->wait);
131 }
132 
133 static int joydev_fasync(int fd, struct file *file, int on)
134 {
135 	int retval;
136 	struct joydev_list *list = file->private_data;
137 	retval = fasync_helper(fd, file, on, &list->fasync);
138 	return retval < 0 ? retval : 0;
139 }
140 
141 static void joydev_free(struct joydev *joydev)
142 {
143 	joydev_table[joydev->minor] = NULL;
144 	kfree(joydev);
145 }
146 
147 static int joydev_release(struct inode * inode, struct file * file)
148 {
149 	struct joydev_list *list = file->private_data;
150 
151 	joydev_fasync(-1, file, 0);
152 
153 	list_del(&list->node);
154 
155 	if (!--list->joydev->open) {
156 		if (list->joydev->exist)
157 			input_close_device(&list->joydev->handle);
158 		else
159 			joydev_free(list->joydev);
160 	}
161 
162 	kfree(list);
163 	return 0;
164 }
165 
166 static int joydev_open(struct inode *inode, struct file *file)
167 {
168 	struct joydev_list *list;
169 	int i = iminor(inode) - JOYDEV_MINOR_BASE;
170 
171 	if (i >= JOYDEV_MINORS || !joydev_table[i])
172 		return -ENODEV;
173 
174 	if (!(list = kmalloc(sizeof(struct joydev_list), GFP_KERNEL)))
175 		return -ENOMEM;
176 	memset(list, 0, sizeof(struct joydev_list));
177 
178 	list->joydev = joydev_table[i];
179 	list_add_tail(&list->node, &joydev_table[i]->list);
180 	file->private_data = list;
181 
182 	if (!list->joydev->open++)
183 		if (list->joydev->exist)
184 			input_open_device(&list->joydev->handle);
185 
186 	return 0;
187 }
188 
189 static ssize_t joydev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
190 {
191 	return -EINVAL;
192 }
193 
194 static ssize_t joydev_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
195 {
196 	struct joydev_list *list = file->private_data;
197 	struct joydev *joydev = list->joydev;
198 	struct input_dev *input = joydev->handle.dev;
199 	int retval = 0;
200 
201 	if (!list->joydev->exist)
202 		return -ENODEV;
203 
204 	if (count < sizeof(struct js_event))
205 		return -EINVAL;
206 
207 	if (count == sizeof(struct JS_DATA_TYPE)) {
208 
209 		struct JS_DATA_TYPE data;
210 		int i;
211 
212 		for (data.buttons = i = 0; i < 32 && i < joydev->nkey; i++)
213 			data.buttons |= test_bit(joydev->keypam[i], input->key) ? (1 << i) : 0;
214 		data.x = (joydev->abs[0] / 256 + 128) >> joydev->glue.JS_CORR.x;
215 		data.y = (joydev->abs[1] / 256 + 128) >> joydev->glue.JS_CORR.y;
216 
217 		if (copy_to_user(buf, &data, sizeof(struct JS_DATA_TYPE)))
218 			return -EFAULT;
219 
220 		list->startup = 0;
221 		list->tail = list->head;
222 
223 		return sizeof(struct JS_DATA_TYPE);
224 	}
225 
226 	if (list->startup == joydev->nabs + joydev->nkey
227 		&& list->head == list->tail && (file->f_flags & O_NONBLOCK))
228 			return -EAGAIN;
229 
230 	retval = wait_event_interruptible(list->joydev->wait,
231 		 			  !list->joydev->exist ||
232 					  list->startup < joydev->nabs + joydev->nkey ||
233 					  list->head != list->tail);
234 
235 	if (retval)
236 		return retval;
237 
238 	if (!list->joydev->exist)
239 		return -ENODEV;
240 
241 	while (list->startup < joydev->nabs + joydev->nkey && retval + sizeof(struct js_event) <= count) {
242 
243 		struct js_event event;
244 
245 		event.time = jiffies_to_msecs(jiffies);
246 
247 		if (list->startup < joydev->nkey) {
248 			event.type = JS_EVENT_BUTTON | JS_EVENT_INIT;
249 			event.number = list->startup;
250 			event.value = !!test_bit(joydev->keypam[event.number], input->key);
251 		} else {
252 			event.type = JS_EVENT_AXIS | JS_EVENT_INIT;
253 			event.number = list->startup - joydev->nkey;
254 			event.value = joydev->abs[event.number];
255 		}
256 
257 		if (copy_to_user(buf + retval, &event, sizeof(struct js_event)))
258 			return -EFAULT;
259 
260 		list->startup++;
261 		retval += sizeof(struct js_event);
262 	}
263 
264 	while (list->head != list->tail && retval + sizeof(struct js_event) <= count) {
265 
266 		if (copy_to_user(buf + retval, list->buffer + list->tail, sizeof(struct js_event)))
267 			return -EFAULT;
268 
269 		list->tail = (list->tail + 1) & (JOYDEV_BUFFER_SIZE - 1);
270 		retval += sizeof(struct js_event);
271 	}
272 
273 	return retval;
274 }
275 
276 /* No kernel lock - fine */
277 static unsigned int joydev_poll(struct file *file, poll_table *wait)
278 {
279 	struct joydev_list *list = file->private_data;
280 	poll_wait(file, &list->joydev->wait, wait);
281 	return ((list->head != list->tail || list->startup < list->joydev->nabs + list->joydev->nkey) ?
282 		(POLLIN | POLLRDNORM) : 0) | (list->joydev->exist ? 0 : (POLLHUP | POLLERR));
283 }
284 
285 static int joydev_ioctl_common(struct joydev *joydev, unsigned int cmd, void __user *argp)
286 {
287 	struct input_dev *dev = joydev->handle.dev;
288 	int i, j;
289 
290 	switch (cmd) {
291 
292 		case JS_SET_CAL:
293 			return copy_from_user(&joydev->glue.JS_CORR, argp,
294 				sizeof(joydev->glue.JS_CORR)) ? -EFAULT : 0;
295 		case JS_GET_CAL:
296 			return copy_to_user(argp, &joydev->glue.JS_CORR,
297 				sizeof(joydev->glue.JS_CORR)) ? -EFAULT : 0;
298 		case JS_SET_TIMEOUT:
299 			return get_user(joydev->glue.JS_TIMEOUT, (s32 __user *) argp);
300 		case JS_GET_TIMEOUT:
301 			return put_user(joydev->glue.JS_TIMEOUT, (s32 __user *) argp);
302 
303 		case JSIOCGVERSION:
304 			return put_user(JS_VERSION, (__u32 __user *) argp);
305 		case JSIOCGAXES:
306 			return put_user(joydev->nabs, (__u8 __user *) argp);
307 		case JSIOCGBUTTONS:
308 			return put_user(joydev->nkey, (__u8 __user *) argp);
309 		case JSIOCSCORR:
310 			if (copy_from_user(joydev->corr, argp,
311 				      sizeof(joydev->corr[0]) * joydev->nabs))
312 			    return -EFAULT;
313 			for (i = 0; i < joydev->nabs; i++) {
314 				j = joydev->abspam[i];
315 			        joydev->abs[i] = joydev_correct(dev->abs[j], joydev->corr + i);
316 			}
317 			return 0;
318 		case JSIOCGCORR:
319 			return copy_to_user(argp, joydev->corr,
320 						sizeof(joydev->corr[0]) * joydev->nabs) ? -EFAULT : 0;
321 		case JSIOCSAXMAP:
322 			if (copy_from_user(joydev->abspam, argp, sizeof(__u8) * (ABS_MAX + 1)))
323 				return -EFAULT;
324 			for (i = 0; i < joydev->nabs; i++) {
325 				if (joydev->abspam[i] > ABS_MAX) return -EINVAL;
326 				joydev->absmap[joydev->abspam[i]] = i;
327 			}
328 			return 0;
329 		case JSIOCGAXMAP:
330 			return copy_to_user(argp, joydev->abspam,
331 						sizeof(__u8) * (ABS_MAX + 1)) ? -EFAULT : 0;
332 		case JSIOCSBTNMAP:
333 			if (copy_from_user(joydev->keypam, argp, sizeof(__u16) * (KEY_MAX - BTN_MISC + 1)))
334 				return -EFAULT;
335 			for (i = 0; i < joydev->nkey; i++) {
336 				if (joydev->keypam[i] > KEY_MAX || joydev->keypam[i] < BTN_MISC) return -EINVAL;
337 				joydev->keymap[joydev->keypam[i] - BTN_MISC] = i;
338 			}
339 			return 0;
340 		case JSIOCGBTNMAP:
341 			return copy_to_user(argp, joydev->keypam,
342 						sizeof(__u16) * (KEY_MAX - BTN_MISC + 1)) ? -EFAULT : 0;
343 		default:
344 			if ((cmd & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT)) == JSIOCGNAME(0)) {
345 				int len;
346 				if (!dev->name) return 0;
347 				len = strlen(dev->name) + 1;
348 				if (len > _IOC_SIZE(cmd)) len = _IOC_SIZE(cmd);
349 				if (copy_to_user(argp, dev->name, len)) return -EFAULT;
350 				return len;
351 			}
352 	}
353 	return -EINVAL;
354 }
355 
356 #ifdef CONFIG_COMPAT
357 static long joydev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
358 {
359 	struct joydev_list *list = file->private_data;
360 	struct joydev *joydev = list->joydev;
361 	void __user *argp = (void __user *)arg;
362 	s32 tmp32;
363 	struct JS_DATA_SAVE_TYPE_32 ds32;
364 	int err;
365 
366 	if (!joydev->exist) return -ENODEV;
367 	switch(cmd) {
368 	case JS_SET_TIMELIMIT:
369 		err = get_user(tmp32, (s32 __user *) arg);
370 		if (err == 0)
371 			joydev->glue.JS_TIMELIMIT = tmp32;
372 		break;
373 	case JS_GET_TIMELIMIT:
374 		tmp32 = joydev->glue.JS_TIMELIMIT;
375 		err = put_user(tmp32, (s32 __user *) arg);
376 		break;
377 
378 	case JS_SET_ALL:
379 		err = copy_from_user(&ds32, argp,
380 				     sizeof(ds32)) ? -EFAULT : 0;
381 		if (err == 0) {
382 			joydev->glue.JS_TIMEOUT    = ds32.JS_TIMEOUT;
383 			joydev->glue.BUSY          = ds32.BUSY;
384 			joydev->glue.JS_EXPIRETIME = ds32.JS_EXPIRETIME;
385 			joydev->glue.JS_TIMELIMIT  = ds32.JS_TIMELIMIT;
386 			joydev->glue.JS_SAVE       = ds32.JS_SAVE;
387 			joydev->glue.JS_CORR       = ds32.JS_CORR;
388 		}
389 		break;
390 
391 	case JS_GET_ALL:
392 		ds32.JS_TIMEOUT    = joydev->glue.JS_TIMEOUT;
393 		ds32.BUSY          = joydev->glue.BUSY;
394 		ds32.JS_EXPIRETIME = joydev->glue.JS_EXPIRETIME;
395 		ds32.JS_TIMELIMIT  = joydev->glue.JS_TIMELIMIT;
396 		ds32.JS_SAVE       = joydev->glue.JS_SAVE;
397 		ds32.JS_CORR       = joydev->glue.JS_CORR;
398 
399 		err = copy_to_user(argp, &ds32,
400 					  sizeof(ds32)) ? -EFAULT : 0;
401 		break;
402 
403 	default:
404 		err = joydev_ioctl_common(joydev, cmd, argp);
405 	}
406 	return err;
407 }
408 #endif /* CONFIG_COMPAT */
409 
410 static int joydev_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
411 {
412 	struct joydev_list *list = file->private_data;
413 	struct joydev *joydev = list->joydev;
414 	void __user *argp = (void __user *)arg;
415 
416 	if (!joydev->exist) return -ENODEV;
417 
418 	switch(cmd) {
419 		case JS_SET_TIMELIMIT:
420 			return get_user(joydev->glue.JS_TIMELIMIT, (long __user *) arg);
421 		case JS_GET_TIMELIMIT:
422 			return put_user(joydev->glue.JS_TIMELIMIT, (long __user *) arg);
423 		case JS_SET_ALL:
424 			return copy_from_user(&joydev->glue, argp,
425 						sizeof(joydev->glue)) ? -EFAULT : 0;
426 		case JS_GET_ALL:
427 			return copy_to_user(argp, &joydev->glue,
428 						sizeof(joydev->glue)) ? -EFAULT : 0;
429 		default:
430 			return joydev_ioctl_common(joydev, cmd, argp);
431 	}
432 }
433 
434 static struct file_operations joydev_fops = {
435 	.owner =	THIS_MODULE,
436 	.read =		joydev_read,
437 	.write =	joydev_write,
438 	.poll =		joydev_poll,
439 	.open =		joydev_open,
440 	.release =	joydev_release,
441 	.ioctl =	joydev_ioctl,
442 #ifdef CONFIG_COMPAT
443 	.compat_ioctl =	joydev_compat_ioctl,
444 #endif
445 	.fasync =	joydev_fasync,
446 };
447 
448 static struct input_handle *joydev_connect(struct input_handler *handler, struct input_dev *dev, struct input_device_id *id)
449 {
450 	struct joydev *joydev;
451 	struct class_device *cdev;
452 	int i, j, t, minor;
453 
454 	for (minor = 0; minor < JOYDEV_MINORS && joydev_table[minor]; minor++);
455 	if (minor == JOYDEV_MINORS) {
456 		printk(KERN_ERR "joydev: no more free joydev devices\n");
457 		return NULL;
458 	}
459 
460 	if (!(joydev = kmalloc(sizeof(struct joydev), GFP_KERNEL)))
461 		return NULL;
462 	memset(joydev, 0, sizeof(struct joydev));
463 
464 	INIT_LIST_HEAD(&joydev->list);
465 	init_waitqueue_head(&joydev->wait);
466 
467 	joydev->minor = minor;
468 	joydev->exist = 1;
469 	joydev->handle.dev = dev;
470 	joydev->handle.name = joydev->name;
471 	joydev->handle.handler = handler;
472 	joydev->handle.private = joydev;
473 	sprintf(joydev->name, "js%d", minor);
474 
475 	for (i = 0; i < ABS_MAX + 1; i++)
476 		if (test_bit(i, dev->absbit)) {
477 			joydev->absmap[i] = joydev->nabs;
478 			joydev->abspam[joydev->nabs] = i;
479 			joydev->nabs++;
480 		}
481 
482 	for (i = BTN_JOYSTICK - BTN_MISC; i < KEY_MAX - BTN_MISC + 1; i++)
483 		if (test_bit(i + BTN_MISC, dev->keybit)) {
484 			joydev->keymap[i] = joydev->nkey;
485 			joydev->keypam[joydev->nkey] = i + BTN_MISC;
486 			joydev->nkey++;
487 		}
488 
489 	for (i = 0; i < BTN_JOYSTICK - BTN_MISC; i++)
490 		if (test_bit(i + BTN_MISC, dev->keybit)) {
491 			joydev->keymap[i] = joydev->nkey;
492 			joydev->keypam[joydev->nkey] = i + BTN_MISC;
493 			joydev->nkey++;
494 		}
495 
496 	for (i = 0; i < joydev->nabs; i++) {
497 		j = joydev->abspam[i];
498 		if (dev->absmax[j] == dev->absmin[j]) {
499 			joydev->corr[i].type = JS_CORR_NONE;
500 			joydev->abs[i] = dev->abs[j];
501 			continue;
502 		}
503 		joydev->corr[i].type = JS_CORR_BROKEN;
504 		joydev->corr[i].prec = dev->absfuzz[j];
505 		joydev->corr[i].coef[0] = (dev->absmax[j] + dev->absmin[j]) / 2 - dev->absflat[j];
506 		joydev->corr[i].coef[1] = (dev->absmax[j] + dev->absmin[j]) / 2 + dev->absflat[j];
507 		if (!(t = ((dev->absmax[j] - dev->absmin[j]) / 2 - 2 * dev->absflat[j])))
508 			continue;
509 		joydev->corr[i].coef[2] = (1 << 29) / t;
510 		joydev->corr[i].coef[3] = (1 << 29) / t;
511 
512 		joydev->abs[i] = joydev_correct(dev->abs[j], joydev->corr + i);
513 	}
514 
515 	joydev_table[minor] = joydev;
516 
517 	cdev = class_device_create(&input_class, &dev->cdev,
518 			MKDEV(INPUT_MAJOR, JOYDEV_MINOR_BASE + minor),
519 			dev->cdev.dev, joydev->name);
520 
521 	/* temporary symlink to keep userspace happy */
522 	sysfs_create_link(&input_class.subsys.kset.kobj, &cdev->kobj,
523 			  joydev->name);
524 
525 	return &joydev->handle;
526 }
527 
528 static void joydev_disconnect(struct input_handle *handle)
529 {
530 	struct joydev *joydev = handle->private;
531 	struct joydev_list *list;
532 
533 	sysfs_remove_link(&input_class.subsys.kset.kobj, joydev->name);
534 	class_device_destroy(&input_class, MKDEV(INPUT_MAJOR, JOYDEV_MINOR_BASE + joydev->minor));
535 	joydev->exist = 0;
536 
537 	if (joydev->open) {
538 		input_close_device(handle);
539 		wake_up_interruptible(&joydev->wait);
540 		list_for_each_entry(list, &joydev->list, node)
541 			kill_fasync(&list->fasync, SIGIO, POLL_HUP);
542 	} else
543 		joydev_free(joydev);
544 }
545 
546 static struct input_device_id joydev_blacklist[] = {
547 	{
548 		.flags = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_KEYBIT,
549 		.evbit = { BIT(EV_KEY) },
550 		.keybit = { [LONG(BTN_TOUCH)] = BIT(BTN_TOUCH) },
551 	}, 	/* Avoid itouchpads, touchscreens and tablets */
552 	{ }, 	/* Terminating entry */
553 };
554 
555 static struct input_device_id joydev_ids[] = {
556 	{
557 		.flags = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
558 		.evbit = { BIT(EV_ABS) },
559 		.absbit = { BIT(ABS_X) },
560 	},
561 	{
562 		.flags = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
563 		.evbit = { BIT(EV_ABS) },
564 		.absbit = { BIT(ABS_WHEEL) },
565 	},
566 	{
567 		.flags = INPUT_DEVICE_ID_MATCH_EVBIT | INPUT_DEVICE_ID_MATCH_ABSBIT,
568 		.evbit = { BIT(EV_ABS) },
569 		.absbit = { BIT(ABS_THROTTLE) },
570 	},
571 	{ }, 	/* Terminating entry */
572 };
573 
574 MODULE_DEVICE_TABLE(input, joydev_ids);
575 
576 static struct input_handler joydev_handler = {
577 	.event =	joydev_event,
578 	.connect =	joydev_connect,
579 	.disconnect =	joydev_disconnect,
580 	.fops =		&joydev_fops,
581 	.minor =	JOYDEV_MINOR_BASE,
582 	.name =		"joydev",
583 	.id_table =	joydev_ids,
584 	.blacklist = 	joydev_blacklist,
585 };
586 
587 static int __init joydev_init(void)
588 {
589 	input_register_handler(&joydev_handler);
590 	return 0;
591 }
592 
593 static void __exit joydev_exit(void)
594 {
595 	input_unregister_handler(&joydev_handler);
596 }
597 
598 module_init(joydev_init);
599 module_exit(joydev_exit);
600