blob: babd65dd46ad4eefa066c4e842288144f2941ab8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (c) 2001 Paul Stewart
3 * Copyright (c) 2001 Vojtech Pavlik
4 *
5 * HID char devices, giving access to raw HID device events.
6 *
7 */
8
9/*
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 * Should you need to contact me, the author, you can do so either by
25 * e-mail - mail your message to Paul Stewart <stewart@wetlogic.net>
26 */
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/poll.h>
29#include <linux/slab.h>
30#include <linux/module.h>
31#include <linux/init.h>
32#include <linux/smp_lock.h>
33#include <linux/input.h>
34#include <linux/usb.h>
Jiri Kosinadde58452006-12-08 18:40:44 +010035#include <linux/hid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/hiddev.h>
Philip Langdalebb6c8d82007-10-14 12:03:58 +020037#include <linux/compat.h>
Jiri Kosinadde58452006-12-08 18:40:44 +010038#include "usbhid.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#ifdef CONFIG_USB_DYNAMIC_MINORS
41#define HIDDEV_MINOR_BASE 0
42#define HIDDEV_MINORS 256
43#else
44#define HIDDEV_MINOR_BASE 96
45#define HIDDEV_MINORS 16
46#endif
47#define HIDDEV_BUFFER_SIZE 64
48
49struct hiddev {
50 int exist;
51 int open;
52 wait_queue_head_t wait;
53 struct hid_device *hid;
Dmitry Torokhov826d5982006-07-19 01:09:10 -040054 struct list_head list;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +020055 spinlock_t list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
58struct hiddev_list {
59 struct hiddev_usage_ref buffer[HIDDEV_BUFFER_SIZE];
60 int head;
61 int tail;
62 unsigned flags;
63 struct fasync_struct *fasync;
64 struct hiddev *hiddev;
Dmitry Torokhov826d5982006-07-19 01:09:10 -040065 struct list_head node;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066};
67
68static struct hiddev *hiddev_table[HIDDEV_MINORS];
69
70/*
71 * Find a report, given the report's type and ID. The ID can be specified
72 * indirectly by REPORT_ID_FIRST (which returns the first report of the given
73 * type) or by (REPORT_ID_NEXT | old_id), which returns the next report of the
74 * given type which follows old_id.
75 */
76static struct hid_report *
77hiddev_lookup_report(struct hid_device *hid, struct hiddev_report_info *rinfo)
78{
Dmitry Torokhov826d5982006-07-19 01:09:10 -040079 unsigned int flags = rinfo->report_id & ~HID_REPORT_ID_MASK;
80 unsigned int rid = rinfo->report_id & HID_REPORT_ID_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 struct hid_report_enum *report_enum;
Dmitry Torokhov826d5982006-07-19 01:09:10 -040082 struct hid_report *report;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 struct list_head *list;
84
85 if (rinfo->report_type < HID_REPORT_TYPE_MIN ||
Dmitry Torokhov826d5982006-07-19 01:09:10 -040086 rinfo->report_type > HID_REPORT_TYPE_MAX)
87 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 report_enum = hid->report_enum +
90 (rinfo->report_type - HID_REPORT_TYPE_MIN);
91
92 switch (flags) {
93 case 0: /* Nothing to do -- report_id is already set correctly */
94 break;
95
96 case HID_REPORT_ID_FIRST:
Dmitry Torokhov826d5982006-07-19 01:09:10 -040097 if (list_empty(&report_enum->report_list))
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 return NULL;
Dmitry Torokhov826d5982006-07-19 01:09:10 -040099
100 list = report_enum->report_list.next;
101 report = list_entry(list, struct hid_report, list);
102 rinfo->report_id = report->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 break;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 case HID_REPORT_ID_NEXT:
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400106 report = report_enum->report_id_hash[rid];
107 if (!report)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 return NULL;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400109
110 list = report->list.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 if (list == &report_enum->report_list)
112 return NULL;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400113
114 report = list_entry(list, struct hid_report, list);
115 rinfo->report_id = report->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 break;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 default:
119 return NULL;
120 }
121
122 return report_enum->report_id_hash[rinfo->report_id];
123}
124
125/*
126 * Perform an exhaustive search of the report table for a usage, given its
127 * type and usage id.
128 */
129static struct hid_field *
130hiddev_lookup_usage(struct hid_device *hid, struct hiddev_usage_ref *uref)
131{
132 int i, j;
133 struct hid_report *report;
134 struct hid_report_enum *report_enum;
135 struct hid_field *field;
136
137 if (uref->report_type < HID_REPORT_TYPE_MIN ||
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400138 uref->report_type > HID_REPORT_TYPE_MAX)
139 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141 report_enum = hid->report_enum +
142 (uref->report_type - HID_REPORT_TYPE_MIN);
143
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400144 list_for_each_entry(report, &report_enum->report_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 for (i = 0; i < report->maxfield; i++) {
146 field = report->field[i];
147 for (j = 0; j < field->maxusage; j++) {
148 if (field->usage[j].hid == uref->usage_code) {
149 uref->report_id = report->id;
150 uref->field_index = i;
151 uref->usage_index = j;
152 return field;
153 }
154 }
155 }
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400156 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158 return NULL;
159}
160
161static void hiddev_send_event(struct hid_device *hid,
162 struct hiddev_usage_ref *uref)
163{
164 struct hiddev *hiddev = hid->hiddev;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400165 struct hiddev_list *list;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200166 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200168 spin_lock_irqsave(&hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400169 list_for_each_entry(list, &hiddev->list, node) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 if (uref->field_index != HID_FIELD_INDEX_NONE ||
171 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
172 list->buffer[list->head] = *uref;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500173 list->head = (list->head + 1) &
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 (HIDDEV_BUFFER_SIZE - 1);
175 kill_fasync(&list->fasync, SIGIO, POLL_IN);
176 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 }
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200178 spin_unlock_irqrestore(&hiddev->list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180 wake_up_interruptible(&hiddev->wait);
181}
182
183/*
184 * This is where hid.c calls into hiddev to pass an event that occurred over
185 * the interrupt pipe
186 */
187void hiddev_hid_event(struct hid_device *hid, struct hid_field *field,
David Howells7d12e782006-10-05 14:55:46 +0100188 struct hid_usage *usage, __s32 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
190 unsigned type = field->report_type;
191 struct hiddev_usage_ref uref;
192
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500193 uref.report_type =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500195 ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400196 ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 uref.report_id = field->report->id;
198 uref.field_index = field->index;
199 uref.usage_index = (usage - field->usage);
200 uref.usage_code = usage->hid;
201 uref.value = value;
202
203 hiddev_send_event(hid, &uref);
204}
Jiri Kosina229695e2006-12-08 18:40:53 +0100205EXPORT_SYMBOL_GPL(hiddev_hid_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207void hiddev_report_event(struct hid_device *hid, struct hid_report *report)
208{
209 unsigned type = report->type;
210 struct hiddev_usage_ref uref;
211
212 memset(&uref, 0, sizeof(uref));
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500213 uref.report_type =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500215 ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400216 ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 uref.report_id = report->id;
218 uref.field_index = HID_FIELD_INDEX_NONE;
219
220 hiddev_send_event(hid, &uref);
221}
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
224 * fasync file op
225 */
226static int hiddev_fasync(int fd, struct file *file, int on)
227{
228 int retval;
229 struct hiddev_list *list = file->private_data;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 retval = fasync_helper(fd, file, on, &list->fasync);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 return retval < 0 ? retval : 0;
234}
235
236
237/*
238 * release file op
239 */
240static int hiddev_release(struct inode * inode, struct file * file)
241{
242 struct hiddev_list *list = file->private_data;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200243 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 hiddev_fasync(-1, file, 0);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200246
247 spin_lock_irqsave(&list->hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400248 list_del(&list->node);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200249 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251 if (!--list->hiddev->open) {
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500252 if (list->hiddev->exist)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100253 usbhid_close(list->hiddev->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 else
255 kfree(list->hiddev);
256 }
257
258 kfree(list);
259
260 return 0;
261}
262
263/*
264 * open file op
265 */
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400266static int hiddev_open(struct inode *inode, struct file *file)
267{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 struct hiddev_list *list;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200269 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271 int i = iminor(inode) - HIDDEV_MINOR_BASE;
272
273 if (i >= HIDDEV_MINORS || !hiddev_table[i])
274 return -ENODEV;
275
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100276 if (!(list = kzalloc(sizeof(struct hiddev_list), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279 list->hiddev = hiddev_table[i];
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200280
281 spin_lock_irqsave(&list->hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400282 list_add_tail(&list->node, &hiddev_table[i]->list);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200283 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 file->private_data = list;
286
287 if (!list->hiddev->open++)
288 if (list->hiddev->exist)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100289 usbhid_open(hiddev_table[i]->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291 return 0;
292}
293
294/*
295 * "write" file op
296 */
297static ssize_t hiddev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
298{
299 return -EINVAL;
300}
301
302/*
303 * "read" file op
304 */
305static ssize_t hiddev_read(struct file * file, char __user * buffer, size_t count, loff_t *ppos)
306{
307 DECLARE_WAITQUEUE(wait, current);
308 struct hiddev_list *list = file->private_data;
309 int event_size;
310 int retval = 0;
311
312 event_size = ((list->flags & HIDDEV_FLAG_UREF) != 0) ?
313 sizeof(struct hiddev_usage_ref) : sizeof(struct hiddev_event);
314
315 if (count < event_size)
316 return 0;
317
318 while (retval == 0) {
319 if (list->head == list->tail) {
320 add_wait_queue(&list->hiddev->wait, &wait);
321 set_current_state(TASK_INTERRUPTIBLE);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 while (list->head == list->tail) {
324 if (file->f_flags & O_NONBLOCK) {
325 retval = -EAGAIN;
326 break;
327 }
328 if (signal_pending(current)) {
329 retval = -ERESTARTSYS;
330 break;
331 }
332 if (!list->hiddev->exist) {
333 retval = -EIO;
334 break;
335 }
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 schedule();
Micon, David48d70552006-05-20 14:59:59 -0700338 set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 }
340
341 set_current_state(TASK_RUNNING);
342 remove_wait_queue(&list->hiddev->wait, &wait);
343 }
344
345 if (retval)
346 return retval;
347
348
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500349 while (list->head != list->tail &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 retval + event_size <= count) {
351 if ((list->flags & HIDDEV_FLAG_UREF) == 0) {
352 if (list->buffer[list->tail].field_index !=
353 HID_FIELD_INDEX_NONE) {
354 struct hiddev_event event;
355 event.hid = list->buffer[list->tail].usage_code;
356 event.value = list->buffer[list->tail].value;
357 if (copy_to_user(buffer + retval, &event, sizeof(struct hiddev_event)))
358 return -EFAULT;
359 retval += sizeof(struct hiddev_event);
360 }
361 } else {
362 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE ||
363 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
364 if (copy_to_user(buffer + retval, list->buffer + list->tail, sizeof(struct hiddev_usage_ref)))
365 return -EFAULT;
366 retval += sizeof(struct hiddev_usage_ref);
367 }
368 }
369 list->tail = (list->tail + 1) & (HIDDEV_BUFFER_SIZE - 1);
370 }
371
372 }
373
374 return retval;
375}
376
377/*
378 * "poll" file op
379 * No kernel lock - fine
380 */
381static unsigned int hiddev_poll(struct file *file, poll_table *wait)
382{
383 struct hiddev_list *list = file->private_data;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 poll_wait(file, &list->hiddev->wait, wait);
386 if (list->head != list->tail)
387 return POLLIN | POLLRDNORM;
388 if (!list->hiddev->exist)
389 return POLLERR | POLLHUP;
390 return 0;
391}
392
393/*
394 * "ioctl" file op
395 */
Jean Delvarecf2a2992008-03-03 11:48:43 +0100396static noinline int hiddev_ioctl_usage(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
397{
398 struct hid_device *hid = hiddev->hid;
399 struct hiddev_report_info rinfo;
400 struct hiddev_usage_ref_multi *uref_multi = NULL;
401 struct hiddev_usage_ref *uref;
402 struct hid_report *report;
403 struct hid_field *field;
404 int i;
405
406 uref_multi = kmalloc(sizeof(struct hiddev_usage_ref_multi), GFP_KERNEL);
407 if (!uref_multi)
408 return -ENOMEM;
Alan Cox7961df12008-05-26 11:25:20 +0200409 lock_kernel();
Jean Delvarecf2a2992008-03-03 11:48:43 +0100410 uref = &uref_multi->uref;
411 if (cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) {
412 if (copy_from_user(uref_multi, user_arg,
413 sizeof(*uref_multi)))
414 goto fault;
415 } else {
416 if (copy_from_user(uref, user_arg, sizeof(*uref)))
417 goto fault;
418 }
419
420 switch (cmd) {
421 case HIDIOCGUCODE:
422 rinfo.report_type = uref->report_type;
423 rinfo.report_id = uref->report_id;
424 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
425 goto inval;
426
427 if (uref->field_index >= report->maxfield)
428 goto inval;
429
430 field = report->field[uref->field_index];
431 if (uref->usage_index >= field->maxusage)
432 goto inval;
433
434 uref->usage_code = field->usage[uref->usage_index].hid;
435
436 if (copy_to_user(user_arg, uref, sizeof(*uref)))
437 goto fault;
438
439 kfree(uref_multi);
440 return 0;
441
442 default:
443 if (cmd != HIDIOCGUSAGE &&
444 cmd != HIDIOCGUSAGES &&
445 uref->report_type == HID_REPORT_TYPE_INPUT)
446 goto inval;
447
448 if (uref->report_id == HID_REPORT_ID_UNKNOWN) {
449 field = hiddev_lookup_usage(hid, uref);
450 if (field == NULL)
451 goto inval;
452 } else {
453 rinfo.report_type = uref->report_type;
454 rinfo.report_id = uref->report_id;
455 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
456 goto inval;
457
458 if (uref->field_index >= report->maxfield)
459 goto inval;
460
461 field = report->field[uref->field_index];
462
463 if (cmd == HIDIOCGCOLLECTIONINDEX) {
464 if (uref->usage_index >= field->maxusage)
465 goto inval;
466 } else if (uref->usage_index >= field->report_count)
467 goto inval;
468
469 else if ((cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) &&
470 (uref_multi->num_values > HID_MAX_MULTI_USAGES ||
471 uref->usage_index + uref_multi->num_values > field->report_count))
472 goto inval;
473 }
474
475 switch (cmd) {
476 case HIDIOCGUSAGE:
477 uref->value = field->value[uref->usage_index];
478 if (copy_to_user(user_arg, uref, sizeof(*uref)))
479 goto fault;
480 goto goodreturn;
481
482 case HIDIOCSUSAGE:
483 field->value[uref->usage_index] = uref->value;
484 goto goodreturn;
485
486 case HIDIOCGCOLLECTIONINDEX:
487 kfree(uref_multi);
488 return field->usage[uref->usage_index].collection_index;
489 case HIDIOCGUSAGES:
490 for (i = 0; i < uref_multi->num_values; i++)
491 uref_multi->values[i] =
492 field->value[uref->usage_index + i];
493 if (copy_to_user(user_arg, uref_multi,
494 sizeof(*uref_multi)))
495 goto fault;
496 goto goodreturn;
497 case HIDIOCSUSAGES:
498 for (i = 0; i < uref_multi->num_values; i++)
499 field->value[uref->usage_index + i] =
500 uref_multi->values[i];
501 goto goodreturn;
502 }
503
504goodreturn:
Alan Cox7961df12008-05-26 11:25:20 +0200505 unlock_kernel();
Jean Delvarecf2a2992008-03-03 11:48:43 +0100506 kfree(uref_multi);
507 return 0;
508fault:
Alan Cox7961df12008-05-26 11:25:20 +0200509 unlock_kernel();
Jean Delvarecf2a2992008-03-03 11:48:43 +0100510 kfree(uref_multi);
511 return -EFAULT;
512inval:
Alan Cox7961df12008-05-26 11:25:20 +0200513 unlock_kernel();
Jean Delvarecf2a2992008-03-03 11:48:43 +0100514 kfree(uref_multi);
515 return -EINVAL;
516 }
517}
518
519static noinline int hiddev_ioctl_string(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
520{
521 struct hid_device *hid = hiddev->hid;
522 struct usb_device *dev = hid_to_usb_dev(hid);
523 int idx, len;
524 char *buf;
525
526 if (get_user(idx, (int __user *)user_arg))
527 return -EFAULT;
528
529 if ((buf = kmalloc(HID_STRING_SIZE, GFP_KERNEL)) == NULL)
530 return -ENOMEM;
531
532 if ((len = usb_string(dev, idx, buf, HID_STRING_SIZE-1)) < 0) {
533 kfree(buf);
534 return -EINVAL;
535 }
536
537 if (copy_to_user(user_arg+sizeof(int), buf, len+1)) {
538 kfree(buf);
539 return -EFAULT;
540 }
541
542 kfree(buf);
543
544 return len;
545}
546
Alan Cox7961df12008-05-26 11:25:20 +0200547static long hiddev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
549 struct hiddev_list *list = file->private_data;
550 struct hiddev *hiddev = list->hiddev;
551 struct hid_device *hid = hiddev->hid;
Anssi Hannulabe820972007-01-19 19:28:17 +0200552 struct usb_device *dev = hid_to_usb_dev(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 struct hiddev_collection_info cinfo;
554 struct hiddev_report_info rinfo;
555 struct hiddev_field_info finfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 struct hiddev_devinfo dinfo;
557 struct hid_report *report;
558 struct hid_field *field;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100559 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 void __user *user_arg = (void __user *)arg;
561 int i;
Alan Cox7961df12008-05-26 11:25:20 +0200562
563 /* Called without BKL by compat methods so no BKL taken */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
Alan Cox7961df12008-05-26 11:25:20 +0200565 /* FIXME: Who or what stop this racing with a disconnect ?? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 if (!hiddev->exist)
567 return -EIO;
568
569 switch (cmd) {
570
571 case HIDIOCGVERSION:
572 return put_user(HID_VERSION, (int __user *)arg);
573
574 case HIDIOCAPPLICATION:
575 if (arg < 0 || arg >= hid->maxapplication)
576 return -EINVAL;
577
578 for (i = 0; i < hid->maxcollection; i++)
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500579 if (hid->collection[i].type ==
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 HID_COLLECTION_APPLICATION && arg-- == 0)
581 break;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 if (i == hid->maxcollection)
584 return -EINVAL;
585
586 return hid->collection[i].usage;
587
588 case HIDIOCGDEVINFO:
589 dinfo.bustype = BUS_USB;
590 dinfo.busnum = dev->bus->busnum;
591 dinfo.devnum = dev->devnum;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100592 dinfo.ifnum = usbhid->ifnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 dinfo.vendor = le16_to_cpu(dev->descriptor.idVendor);
594 dinfo.product = le16_to_cpu(dev->descriptor.idProduct);
595 dinfo.version = le16_to_cpu(dev->descriptor.bcdDevice);
596 dinfo.num_applications = hid->maxapplication;
597 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
598 return -EFAULT;
599
600 return 0;
601
602 case HIDIOCGFLAG:
603 if (put_user(list->flags, (int __user *)arg))
604 return -EFAULT;
605
606 return 0;
607
608 case HIDIOCSFLAG:
609 {
610 int newflags;
611 if (get_user(newflags, (int __user *)arg))
612 return -EFAULT;
613
614 if ((newflags & ~HIDDEV_FLAGS) != 0 ||
615 ((newflags & HIDDEV_FLAG_REPORT) != 0 &&
616 (newflags & HIDDEV_FLAG_UREF) == 0))
617 return -EINVAL;
618
619 list->flags = newflags;
620
621 return 0;
622 }
623
624 case HIDIOCGSTRING:
Jean Delvarecf2a2992008-03-03 11:48:43 +0100625 return hiddev_ioctl_string(hiddev, cmd, user_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627 case HIDIOCINITREPORT:
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100628 usbhid_init_reports(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630 return 0;
631
632 case HIDIOCGREPORT:
633 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
634 return -EFAULT;
635
636 if (rinfo.report_type == HID_REPORT_TYPE_OUTPUT)
637 return -EINVAL;
638
639 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
640 return -EINVAL;
641
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100642 usbhid_submit_report(hid, report, USB_DIR_IN);
643 usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
645 return 0;
646
647 case HIDIOCSREPORT:
648 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
649 return -EFAULT;
650
651 if (rinfo.report_type == HID_REPORT_TYPE_INPUT)
652 return -EINVAL;
653
654 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
655 return -EINVAL;
656
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100657 usbhid_submit_report(hid, report, USB_DIR_OUT);
658 usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
660 return 0;
661
662 case HIDIOCGREPORTINFO:
663 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
664 return -EFAULT;
665
666 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
667 return -EINVAL;
668
669 rinfo.num_fields = report->maxfield;
670
671 if (copy_to_user(user_arg, &rinfo, sizeof(rinfo)))
672 return -EFAULT;
673
674 return 0;
675
676 case HIDIOCGFIELDINFO:
677 if (copy_from_user(&finfo, user_arg, sizeof(finfo)))
678 return -EFAULT;
679 rinfo.report_type = finfo.report_type;
680 rinfo.report_id = finfo.report_id;
681 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
682 return -EINVAL;
683
684 if (finfo.field_index >= report->maxfield)
685 return -EINVAL;
686
687 field = report->field[finfo.field_index];
688 memset(&finfo, 0, sizeof(finfo));
689 finfo.report_type = rinfo.report_type;
690 finfo.report_id = rinfo.report_id;
691 finfo.field_index = field->report_count - 1;
692 finfo.maxusage = field->maxusage;
693 finfo.flags = field->flags;
694 finfo.physical = field->physical;
695 finfo.logical = field->logical;
696 finfo.application = field->application;
697 finfo.logical_minimum = field->logical_minimum;
698 finfo.logical_maximum = field->logical_maximum;
699 finfo.physical_minimum = field->physical_minimum;
700 finfo.physical_maximum = field->physical_maximum;
701 finfo.unit_exponent = field->unit_exponent;
702 finfo.unit = field->unit;
703
704 if (copy_to_user(user_arg, &finfo, sizeof(finfo)))
705 return -EFAULT;
706
707 return 0;
708
709 case HIDIOCGUCODE:
Jean Delvarecf2a2992008-03-03 11:48:43 +0100710 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 case HIDIOCGUSAGE:
712 case HIDIOCSUSAGE:
713 case HIDIOCGUSAGES:
714 case HIDIOCSUSAGES:
715 case HIDIOCGCOLLECTIONINDEX:
Jean Delvarecf2a2992008-03-03 11:48:43 +0100716 return hiddev_ioctl_usage(hiddev, cmd, user_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
718 case HIDIOCGCOLLECTIONINFO:
719 if (copy_from_user(&cinfo, user_arg, sizeof(cinfo)))
720 return -EFAULT;
721
722 if (cinfo.index >= hid->maxcollection)
723 return -EINVAL;
724
725 cinfo.type = hid->collection[cinfo.index].type;
726 cinfo.usage = hid->collection[cinfo.index].usage;
727 cinfo.level = hid->collection[cinfo.index].level;
728
729 if (copy_to_user(user_arg, &cinfo, sizeof(cinfo)))
730 return -EFAULT;
731 return 0;
732
733 default:
734
735 if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ)
736 return -EINVAL;
737
738 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGNAME(0))) {
739 int len;
740 if (!hid->name)
741 return 0;
742 len = strlen(hid->name) + 1;
743 if (len > _IOC_SIZE(cmd))
744 len = _IOC_SIZE(cmd);
745 return copy_to_user(user_arg, hid->name, len) ?
746 -EFAULT : len;
747 }
748
749 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGPHYS(0))) {
750 int len;
751 if (!hid->phys)
752 return 0;
753 len = strlen(hid->phys) + 1;
754 if (len > _IOC_SIZE(cmd))
755 len = _IOC_SIZE(cmd);
756 return copy_to_user(user_arg, hid->phys, len) ?
757 -EFAULT : len;
758 }
759 }
760 return -EINVAL;
761}
762
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200763#ifdef CONFIG_COMPAT
764static long hiddev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
765{
Jiri Kosina88af45b2008-05-27 11:36:40 +0200766 return hiddev_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200767}
768#endif
769
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -0300770static const struct file_operations hiddev_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 .owner = THIS_MODULE,
772 .read = hiddev_read,
773 .write = hiddev_write,
774 .poll = hiddev_poll,
775 .open = hiddev_open,
776 .release = hiddev_release,
Alan Cox7961df12008-05-26 11:25:20 +0200777 .unlocked_ioctl = hiddev_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 .fasync = hiddev_fasync,
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200779#ifdef CONFIG_COMPAT
780 .compat_ioctl = hiddev_compat_ioctl,
781#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782};
783
784static struct usb_class_driver hiddev_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700785 .name = "hiddev%d",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 .fops = &hiddev_fops,
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500787 .minor_base = HIDDEV_MINOR_BASE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788};
789
790/*
791 * This is where hid.c calls us to connect a hid device to the hiddev driver
792 */
Jiri Slaby93c10132008-06-27 00:04:24 +0200793int hiddev_connect(struct hid_device *hid, unsigned int force)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
795 struct hiddev *hiddev;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100796 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 int retval;
798
Jiri Slaby93c10132008-06-27 00:04:24 +0200799 if (!force) {
800 unsigned int i;
801 for (i = 0; i < hid->maxcollection; i++)
802 if (hid->collection[i].type ==
803 HID_COLLECTION_APPLICATION &&
804 !IS_INPUT_APPLICATION(hid->collection[i].usage))
805 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Jiri Slaby93c10132008-06-27 00:04:24 +0200807 if (i == hid->maxcollection)
808 return -1;
809 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100811 if (!(hiddev = kzalloc(sizeof(struct hiddev), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100814 retval = usb_register_dev(usbhid->intf, &hiddev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 if (retval) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200816 err_hid("Not able to get a minor for this device.");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 kfree(hiddev);
818 return -1;
819 }
820
821 init_waitqueue_head(&hiddev->wait);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400822 INIT_LIST_HEAD(&hiddev->list);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200823 spin_lock_init(&hiddev->list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 hiddev->hid = hid;
825 hiddev->exist = 1;
826
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100827 hid->minor = usbhid->intf->minor;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 hid->hiddev = hiddev;
829
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100830 hiddev_table[usbhid->intf->minor - HIDDEV_MINOR_BASE] = hiddev;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 return 0;
833}
834
835/*
836 * This is where hid.c calls us to disconnect a hiddev device from the
837 * corresponding hid device (usually because the usb device has disconnected)
838 */
839static struct usb_class_driver hiddev_class;
840void hiddev_disconnect(struct hid_device *hid)
841{
842 struct hiddev *hiddev = hid->hiddev;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100843 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
845 hiddev->exist = 0;
846
847 hiddev_table[hiddev->hid->minor - HIDDEV_MINOR_BASE] = NULL;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100848 usb_deregister_dev(usbhid->intf, &hiddev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
850 if (hiddev->open) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100851 usbhid_close(hiddev->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 wake_up_interruptible(&hiddev->wait);
853 } else {
854 kfree(hiddev);
855 }
856}
857
858/* Currently this driver is a USB driver. It's not a conventional one in
859 * the sense that it doesn't probe at the USB level. Instead it waits to
860 * be connected by HID through the hiddev_connect / hiddev_disconnect
861 * routines. The reason to register as a USB device is to gain part of the
862 * minor number space from the USB major.
863 *
864 * In theory, should the HID code be generalized to more than one physical
865 * medium (say, IEEE 1384), this driver will probably need to register its
866 * own major number, and in doing so, no longer need to register with USB.
867 * At that point the probe routine and hiddev_driver struct below will no
868 * longer be useful.
869 */
870
871
872/* We never attach in this manner, and rely on HID to connect us. This
873 * is why there is no disconnect routine defined in the usb_driver either.
874 */
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500875static int hiddev_usbd_probe(struct usb_interface *intf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 const struct usb_device_id *hiddev_info)
877{
878 return -ENODEV;
879}
880
881
882static /* const */ struct usb_driver hiddev_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 .name = "hiddev",
884 .probe = hiddev_usbd_probe,
885};
886
887int __init hiddev_init(void)
888{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 return usb_register(&hiddev_driver);
890}
891
892void hiddev_exit(void)
893{
894 usb_deregister(&hiddev_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895}