hiddev.c 23.9 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/*
 *  Copyright (c) 2001 Paul Stewart
 *  Copyright (c) 2001 Vojtech Pavlik
 *
 *  HID char devices, giving access to raw HID device events.
 *
 */

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Should you need to contact me, the author, you can do so either by
 * e-mail - mail your message to Paul Stewart <stewart@wetlogic.net>
 */

#include <linux/poll.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/smp_lock.h>
#include <linux/input.h>
#include <linux/usb.h>
35
#include <linux/hid.h>
Linus Torvalds's avatar
Linus Torvalds committed
36
#include <linux/hiddev.h>
37
#include <linux/compat.h>
38
#include "usbhid.h"
Linus Torvalds's avatar
Linus Torvalds committed
39
40
41
42
43
44
45
46
47
48
49
50
51

#ifdef CONFIG_USB_DYNAMIC_MINORS
#define HIDDEV_MINOR_BASE	0
#define HIDDEV_MINORS		256
#else
#define HIDDEV_MINOR_BASE	96
#define HIDDEV_MINORS		16
#endif
#define HIDDEV_BUFFER_SIZE	64

struct hiddev {
	int exist;
	int open;
52
	struct mutex existancelock;
Linus Torvalds's avatar
Linus Torvalds committed
53
54
	wait_queue_head_t wait;
	struct hid_device *hid;
55
	struct list_head list;
56
	spinlock_t list_lock;
Linus Torvalds's avatar
Linus Torvalds committed
57
58
59
60
61
62
63
64
65
};

struct hiddev_list {
	struct hiddev_usage_ref buffer[HIDDEV_BUFFER_SIZE];
	int head;
	int tail;
	unsigned flags;
	struct fasync_struct *fasync;
	struct hiddev *hiddev;
66
	struct list_head node;
67
	struct mutex thread_lock;
Linus Torvalds's avatar
Linus Torvalds committed
68
69
70
71
72
73
74
75
76
77
78
79
80
};

static struct hiddev *hiddev_table[HIDDEV_MINORS];

/*
 * Find a report, given the report's type and ID.  The ID can be specified
 * indirectly by REPORT_ID_FIRST (which returns the first report of the given
 * type) or by (REPORT_ID_NEXT | old_id), which returns the next report of the
 * given type which follows old_id.
 */
static struct hid_report *
hiddev_lookup_report(struct hid_device *hid, struct hiddev_report_info *rinfo)
{
81
82
	unsigned int flags = rinfo->report_id & ~HID_REPORT_ID_MASK;
	unsigned int rid = rinfo->report_id & HID_REPORT_ID_MASK;
Linus Torvalds's avatar
Linus Torvalds committed
83
	struct hid_report_enum *report_enum;
84
	struct hid_report *report;
Linus Torvalds's avatar
Linus Torvalds committed
85
86
87
	struct list_head *list;

	if (rinfo->report_type < HID_REPORT_TYPE_MIN ||
88
89
	    rinfo->report_type > HID_REPORT_TYPE_MAX)
		return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
90
91
92
93
94
95
96
97
98

	report_enum = hid->report_enum +
		(rinfo->report_type - HID_REPORT_TYPE_MIN);

	switch (flags) {
	case 0: /* Nothing to do -- report_id is already set correctly */
		break;

	case HID_REPORT_ID_FIRST:
99
		if (list_empty(&report_enum->report_list))
Linus Torvalds's avatar
Linus Torvalds committed
100
			return NULL;
101
102
103
104

		list = report_enum->report_list.next;
		report = list_entry(list, struct hid_report, list);
		rinfo->report_id = report->id;
Linus Torvalds's avatar
Linus Torvalds committed
105
		break;
106

Linus Torvalds's avatar
Linus Torvalds committed
107
	case HID_REPORT_ID_NEXT:
108
109
		report = report_enum->report_id_hash[rid];
		if (!report)
Linus Torvalds's avatar
Linus Torvalds committed
110
			return NULL;
111
112

		list = report->list.next;
Linus Torvalds's avatar
Linus Torvalds committed
113
114
		if (list == &report_enum->report_list)
			return NULL;
115
116
117

		report = list_entry(list, struct hid_report, list);
		rinfo->report_id = report->id;
Linus Torvalds's avatar
Linus Torvalds committed
118
		break;
119

Linus Torvalds's avatar
Linus Torvalds committed
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
	default:
		return NULL;
	}

	return report_enum->report_id_hash[rinfo->report_id];
}

/*
 * Perform an exhaustive search of the report table for a usage, given its
 * type and usage id.
 */
