blob: 83e851a5ed3041f9b25bf212634f81355d0dd9f3 [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
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200245 spin_lock_irqsave(&list->hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400246 list_del(&list->node);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200247 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 if (!--list->hiddev->open) {
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500250 if (list->hiddev->exist)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100251 usbhid_close(list->hiddev->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 else
253 kfree(list->hiddev);
254 }
255
256 kfree(list);
257
258 return 0;
259}
260
261/*
262 * open file op
263 */
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400264static int hiddev_open(struct inode *inode, struct file *file)
265{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 struct hiddev_list *list;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200267 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 int i = iminor(inode) - HIDDEV_MINOR_BASE;
270
271 if (i >= HIDDEV_MINORS || !hiddev_table[i])
272 return -ENODEV;
273
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100274 if (!(list = kzalloc(sizeof(struct hiddev_list), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277 list->hiddev = hiddev_table[i];
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200278
279 spin_lock_irqsave(&list->hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400280 list_add_tail(&list->node, &hiddev_table[i]->list);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200281 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 file->private_data = list;
284
285 if (!list->hiddev->open++)
286 if (list->hiddev->exist)
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100287 usbhid_open(hiddev_table[i]->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 return 0;
290}
291
292/*
293 * "write" file op
294 */
295static ssize_t hiddev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
296{
297 return -EINVAL;
298}
299
300/*
301 * "read" file op
302 */
303static ssize_t hiddev_read(struct file * file, char __user * buffer, size_t count, loff_t *ppos)
304{
305 DECLARE_WAITQUEUE(wait, current);
306 struct hiddev_list *list = file->private_data;
307 int event_size;
308 int retval = 0;
309
310 event_size = ((list->flags & HIDDEV_FLAG_UREF) != 0) ?
311 sizeof(struct hiddev_usage_ref) : sizeof(struct hiddev_event);
312
313 if (count < event_size)
314 return 0;
315
316 while (retval == 0) {
317 if (list->head == list->tail) {
318 add_wait_queue(&list->hiddev->wait, &wait);
319 set_current_state(TASK_INTERRUPTIBLE);
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 while (list->head == list->tail) {
322 if (file->f_flags & O_NONBLOCK) {
323 retval = -EAGAIN;
324 break;
325 }
326 if (signal_pending(current)) {
327 retval = -ERESTARTSYS;
328 break;
329 }
330 if (!list->hiddev->exist) {
331 retval = -EIO;
332 break;
333 }
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 schedule();
Micon, David48d70552006-05-20 14:59:59 -0700336 set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 }
338
339 set_current_state(TASK_RUNNING);
340 remove_wait_queue(&list->hiddev->wait, &wait);
341 }
342
343 if (retval)
344 return retval;
345
346
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500347 while (list->head != list->tail &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 retval + event_size <= count) {
349 if ((list->flags & HIDDEV_FLAG_UREF) == 0) {
350 if (list->buffer[list->tail].field_index !=
351 HID_FIELD_INDEX_NONE) {
352 struct hiddev_event event;
353 event.hid = list->buffer[list->tail].usage_code;
354 event.value = list->buffer[list->tail].value;
355 if (copy_to_user(buffer + retval, &event, sizeof(struct hiddev_event)))
356 return -EFAULT;
357 retval += sizeof(struct hiddev_event);
358 }
359 } else {
360 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE ||
361 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
362 if (copy_to_user(buffer + retval, list->buffer + list->tail, sizeof(struct hiddev_usage_ref)))
363 return -EFAULT;
364 retval += sizeof(struct hiddev_usage_ref);
365 }
366 }
367 list->tail = (list->tail + 1) & (HIDDEV_BUFFER_SIZE - 1);
368 }
369
370 }
371
372 return retval;
373}
374
375/*
376 * "poll" file op
377 * No kernel lock - fine
378 */
379static unsigned int hiddev_poll(struct file *file, poll_table *wait)
380{
381 struct hiddev_list *list = file->private_data;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 poll_wait(file, &list->hiddev->wait, wait);
384 if (list->head != list->tail)
385 return POLLIN | POLLRDNORM;
386 if (!list->hiddev->exist)
387 return POLLERR | POLLHUP;
388 return 0;
389}
390
391/*
392 * "ioctl" file op
393 */
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100394static noinline int hiddev_ioctl_usage(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
395{
396 struct hid_device *hid = hiddev->hid;
397 struct hiddev_report_info rinfo;
398 struct hiddev_usage_ref_multi *uref_multi = NULL;
399 struct hiddev_usage_ref *uref;
400 struct hid_report *report;
401 struct hid_field *field;
402 int i;
403
404 uref_multi = kmalloc(sizeof(struct hiddev_usage_ref_multi), GFP_KERNEL);
405 if (!uref_multi)
406 return -ENOMEM;
Alan Cox7961df12008-05-26 11:25:20 +0200407 lock_kernel();
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100408 uref = &uref_multi->uref;
409 if (cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) {
410 if (copy_from_user(uref_multi, user_arg,
411 sizeof(*uref_multi)))
412 goto fault;
413 } else {
414 if (copy_from_user(uref, user_arg, sizeof(*uref)))
415 goto fault;
416 }
417
418 switch (cmd) {
419 case HIDIOCGUCODE:
420 rinfo.report_type = uref->report_type;
421 rinfo.report_id = uref->report_id;
422 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
423 goto inval;
424
425 if (uref->field_index >= report->maxfield)
426 goto inval;
427
428 field = report->field[uref->field_index];
429 if (uref->usage_index >= field->maxusage)
430 goto inval;
431
432 uref->usage_code = field->usage[uref->usage_index].hid;
433
434 if (copy_to_user(user_arg, uref, sizeof(*uref)))
435 goto fault;
436
Jiri Slabyeb991082008-10-23 01:47:34 +0200437 goto goodreturn;
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100438
439 default:
440 if (cmd != HIDIOCGUSAGE &&
441 cmd != HIDIOCGUSAGES &&
442 uref->report_type == HID_REPORT_TYPE_INPUT)
443 goto inval;
444
445 if (uref->report_id == HID_REPORT_ID_UNKNOWN) {
446 field = hiddev_lookup_usage(hid, uref);
447 if (field == NULL)
448 goto inval;
449 } else {
450 rinfo.report_type = uref->report_type;
451 rinfo.report_id = uref->report_id;
452 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
453 goto inval;
454
455 if (uref->field_index >= report->maxfield)
456 goto inval;
457
458 field = report->field[uref->field_index];
459
460 if (cmd == HIDIOCGCOLLECTIONINDEX) {
461 if (uref->usage_index >= field->maxusage)
462 goto inval;
463 } else if (uref->usage_index >= field->report_count)
464 goto inval;
465
466 else if ((cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) &&
467 (uref_multi->num_values > HID_MAX_MULTI_USAGES ||
468 uref->usage_index + uref_multi->num_values > field->report_count))
469 goto inval;
470 }
471
472 switch (cmd) {
473 case HIDIOCGUSAGE:
474 uref->value = field->value[uref->usage_index];
475 if (copy_to_user(user_arg, uref, sizeof(*uref)))
476 goto fault;
477 goto goodreturn;
478
479 case HIDIOCSUSAGE:
480 field->value[uref->usage_index] = uref->value;
481 goto goodreturn;
482
483 case HIDIOCGCOLLECTIONINDEX:
484 kfree(uref_multi);
485 return field->usage[uref->usage_index].collection_index;
486 case HIDIOCGUSAGES:
487 for (i = 0; i < uref_multi->num_values; i++)
488 uref_multi->values[i] =
489 field->value[uref->usage_index + i];
490 if (copy_to_user(user_arg, uref_multi,
491 sizeof(*uref_multi)))
492 goto fault;
493 goto goodreturn;
494 case HIDIOCSUSAGES:
495 for (i = 0; i < uref_multi->num_values; i++)
496 field->value[uref->usage_index + i] =
497 uref_multi->values[i];
498 goto goodreturn;
499 }
500
501goodreturn:
Alan Cox7961df12008-05-26 11:25:20 +0200502 unlock_kernel();
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100503 kfree(uref_multi);
504 return 0;
505fault:
Alan Cox7961df12008-05-26 11:25:20 +0200506 unlock_kernel();
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100507 kfree(uref_multi);
508 return -EFAULT;
509inval:
Alan Cox7961df12008-05-26 11:25:20 +0200510 unlock_kernel();
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100511 kfree(uref_multi);
512 return -EINVAL;
513 }
514}
515
516static noinline int hiddev_ioctl_string(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
517{
518 struct hid_device *hid = hiddev->hid;
519 struct usb_device *dev = hid_to_usb_dev(hid);
520 int idx, len;
521 char *buf;
522
523 if (get_user(idx, (int __user *)user_arg))
524 return -EFAULT;
525
526 if ((buf = kmalloc(HID_STRING_SIZE, GFP_KERNEL)) == NULL)
527 return -ENOMEM;
528
529 if ((len = usb_string(dev, idx, buf, HID_STRING_SIZE-1)) < 0) {
530 kfree(buf);
531 return -EINVAL;
532 }
533
534 if (copy_to_user(user_arg+sizeof(int), buf, len+1)) {
535 kfree(buf);
536 return -EFAULT;
537 }
538
539 kfree(buf);
540
541 return len;
542}
543
Alan Cox7961df12008-05-26 11:25:20 +0200544static long hiddev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 struct hiddev_list *list = file->private_data;
547 struct hiddev *hiddev = list->hiddev;
548 struct hid_device *hid = hiddev->hid;
Anssi Hannulabe820972007-01-19 19:28:17 +0200549 struct usb_device *dev = hid_to_usb_dev(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 struct hiddev_collection_info cinfo;
551 struct hiddev_report_info rinfo;
552 struct hiddev_field_info finfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 struct hiddev_devinfo dinfo;
554 struct hid_report *report;
555 struct hid_field *field;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100556 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 void __user *user_arg = (void __user *)arg;
558 int i;
Alan Cox7961df12008-05-26 11:25:20 +0200559
560 /* Called without BKL by compat methods so no BKL taken */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Alan Cox7961df12008-05-26 11:25:20 +0200562 /* FIXME: Who or what stop this racing with a disconnect ?? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 if (!hiddev->exist)
564 return -EIO;
565
566 switch (cmd) {
567
568 case HIDIOCGVERSION:
569 return put_user(HID_VERSION, (int __user *)arg);
570
571 case HIDIOCAPPLICATION:
572 if (arg < 0 || arg >= hid->maxapplication)
573 return -EINVAL;
574
575 for (i = 0; i < hid->maxcollection; i++)
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500576 if (hid->collection[i].type ==
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 HID_COLLECTION_APPLICATION && arg-- == 0)
578 break;
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 if (i == hid->maxcollection)
581 return -EINVAL;
582
583 return hid->collection[i].usage;
584
585 case HIDIOCGDEVINFO:
586 dinfo.bustype = BUS_USB;
587 dinfo.busnum = dev->bus->busnum;
588 dinfo.devnum = dev->devnum;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100589 dinfo.ifnum = usbhid->ifnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 dinfo.vendor = le16_to_cpu(dev->descriptor.idVendor);
591 dinfo.product = le16_to_cpu(dev->descriptor.idProduct);
592 dinfo.version = le16_to_cpu(dev->descriptor.bcdDevice);
593 dinfo.num_applications = hid->maxapplication;
594 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
595 return -EFAULT;
596
597 return 0;
598
599 case HIDIOCGFLAG:
600 if (put_user(list->flags, (int __user *)arg))
601 return -EFAULT;
602
603 return 0;
604
605 case HIDIOCSFLAG:
606 {
607 int newflags;
608 if (get_user(newflags, (int __user *)arg))
609 return -EFAULT;
610
611 if ((newflags & ~HIDDEV_FLAGS) != 0 ||
612 ((newflags & HIDDEV_FLAG_REPORT) != 0 &&
613 (newflags & HIDDEV_FLAG_UREF) == 0))
614 return -EINVAL;
615
616 list->flags = newflags;
617
618 return 0;
619 }
620
621 case HIDIOCGSTRING:
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100622 return hiddev_ioctl_string(hiddev, cmd, user_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624 case HIDIOCINITREPORT:
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100625 usbhid_init_reports(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627 return 0;
628
629 case HIDIOCGREPORT:
630 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
631 return -EFAULT;
632
633 if (rinfo.report_type == HID_REPORT_TYPE_OUTPUT)
634 return -EINVAL;
635
636 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
637 return -EINVAL;
638
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100639 usbhid_submit_report(hid, report, USB_DIR_IN);
640 usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
642 return 0;
643
644 case HIDIOCSREPORT:
645 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
646 return -EFAULT;
647
648 if (rinfo.report_type == HID_REPORT_TYPE_INPUT)
649 return -EINVAL;
650
651 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
652 return -EINVAL;
653
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100654 usbhid_submit_report(hid, report, USB_DIR_OUT);
655 usbhid_wait_io(hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657 return 0;
658
659 case HIDIOCGREPORTINFO:
660 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
661 return -EFAULT;
662
663 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
664 return -EINVAL;
665
666 rinfo.num_fields = report->maxfield;
667
668 if (copy_to_user(user_arg, &rinfo, sizeof(rinfo)))
669 return -EFAULT;
670
671 return 0;
672
673 case HIDIOCGFIELDINFO:
674 if (copy_from_user(&finfo, user_arg, sizeof(finfo)))
675 return -EFAULT;
676 rinfo.report_type = finfo.report_type;
677 rinfo.report_id = finfo.report_id;
678 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
679 return -EINVAL;
680
681 if (finfo.field_index >= report->maxfield)
682 return -EINVAL;
683
684 field = report->field[finfo.field_index];
685 memset(&finfo, 0, sizeof(finfo));
686 finfo.report_type = rinfo.report_type;
687 finfo.report_id = rinfo.report_id;
688 finfo.field_index = field->report_count - 1;
689 finfo.maxusage = field->maxusage;
690 finfo.flags = field->flags;
691 finfo.physical = field->physical;
692 finfo.logical = field->logical;
693 finfo.application = field->application;
694 finfo.logical_minimum = field->logical_minimum;
695 finfo.logical_maximum = field->logical_maximum;
696 finfo.physical_minimum = field->physical_minimum;
697 finfo.physical_maximum = field->physical_maximum;
698 finfo.unit_exponent = field->unit_exponent;
699 finfo.unit = field->unit;
700
701 if (copy_to_user(user_arg, &finfo, sizeof(finfo)))
702 return -EFAULT;
703
704 return 0;
705
706 case HIDIOCGUCODE:
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100707 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 case HIDIOCGUSAGE:
709 case HIDIOCSUSAGE:
710 case HIDIOCGUSAGES:
711 case HIDIOCSUSAGES:
712 case HIDIOCGCOLLECTIONINDEX:
Jean Delvarecf2a299e2008-03-03 11:48:43 +0100713 return hiddev_ioctl_usage(hiddev, cmd, user_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 case HIDIOCGCOLLECTIONINFO:
716 if (copy_from_user(&cinfo, user_arg, sizeof(cinfo)))
717 return -EFAULT;
718
719 if (cinfo.index >= hid->maxcollection)
720 return -EINVAL;
721
722 cinfo.type = hid->collection[cinfo.index].type;
723 cinfo.usage = hid->collection[cinfo.index].usage;
724 cinfo.level = hid->collection[cinfo.index].level;
725
726 if (copy_to_user(user_arg, &cinfo, sizeof(cinfo)))
727 return -EFAULT;
728 return 0;
729
730 default:
731
732 if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ)
733 return -EINVAL;
734
735 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGNAME(0))) {
736 int len;
737 if (!hid->name)
738 return 0;
739 len = strlen(hid->name) + 1;
740 if (len > _IOC_SIZE(cmd))
741 len = _IOC_SIZE(cmd);
742 return copy_to_user(user_arg, hid->name, len) ?
743 -EFAULT : len;
744 }
745
746 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGPHYS(0))) {
747 int len;
748 if (!hid->phys)
749 return 0;
750 len = strlen(hid->phys) + 1;
751 if (len > _IOC_SIZE(cmd))
752 len = _IOC_SIZE(cmd);
753 return copy_to_user(user_arg, hid->phys, len) ?
754 -EFAULT : len;
755 }
756 }
757 return -EINVAL;
758}
759
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200760#ifdef CONFIG_COMPAT
761static long hiddev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
762{
Jiri Kosina88af45b2008-05-27 11:36:40 +0200763 return hiddev_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200764}
765#endif
766
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -0300767static const struct file_operations hiddev_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 .owner = THIS_MODULE,
769 .read = hiddev_read,
770 .write = hiddev_write,
771 .poll = hiddev_poll,
772 .open = hiddev_open,
773 .release = hiddev_release,
Alan Cox7961df12008-05-26 11:25:20 +0200774 .unlocked_ioctl = hiddev_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 .fasync = hiddev_fasync,
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200776#ifdef CONFIG_COMPAT
777 .compat_ioctl = hiddev_compat_ioctl,
778#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779};
780
781static struct usb_class_driver hiddev_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700782 .name = "hiddev%d",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 .fops = &hiddev_fops,
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500784 .minor_base = HIDDEV_MINOR_BASE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785};
786
787/*
788 * This is where hid.c calls us to connect a hid device to the hiddev driver
789 */
Jiri Slaby93c10132008-06-27 00:04:24 +0200790int hiddev_connect(struct hid_device *hid, unsigned int force)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
792 struct hiddev *hiddev;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100793 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 int retval;
795
Jiri Slaby93c10132008-06-27 00:04:24 +0200796 if (!force) {
797 unsigned int i;
798 for (i = 0; i < hid->maxcollection; i++)
799 if (hid->collection[i].type ==
800 HID_COLLECTION_APPLICATION &&
801 !IS_INPUT_APPLICATION(hid->collection[i].usage))
802 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Jiri Slaby93c10132008-06-27 00:04:24 +0200804 if (i == hid->maxcollection)
805 return -1;
806 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100808 if (!(hiddev = kzalloc(sizeof(struct hiddev), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100811 retval = usb_register_dev(usbhid->intf, &hiddev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 if (retval) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200813 err_hid("Not able to get a minor for this device.");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 kfree(hiddev);
815 return -1;
816 }
817
818 init_waitqueue_head(&hiddev->wait);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400819 INIT_LIST_HEAD(&hiddev->list);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200820 spin_lock_init(&hiddev->list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 hiddev->hid = hid;
822 hiddev->exist = 1;
823
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100824 hid->minor = usbhid->intf->minor;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 hid->hiddev = hiddev;
826
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100827 hiddev_table[usbhid->intf->minor - HIDDEV_MINOR_BASE] = hiddev;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 return 0;
830}
831
832/*
833 * This is where hid.c calls us to disconnect a hiddev device from the
834 * corresponding hid device (usually because the usb device has disconnected)
835 */
836static struct usb_class_driver hiddev_class;
837void hiddev_disconnect(struct hid_device *hid)
838{
839 struct hiddev *hiddev = hid->hiddev;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100840 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
842 hiddev->exist = 0;
843
844 hiddev_table[hiddev->hid->minor - HIDDEV_MINOR_BASE] = NULL;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100845 usb_deregister_dev(usbhid->intf, &hiddev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
847 if (hiddev->open) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100848 usbhid_close(hiddev->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 wake_up_interruptible(&hiddev->wait);
850 } else {
851 kfree(hiddev);
852 }
853}
854
855/* Currently this driver is a USB driver. It's not a conventional one in
856 * the sense that it doesn't probe at the USB level. Instead it waits to
857 * be connected by HID through the hiddev_connect / hiddev_disconnect
858 * routines. The reason to register as a USB device is to gain part of the
859 * minor number space from the USB major.
860 *
861 * In theory, should the HID code be generalized to more than one physical
862 * medium (say, IEEE 1384), this driver will probably need to register its
863 * own major number, and in doing so, no longer need to register with USB.
864 * At that point the probe routine and hiddev_driver struct below will no
865 * longer be useful.
866 */
867
868
869/* We never attach in this manner, and rely on HID to connect us. This
870 * is why there is no disconnect routine defined in the usb_driver either.
871 */
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500872static int hiddev_usbd_probe(struct usb_interface *intf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 const struct usb_device_id *hiddev_info)
874{
875 return -ENODEV;
876}
877
878
879static /* const */ struct usb_driver hiddev_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 .name = "hiddev",
881 .probe = hiddev_usbd_probe,
882};
883
884int __init hiddev_init(void)
885{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 return usb_register(&hiddev_driver);
887}
888
889void hiddev_exit(void)
890{
891 usb_deregister(&hiddev_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892}