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