static struct hid_field *
hiddev_lookup_usage(struct hid_device *hid, struct hiddev_usage_ref *uref)
{
	int i, j;
	struct hid_report *report;
	struct hid_report_enum *report_enum;
	struct hid_field *field;

	if (uref->report_type < HID_REPORT_TYPE_MIN ||
140
141
	    uref->report_type > HID_REPORT_TYPE_MAX)
		return NULL;
Linus Torvalds's avatar
Linus Torvalds committed
142
143
144
145

	report_enum = hid->report_enum +
		(uref->report_type - HID_REPORT_TYPE_MIN);

146
	list_for_each_entry(report, &report_enum->report_list, list) {
Linus Torvalds's avatar
Linus Torvalds committed
147
148
149
150
151
152
153
154
155
156
157
		for (i = 0; i < report->maxfield; i++) {
			field = report->field[i];
			for (j = 0; j < field->maxusage; j++) {
				if (field->usage[j].hid == uref->usage_code) {
					uref->report_id = report->id;
					uref->field_index = i;
					uref->usage_index = j;
					return field;
				}
			}
		}
158
	}
Linus Torvalds's avatar
Linus Torvalds committed
159
160
161
162
163
164
165
166

	return NULL;
}

static void hiddev_send_event(struct hid_device *hid,
			      struct hiddev_usage_ref *uref)
{
	struct hiddev *hiddev = hid->hiddev;
167
	struct hiddev_list *list;
168
	unsigned long flags;
Linus Torvalds's avatar
Linus Torvalds committed
169

170
	spin_lock_irqsave(&hiddev->list_lock, flags);
171
	list_for_each_entry(list, &hiddev->list, node) {
Linus Torvalds's avatar
Linus Torvalds committed
172
173
174
		if (uref->field_index != HID_FIELD_INDEX_NONE ||
		    (list->flags & HIDDEV_FLAG_REPORT) != 0) {
			list->buffer[list->head] = *uref;
175
			list->head = (list->head + 1) &
Linus Torvalds's avatar
Linus Torvalds committed
176
177
178
179
				(HIDDEV_BUFFER_SIZE - 1);
			kill_fasync(&list->fasync, SIGIO, POLL_IN);
		}
	}
180
	spin_unlock_irqrestore(&hiddev->list_lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
181
182
183
184
185
186
187
188
189

	wake_up_interruptible(&hiddev->wait);
}

/*
 * This is where hid.c calls into hiddev to pass an event that occurred over
 * the interrupt pipe
 */
void hiddev_hid_event(struct hid_device *hid, struct hid_field *field,
190
		      struct hid_usage *usage, __s32 value)
Linus Torvalds's avatar
Linus Torvalds committed
191
192
193
194
{
	unsigned type = field->report_type;
	struct hiddev_usage_ref uref;

195
	uref.report_type =
Linus Torvalds's avatar
Linus Torvalds committed
196
	  (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
197
	  ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
198
	   ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
Linus Torvalds's avatar
Linus Torvalds committed
199
200
201
202
203
204
205
206
	uref.report_id = field->report->id;
	uref.field_index = field->index;
	uref.usage_index = (usage - field->usage);
	uref.usage_code = usage->hid;
	uref.value = value;

	hiddev_send_event(hid, &uref);
}
Jiri Kosina's avatar
Jiri Kosina committed
207
EXPORT_SYMBOL_GPL(hiddev_hid_event);
Linus Torvalds's avatar
Linus Torvalds committed
208
209
210
211
212
213
214

void hiddev_report_event(struct hid_device *hid, struct hid_report *report)
{
	unsigned type = report->type;
	struct hiddev_usage_ref uref;

	memset(&uref, 0, sizeof(uref));
215
	uref.report_type =
Linus Torvalds's avatar
Linus Torvalds committed
216
	  (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
217
	  ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
218
	   ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
Linus Torvalds's avatar
Linus Torvalds committed
219
220
221
222
223
	uref.report_id = report->id;
	uref.field_index = HID_FIELD_INDEX_NONE;

	hiddev_send_event(hid, &uref);
}
224

Linus Torvalds's avatar
Linus Torvalds committed
225
226
227
228
229
230
/*
 * fasync file op
 */
static int hiddev_fasync(int fd, struct file *file, int on)
{
	struct hiddev_list *list = file->private_data;
231

232
	return fasync_helper(fd, file, on, &list->fasync);
Linus Torvalds's avatar
Linus Torvalds committed
233
234
235
236
237
238
239
240
241
}


/*
 * release file op
 */
static int hiddev_release(struct inode * inode, struct file * file)
{
	struct hiddev_list *list = file->private_data;
242
	unsigned long flags;
Linus Torvalds's avatar
Linus Torvalds committed
243

244
	spin_lock_irqsave(&list->hiddev->list_lock, flags);
245
	list_del(&list->node);
246
	spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
247
248

	if (!--list->hiddev->open) {
249
		if (list->hiddev->exist) {
250
			usbhid_close(list->hiddev->hid);
251
252
			usbhid_put_power(list->hiddev->hid);
		} else {
Linus Torvalds's avatar
Linus Torvalds committed
253
			kfree(list->hiddev);
254
		}
Linus Torvalds's avatar
Linus Torvalds committed
255
256
257
258
259
260
261
262
263
264
	}

	kfree(list);

	return 0;
}

/*
 * open file op
 */
265
266
static int hiddev_open(struct inode *inode, struct file *file)
{
Linus Torvalds's avatar
Linus Torvalds committed
267
	struct hiddev_list *list;
268
	int res;
Linus Torvalds's avatar
Linus Torvalds committed
269
270
271

	int i = iminor(inode) - HIDDEV_MINOR_BASE;

272
	if (i >= HIDDEV_MINORS || i < 0 || !hiddev_table[i])
Linus Torvalds's avatar
Linus Torvalds committed
273
274
		return -ENODEV;

Oliver Neukum's avatar
Oliver Neukum committed
275
	if (!(list = kzalloc(sizeof(struct hiddev_list), GFP_KERNEL)))
Linus Torvalds's avatar
Linus Torvalds committed
276
		return -ENOMEM;
277
	mutex_init(&list->thread_lock);
Linus Torvalds's avatar
Linus Torvalds committed
278
279

	list->hiddev = hiddev_table[i];
280
281


Linus Torvalds's avatar
Linus Torvalds committed
282
283
	file->private_data = list;

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
	/*
	 * no need for locking because the USB major number
	 * is shared which usbcore guards against disconnect
	 */
	if (list->hiddev->exist) {
		if (!list->hiddev->open++) {
			res = usbhid_open(hiddev_table[i]->hid);
			if (res < 0) {
				res = -EIO;
				goto bail;
			}
		}
	} else {
		res = -ENODEV;
		goto bail;
	}

	spin_lock_irq(&list->hiddev->list_lock);
	list_add_tail(&list->node, &hiddev_table[i]->list);
	spin_unlock_irq(&list->hiddev->list_lock);
Linus Torvalds's avatar
Linus Torvalds committed
304

305
306
307
308
309
310
311
312
313
314
315
	if (!list->hiddev->open++)
		if (list->hiddev->exist) {
			struct hid_device *hid = hiddev_table[i]->hid;
			res = usbhid_get_power(hid);
			if (res < 0) {
				res = -EIO;
				goto bail;
			}
			usbhid_open(hid);
		}

Linus Torvalds's avatar
Linus Torvalds committed
316
	return 0;
317
318
bail:
	file->private_data = NULL;
319
	kfree(list);
320
	return res;
Linus Torvalds's avatar
Linus Torvalds committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
}

/*
 * "write" file op
 */
static ssize_t hiddev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
{
	return -EINVAL;
}

/*
 * "read" file op
 */
static ssize_t hiddev_read(struct file * file, char __user * buffer, size_t count, loff_t *ppos)
{
336
	DEFINE_WAIT(wait);
Linus Torvalds's avatar
Linus Torvalds committed
337
338
	struct hiddev_list *list = file->private_data;
	int event_size;
339
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
340
341
342
343
344
345
346

	event_size = ((list->flags & HIDDEV_FLAG_UREF) != 0) ?
		sizeof(struct hiddev_usage_ref) : sizeof(struct hiddev_event);

	if (count < event_size)
		return 0;

347
348
349
350
351
	/* lock against other threads */
	retval = mutex_lock_interruptible(&list->thread_lock);
	if (retval)
		return -ERESTARTSYS;

Linus Torvalds's avatar
Linus Torvalds committed
352
353
	while (retval == 0) {
		if (list->head == list->tail) {
354
			prepare_to_wait(&list->hiddev->wait, &wait, TASK_INTERRUPTIBLE);
355

Linus Torvalds's avatar
Linus Torvalds committed
356
357
358
359
360
361
362
363
364
365
366
367
368
			while (list->head == list->tail) {
				if (file->f_flags & O_NONBLOCK) {
					retval = -EAGAIN;
					break;
				}
				if (signal_pending(current)) {
					retval = -ERESTARTSYS;
					break;
				}
				if (!list->hiddev->exist) {
					retval = -EIO;
					break;
				}
369

370
371
				/* let O_NONBLOCK tasks run */
				mutex_unlock(&list->thread_lock);
Linus Torvalds's avatar
Linus Torvalds committed
372
				schedule();
373
374
				if (mutex_lock_interruptible(&list->thread_lock))
					return -EINTR;
Micon, David's avatar
Micon, David committed
375
				set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds's avatar
Linus Torvalds committed
376
			}
377
			finish_wait(&list->hiddev->wait, &wait);
Linus Torvalds's avatar
Linus Torvalds committed
378
379
380

		}

381
382
		if (retval) {
			mutex_unlock(&list->thread_lock);
Linus Torvalds's avatar
Linus Torvalds committed
383
			return retval;
384
		}
Linus Torvalds's avatar
Linus Torvalds committed
385
386


387
		while (list->head != list->tail &&
Linus Torvalds's avatar
Linus Torvalds committed
388
389
		       retval + event_size <= count) {
			if ((list->flags & HIDDEV_FLAG_UREF) == 0) {
390
				if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE) {
Linus Torvalds's avatar
Linus Torvalds committed
391
					struct hiddev_event event;
392

Linus Torvalds's avatar
Linus Torvalds committed
393
394
					event.hid = list->buffer[list->tail].usage_code;
					event.value = list->buffer[list->tail].value;
395
396
					if (copy_to_user(buffer + retval, &event, sizeof(struct hiddev_event))) {
						mutex_unlock(&list->thread_lock);
Linus Torvalds's avatar
Linus Torvalds committed
397
						return -EFAULT;
398
					}
Linus Torvalds's avatar
Linus Torvalds committed
399
400
401
402
403
					retval += sizeof(struct hiddev_event);
				}
			} else {
				if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE ||
				    (list->flags & HIDDEV_FLAG_REPORT) != 0) {
404
405
406

					if (copy_to_user(buffer + retval, list->buffer + list->tail, sizeof(struct hiddev_usage_ref))) {
						mutex_unlock(&list->thread_lock);
Linus Torvalds's avatar
Linus Torvalds committed
407
						return -EFAULT;
408
					}
Linus Torvalds's avatar
Linus Torvalds committed
409
410
411
412
413
414
415
					retval += sizeof(struct hiddev_usage_ref);
				}
			}
			list->tail = (list->tail + 1) & (HIDDEV_BUFFER_SIZE - 1);
		}

	}
416
	mutex_unlock(&list->thread_lock);
Linus Torvalds's avatar
Linus Torvalds committed
417
418
419
420
421
422
423
424
425
426
427

	return retval;
}

/*
 * "poll" file op
 * No kernel lock - fine
 */
static unsigned int hiddev_poll(struct file *file, poll_table *wait)
{
	struct hiddev_list *list = file->private_data;
428

Linus Torvalds's avatar
Linus Torvalds committed
429
430
431
432
433
434
435
436
437
438
439
	poll_wait(file, &list->hiddev->wait, wait);
	if (list->head != list->tail)
		return POLLIN | POLLRDNORM;
	if (!list->hiddev->exist)
		return POLLERR | POLLHUP;
	return 0;
}

/*
 * "ioctl" file op
 */
440
441
442
443
444
445
446
447
448
449
450
451
452
static noinline int hiddev_ioctl_usage(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
{
	struct hid_device *hid = hiddev->hid;
	struct hiddev_report_info rinfo;
	struct hiddev_usage_ref_multi *uref_multi = NULL;
	struct hiddev_usage_ref *uref;
	struct hid_report *report;
	struct hid_field *field;
	int i;

	uref_multi = kmalloc(sizeof(struct hiddev_usage_ref_multi), GFP_KERNEL);
	if (!uref_multi)
		return -ENOMEM;
453
	lock_kernel();
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
	uref = &uref_multi->uref;
	if (cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) {
		if (copy_from_user(uref_multi, user_arg,
				   sizeof(*uref_multi)))
			goto fault;
	} else {
		if (copy_from_user(uref, user_arg, sizeof(*uref)))
			goto fault;
	}

	switch (cmd) {
	case HIDIOCGUCODE:
		rinfo.report_type = uref->report_type;
		rinfo.report_id = uref->report_id;
		if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
			goto inval;

		if (uref->field_index >= report->maxfield)
			goto inval;

		field = report->field[uref->field_index];
		if (uref->usage_index >= field->maxusage)
			goto inval;

		uref->usage_code = field->usage[uref->usage_index].hid;

		if (copy_to_user(user_arg, uref, sizeof(*uref)))
			goto fault;

Jiri Slaby's avatar
Jiri Slaby committed
483
		goto goodreturn;
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529

	default:
		if (cmd != HIDIOCGUSAGE &&
		    cmd != HIDIOCGUSAGES &&
		    uref->report_type == HID_REPORT_TYPE_INPUT)
			goto inval;

		if (uref->report_id == HID_REPORT_ID_UNKNOWN) {
			field = hiddev_lookup_usage(hid, uref);
			if (field == NULL)
				goto inval;
		} else {
			rinfo.report_type = uref->report_type;
			rinfo.report_id = uref->report_id;
			if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
				goto inval;

			if (uref->field_index >= report->maxfield)
				goto inval;

			field = report->field[uref->field_index];

			if (cmd == HIDIOCGCOLLECTIONINDEX) {
				if (uref->usage_index >= field->maxusage)
					goto inval;
			} else if (uref->usage_index >= field->report_count)
				goto inval;

			else if ((cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) &&
				 (uref_multi->num_values > HID_MAX_MULTI_USAGES ||
				  uref->usage_index + uref_multi->num_values > field->report_count))
				goto inval;
			}

		switch (cmd) {
		case HIDIOCGUSAGE:
			uref->value = field->value[uref->usage_index];
			if (copy_to_user(user_arg, uref, sizeof(*uref)))
				goto fault;
			goto goodreturn;

		case HIDIOCSUSAGE:
			field->value[uref->usage_index] = uref->value;
			goto goodreturn;

		case HIDIOCGCOLLECTIONINDEX:
Jiri Slaby's avatar
Jiri Slaby committed
530
531
			i = field->usage[uref->usage_index].collection_index;
			unlock_kernel();
532
			kfree(uref_multi);
Jiri Slaby's avatar
Jiri Slaby committed
533
			return i;
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
		case HIDIOCGUSAGES:
			for (i = 0; i < uref_multi->num_values; i++)
				uref_multi->values[i] =
				    field->value[uref->usage_index + i];
			if (copy_to_user(user_arg, uref_multi,
					 sizeof(*uref_multi)))
				goto fault;
			goto goodreturn;
		case HIDIOCSUSAGES:
			for (i = 0; i < uref_multi->num_values; i++)
				field->value[uref->usage_index + i] =
				    uref_multi->values[i];
			goto goodreturn;
		}

goodreturn:
550
		unlock_kernel();
551
552
553
		kfree(uref_multi);
		return 0;
fault:
554
		unlock_kernel();
555
556
557
		kfree(uref_multi);
		return -EFAULT;
inval:
558
		unlock_kernel();
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
		kfree(uref_multi);
		return -EINVAL;
	}
}

static noinline int hiddev_ioctl_string(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
{
	struct hid_device *hid = hiddev->hid;
	struct usb_device *dev = hid_to_usb_dev(hid);
	int idx, len;
	char *buf;

	if (get_user(idx, (int __user *)user_arg))
		return -EFAULT;

	if ((buf = kmalloc(HID_STRING_SIZE, GFP_KERNEL)) == NULL)
		return -ENOMEM;

	if ((len = usb_string(dev, idx, buf, HID_STRING_SIZE-1)) < 0) {
		kfree(buf);
		return -EINVAL;
	}

	if (copy_to_user(user_arg+sizeof(int), buf, len+1)) {
		kfree(buf);
		return -EFAULT;
	}

	kfree(buf);

	return len;
}

592
static long hiddev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
593
594
595
596
{
	struct hiddev_list *list = file->private_data;
	struct hiddev *hiddev = list->hiddev;
	struct hid_device *hid = hiddev->hid;
597
	struct usb_device *dev = hid_to_usb_dev(hid);
Linus Torvalds's avatar
Linus Torvalds committed
598
599
600
601
602
603
	struct hiddev_collection_info cinfo;
	struct hiddev_report_info rinfo;
	struct hiddev_field_info finfo;
	struct hiddev_devinfo dinfo;
	struct hid_report *report;
	struct hid_field *field;
604
	struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
605
	void __user *user_arg = (void __user *)arg;
606
	int i, r;
607
608
	
	/* Called without BKL by compat methods so no BKL taken */
Linus Torvalds's avatar
Linus Torvalds committed
609

610
	/* FIXME: Who or what stop this racing with a disconnect ?? */
Linus Torvalds's avatar
Linus Torvalds committed
611
612
613
614
615
616
617
618
619
620
621
622
623
	if (!hiddev->exist)
		return -EIO;

	switch (cmd) {

	case HIDIOCGVERSION:
		return put_user(HID_VERSION, (int __user *)arg);

	case HIDIOCAPPLICATION:
		if (arg < 0 || arg >= hid->maxapplication)
			return -EINVAL;

		for (i = 0; i < hid->maxcollection; i++)
624
			if (hid->collection[i].type ==
Linus Torvalds's avatar
Linus Torvalds committed
625
626
			    HID_COLLECTION_APPLICATION && arg-- == 0)
				break;
627

Linus Torvalds's avatar
Linus Torvalds committed
628
629
630
631
632
633
634
635
636
		if (i == hid->maxcollection)
			return -EINVAL;

		return hid->collection[i].usage;

	case HIDIOCGDEVINFO:
		dinfo.bustype = BUS_USB;
		dinfo.busnum = dev->bus->busnum;
		dinfo.devnum = dev->devnum;
637
		dinfo.ifnum = usbhid->ifnum;
Linus Torvalds's avatar
Linus Torvalds committed
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
		dinfo.vendor = le16_to_cpu(dev->descriptor.idVendor);
		dinfo.product = le16_to_cpu(dev->descriptor.idProduct);
		dinfo.version = le16_to_cpu(dev->descriptor.bcdDevice);
		dinfo.num_applications = hid->maxapplication;
		if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
			return -EFAULT;

		return 0;

	case HIDIOCGFLAG:
		if (put_user(list->flags, (int __user *)arg))
			return -EFAULT;

		return 0;

	case HIDIOCSFLAG:
		{
			int newflags;
			if (get_user(newflags, (int __user *)arg))
				return -EFAULT;

			if ((newflags & ~HIDDEV_FLAGS) != 0 ||
			    ((newflags & HIDDEV_FLAG_REPORT) != 0 &&
			     (newflags & HIDDEV_FLAG_UREF) == 0))
				return -EINVAL;

			list->flags = newflags;

			return 0;
		}

	case HIDIOCGSTRING:
670
		mutex_lock(&hiddev->existancelock);
671
		if (hiddev->exist)
672
673
674
675
676
			r = hiddev_ioctl_string(hiddev, cmd, user_arg);
		else
			r = -ENODEV;
		mutex_unlock(&hiddev->existancelock);
		return r;
Linus Torvalds's avatar
Linus Torvalds committed
677
678

	case HIDIOCINITREPORT:
679
680
681
682
683
		mutex_lock(&hiddev->existancelock);
		if (!hiddev->exist) {
			mutex_unlock(&hiddev->existancelock);
			return -ENODEV;
		}
684
		usbhid_init_reports(hid);
685
		mutex_unlock(&hiddev->existancelock);
Linus Torvalds's avatar
Linus Torvalds committed
686
687
688
689
690
691
692
693
694
695
696
697
698

		return 0;

	case HIDIOCGREPORT:
		if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
			return -EFAULT;

		if (rinfo.report_type == HID_REPORT_TYPE_OUTPUT)
			return -EINVAL;

		if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
			return -EINVAL;

699
700
701
702
703
704
		mutex_lock(&hiddev->existancelock);
		if (hiddev->exist) {
			usbhid_submit_report(hid, report, USB_DIR_IN);
			usbhid_wait_io(hid);
		}
		mutex_unlock(&hiddev->existancelock);
Linus Torvalds's avatar
Linus Torvalds committed
705
706
707
708
709
710
711
712
713
714
715
716
717

		return 0;

	case HIDIOCSREPORT:
		if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
			return -EFAULT;

		if (rinfo.report_type == HID_REPORT_TYPE_INPUT)
			return -EINVAL;

		if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
			return -EINVAL;

718
719
720
721
722
723
		mutex_lock(&hiddev->existancelock);
		if (hiddev->exist) {
			usbhid_submit_report(hid, report, USB_DIR_OUT);
			usbhid_wait_io(hid);
		}
		mutex_unlock(&hiddev->existancelock);
Linus Torvalds's avatar
Linus Torvalds committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774

		return 0;

	case HIDIOCGREPORTINFO:
		if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
			return -EFAULT;

		if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
			return -EINVAL;

		rinfo.num_fields = report->maxfield;

		if (copy_to_user(user_arg, &rinfo, sizeof(rinfo)))
			return -EFAULT;

		return 0;

	case HIDIOCGFIELDINFO:
		if (copy_from_user(&finfo, user_arg, sizeof(finfo)))
			return -EFAULT;
		rinfo.report_type = finfo.report_type;
		rinfo.report_id = finfo.report_id;
		if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
			return -EINVAL;

		if (finfo.field_index >= report->maxfield)
			return -EINVAL;

		field = report->field[finfo.field_index];
		memset(&finfo, 0, sizeof(finfo));
		finfo.report_type = rinfo.report_type;
		finfo.report_id = rinfo.report_id;
		finfo.field_index = field->report_count - 1;
		finfo.maxusage = field->maxusage;
		finfo.flags = field->flags;
		finfo.physical = field->physical;
		finfo.logical = field->logical;
		finfo.application = field->application;
		finfo.logical_minimum = field->logical_minimum;
		finfo.logical_maximum = field->logical_maximum;
		finfo.physical_minimum = field->physical_minimum;
		finfo.physical_maximum = field->physical_maximum;
		finfo.unit_exponent = field->unit_exponent;
		finfo.unit = field->unit;

		if (copy_to_user(user_arg, &finfo, sizeof(finfo)))
			return -EFAULT;

		return 0;

	case HIDIOCGUCODE:
775
		/* fall through */
Linus Torvalds's avatar
Linus Torvalds committed
776
777
778
779
780
	case HIDIOCGUSAGE:
	case HIDIOCSUSAGE:
	case HIDIOCGUSAGES:
	case HIDIOCSUSAGES:
	case HIDIOCGCOLLECTIONINDEX:
781
782
783
784
785
786
787
		mutex_lock(&hiddev->existancelock);
		if (hiddev->exist)
			r = hiddev_ioctl_usage(hiddev, cmd, user_arg);
		else
			r = -ENODEV;
		mutex_unlock(&hiddev->existancelock);
		return r;
Linus Torvalds's avatar
Linus Torvalds committed
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833

	case HIDIOCGCOLLECTIONINFO:
		if (copy_from_user(&cinfo, user_arg, sizeof(cinfo)))
			return -EFAULT;

		if (cinfo.index >= hid->maxcollection)
			return -EINVAL;

		cinfo.type = hid->collection[cinfo.index].type;
		cinfo.usage = hid->collection[cinfo.index].usage;
		cinfo.level = hid->collection[cinfo.index].level;

		if (copy_to_user(user_arg, &cinfo, sizeof(cinfo)))
			return -EFAULT;
		return 0;

	default:

		if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ)
			return -EINVAL;

		if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGNAME(0))) {
			int len;
			if (!hid->name)
				return 0;
			len = strlen(hid->name) + 1;
			if (len > _IOC_SIZE(cmd))
				 len = _IOC_SIZE(cmd);
			return copy_to_user(user_arg, hid->name, len) ?
				-EFAULT : len;
		}

		if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGPHYS(0))) {
			int len;
			if (!hid->phys)
				return 0;
			len = strlen(hid->phys) + 1;
			if (len > _IOC_SIZE(cmd))
				len = _IOC_SIZE(cmd);
			return copy_to_user(user_arg, hid->phys, len) ?
				-EFAULT : len;
		}
	}
	return -EINVAL;
}

