blob: 984feb351a5a3205de716fdb68ad9e5f983bdadd [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/input.h>
33#include <linux/usb.h>
Jiri Kosinadde58452006-12-08 18:40:44 +010034#include <linux/hid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/hiddev.h>
Philip Langdalebb6c8d82007-10-14 12:03:58 +020036#include <linux/compat.h>
Jiri Kosinadde58452006-12-08 18:40:44 +010037#include "usbhid.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#ifdef CONFIG_USB_DYNAMIC_MINORS
40#define HIDDEV_MINOR_BASE 0
41#define HIDDEV_MINORS 256
42#else
43#define HIDDEV_MINOR_BASE 96
44#define HIDDEV_MINORS 16
45#endif
Jiri Kosinaaffbb8c2009-08-20 12:04:14 +020046#define HIDDEV_BUFFER_SIZE 2048
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48struct hiddev {
49 int exist;
50 int open;
Oliver Neukum07903402008-12-16 10:55:15 +010051 struct mutex existancelock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 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;
Oliver Neukum07903402008-12-16 10:55:15 +010066 struct mutex thread_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067};
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/*
70 * Find a report, given the report's type and ID. The ID can be specified
71 * indirectly by REPORT_ID_FIRST (which returns the first report of the given
72 * type) or by (REPORT_ID_NEXT | old_id), which returns the next report of the
73 * given type which follows old_id.
74 */
75static struct hid_report *
76hiddev_lookup_report(struct hid_device *hid, struct hiddev_report_info *rinfo)
77{
Dmitry Torokhov826d5982006-07-19 01:09:10 -040078 unsigned int flags = rinfo->report_id & ~HID_REPORT_ID_MASK;
79 unsigned int rid = rinfo->report_id & HID_REPORT_ID_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 struct hid_report_enum *report_enum;
Dmitry Torokhov826d5982006-07-19 01:09:10 -040081 struct hid_report *report;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 struct list_head *list;
83
84 if (rinfo->report_type < HID_REPORT_TYPE_MIN ||
Dmitry Torokhov826d5982006-07-19 01:09:10 -040085 rinfo->report_type > HID_REPORT_TYPE_MAX)
86 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
88 report_enum = hid->report_enum +
89 (rinfo->report_type - HID_REPORT_TYPE_MIN);
90
91 switch (flags) {
92 case 0: /* Nothing to do -- report_id is already set correctly */
93 break;
94
95 case HID_REPORT_ID_FIRST:
Dmitry Torokhov826d5982006-07-19 01:09:10 -040096 if (list_empty(&report_enum->report_list))
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 return NULL;
Dmitry Torokhov826d5982006-07-19 01:09:10 -040098
99 list = report_enum->report_list.next;
100 report = list_entry(list, struct hid_report, list);
101 rinfo->report_id = report->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 break;
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 case HID_REPORT_ID_NEXT:
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400105 report = report_enum->report_id_hash[rid];
106 if (!report)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 return NULL;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400108
109 list = report->list.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 if (list == &report_enum->report_list)
111 return NULL;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400112
113 report = list_entry(list, struct hid_report, list);
114 rinfo->report_id = report->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 break;
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 default:
118 return NULL;
119 }
120
121 return report_enum->report_id_hash[rinfo->report_id];
122}
123
124/*
125 * Perform an exhaustive search of the report table for a usage, given its
126 * type and usage id.
127 */
128static struct hid_field *
129hiddev_lookup_usage(struct hid_device *hid, struct hiddev_usage_ref *uref)
130{
131 int i, j;
132 struct hid_report *report;
133 struct hid_report_enum *report_enum;
134 struct hid_field *field;
135
136 if (uref->report_type < HID_REPORT_TYPE_MIN ||
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400137 uref->report_type > HID_REPORT_TYPE_MAX)
138 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140 report_enum = hid->report_enum +
141 (uref->report_type - HID_REPORT_TYPE_MIN);
142
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400143 list_for_each_entry(report, &report_enum->report_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 for (i = 0; i < report->maxfield; i++) {
145 field = report->field[i];
146 for (j = 0; j < field->maxusage; j++) {
147 if (field->usage[j].hid == uref->usage_code) {
148 uref->report_id = report->id;
149 uref->field_index = i;
150 uref->usage_index = j;
151 return field;
152 }
153 }
154 }
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400155 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 return NULL;
158}
159
160static void hiddev_send_event(struct hid_device *hid,
161 struct hiddev_usage_ref *uref)
162{
163 struct hiddev *hiddev = hid->hiddev;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400164 struct hiddev_list *list;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200165 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200167 spin_lock_irqsave(&hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400168 list_for_each_entry(list, &hiddev->list, node) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 if (uref->field_index != HID_FIELD_INDEX_NONE ||
170 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
171 list->buffer[list->head] = *uref;
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500172 list->head = (list->head + 1) &
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 (HIDDEV_BUFFER_SIZE - 1);
174 kill_fasync(&list->fasync, SIGIO, POLL_IN);
175 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 }
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200177 spin_unlock_irqrestore(&hiddev->list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179 wake_up_interruptible(&hiddev->wait);
180}
181
182/*
183 * This is where hid.c calls into hiddev to pass an event that occurred over
184 * the interrupt pipe
185 */
186void hiddev_hid_event(struct hid_device *hid, struct hid_field *field,
David Howells7d12e782006-10-05 14:55:46 +0100187 struct hid_usage *usage, __s32 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
189 unsigned type = field->report_type;
190 struct hiddev_usage_ref uref;
191
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500192 uref.report_type =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500194 ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400195 ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 uref.report_id = field->report->id;
197 uref.field_index = field->index;
198 uref.usage_index = (usage - field->usage);
199 uref.usage_code = usage->hid;
200 uref.value = value;
201
202 hiddev_send_event(hid, &uref);
203}
Jiri Kosina229695e2006-12-08 18:40:53 +0100204EXPORT_SYMBOL_GPL(hiddev_hid_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206void hiddev_report_event(struct hid_device *hid, struct hid_report *report)
207{
208 unsigned type = report->type;
209 struct hiddev_usage_ref uref;
210
211 memset(&uref, 0, sizeof(uref));
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500212 uref.report_type =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500214 ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400215 ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 uref.report_id = report->id;
217 uref.field_index = HID_FIELD_INDEX_NONE;
218
219 hiddev_send_event(hid, &uref);
220}
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*
223 * fasync file op
224 */
225static int hiddev_fasync(int fd, struct file *file, int on)
226{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 struct hiddev_list *list = file->private_data;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400228
Jonathan Corbet60aa4922009-02-01 14:52:56 -0700229 return fasync_helper(fd, file, on, &list->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230}
231
232
233/*
234 * release file op
235 */
236static int hiddev_release(struct inode * inode, struct file * file)
237{
238 struct hiddev_list *list = file->private_data;
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200239 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200241 spin_lock_irqsave(&list->hiddev->list_lock, flags);
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400242 list_del(&list->node);
Jiri Kosinacdcb44e2007-05-10 08:45:56 +0200243 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245 if (!--list->hiddev->open) {
Oliver Neukum0361a282008-12-17 15:38:03 +0100246 if (list->hiddev->exist) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100247 usbhid_close(list->hiddev->hid);
Oliver Neukum0361a282008-12-17 15:38:03 +0100248 usbhid_put_power(list->hiddev->hid);
249 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 kfree(list->hiddev);
Oliver Neukum0361a282008-12-17 15:38:03 +0100251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 }
253
254 kfree(list);
255
256 return 0;
257}
258
259/*
260 * open file op
261 */
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400262static int hiddev_open(struct inode *inode, struct file *file)
263{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 struct hiddev_list *list;
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200265 struct usb_interface *intf;
Jiri Kosina9c9e54a2010-08-13 12:19:45 +0200266 struct hid_device *hid;
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200267 struct hiddev *hiddev;
268 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Guillaume Chazarain8fe294c2010-09-12 21:32:35 +0200270 intf = usbhid_find_interface(iminor(inode));
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200271 if (!intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 return -ENODEV;
Jiri Kosina9c9e54a2010-08-13 12:19:45 +0200273 hid = usb_get_intfdata(intf);
274 hiddev = hid->hiddev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
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;
Oliver Neukum07903402008-12-16 10:55:15 +0100278 mutex_init(&list->thread_lock);
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200279 list->hiddev = hiddev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 file->private_data = list;
281
Oliver Neukum07903402008-12-16 10:55:15 +0100282 /*
283 * no need for locking because the USB major number
284 * is shared which usbcore guards against disconnect
285 */
286 if (list->hiddev->exist) {
287 if (!list->hiddev->open++) {
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200288 res = usbhid_open(hiddev->hid);
Oliver Neukum07903402008-12-16 10:55:15 +0100289 if (res < 0) {
290 res = -EIO;
291 goto bail;
292 }
293 }
294 } else {
295 res = -ENODEV;
296 goto bail;
297 }
298
299 spin_lock_irq(&list->hiddev->list_lock);
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200300 list_add_tail(&list->node, &hiddev->list);
Oliver Neukum07903402008-12-16 10:55:15 +0100301 spin_unlock_irq(&list->hiddev->list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Oliver Neukum0361a282008-12-17 15:38:03 +0100303 if (!list->hiddev->open++)
304 if (list->hiddev->exist) {
Arnd Bergmannbd25f4d2010-07-11 15:34:05 +0200305 struct hid_device *hid = hiddev->hid;
Oliver Neukum0361a282008-12-17 15:38:03 +0100306 res = usbhid_get_power(hid);
307 if (res < 0) {
308 res = -EIO;
309 goto bail;
310 }
311 usbhid_open(hid);
312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return 0;
Oliver Neukum07903402008-12-16 10:55:15 +0100314bail:
315 file->private_data = NULL;
Johannes Weiner48e7a3c2009-03-10 22:43:56 +0100316 kfree(list);
Oliver Neukum07903402008-12-16 10:55:15 +0100317 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318}
319
320/*
321 * "write" file op
322 */
323static ssize_t hiddev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
324{
325 return -EINVAL;
326}
327
328/*
329 * "read" file op
330 */
331static ssize_t hiddev_read(struct file * file, char __user * buffer, size_t count, loff_t *ppos)
332{
Johannes Weiner96fe2ab2009-03-10 22:44:01 +0100333 DEFINE_WAIT(wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 struct hiddev_list *list = file->private_data;
335 int event_size;
Oliver Neukum07903402008-12-16 10:55:15 +0100336 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 event_size = ((list->flags & HIDDEV_FLAG_UREF) != 0) ?
339 sizeof(struct hiddev_usage_ref) : sizeof(struct hiddev_event);
340
341 if (count < event_size)
342 return 0;
343
Oliver Neukum07903402008-12-16 10:55:15 +0100344 /* lock against other threads */
345 retval = mutex_lock_interruptible(&list->thread_lock);
346 if (retval)
347 return -ERESTARTSYS;
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 while (retval == 0) {
350 if (list->head == list->tail) {
Oliver Neukum07903402008-12-16 10:55:15 +0100351 prepare_to_wait(&list->hiddev->wait, &wait, TASK_INTERRUPTIBLE);
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 while (list->head == list->tail) {
354 if (file->f_flags & O_NONBLOCK) {
355 retval = -EAGAIN;
356 break;
357 }
358 if (signal_pending(current)) {
359 retval = -ERESTARTSYS;
360 break;
361 }
362 if (!list->hiddev->exist) {
363 retval = -EIO;
364 break;
365 }
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500366
Oliver Neukum07903402008-12-16 10:55:15 +0100367 /* let O_NONBLOCK tasks run */
368 mutex_unlock(&list->thread_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 schedule();
Oliver Neukum07903402008-12-16 10:55:15 +0100370 if (mutex_lock_interruptible(&list->thread_lock))
371 return -EINTR;
Micon, David48d70552006-05-20 14:59:59 -0700372 set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 }
Oliver Neukum07903402008-12-16 10:55:15 +0100374 finish_wait(&list->hiddev->wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 }
377
Oliver Neukum07903402008-12-16 10:55:15 +0100378 if (retval) {
379 mutex_unlock(&list->thread_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 return retval;
Oliver Neukum07903402008-12-16 10:55:15 +0100381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500384 while (list->head != list->tail &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 retval + event_size <= count) {
386 if ((list->flags & HIDDEV_FLAG_UREF) == 0) {
Oliver Neukum07903402008-12-16 10:55:15 +0100387 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 struct hiddev_event event;
Oliver Neukum07903402008-12-16 10:55:15 +0100389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 event.hid = list->buffer[list->tail].usage_code;
391 event.value = list->buffer[list->tail].value;
Oliver Neukum07903402008-12-16 10:55:15 +0100392 if (copy_to_user(buffer + retval, &event, sizeof(struct hiddev_event))) {
393 mutex_unlock(&list->thread_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 return -EFAULT;
Oliver Neukum07903402008-12-16 10:55:15 +0100395 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 retval += sizeof(struct hiddev_event);
397 }
398 } else {
399 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE ||
400 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
Oliver Neukum07903402008-12-16 10:55:15 +0100401
402 if (copy_to_user(buffer + retval, list->buffer + list->tail, sizeof(struct hiddev_usage_ref))) {
403 mutex_unlock(&list->thread_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 return -EFAULT;
Oliver Neukum07903402008-12-16 10:55:15 +0100405 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 retval += sizeof(struct hiddev_usage_ref);
407 }
408 }
409 list->tail = (list->tail + 1) & (HIDDEV_BUFFER_SIZE - 1);
410 }
411
412 }
Oliver Neukum07903402008-12-16 10:55:15 +0100413 mutex_unlock(&list->thread_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415 return retval;
416}
417
418/*
419 * "poll" file op
420 * No kernel lock - fine
421 */
422static unsigned int hiddev_poll(struct file *file, poll_table *wait)
423{
424 struct hiddev_list *list = file->private_data;
Dmitry Torokhov826d5982006-07-19 01:09:10 -0400425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 poll_wait(file, &list->hiddev->wait, wait);
427 if (list->head != list->tail)
428 return POLLIN | POLLRDNORM;
429 if (!list->hiddev->exist)
430 return POLLERR | POLLHUP;
431 return 0;
432}
433
434/*
435 * "ioctl" file op
436 */
Jean Delvarecf2a2992008-03-03 11:48:43 +0100437static noinline int hiddev_ioctl_usage(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
438{
439 struct hid_device *hid = hiddev->hid;
440 struct hiddev_report_info rinfo;
441 struct hiddev_usage_ref_multi *uref_multi = NULL;
442 struct hiddev_usage_ref *uref;
443 struct hid_report *report;
444 struct hid_field *field;
445 int i;
446
447 uref_multi = kmalloc(sizeof(struct hiddev_usage_ref_multi), GFP_KERNEL);
448 if (!uref_multi)
449 return -ENOMEM;
450 uref = &uref_multi->uref;
451 if (cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) {
452 if (copy_from_user(uref_multi, user_arg,
453 sizeof(*uref_multi)))
454 goto fault;
455 } else {
456 if (copy_from_user(uref, user_arg, sizeof(*uref)))
457 goto fault;
458 }
459
460 switch (cmd) {
461 case HIDIOCGUCODE:
462 rinfo.report_type = uref->report_type;
463 rinfo.report_id = uref->report_id;
464 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
465 goto inval;
466
467 if (uref->field_index >= report->maxfield)
468 goto inval;
469
470 field = report->field[uref->field_index];
471 if (uref->usage_index >= field->maxusage)
472 goto inval;
473
474 uref->usage_code = field->usage[uref->usage_index].hid;
475
476 if (copy_to_user(user_arg, uref, sizeof(*uref)))
477 goto fault;
478
Jiri Slabyeb991082008-10-23 01:47:34 +0200479 goto goodreturn;
Jean Delvarecf2a2992008-03-03 11:48:43 +0100480
481 default:
482 if (cmd != HIDIOCGUSAGE &&
483 cmd != HIDIOCGUSAGES &&
484 uref->report_type == HID_REPORT_TYPE_INPUT)
485 goto inval;
486
487 if (uref->report_id == HID_REPORT_ID_UNKNOWN) {
488 field = hiddev_lookup_usage(hid, uref);
489 if (field == NULL)
490 goto inval;
491 } else {
492 rinfo.report_type = uref->report_type;
493 rinfo.report_id = uref->report_id;
494 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
495 goto inval;
496
497 if (uref->field_index >= report->maxfield)
498 goto inval;
499
500 field = report->field[uref->field_index];
501
502 if (cmd == HIDIOCGCOLLECTIONINDEX) {
503 if (uref->usage_index >= field->maxusage)
504 goto inval;
505 } else if (uref->usage_index >= field->report_count)
506 goto inval;
507
508 else if ((cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) &&
509 (uref_multi->num_values > HID_MAX_MULTI_USAGES ||
510 uref->usage_index + uref_multi->num_values > field->report_count))
511 goto inval;
512 }
513
514 switch (cmd) {
515 case HIDIOCGUSAGE:
516 uref->value = field->value[uref->usage_index];
517 if (copy_to_user(user_arg, uref, sizeof(*uref)))
518 goto fault;
519 goto goodreturn;
520
521 case HIDIOCSUSAGE:
522 field->value[uref->usage_index] = uref->value;
523 goto goodreturn;
524
525 case HIDIOCGCOLLECTIONINDEX:
Jiri Slaby48594842009-06-19 23:24:11 +0200526 i = field->usage[uref->usage_index].collection_index;
Jean Delvarecf2a2992008-03-03 11:48:43 +0100527 kfree(uref_multi);
Jiri Slaby48594842009-06-19 23:24:11 +0200528 return i;
Jean Delvarecf2a2992008-03-03 11:48:43 +0100529 case HIDIOCGUSAGES:
530 for (i = 0; i < uref_multi->num_values; i++)
531 uref_multi->values[i] =
532 field->value[uref->usage_index + i];
533 if (copy_to_user(user_arg, uref_multi,
534 sizeof(*uref_multi)))
535 goto fault;
536 goto goodreturn;
537 case HIDIOCSUSAGES:
538 for (i = 0; i < uref_multi->num_values; i++)
539 field->value[uref->usage_index + i] =
540 uref_multi->values[i];
541 goto goodreturn;
542 }
543
544goodreturn:
545 kfree(uref_multi);
546 return 0;
547fault:
548 kfree(uref_multi);
549 return -EFAULT;
550inval:
551 kfree(uref_multi);
552 return -EINVAL;
553 }
554}
555
556static noinline int hiddev_ioctl_string(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
557{
558 struct hid_device *hid = hiddev->hid;
559 struct usb_device *dev = hid_to_usb_dev(hid);
560 int idx, len;
561 char *buf;
562
563 if (get_user(idx, (int __user *)user_arg))
564 return -EFAULT;
565
566 if ((buf = kmalloc(HID_STRING_SIZE, GFP_KERNEL)) == NULL)
567 return -ENOMEM;
568
569 if ((len = usb_string(dev, idx, buf, HID_STRING_SIZE-1)) < 0) {
570 kfree(buf);
571 return -EINVAL;
572 }
573
574 if (copy_to_user(user_arg+sizeof(int), buf, len+1)) {
575 kfree(buf);
576 return -EFAULT;
577 }
578
579 kfree(buf);
580
581 return len;
582}
583
Alan Cox7961df12008-05-26 11:25:20 +0200584static long hiddev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
586 struct hiddev_list *list = file->private_data;
587 struct hiddev *hiddev = list->hiddev;
588 struct hid_device *hid = hiddev->hid;
Chris Ball70322692010-08-12 19:07:40 -0400589 struct usb_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 struct hiddev_collection_info cinfo;
591 struct hiddev_report_info rinfo;
592 struct hiddev_field_info finfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 struct hiddev_devinfo dinfo;
594 struct hid_report *report;
595 struct hid_field *field;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100596 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 void __user *user_arg = (void __user *)arg;
Oliver Neukum07903402008-12-16 10:55:15 +0100598 int i, r;
Alan Cox7961df12008-05-26 11:25:20 +0200599
600 /* Called without BKL by compat methods so no BKL taken */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Alan Cox7961df12008-05-26 11:25:20 +0200602 /* FIXME: Who or what stop this racing with a disconnect ?? */
Chris Ball70322692010-08-12 19:07:40 -0400603 if (!hiddev->exist || !hid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 return -EIO;
605
Chris Ball70322692010-08-12 19:07:40 -0400606 dev = hid_to_usb_dev(hid);
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 switch (cmd) {
609
610 case HIDIOCGVERSION:
611 return put_user(HID_VERSION, (int __user *)arg);
612
613 case HIDIOCAPPLICATION:
614 if (arg < 0 || arg >= hid->maxapplication)
615 return -EINVAL;
616
617 for (i = 0; i < hid->maxcollection; i++)
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500618 if (hid->collection[i].type ==
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 HID_COLLECTION_APPLICATION && arg-- == 0)
620 break;
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 if (i == hid->maxcollection)
623 return -EINVAL;
624
625 return hid->collection[i].usage;
626
627 case HIDIOCGDEVINFO:
628 dinfo.bustype = BUS_USB;
629 dinfo.busnum = dev->bus->busnum;
630 dinfo.devnum = dev->devnum;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100631 dinfo.ifnum = usbhid->ifnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 dinfo.vendor = le16_to_cpu(dev->descriptor.idVendor);
633 dinfo.product = le16_to_cpu(dev->descriptor.idProduct);
634 dinfo.version = le16_to_cpu(dev->descriptor.bcdDevice);
635 dinfo.num_applications = hid->maxapplication;
636 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
637 return -EFAULT;
638
639 return 0;
640
641 case HIDIOCGFLAG:
642 if (put_user(list->flags, (int __user *)arg))
643 return -EFAULT;
644
645 return 0;
646
647 case HIDIOCSFLAG:
648 {
649 int newflags;
650 if (get_user(newflags, (int __user *)arg))
651 return -EFAULT;
652
653 if ((newflags & ~HIDDEV_FLAGS) != 0 ||
654 ((newflags & HIDDEV_FLAG_REPORT) != 0 &&
655 (newflags & HIDDEV_FLAG_UREF) == 0))
656 return -EINVAL;
657
658 list->flags = newflags;
659
660 return 0;
661 }
662
663 case HIDIOCGSTRING:
Oliver Neukum07903402008-12-16 10:55:15 +0100664 mutex_lock(&hiddev->existancelock);
Oliver Neukumbe5d0c82009-01-28 09:36:18 +0100665 if (hiddev->exist)
Oliver Neukum07903402008-12-16 10:55:15 +0100666 r = hiddev_ioctl_string(hiddev, cmd, user_arg);
667 else
668 r = -ENODEV;
669 mutex_unlock(&hiddev->existancelock);
670 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672 case HIDIOCINITREPORT:
Oliver Neukum07903402008-12-16 10:55:15 +0100673 mutex_lock(&hiddev->existancelock);
674 if (!hiddev->exist) {
675 mutex_unlock(&hiddev->existancelock);
676 return -ENODEV;
677 }
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100678 usbhid_init_reports(hid);
Oliver Neukum07903402008-12-16 10:55:15 +0100679 mutex_unlock(&hiddev->existancelock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
681 return 0;
682
683 case HIDIOCGREPORT:
684 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
685 return -EFAULT;
686
687 if (rinfo.report_type == HID_REPORT_TYPE_OUTPUT)
688 return -EINVAL;
689
690 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
691 return -EINVAL;
692
Oliver Neukum07903402008-12-16 10:55:15 +0100693 mutex_lock(&hiddev->existancelock);
694 if (hiddev->exist) {
695 usbhid_submit_report(hid, report, USB_DIR_IN);
696 usbhid_wait_io(hid);
697 }
698 mutex_unlock(&hiddev->existancelock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700 return 0;
701
702 case HIDIOCSREPORT:
703 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
704 return -EFAULT;
705
706 if (rinfo.report_type == HID_REPORT_TYPE_INPUT)
707 return -EINVAL;
708
709 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
710 return -EINVAL;
711
Oliver Neukum07903402008-12-16 10:55:15 +0100712 mutex_lock(&hiddev->existancelock);
713 if (hiddev->exist) {
714 usbhid_submit_report(hid, report, USB_DIR_OUT);
715 usbhid_wait_io(hid);
716 }
717 mutex_unlock(&hiddev->existancelock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 return 0;
720
721 case HIDIOCGREPORTINFO:
722 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
723 return -EFAULT;
724
725 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
726 return -EINVAL;
727
728 rinfo.num_fields = report->maxfield;
729
730 if (copy_to_user(user_arg, &rinfo, sizeof(rinfo)))
731 return -EFAULT;
732
733 return 0;
734
735 case HIDIOCGFIELDINFO:
736 if (copy_from_user(&finfo, user_arg, sizeof(finfo)))
737 return -EFAULT;
738 rinfo.report_type = finfo.report_type;
739 rinfo.report_id = finfo.report_id;
740 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
741 return -EINVAL;
742
743 if (finfo.field_index >= report->maxfield)
744 return -EINVAL;
745
746 field = report->field[finfo.field_index];
747 memset(&finfo, 0, sizeof(finfo));
748 finfo.report_type = rinfo.report_type;
749 finfo.report_id = rinfo.report_id;
750 finfo.field_index = field->report_count - 1;
751 finfo.maxusage = field->maxusage;
752 finfo.flags = field->flags;
753 finfo.physical = field->physical;
754 finfo.logical = field->logical;
755 finfo.application = field->application;
756 finfo.logical_minimum = field->logical_minimum;
757 finfo.logical_maximum = field->logical_maximum;
758 finfo.physical_minimum = field->physical_minimum;
759 finfo.physical_maximum = field->physical_maximum;
760 finfo.unit_exponent = field->unit_exponent;
761 finfo.unit = field->unit;
762
763 if (copy_to_user(user_arg, &finfo, sizeof(finfo)))
764 return -EFAULT;
765
766 return 0;
767
768 case HIDIOCGUCODE:
Jean Delvarecf2a2992008-03-03 11:48:43 +0100769 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 case HIDIOCGUSAGE:
771 case HIDIOCSUSAGE:
772 case HIDIOCGUSAGES:
773 case HIDIOCSUSAGES:
774 case HIDIOCGCOLLECTIONINDEX:
Oliver Neukum07903402008-12-16 10:55:15 +0100775 mutex_lock(&hiddev->existancelock);
776 if (hiddev->exist)
777 r = hiddev_ioctl_usage(hiddev, cmd, user_arg);
778 else
779 r = -ENODEV;
780 mutex_unlock(&hiddev->existancelock);
781 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
783 case HIDIOCGCOLLECTIONINFO:
784 if (copy_from_user(&cinfo, user_arg, sizeof(cinfo)))
785 return -EFAULT;
786
787 if (cinfo.index >= hid->maxcollection)
788 return -EINVAL;
789
790 cinfo.type = hid->collection[cinfo.index].type;
791 cinfo.usage = hid->collection[cinfo.index].usage;
792 cinfo.level = hid->collection[cinfo.index].level;
793
794 if (copy_to_user(user_arg, &cinfo, sizeof(cinfo)))
795 return -EFAULT;
796 return 0;
797
798 default:
799
800 if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ)
801 return -EINVAL;
802
803 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGNAME(0))) {
804 int len;
805 if (!hid->name)
806 return 0;
807 len = strlen(hid->name) + 1;
808 if (len > _IOC_SIZE(cmd))
809 len = _IOC_SIZE(cmd);
810 return copy_to_user(user_arg, hid->name, len) ?
811 -EFAULT : len;
812 }
813
814 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGPHYS(0))) {
815 int len;
816 if (!hid->phys)
817 return 0;
818 len = strlen(hid->phys) + 1;
819 if (len > _IOC_SIZE(cmd))
820 len = _IOC_SIZE(cmd);
821 return copy_to_user(user_arg, hid->phys, len) ?
822 -EFAULT : len;
823 }
824 }
825 return -EINVAL;
826}
827
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200828#ifdef CONFIG_COMPAT
829static long hiddev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
830{
Jiri Kosina88af45b2008-05-27 11:36:40 +0200831 return hiddev_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200832}
833#endif
834
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -0300835static const struct file_operations hiddev_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 .owner = THIS_MODULE,
837 .read = hiddev_read,
838 .write = hiddev_write,
839 .poll = hiddev_poll,
840 .open = hiddev_open,
841 .release = hiddev_release,
Alan Cox7961df12008-05-26 11:25:20 +0200842 .unlocked_ioctl = hiddev_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 .fasync = hiddev_fasync,
Philip Langdalebb6c8d82007-10-14 12:03:58 +0200844#ifdef CONFIG_COMPAT
845 .compat_ioctl = hiddev_compat_ioctl,
846#endif
Arnd Bergmann6038f372010-08-15 18:52:59 +0200847 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848};
849
Kay Sieverse454cea2009-09-18 23:01:12 +0200850static char *hiddev_devnode(struct device *dev, mode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +0200851{
852 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
853}
854
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855static struct usb_class_driver hiddev_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700856 .name = "hiddev%d",
Kay Sieverse454cea2009-09-18 23:01:12 +0200857 .devnode = hiddev_devnode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 .fops = &hiddev_fops,
Dmitry Torokhov05f091a2005-05-29 02:29:01 -0500859 .minor_base = HIDDEV_MINOR_BASE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860};
861
862/*
863 * This is where hid.c calls us to connect a hid device to the hiddev driver
864 */
Jiri Slaby93c10132008-06-27 00:04:24 +0200865int hiddev_connect(struct hid_device *hid, unsigned int force)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
867 struct hiddev *hiddev;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100868 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 int retval;
870
Jiri Slaby93c10132008-06-27 00:04:24 +0200871 if (!force) {
872 unsigned int i;
873 for (i = 0; i < hid->maxcollection; i++)
874 if (hid->collection[i].type ==
875 HID_COLLECTION_APPLICATION &&
876 !IS_INPUT_APPLICATION(hid->collection[i].usage))
877 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Jiri Slaby93c10132008-06-27 00:04:24 +0200879 if (i == hid->maxcollection)
880 return -1;
881 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Oliver Neukumbbdb7da2006-01-06 20:54:29 +0100883 if (!(hiddev = kzalloc(sizeof(struct hiddev), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Oliver Neukum07903402008-12-16 10:55:15 +0100886 init_waitqueue_head(&hiddev->wait);
887 INIT_LIST_HEAD(&hiddev->list);
888 spin_lock_init(&hiddev->list_lock);
889 mutex_init(&hiddev->existancelock);
Jiri Kosina76052742009-01-07 13:25:36 +0100890 hid->hiddev = hiddev;
Oliver Neukum07903402008-12-16 10:55:15 +0100891 hiddev->hid = hid;
892 hiddev->exist = 1;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100893 retval = usb_register_dev(usbhid->intf, &hiddev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 if (retval) {
Jiri Kosina58037eb2007-05-30 15:07:13 +0200895 err_hid("Not able to get a minor for this device.");
Jiri Kosina76052742009-01-07 13:25:36 +0100896 hid->hiddev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 kfree(hiddev);
898 return -1;
899 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 return 0;
901}
902
903/*
904 * This is where hid.c calls us to disconnect a hiddev device from the
905 * corresponding hid device (usually because the usb device has disconnected)
906 */
907static struct usb_class_driver hiddev_class;
908void hiddev_disconnect(struct hid_device *hid)
909{
910 struct hiddev *hiddev = hid->hiddev;
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100911 struct usbhid_device *usbhid = hid->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Oliver Neukum07903402008-12-16 10:55:15 +0100913 mutex_lock(&hiddev->existancelock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 hiddev->exist = 0;
Oliver Neukum07903402008-12-16 10:55:15 +0100915 mutex_unlock(&hiddev->existancelock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100917 usb_deregister_dev(usbhid->intf, &hiddev_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 if (hiddev->open) {
Jiri Kosina4916b3a2006-12-08 18:41:03 +0100920 usbhid_close(hiddev->hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 wake_up_interruptible(&hiddev->wait);
922 } else {
923 kfree(hiddev);
924 }
925}