xref: /openbmc/linux/drivers/hid/hid-core.c (revision dde5845a529ff753364a6d1aea61180946270bfa)
1*dde5845aSJiri Kosina /*
2*dde5845aSJiri Kosina  *  USB HID support for Linux
3*dde5845aSJiri Kosina  *
4*dde5845aSJiri Kosina  *  Copyright (c) 1999 Andreas Gal
5*dde5845aSJiri Kosina  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
6*dde5845aSJiri Kosina  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
7*dde5845aSJiri Kosina  *  Copyright (c) 2006 Jiri Kosina
8*dde5845aSJiri Kosina  */
9*dde5845aSJiri Kosina 
10*dde5845aSJiri Kosina /*
11*dde5845aSJiri Kosina  * This program is free software; you can redistribute it and/or modify it
12*dde5845aSJiri Kosina  * under the terms of the GNU General Public License as published by the Free
13*dde5845aSJiri Kosina  * Software Foundation; either version 2 of the License, or (at your option)
14*dde5845aSJiri Kosina  * any later version.
15*dde5845aSJiri Kosina  */
16*dde5845aSJiri Kosina 
17*dde5845aSJiri Kosina #include <linux/module.h>
18*dde5845aSJiri Kosina #include <linux/slab.h>
19*dde5845aSJiri Kosina #include <linux/init.h>
20*dde5845aSJiri Kosina #include <linux/kernel.h>
21*dde5845aSJiri Kosina #include <linux/sched.h>
22*dde5845aSJiri Kosina #include <linux/list.h>
23*dde5845aSJiri Kosina #include <linux/mm.h>
24*dde5845aSJiri Kosina #include <linux/smp_lock.h>
25*dde5845aSJiri Kosina #include <linux/spinlock.h>
26*dde5845aSJiri Kosina #include <asm/unaligned.h>
27*dde5845aSJiri Kosina #include <asm/byteorder.h>
28*dde5845aSJiri Kosina #include <linux/input.h>
29*dde5845aSJiri Kosina #include <linux/wait.h>
30*dde5845aSJiri Kosina 
31*dde5845aSJiri Kosina #undef DEBUG
32*dde5845aSJiri Kosina #undef DEBUG_DATA
33*dde5845aSJiri Kosina 
34*dde5845aSJiri Kosina #include <linux/usb.h>
35*dde5845aSJiri Kosina 
36*dde5845aSJiri Kosina #include <linux/hid.h>
37*dde5845aSJiri Kosina #include <linux/hiddev.h>
38*dde5845aSJiri Kosina 
39*dde5845aSJiri Kosina /*
40*dde5845aSJiri Kosina  * Version Information
41*dde5845aSJiri Kosina  */
42*dde5845aSJiri Kosina 
43*dde5845aSJiri Kosina #define DRIVER_VERSION "v2.6"
44*dde5845aSJiri Kosina #define DRIVER_AUTHOR "Andreas Gal, Vojtech Pavlik"
45*dde5845aSJiri Kosina #define DRIVER_DESC "USB HID core driver"
46*dde5845aSJiri Kosina #define DRIVER_LICENSE "GPL"
47*dde5845aSJiri Kosina 
48*dde5845aSJiri Kosina /*
49*dde5845aSJiri Kosina  * Module parameters.
50*dde5845aSJiri Kosina  */
51*dde5845aSJiri Kosina 
52*dde5845aSJiri Kosina static unsigned int hid_mousepoll_interval;
53*dde5845aSJiri Kosina module_param_named(mousepoll, hid_mousepoll_interval, uint, 0644);
54*dde5845aSJiri Kosina MODULE_PARM_DESC(mousepoll, "Polling interval of mice");
55*dde5845aSJiri Kosina 
56*dde5845aSJiri Kosina /*
57*dde5845aSJiri Kosina  * Register a new report for a device.
58*dde5845aSJiri Kosina  */
59*dde5845aSJiri Kosina 
60*dde5845aSJiri Kosina static struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id)
61*dde5845aSJiri Kosina {
62*dde5845aSJiri Kosina 	struct hid_report_enum *report_enum = device->report_enum + type;
63*dde5845aSJiri Kosina 	struct hid_report *report;
64*dde5845aSJiri Kosina 
65*dde5845aSJiri Kosina 	if (report_enum->report_id_hash[id])
66*dde5845aSJiri Kosina 		return report_enum->report_id_hash[id];
67*dde5845aSJiri Kosina 
68*dde5845aSJiri Kosina 	if (!(report = kzalloc(sizeof(struct hid_report), GFP_KERNEL)))
69*dde5845aSJiri Kosina 		return NULL;
70*dde5845aSJiri Kosina 
71*dde5845aSJiri Kosina 	if (id != 0)
72*dde5845aSJiri Kosina 		report_enum->numbered = 1;
73*dde5845aSJiri Kosina 
74*dde5845aSJiri Kosina 	report->id = id;
75*dde5845aSJiri Kosina 	report->type = type;
76*dde5845aSJiri Kosina 	report->size = 0;
77*dde5845aSJiri Kosina 	report->device = device;
78*dde5845aSJiri Kosina 	report_enum->report_id_hash[id] = report;
79*dde5845aSJiri Kosina 
80*dde5845aSJiri Kosina 	list_add_tail(&report->list, &report_enum->report_list);
81*dde5845aSJiri Kosina 
82*dde5845aSJiri Kosina 	return report;
83*dde5845aSJiri Kosina }
84*dde5845aSJiri Kosina 
85*dde5845aSJiri Kosina /*
86*dde5845aSJiri Kosina  * Register a new field for this report.
87*dde5845aSJiri Kosina  */
88*dde5845aSJiri Kosina 
89*dde5845aSJiri Kosina static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values)
90*dde5845aSJiri Kosina {
91*dde5845aSJiri Kosina 	struct hid_field *field;
92*dde5845aSJiri Kosina 
93*dde5845aSJiri Kosina 	if (report->maxfield == HID_MAX_FIELDS) {
94*dde5845aSJiri Kosina 		dbg("too many fields in report");
95*dde5845aSJiri Kosina 		return NULL;
96*dde5845aSJiri Kosina 	}
97*dde5845aSJiri Kosina 
98*dde5845aSJiri Kosina 	if (!(field = kzalloc(sizeof(struct hid_field) + usages * sizeof(struct hid_usage)
99*dde5845aSJiri Kosina 		+ values * sizeof(unsigned), GFP_KERNEL))) return NULL;
100*dde5845aSJiri Kosina 
101*dde5845aSJiri Kosina 	field->index = report->maxfield++;
102*dde5845aSJiri Kosina 	report->field[field->index] = field;
103*dde5845aSJiri Kosina 	field->usage = (struct hid_usage *)(field + 1);
104*dde5845aSJiri Kosina 	field->value = (unsigned *)(field->usage + usages);
105*dde5845aSJiri Kosina 	field->report = report;
106*dde5845aSJiri Kosina 
107*dde5845aSJiri Kosina 	return field;
108*dde5845aSJiri Kosina }
109*dde5845aSJiri Kosina 
110*dde5845aSJiri Kosina /*
111*dde5845aSJiri Kosina  * Open a collection. The type/usage is pushed on the stack.
112*dde5845aSJiri Kosina  */
113*dde5845aSJiri Kosina 
114*dde5845aSJiri Kosina static int open_collection(struct hid_parser *parser, unsigned type)
115*dde5845aSJiri Kosina {
116*dde5845aSJiri Kosina 	struct hid_collection *collection;
117*dde5845aSJiri Kosina 	unsigned usage;
118*dde5845aSJiri Kosina 
119*dde5845aSJiri Kosina 	usage = parser->local.usage[0];
120*dde5845aSJiri Kosina 
121*dde5845aSJiri Kosina 	if (parser->collection_stack_ptr == HID_COLLECTION_STACK_SIZE) {
122*dde5845aSJiri Kosina 		dbg("collection stack overflow");
123*dde5845aSJiri Kosina 		return -1;
124*dde5845aSJiri Kosina 	}
125*dde5845aSJiri Kosina 
126*dde5845aSJiri Kosina 	if (parser->device->maxcollection == parser->device->collection_size) {
127*dde5845aSJiri Kosina 		collection = kmalloc(sizeof(struct hid_collection) *
128*dde5845aSJiri Kosina 				parser->device->collection_size * 2, GFP_KERNEL);
129*dde5845aSJiri Kosina 		if (collection == NULL) {
130*dde5845aSJiri Kosina 			dbg("failed to reallocate collection array");
131*dde5845aSJiri Kosina 			return -1;
132*dde5845aSJiri Kosina 		}
133*dde5845aSJiri Kosina 		memcpy(collection, parser->device->collection,
134*dde5845aSJiri Kosina 			sizeof(struct hid_collection) *
135*dde5845aSJiri Kosina 			parser->device->collection_size);
136*dde5845aSJiri Kosina 		memset(collection + parser->device->collection_size, 0,
137*dde5845aSJiri Kosina 			sizeof(struct hid_collection) *
138*dde5845aSJiri Kosina 			parser->device->collection_size);
139*dde5845aSJiri Kosina 		kfree(parser->device->collection);
140*dde5845aSJiri Kosina 		parser->device->collection = collection;
141*dde5845aSJiri Kosina 		parser->device->collection_size *= 2;
142*dde5845aSJiri Kosina 	}
143*dde5845aSJiri Kosina 
144*dde5845aSJiri Kosina 	parser->collection_stack[parser->collection_stack_ptr++] =
145*dde5845aSJiri Kosina 		parser->device->maxcollection;
146*dde5845aSJiri Kosina 
147*dde5845aSJiri Kosina 	collection = parser->device->collection +
148*dde5845aSJiri Kosina 		parser->device->maxcollection++;
149*dde5845aSJiri Kosina 	collection->type = type;
150*dde5845aSJiri Kosina 	collection->usage = usage;
151*dde5845aSJiri Kosina 	collection->level = parser->collection_stack_ptr - 1;
152*dde5845aSJiri Kosina 
153*dde5845aSJiri Kosina 	if (type == HID_COLLECTION_APPLICATION)
154*dde5845aSJiri Kosina 		parser->device->maxapplication++;
155*dde5845aSJiri Kosina 
156*dde5845aSJiri Kosina 	return 0;
157*dde5845aSJiri Kosina }
158*dde5845aSJiri Kosina 
159*dde5845aSJiri Kosina /*
160*dde5845aSJiri Kosina  * Close a collection.
161*dde5845aSJiri Kosina  */
162*dde5845aSJiri Kosina 
163*dde5845aSJiri Kosina static int close_collection(struct hid_parser *parser)
164*dde5845aSJiri Kosina {
165*dde5845aSJiri Kosina 	if (!parser->collection_stack_ptr) {
166*dde5845aSJiri Kosina 		dbg("collection stack underflow");
167*dde5845aSJiri Kosina 		return -1;
168*dde5845aSJiri Kosina 	}
169*dde5845aSJiri Kosina 	parser->collection_stack_ptr--;
170*dde5845aSJiri Kosina 	return 0;
171*dde5845aSJiri Kosina }
172*dde5845aSJiri Kosina 
173*dde5845aSJiri Kosina /*
174*dde5845aSJiri Kosina  * Climb up the stack, search for the specified collection type
175*dde5845aSJiri Kosina  * and return the usage.
176*dde5845aSJiri Kosina  */
177*dde5845aSJiri Kosina 
178*dde5845aSJiri Kosina static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type)
179*dde5845aSJiri Kosina {
180*dde5845aSJiri Kosina 	int n;
181*dde5845aSJiri Kosina 	for (n = parser->collection_stack_ptr - 1; n >= 0; n--)
182*dde5845aSJiri Kosina 		if (parser->device->collection[parser->collection_stack[n]].type == type)
183*dde5845aSJiri Kosina 			return parser->device->collection[parser->collection_stack[n]].usage;
184*dde5845aSJiri Kosina 	return 0; /* we know nothing about this usage type */
185*dde5845aSJiri Kosina }
186*dde5845aSJiri Kosina 
187*dde5845aSJiri Kosina /*
188*dde5845aSJiri Kosina  * Add a usage to the temporary parser table.
189*dde5845aSJiri Kosina  */
190*dde5845aSJiri Kosina 
191*dde5845aSJiri Kosina static int hid_add_usage(struct hid_parser *parser, unsigned usage)
192*dde5845aSJiri Kosina {
193*dde5845aSJiri Kosina 	if (parser->local.usage_index >= HID_MAX_USAGES) {
194*dde5845aSJiri Kosina 		dbg("usage index exceeded");
195*dde5845aSJiri Kosina 		return -1;
196*dde5845aSJiri Kosina 	}
197*dde5845aSJiri Kosina 	parser->local.usage[parser->local.usage_index] = usage;
198*dde5845aSJiri Kosina 	parser->local.collection_index[parser->local.usage_index] =
199*dde5845aSJiri Kosina 		parser->collection_stack_ptr ?
200*dde5845aSJiri Kosina 		parser->collection_stack[parser->collection_stack_ptr - 1] : 0;
201*dde5845aSJiri Kosina 	parser->local.usage_index++;
202*dde5845aSJiri Kosina 	return 0;
203*dde5845aSJiri Kosina }
204*dde5845aSJiri Kosina 
205*dde5845aSJiri Kosina /*
206*dde5845aSJiri Kosina  * Register a new field for this report.
207*dde5845aSJiri Kosina  */
208*dde5845aSJiri Kosina 
209*dde5845aSJiri Kosina static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags)
210*dde5845aSJiri Kosina {
211*dde5845aSJiri Kosina 	struct hid_report *report;
212*dde5845aSJiri Kosina 	struct hid_field *field;
213*dde5845aSJiri Kosina 	int usages;
214*dde5845aSJiri Kosina 	unsigned offset;
215*dde5845aSJiri Kosina 	int i;
216*dde5845aSJiri Kosina 
217*dde5845aSJiri Kosina 	if (!(report = hid_register_report(parser->device, report_type, parser->global.report_id))) {
218*dde5845aSJiri Kosina 		dbg("hid_register_report failed");
219*dde5845aSJiri Kosina 		return -1;
220*dde5845aSJiri Kosina 	}
221*dde5845aSJiri Kosina 
222*dde5845aSJiri Kosina 	if (parser->global.logical_maximum < parser->global.logical_minimum) {
223*dde5845aSJiri Kosina 		dbg("logical range invalid %d %d", parser->global.logical_minimum, parser->global.logical_maximum);
224*dde5845aSJiri Kosina 		return -1;
225*dde5845aSJiri Kosina 	}
226*dde5845aSJiri Kosina 
227*dde5845aSJiri Kosina 	offset = report->size;
228*dde5845aSJiri Kosina 	report->size += parser->global.report_size * parser->global.report_count;
229*dde5845aSJiri Kosina 
230*dde5845aSJiri Kosina 	if (!parser->local.usage_index) /* Ignore padding fields */
231*dde5845aSJiri Kosina 		return 0;
232*dde5845aSJiri Kosina 
233*dde5845aSJiri Kosina 	usages = max_t(int, parser->local.usage_index, parser->global.report_count);
234*dde5845aSJiri Kosina 
235*dde5845aSJiri Kosina 	if ((field = hid_register_field(report, usages, parser->global.report_count)) == NULL)
236*dde5845aSJiri Kosina 		return 0;
237*dde5845aSJiri Kosina 
238*dde5845aSJiri Kosina 	field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL);
239*dde5845aSJiri Kosina 	field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL);
240*dde5845aSJiri Kosina 	field->application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION);
241*dde5845aSJiri Kosina 
242*dde5845aSJiri Kosina 	for (i = 0; i < usages; i++) {
243*dde5845aSJiri Kosina 		int j = i;
244*dde5845aSJiri Kosina 		/* Duplicate the last usage we parsed if we have excess values */
245*dde5845aSJiri Kosina 		if (i >= parser->local.usage_index)
246*dde5845aSJiri Kosina 			j = parser->local.usage_index - 1;
247*dde5845aSJiri Kosina 		field->usage[i].hid = parser->local.usage[j];
248*dde5845aSJiri Kosina 		field->usage[i].collection_index =
249*dde5845aSJiri Kosina 			parser->local.collection_index[j];
250*dde5845aSJiri Kosina 	}
251*dde5845aSJiri Kosina 
252*dde5845aSJiri Kosina 	field->maxusage = usages;
253*dde5845aSJiri Kosina 	field->flags = flags;
254*dde5845aSJiri Kosina 	field->report_offset = offset;
255*dde5845aSJiri Kosina 	field->report_type = report_type;
256*dde5845aSJiri Kosina 	field->report_size = parser->global.report_size;
257*dde5845aSJiri Kosina 	field->report_count = parser->global.report_count;
258*dde5845aSJiri Kosina 	field->logical_minimum = parser->global.logical_minimum;
259*dde5845aSJiri Kosina 	field->logical_maximum = parser->global.logical_maximum;
260*dde5845aSJiri Kosina 	field->physical_minimum = parser->global.physical_minimum;
261*dde5845aSJiri Kosina 	field->physical_maximum = parser->global.physical_maximum;
262*dde5845aSJiri Kosina 	field->unit_exponent = parser->global.unit_exponent;
263*dde5845aSJiri Kosina 	field->unit = parser->global.unit;
264*dde5845aSJiri Kosina 
265*dde5845aSJiri Kosina 	return 0;
266*dde5845aSJiri Kosina }
267*dde5845aSJiri Kosina 
268*dde5845aSJiri Kosina /*
269*dde5845aSJiri Kosina  * Read data value from item.
270*dde5845aSJiri Kosina  */
271*dde5845aSJiri Kosina 
272*dde5845aSJiri Kosina static u32 item_udata(struct hid_item *item)
273*dde5845aSJiri Kosina {
274*dde5845aSJiri Kosina 	switch (item->size) {
275*dde5845aSJiri Kosina 		case 1: return item->data.u8;
276*dde5845aSJiri Kosina 		case 2: return item->data.u16;
277*dde5845aSJiri Kosina 		case 4: return item->data.u32;
278*dde5845aSJiri Kosina 	}
279*dde5845aSJiri Kosina 	return 0;
280*dde5845aSJiri Kosina }
281*dde5845aSJiri Kosina 
282*dde5845aSJiri Kosina static s32 item_sdata(struct hid_item *item)
283*dde5845aSJiri Kosina {
284*dde5845aSJiri Kosina 	switch (item->size) {
285*dde5845aSJiri Kosina 		case 1: return item->data.s8;
286*dde5845aSJiri Kosina 		case 2: return item->data.s16;
287*dde5845aSJiri Kosina 		case 4: return item->data.s32;
288*dde5845aSJiri Kosina 	}
289*dde5845aSJiri Kosina 	return 0;
290*dde5845aSJiri Kosina }
291*dde5845aSJiri Kosina 
292*dde5845aSJiri Kosina /*
293*dde5845aSJiri Kosina  * Process a global item.
294*dde5845aSJiri Kosina  */
295*dde5845aSJiri Kosina 
296*dde5845aSJiri Kosina static int hid_parser_global(struct hid_parser *parser, struct hid_item *item)
297*dde5845aSJiri Kosina {
298*dde5845aSJiri Kosina 	switch (item->tag) {
299*dde5845aSJiri Kosina 
300*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_PUSH:
301*dde5845aSJiri Kosina 
302*dde5845aSJiri Kosina 			if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) {
303*dde5845aSJiri Kosina 				dbg("global enviroment stack overflow");
304*dde5845aSJiri Kosina 				return -1;
305*dde5845aSJiri Kosina 			}
306*dde5845aSJiri Kosina 
307*dde5845aSJiri Kosina 			memcpy(parser->global_stack + parser->global_stack_ptr++,
308*dde5845aSJiri Kosina 				&parser->global, sizeof(struct hid_global));
309*dde5845aSJiri Kosina 			return 0;
310*dde5845aSJiri Kosina 
311*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_POP:
312*dde5845aSJiri Kosina 
313*dde5845aSJiri Kosina 			if (!parser->global_stack_ptr) {
314*dde5845aSJiri Kosina 				dbg("global enviroment stack underflow");
315*dde5845aSJiri Kosina 				return -1;
316*dde5845aSJiri Kosina 			}
317*dde5845aSJiri Kosina 
318*dde5845aSJiri Kosina 			memcpy(&parser->global, parser->global_stack + --parser->global_stack_ptr,
319*dde5845aSJiri Kosina 				sizeof(struct hid_global));
320*dde5845aSJiri Kosina 			return 0;
321*dde5845aSJiri Kosina 
322*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_USAGE_PAGE:
323*dde5845aSJiri Kosina 			parser->global.usage_page = item_udata(item);
324*dde5845aSJiri Kosina 			return 0;
325*dde5845aSJiri Kosina 
326*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM:
327*dde5845aSJiri Kosina 			parser->global.logical_minimum = item_sdata(item);
328*dde5845aSJiri Kosina 			return 0;
329*dde5845aSJiri Kosina 
330*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM:
331*dde5845aSJiri Kosina 			if (parser->global.logical_minimum < 0)
332*dde5845aSJiri Kosina 				parser->global.logical_maximum = item_sdata(item);
333*dde5845aSJiri Kosina 			else
334*dde5845aSJiri Kosina 				parser->global.logical_maximum = item_udata(item);
335*dde5845aSJiri Kosina 			return 0;
336*dde5845aSJiri Kosina 
337*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM:
338*dde5845aSJiri Kosina 			parser->global.physical_minimum = item_sdata(item);
339*dde5845aSJiri Kosina 			return 0;
340*dde5845aSJiri Kosina 
341*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM:
342*dde5845aSJiri Kosina 			if (parser->global.physical_minimum < 0)
343*dde5845aSJiri Kosina 				parser->global.physical_maximum = item_sdata(item);
344*dde5845aSJiri Kosina 			else
345*dde5845aSJiri Kosina 				parser->global.physical_maximum = item_udata(item);
346*dde5845aSJiri Kosina 			return 0;
347*dde5845aSJiri Kosina 
348*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT:
349*dde5845aSJiri Kosina 			parser->global.unit_exponent = item_sdata(item);
350*dde5845aSJiri Kosina 			return 0;
351*dde5845aSJiri Kosina 
352*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_UNIT:
353*dde5845aSJiri Kosina 			parser->global.unit = item_udata(item);
354*dde5845aSJiri Kosina 			return 0;
355*dde5845aSJiri Kosina 
356*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_REPORT_SIZE:
357*dde5845aSJiri Kosina 			if ((parser->global.report_size = item_udata(item)) > 32) {
358*dde5845aSJiri Kosina 				dbg("invalid report_size %d", parser->global.report_size);
359*dde5845aSJiri Kosina 				return -1;
360*dde5845aSJiri Kosina 			}
361*dde5845aSJiri Kosina 			return 0;
362*dde5845aSJiri Kosina 
363*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_REPORT_COUNT:
364*dde5845aSJiri Kosina 			if ((parser->global.report_count = item_udata(item)) > HID_MAX_USAGES) {
365*dde5845aSJiri Kosina 				dbg("invalid report_count %d", parser->global.report_count);
366*dde5845aSJiri Kosina 				return -1;
367*dde5845aSJiri Kosina 			}
368*dde5845aSJiri Kosina 			return 0;
369*dde5845aSJiri Kosina 
370*dde5845aSJiri Kosina 		case HID_GLOBAL_ITEM_TAG_REPORT_ID:
371*dde5845aSJiri Kosina 			if ((parser->global.report_id = item_udata(item)) == 0) {
372*dde5845aSJiri Kosina 				dbg("report_id 0 is invalid");
373*dde5845aSJiri Kosina 				return -1;
374*dde5845aSJiri Kosina 			}
375*dde5845aSJiri Kosina 			return 0;
376*dde5845aSJiri Kosina 
377*dde5845aSJiri Kosina 		default:
378*dde5845aSJiri Kosina 			dbg("unknown global tag 0x%x", item->tag);
379*dde5845aSJiri Kosina 			return -1;
380*dde5845aSJiri Kosina 	}
381*dde5845aSJiri Kosina }
382*dde5845aSJiri Kosina 
383*dde5845aSJiri Kosina /*
384*dde5845aSJiri Kosina  * Process a local item.
385*dde5845aSJiri Kosina  */
386*dde5845aSJiri Kosina 
387*dde5845aSJiri Kosina static int hid_parser_local(struct hid_parser *parser, struct hid_item *item)
388*dde5845aSJiri Kosina {
389*dde5845aSJiri Kosina 	__u32 data;
390*dde5845aSJiri Kosina 	unsigned n;
391*dde5845aSJiri Kosina 
392*dde5845aSJiri Kosina 	if (item->size == 0) {
393*dde5845aSJiri Kosina 		dbg("item data expected for local item");
394*dde5845aSJiri Kosina 		return -1;
395*dde5845aSJiri Kosina 	}
396*dde5845aSJiri Kosina 
397*dde5845aSJiri Kosina 	data = item_udata(item);
398*dde5845aSJiri Kosina 
399*dde5845aSJiri Kosina 	switch (item->tag) {
400*dde5845aSJiri Kosina 
401*dde5845aSJiri Kosina 		case HID_LOCAL_ITEM_TAG_DELIMITER:
402*dde5845aSJiri Kosina 
403*dde5845aSJiri Kosina 			if (data) {
404*dde5845aSJiri Kosina 				/*
405*dde5845aSJiri Kosina 				 * We treat items before the first delimiter
406*dde5845aSJiri Kosina 				 * as global to all usage sets (branch 0).
407*dde5845aSJiri Kosina 				 * In the moment we process only these global
408*dde5845aSJiri Kosina 				 * items and the first delimiter set.
409*dde5845aSJiri Kosina 				 */
410*dde5845aSJiri Kosina 				if (parser->local.delimiter_depth != 0) {
411*dde5845aSJiri Kosina 					dbg("nested delimiters");
412*dde5845aSJiri Kosina 					return -1;
413*dde5845aSJiri Kosina 				}
414*dde5845aSJiri Kosina 				parser->local.delimiter_depth++;
415*dde5845aSJiri Kosina 				parser->local.delimiter_branch++;
416*dde5845aSJiri Kosina 			} else {
417*dde5845aSJiri Kosina 				if (parser->local.delimiter_depth < 1) {
418*dde5845aSJiri Kosina 					dbg("bogus close delimiter");
419*dde5845aSJiri Kosina 					return -1;
420*dde5845aSJiri Kosina 				}
421*dde5845aSJiri Kosina 				parser->local.delimiter_depth--;
422*dde5845aSJiri Kosina 			}
423*dde5845aSJiri Kosina 			return 1;
424*dde5845aSJiri Kosina 
425*dde5845aSJiri Kosina 		case HID_LOCAL_ITEM_TAG_USAGE:
426*dde5845aSJiri Kosina 
427*dde5845aSJiri Kosina 			if (parser->local.delimiter_branch > 1) {
428*dde5845aSJiri Kosina 				dbg("alternative usage ignored");
429*dde5845aSJiri Kosina 				return 0;
430*dde5845aSJiri Kosina 			}
431*dde5845aSJiri Kosina 
432*dde5845aSJiri Kosina 			if (item->size <= 2)
433*dde5845aSJiri Kosina 				data = (parser->global.usage_page << 16) + data;
434*dde5845aSJiri Kosina 
435*dde5845aSJiri Kosina 			return hid_add_usage(parser, data);
436*dde5845aSJiri Kosina 
437*dde5845aSJiri Kosina 		case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:
438*dde5845aSJiri Kosina 
439*dde5845aSJiri Kosina 			if (parser->local.delimiter_branch > 1) {
440*dde5845aSJiri Kosina 				dbg("alternative usage ignored");
441*dde5845aSJiri Kosina 				return 0;
442*dde5845aSJiri Kosina 			}
443*dde5845aSJiri Kosina 
444*dde5845aSJiri Kosina 			if (item->size <= 2)
445*dde5845aSJiri Kosina 				data = (parser->global.usage_page << 16) + data;
446*dde5845aSJiri Kosina 
447*dde5845aSJiri Kosina 			parser->local.usage_minimum = data;
448*dde5845aSJiri Kosina 			return 0;
449*dde5845aSJiri Kosina 
450*dde5845aSJiri Kosina 		case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:
451*dde5845aSJiri Kosina 
452*dde5845aSJiri Kosina 			if (parser->local.delimiter_branch > 1) {
453*dde5845aSJiri Kosina 				dbg("alternative usage ignored");
454*dde5845aSJiri Kosina 				return 0;
455*dde5845aSJiri Kosina 			}
456*dde5845aSJiri Kosina 
457*dde5845aSJiri Kosina 			if (item->size <= 2)
458*dde5845aSJiri Kosina 				data = (parser->global.usage_page << 16) + data;
459*dde5845aSJiri Kosina 
460*dde5845aSJiri Kosina 			for (n = parser->local.usage_minimum; n <= data; n++)
461*dde5845aSJiri Kosina 				if (hid_add_usage(parser, n)) {
462*dde5845aSJiri Kosina 					dbg("hid_add_usage failed\n");
463*dde5845aSJiri Kosina 					return -1;
464*dde5845aSJiri Kosina 				}
465*dde5845aSJiri Kosina 			return 0;
466*dde5845aSJiri Kosina 
467*dde5845aSJiri Kosina 		default:
468*dde5845aSJiri Kosina 
469*dde5845aSJiri Kosina 			dbg("unknown local item tag 0x%x", item->tag);
470*dde5845aSJiri Kosina 			return 0;
471*dde5845aSJiri Kosina 	}
472*dde5845aSJiri Kosina 	return 0;
473*dde5845aSJiri Kosina }
474*dde5845aSJiri Kosina 
475*dde5845aSJiri Kosina /*
476*dde5845aSJiri Kosina  * Process a main item.
477*dde5845aSJiri Kosina  */
478*dde5845aSJiri Kosina 
479*dde5845aSJiri Kosina static int hid_parser_main(struct hid_parser *parser, struct hid_item *item)
480*dde5845aSJiri Kosina {
481*dde5845aSJiri Kosina 	__u32 data;
482*dde5845aSJiri Kosina 	int ret;
483*dde5845aSJiri Kosina 
484*dde5845aSJiri Kosina 	data = item_udata(item);
485*dde5845aSJiri Kosina 
486*dde5845aSJiri Kosina 	switch (item->tag) {
487*dde5845aSJiri Kosina 		case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION:
488*dde5845aSJiri Kosina 			ret = open_collection(parser, data & 0xff);
489*dde5845aSJiri Kosina 			break;
490*dde5845aSJiri Kosina 		case HID_MAIN_ITEM_TAG_END_COLLECTION:
491*dde5845aSJiri Kosina 			ret = close_collection(parser);
492*dde5845aSJiri Kosina 			break;
493*dde5845aSJiri Kosina 		case HID_MAIN_ITEM_TAG_INPUT:
494*dde5845aSJiri Kosina 			ret = hid_add_field(parser, HID_INPUT_REPORT, data);
495*dde5845aSJiri Kosina 			break;
496*dde5845aSJiri Kosina 		case HID_MAIN_ITEM_TAG_OUTPUT:
497*dde5845aSJiri Kosina 			ret = hid_add_field(parser, HID_OUTPUT_REPORT, data);
498*dde5845aSJiri Kosina 			break;
499*dde5845aSJiri Kosina 		case HID_MAIN_ITEM_TAG_FEATURE:
500*dde5845aSJiri Kosina 			ret = hid_add_field(parser, HID_FEATURE_REPORT, data);
501*dde5845aSJiri Kosina 			break;
502*dde5845aSJiri Kosina 		default:
503*dde5845aSJiri Kosina 			dbg("unknown main item tag 0x%x", item->tag);
504*dde5845aSJiri Kosina 			ret = 0;
505*dde5845aSJiri Kosina 	}
506*dde5845aSJiri Kosina 
507*dde5845aSJiri Kosina 	memset(&parser->local, 0, sizeof(parser->local));	/* Reset the local parser environment */
508*dde5845aSJiri Kosina 
509*dde5845aSJiri Kosina 	return ret;
510*dde5845aSJiri Kosina }
511*dde5845aSJiri Kosina 
512*dde5845aSJiri Kosina /*
513*dde5845aSJiri Kosina  * Process a reserved item.
514*dde5845aSJiri Kosina  */
515*dde5845aSJiri Kosina 
516*dde5845aSJiri Kosina static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item)
517*dde5845aSJiri Kosina {
518*dde5845aSJiri Kosina 	dbg("reserved item type, tag 0x%x", item->tag);
519*dde5845aSJiri Kosina 	return 0;
520*dde5845aSJiri Kosina }
521*dde5845aSJiri Kosina 
522*dde5845aSJiri Kosina /*
523*dde5845aSJiri Kosina  * Free a report and all registered fields. The field->usage and
524*dde5845aSJiri Kosina  * field->value table's are allocated behind the field, so we need
525*dde5845aSJiri Kosina  * only to free(field) itself.
526*dde5845aSJiri Kosina  */
527*dde5845aSJiri Kosina 
528*dde5845aSJiri Kosina static void hid_free_report(struct hid_report *report)
529*dde5845aSJiri Kosina {
530*dde5845aSJiri Kosina 	unsigned n;
531*dde5845aSJiri Kosina 
532*dde5845aSJiri Kosina 	for (n = 0; n < report->maxfield; n++)
533*dde5845aSJiri Kosina 		kfree(report->field[n]);
534*dde5845aSJiri Kosina 	kfree(report);
535*dde5845aSJiri Kosina }
536*dde5845aSJiri Kosina 
537*dde5845aSJiri Kosina /*
538*dde5845aSJiri Kosina  * Free a device structure, all reports, and all fields.
539*dde5845aSJiri Kosina  */
540*dde5845aSJiri Kosina 
541*dde5845aSJiri Kosina static void hid_free_device(struct hid_device *device)
542*dde5845aSJiri Kosina {
543*dde5845aSJiri Kosina 	unsigned i,j;
544*dde5845aSJiri Kosina 
545*dde5845aSJiri Kosina 	for (i = 0; i < HID_REPORT_TYPES; i++) {
546*dde5845aSJiri Kosina 		struct hid_report_enum *report_enum = device->report_enum + i;
547*dde5845aSJiri Kosina 
548*dde5845aSJiri Kosina 		for (j = 0; j < 256; j++) {
549*dde5845aSJiri Kosina 			struct hid_report *report = report_enum->report_id_hash[j];
550*dde5845aSJiri Kosina 			if (report)
551*dde5845aSJiri Kosina 				hid_free_report(report);
552*dde5845aSJiri Kosina 		}
553*dde5845aSJiri Kosina 	}
554*dde5845aSJiri Kosina 
555*dde5845aSJiri Kosina 	kfree(device->rdesc);
556*dde5845aSJiri Kosina 	kfree(device);
557*dde5845aSJiri Kosina }
558*dde5845aSJiri Kosina 
559*dde5845aSJiri Kosina /*
560*dde5845aSJiri Kosina  * Fetch a report description item from the data stream. We support long
561*dde5845aSJiri Kosina  * items, though they are not used yet.
562*dde5845aSJiri Kosina  */
563*dde5845aSJiri Kosina 
564*dde5845aSJiri Kosina static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item)
565*dde5845aSJiri Kosina {
566*dde5845aSJiri Kosina 	u8 b;
567*dde5845aSJiri Kosina 
568*dde5845aSJiri Kosina 	if ((end - start) <= 0)
569*dde5845aSJiri Kosina 		return NULL;
570*dde5845aSJiri Kosina 
571*dde5845aSJiri Kosina 	b = *start++;
572*dde5845aSJiri Kosina 
573*dde5845aSJiri Kosina 	item->type = (b >> 2) & 3;
574*dde5845aSJiri Kosina 	item->tag  = (b >> 4) & 15;
575*dde5845aSJiri Kosina 
576*dde5845aSJiri Kosina 	if (item->tag == HID_ITEM_TAG_LONG) {
577*dde5845aSJiri Kosina 
578*dde5845aSJiri Kosina 		item->format = HID_ITEM_FORMAT_LONG;
579*dde5845aSJiri Kosina 
580*dde5845aSJiri Kosina 		if ((end - start) < 2)
581*dde5845aSJiri Kosina 			return NULL;
582*dde5845aSJiri Kosina 
583*dde5845aSJiri Kosina 		item->size = *start++;
584*dde5845aSJiri Kosina 		item->tag  = *start++;
585*dde5845aSJiri Kosina 
586*dde5845aSJiri Kosina 		if ((end - start) < item->size)
587*dde5845aSJiri Kosina 			return NULL;
588*dde5845aSJiri Kosina 
589*dde5845aSJiri Kosina 		item->data.longdata = start;
590*dde5845aSJiri Kosina 		start += item->size;
591*dde5845aSJiri Kosina 		return start;
592*dde5845aSJiri Kosina 	}
593*dde5845aSJiri Kosina 
594*dde5845aSJiri Kosina 	item->format = HID_ITEM_FORMAT_SHORT;
595*dde5845aSJiri Kosina 	item->size = b & 3;
596*dde5845aSJiri Kosina 
597*dde5845aSJiri Kosina 	switch (item->size) {
598*dde5845aSJiri Kosina 
599*dde5845aSJiri Kosina 		case 0:
600*dde5845aSJiri Kosina 			return start;
601*dde5845aSJiri Kosina 
602*dde5845aSJiri Kosina 		case 1:
603*dde5845aSJiri Kosina 			if ((end - start) < 1)
604*dde5845aSJiri Kosina 				return NULL;
605*dde5845aSJiri Kosina 			item->data.u8 = *start++;
606*dde5845aSJiri Kosina 			return start;
607*dde5845aSJiri Kosina 
608*dde5845aSJiri Kosina 		case 2:
609*dde5845aSJiri Kosina 			if ((end - start) < 2)
610*dde5845aSJiri Kosina 				return NULL;
611*dde5845aSJiri Kosina 			item->data.u16 = le16_to_cpu(get_unaligned((__le16*)start));
612*dde5845aSJiri Kosina 			start = (__u8 *)((__le16 *)start + 1);
613*dde5845aSJiri Kosina 			return start;
614*dde5845aSJiri Kosina 
615*dde5845aSJiri Kosina 		case 3:
616*dde5845aSJiri Kosina 			item->size++;
617*dde5845aSJiri Kosina 			if ((end - start) < 4)
618*dde5845aSJiri Kosina 				return NULL;
619*dde5845aSJiri Kosina 			item->data.u32 = le32_to_cpu(get_unaligned((__le32*)start));
620*dde5845aSJiri Kosina 			start = (__u8 *)((__le32 *)start + 1);
621*dde5845aSJiri Kosina 			return start;
622*dde5845aSJiri Kosina 	}
623*dde5845aSJiri Kosina 
624*dde5845aSJiri Kosina 	return NULL;
625*dde5845aSJiri Kosina }
626*dde5845aSJiri Kosina 
627*dde5845aSJiri Kosina /*
628*dde5845aSJiri Kosina  * Parse a report description into a hid_device structure. Reports are
629*dde5845aSJiri Kosina  * enumerated, fields are attached to these reports.
630*dde5845aSJiri Kosina  */
631*dde5845aSJiri Kosina 
632*dde5845aSJiri Kosina static struct hid_device *hid_parse_report(__u8 *start, unsigned size)
633*dde5845aSJiri Kosina {
634*dde5845aSJiri Kosina 	struct hid_device *device;
635*dde5845aSJiri Kosina 	struct hid_parser *parser;
636*dde5845aSJiri Kosina 	struct hid_item item;
637*dde5845aSJiri Kosina 	__u8 *end;
638*dde5845aSJiri Kosina 	unsigned i;
639*dde5845aSJiri Kosina 	static int (*dispatch_type[])(struct hid_parser *parser,
640*dde5845aSJiri Kosina 				      struct hid_item *item) = {
641*dde5845aSJiri Kosina 		hid_parser_main,
642*dde5845aSJiri Kosina 		hid_parser_global,
643*dde5845aSJiri Kosina 		hid_parser_local,
644*dde5845aSJiri Kosina 		hid_parser_reserved
645*dde5845aSJiri Kosina 	};
646*dde5845aSJiri Kosina 
647*dde5845aSJiri Kosina 	if (!(device = kzalloc(sizeof(struct hid_device), GFP_KERNEL)))
648*dde5845aSJiri Kosina 		return NULL;
649*dde5845aSJiri Kosina 
650*dde5845aSJiri Kosina 	if (!(device->collection = kzalloc(sizeof(struct hid_collection) *
651*dde5845aSJiri Kosina 				   HID_DEFAULT_NUM_COLLECTIONS, GFP_KERNEL))) {
652*dde5845aSJiri Kosina 		kfree(device);
653*dde5845aSJiri Kosina 		return NULL;
654*dde5845aSJiri Kosina 	}
655*dde5845aSJiri Kosina 	device->collection_size = HID_DEFAULT_NUM_COLLECTIONS;
656*dde5845aSJiri Kosina 
657*dde5845aSJiri Kosina 	for (i = 0; i < HID_REPORT_TYPES; i++)
658*dde5845aSJiri Kosina 		INIT_LIST_HEAD(&device->report_enum[i].report_list);
659*dde5845aSJiri Kosina 
660*dde5845aSJiri Kosina 	if (!(device->rdesc = (__u8 *)kmalloc(size, GFP_KERNEL))) {
661*dde5845aSJiri Kosina 		kfree(device->collection);
662*dde5845aSJiri Kosina 		kfree(device);
663*dde5845aSJiri Kosina 		return NULL;
664*dde5845aSJiri Kosina 	}
665*dde5845aSJiri Kosina 	memcpy(device->rdesc, start, size);
666*dde5845aSJiri Kosina 	device->rsize = size;
667*dde5845aSJiri Kosina 
668*dde5845aSJiri Kosina 	if (!(parser = kzalloc(sizeof(struct hid_parser), GFP_KERNEL))) {
669*dde5845aSJiri Kosina 		kfree(device->rdesc);
670*dde5845aSJiri Kosina 		kfree(device->collection);
671*dde5845aSJiri Kosina 		kfree(device);
672*dde5845aSJiri Kosina 		return NULL;
673*dde5845aSJiri Kosina 	}
674*dde5845aSJiri Kosina 	parser->device = device;
675*dde5845aSJiri Kosina 
676*dde5845aSJiri Kosina 	end = start + size;
677*dde5845aSJiri Kosina 	while ((start = fetch_item(start, end, &item)) != NULL) {
678*dde5845aSJiri Kosina 
679*dde5845aSJiri Kosina 		if (item.format != HID_ITEM_FORMAT_SHORT) {
680*dde5845aSJiri Kosina 			dbg("unexpected long global item");
681*dde5845aSJiri Kosina 			kfree(device->collection);
682*dde5845aSJiri Kosina 			hid_free_device(device);
683*dde5845aSJiri Kosina 			kfree(parser);
684*dde5845aSJiri Kosina 			return NULL;
685*dde5845aSJiri Kosina 		}
686*dde5845aSJiri Kosina 
687*dde5845aSJiri Kosina 		if (dispatch_type[item.type](parser, &item)) {
688*dde5845aSJiri Kosina 			dbg("item %u %u %u %u parsing failed\n",
689*dde5845aSJiri Kosina 				item.format, (unsigned)item.size, (unsigned)item.type, (unsigned)item.tag);
690*dde5845aSJiri Kosina 			kfree(device->collection);
691*dde5845aSJiri Kosina 			hid_free_device(device);
692*dde5845aSJiri Kosina 			kfree(parser);
693*dde5845aSJiri Kosina 			return NULL;
694*dde5845aSJiri Kosina 		}
695*dde5845aSJiri Kosina 
696*dde5845aSJiri Kosina 		if (start == end) {
697*dde5845aSJiri Kosina 			if (parser->collection_stack_ptr) {
698*dde5845aSJiri Kosina 				dbg("unbalanced collection at end of report description");
699*dde5845aSJiri Kosina 				kfree(device->collection);
700*dde5845aSJiri Kosina 				hid_free_device(device);
701*dde5845aSJiri Kosina 				kfree(parser);
702*dde5845aSJiri Kosina 				return NULL;
703*dde5845aSJiri Kosina 			}
704*dde5845aSJiri Kosina 			if (parser->local.delimiter_depth) {
705*dde5845aSJiri Kosina 				dbg("unbalanced delimiter at end of report description");
706*dde5845aSJiri Kosina 				kfree(device->collection);
707*dde5845aSJiri Kosina 				hid_free_device(device);
708*dde5845aSJiri Kosina 				kfree(parser);
709*dde5845aSJiri Kosina 				return NULL;
710*dde5845aSJiri Kosina 			}
711*dde5845aSJiri Kosina 			kfree(parser);
712*dde5845aSJiri Kosina 			return device;
713*dde5845aSJiri Kosina 		}
714*dde5845aSJiri Kosina 	}
715*dde5845aSJiri Kosina 
716*dde5845aSJiri Kosina 	dbg("item fetching failed at offset %d\n", (int)(end - start));
717*dde5845aSJiri Kosina 	kfree(device->collection);
718*dde5845aSJiri Kosina 	hid_free_device(device);
719*dde5845aSJiri Kosina 	kfree(parser);
720*dde5845aSJiri Kosina 	return NULL;
721*dde5845aSJiri Kosina }
722*dde5845aSJiri Kosina 
723*dde5845aSJiri Kosina /*
724*dde5845aSJiri Kosina  * Convert a signed n-bit integer to signed 32-bit integer. Common
725*dde5845aSJiri Kosina  * cases are done through the compiler, the screwed things has to be
726*dde5845aSJiri Kosina  * done by hand.
727*dde5845aSJiri Kosina  */
728*dde5845aSJiri Kosina 
729*dde5845aSJiri Kosina static s32 snto32(__u32 value, unsigned n)
730*dde5845aSJiri Kosina {
731*dde5845aSJiri Kosina 	switch (n) {
732*dde5845aSJiri Kosina 		case 8:  return ((__s8)value);
733*dde5845aSJiri Kosina 		case 16: return ((__s16)value);
734*dde5845aSJiri Kosina 		case 32: return ((__s32)value);
735*dde5845aSJiri Kosina 	}
736*dde5845aSJiri Kosina 	return value & (1 << (n - 1)) ? value | (-1 << n) : value;
737*dde5845aSJiri Kosina }
738*dde5845aSJiri Kosina 
739*dde5845aSJiri Kosina /*
740*dde5845aSJiri Kosina  * Convert a signed 32-bit integer to a signed n-bit integer.
741*dde5845aSJiri Kosina  */
742*dde5845aSJiri Kosina 
743*dde5845aSJiri Kosina static u32 s32ton(__s32 value, unsigned n)
744*dde5845aSJiri Kosina {
745*dde5845aSJiri Kosina 	s32 a = value >> (n - 1);
746*dde5845aSJiri Kosina 	if (a && a != -1)
747*dde5845aSJiri Kosina 		return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1;
748*dde5845aSJiri Kosina 	return value & ((1 << n) - 1);
749*dde5845aSJiri Kosina }
750*dde5845aSJiri Kosina 
751*dde5845aSJiri Kosina /*
752*dde5845aSJiri Kosina  * Extract/implement a data field from/to a little endian report (bit array).
753*dde5845aSJiri Kosina  *
754*dde5845aSJiri Kosina  * Code sort-of follows HID spec:
755*dde5845aSJiri Kosina  *     http://www.usb.org/developers/devclass_docs/HID1_11.pdf
756*dde5845aSJiri Kosina  *
757*dde5845aSJiri Kosina  * While the USB HID spec allows unlimited length bit fields in "report
758*dde5845aSJiri Kosina  * descriptors", most devices never use more than 16 bits.
759*dde5845aSJiri Kosina  * One model of UPS is claimed to report "LINEV" as a 32-bit field.
760*dde5845aSJiri Kosina  * Search linux-kernel and linux-usb-devel archives for "hid-core extract".
761*dde5845aSJiri Kosina  */
762*dde5845aSJiri Kosina 
763*dde5845aSJiri Kosina static __inline__ __u32 extract(__u8 *report, unsigned offset, unsigned n)
764*dde5845aSJiri Kosina {
765*dde5845aSJiri Kosina 	u64 x;
766*dde5845aSJiri Kosina 
767*dde5845aSJiri Kosina 	WARN_ON(n > 32);
768*dde5845aSJiri Kosina 
769*dde5845aSJiri Kosina 	report += offset >> 3;  /* adjust byte index */
770*dde5845aSJiri Kosina 	offset &= 7;		/* now only need bit offset into one byte */
771*dde5845aSJiri Kosina 	x = get_unaligned((u64 *) report);
772*dde5845aSJiri Kosina 	x = le64_to_cpu(x);
773*dde5845aSJiri Kosina 	x = (x >> offset) & ((1ULL << n) - 1);	/* extract bit field */
774*dde5845aSJiri Kosina 	return (u32) x;
775*dde5845aSJiri Kosina }
776*dde5845aSJiri Kosina 
777*dde5845aSJiri Kosina /*
778*dde5845aSJiri Kosina  * "implement" : set bits in a little endian bit stream.
779*dde5845aSJiri Kosina  * Same concepts as "extract" (see comments above).
780*dde5845aSJiri Kosina  * The data mangled in the bit stream remains in little endian
781*dde5845aSJiri Kosina  * order the whole time. It make more sense to talk about
782*dde5845aSJiri Kosina  * endianness of register values by considering a register
783*dde5845aSJiri Kosina  * a "cached" copy of the little endiad bit stream.
784*dde5845aSJiri Kosina  */
785*dde5845aSJiri Kosina static __inline__ void implement(__u8 *report, unsigned offset, unsigned n, __u32 value)
786*dde5845aSJiri Kosina {
787*dde5845aSJiri Kosina 	u64 x;
788*dde5845aSJiri Kosina 	u64 m = (1ULL << n) - 1;
789*dde5845aSJiri Kosina 
790*dde5845aSJiri Kosina 	WARN_ON(n > 32);
791*dde5845aSJiri Kosina 
792*dde5845aSJiri Kosina 	WARN_ON(value > m);
793*dde5845aSJiri Kosina 	value &= m;
794*dde5845aSJiri Kosina 
795*dde5845aSJiri Kosina 	report += offset >> 3;
796*dde5845aSJiri Kosina 	offset &= 7;
797*dde5845aSJiri Kosina 
798*dde5845aSJiri Kosina 	x = get_unaligned((u64 *)report);
799*dde5845aSJiri Kosina 	x &= cpu_to_le64(~(m << offset));
800*dde5845aSJiri Kosina 	x |= cpu_to_le64(((u64) value) << offset);
801*dde5845aSJiri Kosina 	put_unaligned(x, (u64 *) report);
802*dde5845aSJiri Kosina }
803*dde5845aSJiri Kosina 
804*dde5845aSJiri Kosina /*
805*dde5845aSJiri Kosina  * Search an array for a value.
806*dde5845aSJiri Kosina  */
807*dde5845aSJiri Kosina 
808*dde5845aSJiri Kosina static __inline__ int search(__s32 *array, __s32 value, unsigned n)
809*dde5845aSJiri Kosina {
810*dde5845aSJiri Kosina 	while (n--) {
811*dde5845aSJiri Kosina 		if (*array++ == value)
812*dde5845aSJiri Kosina 			return 0;
813*dde5845aSJiri Kosina 	}
814*dde5845aSJiri Kosina 	return -1;
815*dde5845aSJiri Kosina }
816*dde5845aSJiri Kosina 
817*dde5845aSJiri Kosina static void hid_process_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, int interrupt)
818*dde5845aSJiri Kosina {
819*dde5845aSJiri Kosina 	hid_dump_input(usage, value);
820*dde5845aSJiri Kosina 	if (hid->claimed & HID_CLAIMED_INPUT)
821*dde5845aSJiri Kosina 		hidinput_hid_event(hid, field, usage, value);
822*dde5845aSJiri Kosina 	if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt)
823*dde5845aSJiri Kosina 		hiddev_hid_event(hid, field, usage, value);
824*dde5845aSJiri Kosina }
825*dde5845aSJiri Kosina 
826*dde5845aSJiri Kosina /*
827*dde5845aSJiri Kosina  * Analyse a received field, and fetch the data from it. The field
828*dde5845aSJiri Kosina  * content is stored for next report processing (we do differential
829*dde5845aSJiri Kosina  * reporting to the layer).
830*dde5845aSJiri Kosina  */
831*dde5845aSJiri Kosina 
832*dde5845aSJiri Kosina static void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt)
833*dde5845aSJiri Kosina {
834*dde5845aSJiri Kosina 	unsigned n;
835*dde5845aSJiri Kosina 	unsigned count = field->report_count;
836*dde5845aSJiri Kosina 	unsigned offset = field->report_offset;
837*dde5845aSJiri Kosina 	unsigned size = field->report_size;
838*dde5845aSJiri Kosina 	__s32 min = field->logical_minimum;
839*dde5845aSJiri Kosina 	__s32 max = field->logical_maximum;
840*dde5845aSJiri Kosina 	__s32 *value;
841*dde5845aSJiri Kosina 
842*dde5845aSJiri Kosina 	if (!(value = kmalloc(sizeof(__s32) * count, GFP_ATOMIC)))
843*dde5845aSJiri Kosina 		return;
844*dde5845aSJiri Kosina 
845*dde5845aSJiri Kosina 	for (n = 0; n < count; n++) {
846*dde5845aSJiri Kosina 
847*dde5845aSJiri Kosina 			value[n] = min < 0 ? snto32(extract(data, offset + n * size, size), size) :
848*dde5845aSJiri Kosina 						    extract(data, offset + n * size, size);
849*dde5845aSJiri Kosina 
850*dde5845aSJiri Kosina 			if (!(field->flags & HID_MAIN_ITEM_VARIABLE) /* Ignore report if ErrorRollOver */
851*dde5845aSJiri Kosina 			    && value[n] >= min && value[n] <= max
852*dde5845aSJiri Kosina 			    && field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1)
853*dde5845aSJiri Kosina 				goto exit;
854*dde5845aSJiri Kosina 	}
855*dde5845aSJiri Kosina 
856*dde5845aSJiri Kosina 	for (n = 0; n < count; n++) {
857*dde5845aSJiri Kosina 
858*dde5845aSJiri Kosina 		if (HID_MAIN_ITEM_VARIABLE & field->flags) {
859*dde5845aSJiri Kosina 			hid_process_event(hid, field, &field->usage[n], value[n], interrupt);
860*dde5845aSJiri Kosina 			continue;
861*dde5845aSJiri Kosina 		}
862*dde5845aSJiri Kosina 
863*dde5845aSJiri Kosina 		if (field->value[n] >= min && field->value[n] <= max
864*dde5845aSJiri Kosina 			&& field->usage[field->value[n] - min].hid
865*dde5845aSJiri Kosina 			&& search(value, field->value[n], count))
866*dde5845aSJiri Kosina 				hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt);
867*dde5845aSJiri Kosina 
868*dde5845aSJiri Kosina 		if (value[n] >= min && value[n] <= max
869*dde5845aSJiri Kosina 			&& field->usage[value[n] - min].hid
870*dde5845aSJiri Kosina 			&& search(field->value, value[n], count))
871*dde5845aSJiri Kosina 				hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt);
872*dde5845aSJiri Kosina 	}
873*dde5845aSJiri Kosina 
874*dde5845aSJiri Kosina 	memcpy(field->value, value, count * sizeof(__s32));
875*dde5845aSJiri Kosina exit:
876*dde5845aSJiri Kosina 	kfree(value);
877*dde5845aSJiri Kosina }
878*dde5845aSJiri Kosina 
879*dde5845aSJiri Kosina 
880*dde5845aSJiri Kosina /*
881*dde5845aSJiri Kosina  * Output the field into the report.
882*dde5845aSJiri Kosina  */
883*dde5845aSJiri Kosina 
884*dde5845aSJiri Kosina static void hid_output_field(struct hid_field *field, __u8 *data)
885*dde5845aSJiri Kosina {
886*dde5845aSJiri Kosina 	unsigned count = field->report_count;
887*dde5845aSJiri Kosina 	unsigned offset = field->report_offset;
888*dde5845aSJiri Kosina 	unsigned size = field->report_size;
889*dde5845aSJiri Kosina 	unsigned n;
890*dde5845aSJiri Kosina 
891*dde5845aSJiri Kosina 	for (n = 0; n < count; n++) {
892*dde5845aSJiri Kosina 		if (field->logical_minimum < 0)	/* signed values */
893*dde5845aSJiri Kosina 			implement(data, offset + n * size, size, s32ton(field->value[n], size));
894*dde5845aSJiri Kosina 		else				/* unsigned values */
895*dde5845aSJiri Kosina 			implement(data, offset + n * size, size, field->value[n]);
896*dde5845aSJiri Kosina 	}
897*dde5845aSJiri Kosina }
898*dde5845aSJiri Kosina 
899*dde5845aSJiri Kosina /*
900*dde5845aSJiri Kosina  * Create a report.
901*dde5845aSJiri Kosina  */
902*dde5845aSJiri Kosina 
903*dde5845aSJiri Kosina static void hid_output_report(struct hid_report *report, __u8 *data)
904*dde5845aSJiri Kosina {
905*dde5845aSJiri Kosina 	unsigned n;
906*dde5845aSJiri Kosina 
907*dde5845aSJiri Kosina 	if (report->id > 0)
908*dde5845aSJiri Kosina 		*data++ = report->id;
909*dde5845aSJiri Kosina 
910*dde5845aSJiri Kosina 	for (n = 0; n < report->maxfield; n++)
911*dde5845aSJiri Kosina 		hid_output_field(report->field[n], data);
912*dde5845aSJiri Kosina }
913*dde5845aSJiri Kosina 
914*dde5845aSJiri Kosina /*
915*dde5845aSJiri Kosina  * Set a field value. The report this field belongs to has to be
916*dde5845aSJiri Kosina  * created and transferred to the device, to set this value in the
917*dde5845aSJiri Kosina  * device.
918*dde5845aSJiri Kosina  */
919*dde5845aSJiri Kosina 
920*dde5845aSJiri Kosina int hid_set_field(struct hid_field *field, unsigned offset, __s32 value)
921*dde5845aSJiri Kosina {
922*dde5845aSJiri Kosina 	unsigned size = field->report_size;
923*dde5845aSJiri Kosina 
924*dde5845aSJiri Kosina 	hid_dump_input(field->usage + offset, value);
925*dde5845aSJiri Kosina 
926*dde5845aSJiri Kosina 	if (offset >= field->report_count) {
927*dde5845aSJiri Kosina 		dbg("offset (%d) exceeds report_count (%d)", offset, field->report_count);
928*dde5845aSJiri Kosina 		hid_dump_field(field, 8);
929*dde5845aSJiri Kosina 		return -1;
930*dde5845aSJiri Kosina 	}
931*dde5845aSJiri Kosina 	if (field->logical_minimum < 0) {
932*dde5845aSJiri Kosina 		if (value != snto32(s32ton(value, size), size)) {
933*dde5845aSJiri Kosina 			dbg("value %d is out of range", value);
934*dde5845aSJiri Kosina 			return -1;
935*dde5845aSJiri Kosina 		}
936*dde5845aSJiri Kosina 	}
937*dde5845aSJiri Kosina 	field->value[offset] = value;
938*dde5845aSJiri Kosina 	return 0;
939*dde5845aSJiri Kosina }
940*dde5845aSJiri Kosina 
941