834
835
836
#ifdef CONFIG_COMPAT
static long hiddev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
{
837
	return hiddev_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
838
839
840
}
#endif

841
static const struct file_operations hiddev_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
842
843
844
845
846
847
	.owner =	THIS_MODULE,
	.read =		hiddev_read,
	.write =	hiddev_write,
	.poll =		hiddev_poll,
	.open =		hiddev_open,
	.release =	hiddev_release,
848
	.unlocked_ioctl =	hiddev_ioctl,
Linus Torvalds's avatar
Linus Torvalds committed
849
	.fasync =	hiddev_fasync,
850
851
852
#ifdef CONFIG_COMPAT
	.compat_ioctl	= hiddev_compat_ioctl,
#endif
Linus Torvalds's avatar
Linus Torvalds committed
853
854
};

855
856
857
858
859
static char *hiddev_nodename(struct device *dev)
{
	return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
}

Linus Torvalds's avatar
Linus Torvalds committed
860
static struct usb_class_driver hiddev_class = {
861
	.name =		"hiddev%d",
862
	.nodename =	hiddev_nodename,
Linus Torvalds's avatar
Linus Torvalds committed
863
	.fops =		&hiddev_fops,
864
	.minor_base =	HIDDEV_MINOR_BASE,
Linus Torvalds's avatar
Linus Torvalds committed
865
866
867
868
869
};

/*
 * This is where hid.c calls us to connect a hid device to the hiddev driver
 */
Jiri Slaby's avatar
Jiri Slaby committed
870
int hiddev_connect(struct hid_device *hid, unsigned int force)
Linus Torvalds's avatar
Linus Torvalds committed
871
872
{
	struct hiddev *hiddev;
873
	struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
874
875
	int retval;

Jiri Slaby's avatar
Jiri Slaby committed
876
877
878
879
880
881
882
	if (!force) {
		unsigned int i;
		for (i = 0; i < hid->maxcollection; i++)
			if (hid->collection[i].type ==
			    HID_COLLECTION_APPLICATION &&
			    !IS_INPUT_APPLICATION(hid->collection[i].usage))
				break;
Linus Torvalds's avatar
Linus Torvalds committed
883

Jiri Slaby's avatar
Jiri Slaby committed
884
885
886
		if (i == hid->maxcollection)
			return -1;
	}
Linus Torvalds's avatar
Linus Torvalds committed
887

Oliver Neukum's avatar
Oliver Neukum committed
888
	if (!(hiddev = kzalloc(sizeof(struct hiddev), GFP_KERNEL)))
Linus Torvalds's avatar
Linus Torvalds committed
889
890
891
		return -1;

	init_waitqueue_head(&hiddev->wait);
892
	INIT_LIST_HEAD(&hiddev->list);
893
	spin_lock_init(&hiddev->list_lock);
894
	mutex_init(&hiddev->existancelock);
895
	hid->hiddev = hiddev;
Linus Torvalds's avatar
Linus Torvalds committed
896
897
898
	hiddev->hid = hid;
	hiddev->exist = 1;

899
900
901
	/* when lock_kernel() usage is fixed in usb_open(),
	 * we could also fix it here */
	lock_kernel();
902
903
904
	retval = usb_register_dev(usbhid->intf, &hiddev_class);
	if (retval) {
		err_hid("Not able to get a minor for this device.");
905
		hid->hiddev = NULL;
906
		unlock_kernel();
907
908
909
910
911
912
		kfree(hiddev);
		return -1;
	} else {
		hid->minor = usbhid->intf->minor;
		hiddev_table[usbhid->intf->minor - HIDDEV_MINOR_BASE] = hiddev;
	}
913
	unlock_kernel();
914

Linus Torvalds's avatar
Linus Torvalds committed
915
916
917
918
919
920
921
922
923
924
925
	return 0;
}

/*
 * This is where hid.c calls us to disconnect a hiddev device from the
 * corresponding hid device (usually because the usb device has disconnected)
 */
static struct usb_class_driver hiddev_class;
void hiddev_disconnect(struct hid_device *hid)
{
	struct hiddev *hiddev = hid->hiddev;
926
	struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
927

928
	mutex_lock(&hiddev->existancelock);
Linus Torvalds's avatar
Linus Torvalds committed
929
	hiddev->exist = 0;
930
	mutex_unlock(&hiddev->existancelock);
Linus Torvalds's avatar
Linus Torvalds committed
931
932

	hiddev_table[hiddev->hid->minor - HIDDEV_MINOR_BASE] = NULL;
933
	usb_deregister_dev(usbhid->intf, &hiddev_class);
Linus Torvalds's avatar
Linus Torvalds committed
934
935

	if (hiddev->open) {
936
		usbhid_close(hiddev->hid);
Linus Torvalds's avatar
Linus Torvalds committed
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
		wake_up_interruptible(&hiddev->wait);
	} else {
		kfree(hiddev);
	}
}

/* Currently this driver is a USB driver.  It's not a conventional one in
 * the sense that it doesn't probe at the USB level.  Instead it waits to
 * be connected by HID through the hiddev_connect / hiddev_disconnect
 * routines.  The reason to register as a USB device is to gain part of the
 * minor number space from the USB major.
 *
 * In theory, should the HID code be generalized to more than one physical
 * medium (say, IEEE 1384), this driver will probably need to register its
 * own major number, and in doing so, no longer need to register with USB.
 * At that point the probe routine and hiddev_driver struct below will no
 * longer be useful.
 */


/* We never attach in this manner, and rely on HID to connect us.  This
 * is why there is no disconnect routine defined in the usb_driver either.
 */
960
static int hiddev_usbd_probe(struct usb_interface *intf,
Linus Torvalds's avatar
Linus Torvalds committed
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
			     const struct usb_device_id *hiddev_info)
{
	return -ENODEV;
}

static /* const */ struct usb_driver hiddev_driver = {
	.name =		"hiddev",
	.probe =	hiddev_usbd_probe,
};

int __init hiddev_init(void)
{
	return usb_register(&hiddev_driver);
}

void hiddev_exit(void)
{
	usb_deregister(&hiddev_driver);
}