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 76b1968d5SJiri Kosina * Copyright (c) 2006-2012 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 174291ee30SJoe Perches #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 184291ee30SJoe Perches 19dde5845aSJiri Kosina #include <linux/module.h> 20dde5845aSJiri Kosina #include <linux/slab.h> 21dde5845aSJiri Kosina #include <linux/init.h> 22dde5845aSJiri Kosina #include <linux/kernel.h> 23dde5845aSJiri Kosina #include <linux/list.h> 24dde5845aSJiri Kosina #include <linux/mm.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> 3047a80edbSJiri Kosina #include <linux/vmalloc.h> 31c4124c9bSJiri Kosina #include <linux/sched.h> 324ea54542SDavid Herrmann #include <linux/semaphore.h> 334ceabaf7SHans de Goede #include <linux/async.h> 34dde5845aSJiri Kosina 35dde5845aSJiri Kosina #include <linux/hid.h> 36dde5845aSJiri Kosina #include <linux/hiddev.h> 37c080d89aSJiri Kosina #include <linux/hid-debug.h> 3886166b7bSJiri Kosina #include <linux/hidraw.h> 39dde5845aSJiri Kosina 405f22a799SJiri Slaby #include "hid-ids.h" 415f22a799SJiri Slaby 42dde5845aSJiri Kosina /* 43dde5845aSJiri Kosina * Version Information 44dde5845aSJiri Kosina */ 45dde5845aSJiri Kosina 4653149801SJiri Kosina #define DRIVER_DESC "HID core driver" 47dde5845aSJiri Kosina 4858037eb9SJiri Kosina int hid_debug = 0; 49377e10fbSAnssi Hannula module_param_named(debug, hid_debug, int, 0600); 50cd667ce2SJiri Kosina MODULE_PARM_DESC(debug, "toggle HID debugging messages"); 5158037eb9SJiri Kosina EXPORT_SYMBOL_GPL(hid_debug); 5258037eb9SJiri Kosina 536b1968d5SJiri Kosina static int hid_ignore_special_drivers = 0; 546b1968d5SJiri Kosina module_param_named(ignore_special_drivers, hid_ignore_special_drivers, int, 0600); 55643727a9SHans Petter Selasky MODULE_PARM_DESC(ignore_special_drivers, "Ignore any special drivers and handle all devices by generic driver"); 566b1968d5SJiri Kosina 57dde5845aSJiri Kosina /* 58dde5845aSJiri Kosina * Register a new report for a device. 59dde5845aSJiri Kosina */ 60dde5845aSJiri Kosina 61f07b3c1dSBenjamin Tissoires struct hid_report *hid_register_report(struct hid_device *device, 62f07b3c1dSBenjamin Tissoires unsigned int type, unsigned int id, 63f07b3c1dSBenjamin Tissoires unsigned int application) 64dde5845aSJiri Kosina { 65dde5845aSJiri Kosina struct hid_report_enum *report_enum = device->report_enum + type; 66dde5845aSJiri Kosina struct hid_report *report; 67dde5845aSJiri Kosina 6843622021SKees Cook if (id >= HID_MAX_IDS) 6943622021SKees Cook return NULL; 70dde5845aSJiri Kosina if (report_enum->report_id_hash[id]) 71dde5845aSJiri Kosina return report_enum->report_id_hash[id]; 72dde5845aSJiri Kosina 73a3789a17SJoe Perches report = kzalloc(sizeof(struct hid_report), GFP_KERNEL); 74a3789a17SJoe Perches if (!report) 75dde5845aSJiri Kosina return NULL; 76dde5845aSJiri Kosina 77dde5845aSJiri Kosina if (id != 0) 78dde5845aSJiri Kosina report_enum->numbered = 1; 79dde5845aSJiri Kosina 80dde5845aSJiri Kosina report->id = id; 81dde5845aSJiri Kosina report->type = type; 82dde5845aSJiri Kosina report->size = 0; 83dde5845aSJiri Kosina report->device = device; 84f07b3c1dSBenjamin Tissoires report->application = application; 85dde5845aSJiri Kosina report_enum->report_id_hash[id] = report; 86dde5845aSJiri Kosina 87dde5845aSJiri Kosina list_add_tail(&report->list, &report_enum->report_list); 88dde5845aSJiri Kosina 89dde5845aSJiri Kosina return report; 90dde5845aSJiri Kosina } 9190a006abSMichael Poole EXPORT_SYMBOL_GPL(hid_register_report); 92dde5845aSJiri Kosina 93dde5845aSJiri Kosina /* 94dde5845aSJiri Kosina * Register a new field for this report. 95dde5845aSJiri Kosina */ 96dde5845aSJiri Kosina 97dde5845aSJiri Kosina static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values) 98dde5845aSJiri Kosina { 99dde5845aSJiri Kosina struct hid_field *field; 100dde5845aSJiri Kosina 101dde5845aSJiri Kosina if (report->maxfield == HID_MAX_FIELDS) { 1028c3d52fcSJiri Kosina hid_err(report->device, "too many fields in report\n"); 103dde5845aSJiri Kosina return NULL; 104dde5845aSJiri Kosina } 105dde5845aSJiri Kosina 106a3789a17SJoe Perches field = kzalloc((sizeof(struct hid_field) + 107a3789a17SJoe Perches usages * sizeof(struct hid_usage) + 108a3789a17SJoe Perches values * sizeof(unsigned)), GFP_KERNEL); 109a3789a17SJoe Perches if (!field) 110a3789a17SJoe Perches return NULL; 111dde5845aSJiri Kosina 112dde5845aSJiri Kosina field->index = report->maxfield++; 113dde5845aSJiri Kosina report->field[field->index] = field; 114dde5845aSJiri Kosina field->usage = (struct hid_usage *)(field + 1); 115282bfd4cSJiri Slaby field->value = (s32 *)(field->usage + usages); 116dde5845aSJiri Kosina field->report = report; 117dde5845aSJiri Kosina 118dde5845aSJiri Kosina return field; 119dde5845aSJiri Kosina } 120dde5845aSJiri Kosina 121dde5845aSJiri Kosina /* 122dde5845aSJiri Kosina * Open a collection. The type/usage is pushed on the stack. 123dde5845aSJiri Kosina */ 124dde5845aSJiri Kosina 125dde5845aSJiri Kosina static int open_collection(struct hid_parser *parser, unsigned type) 126dde5845aSJiri Kosina { 127dde5845aSJiri Kosina struct hid_collection *collection; 128dde5845aSJiri Kosina unsigned usage; 129ee46967fSPeter Hutterer int collection_index; 130dde5845aSJiri Kosina 131dde5845aSJiri Kosina usage = parser->local.usage[0]; 132dde5845aSJiri Kosina 13308a8a7cfSBenjamin Tissoires if (parser->collection_stack_ptr == parser->collection_stack_size) { 13408a8a7cfSBenjamin Tissoires unsigned int *collection_stack; 13508a8a7cfSBenjamin Tissoires unsigned int new_size = parser->collection_stack_size + 13608a8a7cfSBenjamin Tissoires HID_COLLECTION_STACK_SIZE; 13708a8a7cfSBenjamin Tissoires 13808a8a7cfSBenjamin Tissoires collection_stack = krealloc(parser->collection_stack, 13908a8a7cfSBenjamin Tissoires new_size * sizeof(unsigned int), 14008a8a7cfSBenjamin Tissoires GFP_KERNEL); 14108a8a7cfSBenjamin Tissoires if (!collection_stack) 14208a8a7cfSBenjamin Tissoires return -ENOMEM; 14308a8a7cfSBenjamin Tissoires 14408a8a7cfSBenjamin Tissoires parser->collection_stack = collection_stack; 14508a8a7cfSBenjamin Tissoires parser->collection_stack_size = new_size; 146dde5845aSJiri Kosina } 147dde5845aSJiri Kosina 148dde5845aSJiri Kosina if (parser->device->maxcollection == parser->device->collection_size) { 1496da2ec56SKees Cook collection = kmalloc( 1506da2ec56SKees Cook array3_size(sizeof(struct hid_collection), 1516da2ec56SKees Cook parser->device->collection_size, 1526da2ec56SKees Cook 2), 1536da2ec56SKees Cook GFP_KERNEL); 154dde5845aSJiri Kosina if (collection == NULL) { 1558c3d52fcSJiri Kosina hid_err(parser->device, "failed to reallocate collection array\n"); 156a6fbaacfSSachin Kamat return -ENOMEM; 157dde5845aSJiri Kosina } 158dde5845aSJiri Kosina memcpy(collection, parser->device->collection, 159dde5845aSJiri Kosina sizeof(struct hid_collection) * 160dde5845aSJiri Kosina parser->device->collection_size); 161dde5845aSJiri Kosina memset(collection + parser->device->collection_size, 0, 162dde5845aSJiri Kosina sizeof(struct hid_collection) * 163dde5845aSJiri Kosina parser->device->collection_size); 164dde5845aSJiri Kosina kfree(parser->device->collection); 165dde5845aSJiri Kosina parser->device->collection = collection; 166dde5845aSJiri Kosina parser->device->collection_size *= 2; 167dde5845aSJiri Kosina } 168dde5845aSJiri Kosina 169dde5845aSJiri Kosina parser->collection_stack[parser->collection_stack_ptr++] = 170dde5845aSJiri Kosina parser->device->maxcollection; 171dde5845aSJiri Kosina 172ee46967fSPeter Hutterer collection_index = parser->device->maxcollection++; 173ee46967fSPeter Hutterer collection = parser->device->collection + collection_index; 174dde5845aSJiri Kosina collection->type = type; 175dde5845aSJiri Kosina collection->usage = usage; 176dde5845aSJiri Kosina collection->level = parser->collection_stack_ptr - 1; 1771950f462SPhilipp Zabel collection->parent_idx = (collection->level == 0) ? -1 : 1781950f462SPhilipp Zabel parser->collection_stack[collection->level - 1]; 179dde5845aSJiri Kosina 180dde5845aSJiri Kosina if (type == HID_COLLECTION_APPLICATION) 181dde5845aSJiri Kosina parser->device->maxapplication++; 182dde5845aSJiri Kosina 183dde5845aSJiri Kosina return 0; 184dde5845aSJiri Kosina } 185dde5845aSJiri Kosina 186dde5845aSJiri Kosina /* 187dde5845aSJiri Kosina * Close a collection. 188dde5845aSJiri Kosina */ 189dde5845aSJiri Kosina 190dde5845aSJiri Kosina static int close_collection(struct hid_parser *parser) 191dde5845aSJiri Kosina { 192dde5845aSJiri Kosina if (!parser->collection_stack_ptr) { 1938c3d52fcSJiri Kosina hid_err(parser->device, "collection stack underflow\n"); 194a6fbaacfSSachin Kamat return -EINVAL; 195dde5845aSJiri Kosina } 196dde5845aSJiri Kosina parser->collection_stack_ptr--; 197dde5845aSJiri Kosina return 0; 198dde5845aSJiri Kosina } 199dde5845aSJiri Kosina 200dde5845aSJiri Kosina /* 201dde5845aSJiri Kosina * Climb up the stack, search for the specified collection type 202dde5845aSJiri Kosina * and return the usage. 203dde5845aSJiri Kosina */ 204dde5845aSJiri Kosina 205dde5845aSJiri Kosina static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type) 206dde5845aSJiri Kosina { 207504499f2SJoe Perches struct hid_collection *collection = parser->device->collection; 208dde5845aSJiri Kosina int n; 209504499f2SJoe Perches 210504499f2SJoe Perches for (n = parser->collection_stack_ptr - 1; n >= 0; n--) { 211504499f2SJoe Perches unsigned index = parser->collection_stack[n]; 212504499f2SJoe Perches if (collection[index].type == type) 213504499f2SJoe Perches return collection[index].usage; 214504499f2SJoe Perches } 215dde5845aSJiri Kosina return 0; /* we know nothing about this usage type */ 216dde5845aSJiri Kosina } 217dde5845aSJiri Kosina 218dde5845aSJiri Kosina /* 219dde5845aSJiri Kosina * Add a usage to the temporary parser table. 220dde5845aSJiri Kosina */ 221dde5845aSJiri Kosina 22258e75155SNicolas Saenz Julienne static int hid_add_usage(struct hid_parser *parser, unsigned usage, u8 size) 223dde5845aSJiri Kosina { 224dde5845aSJiri Kosina if (parser->local.usage_index >= HID_MAX_USAGES) { 2258c3d52fcSJiri Kosina hid_err(parser->device, "usage index exceeded\n"); 226dde5845aSJiri Kosina return -1; 227dde5845aSJiri Kosina } 228dde5845aSJiri Kosina parser->local.usage[parser->local.usage_index] = usage; 22958e75155SNicolas Saenz Julienne parser->local.usage_size[parser->local.usage_index] = size; 230dde5845aSJiri Kosina parser->local.collection_index[parser->local.usage_index] = 231dde5845aSJiri Kosina parser->collection_stack_ptr ? 232dde5845aSJiri Kosina parser->collection_stack[parser->collection_stack_ptr - 1] : 0; 233dde5845aSJiri Kosina parser->local.usage_index++; 234dde5845aSJiri Kosina return 0; 235dde5845aSJiri Kosina } 236dde5845aSJiri Kosina 237dde5845aSJiri Kosina /* 238dde5845aSJiri Kosina * Register a new field for this report. 239dde5845aSJiri Kosina */ 240dde5845aSJiri Kosina 241dde5845aSJiri Kosina static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags) 242dde5845aSJiri Kosina { 243dde5845aSJiri Kosina struct hid_report *report; 244dde5845aSJiri Kosina struct hid_field *field; 245f07b3c1dSBenjamin Tissoires unsigned int usages; 246f07b3c1dSBenjamin Tissoires unsigned int offset; 247f07b3c1dSBenjamin Tissoires unsigned int i; 248f07b3c1dSBenjamin Tissoires unsigned int application; 249dde5845aSJiri Kosina 250f07b3c1dSBenjamin Tissoires application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION); 251f07b3c1dSBenjamin Tissoires 252f07b3c1dSBenjamin Tissoires report = hid_register_report(parser->device, report_type, 253f07b3c1dSBenjamin Tissoires parser->global.report_id, application); 254a3789a17SJoe Perches if (!report) { 2558c3d52fcSJiri Kosina hid_err(parser->device, "hid_register_report failed\n"); 256dde5845aSJiri Kosina return -1; 257dde5845aSJiri Kosina } 258dde5845aSJiri Kosina 259bb2e1976SJiri Kosina /* Handle both signed and unsigned cases properly */ 2600cd516c2Ssrinivas pandruvada if ((parser->global.logical_minimum < 0 && 2610cd516c2Ssrinivas pandruvada parser->global.logical_maximum < 2620cd516c2Ssrinivas pandruvada parser->global.logical_minimum) || 2630cd516c2Ssrinivas pandruvada (parser->global.logical_minimum >= 0 && 2640cd516c2Ssrinivas pandruvada (__u32)parser->global.logical_maximum < 2650cd516c2Ssrinivas pandruvada (__u32)parser->global.logical_minimum)) { 2660cd516c2Ssrinivas pandruvada dbg_hid("logical range invalid 0x%x 0x%x\n", 2670cd516c2Ssrinivas pandruvada parser->global.logical_minimum, 2680cd516c2Ssrinivas pandruvada parser->global.logical_maximum); 269dde5845aSJiri Kosina return -1; 270dde5845aSJiri Kosina } 271dde5845aSJiri Kosina 272dde5845aSJiri Kosina offset = report->size; 273dde5845aSJiri Kosina report->size += parser->global.report_size * parser->global.report_count; 274dde5845aSJiri Kosina 275dde5845aSJiri Kosina if (!parser->local.usage_index) /* Ignore padding fields */ 276dde5845aSJiri Kosina return 0; 277dde5845aSJiri Kosina 278cc6b54aaSBenjamin Tissoires usages = max_t(unsigned, parser->local.usage_index, 279cc6b54aaSBenjamin Tissoires parser->global.report_count); 280dde5845aSJiri Kosina 281a3789a17SJoe Perches field = hid_register_field(report, usages, parser->global.report_count); 282a3789a17SJoe Perches if (!field) 283dde5845aSJiri Kosina return 0; 284dde5845aSJiri Kosina 285dde5845aSJiri Kosina field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL); 286dde5845aSJiri Kosina field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL); 287f07b3c1dSBenjamin Tissoires field->application = application; 288dde5845aSJiri Kosina 289dde5845aSJiri Kosina for (i = 0; i < usages; i++) { 290cc6b54aaSBenjamin Tissoires unsigned j = i; 291dde5845aSJiri Kosina /* Duplicate the last usage we parsed if we have excess values */ 292dde5845aSJiri Kosina if (i >= parser->local.usage_index) 293dde5845aSJiri Kosina j = parser->local.usage_index - 1; 294dde5845aSJiri Kosina field->usage[i].hid = parser->local.usage[j]; 295dde5845aSJiri Kosina field->usage[i].collection_index = 296dde5845aSJiri Kosina parser->local.collection_index[j]; 297cc6b54aaSBenjamin Tissoires field->usage[i].usage_index = i; 2985a4abb36SPeter Hutterer field->usage[i].resolution_multiplier = 1; 299dde5845aSJiri Kosina } 300dde5845aSJiri Kosina 301dde5845aSJiri Kosina field->maxusage = usages; 302dde5845aSJiri Kosina field->flags = flags; 303dde5845aSJiri Kosina field->report_offset = offset; 304dde5845aSJiri Kosina field->report_type = report_type; 305dde5845aSJiri Kosina field->report_size = parser->global.report_size; 306dde5845aSJiri Kosina field->report_count = parser->global.report_count; 307dde5845aSJiri Kosina field->logical_minimum = parser->global.logical_minimum; 308dde5845aSJiri Kosina field->logical_maximum = parser->global.logical_maximum; 309dde5845aSJiri Kosina field->physical_minimum = parser->global.physical_minimum; 310dde5845aSJiri Kosina field->physical_maximum = parser->global.physical_maximum; 311dde5845aSJiri Kosina field->unit_exponent = parser->global.unit_exponent; 312dde5845aSJiri Kosina field->unit = parser->global.unit; 313dde5845aSJiri Kosina 314dde5845aSJiri Kosina return 0; 315dde5845aSJiri Kosina } 316dde5845aSJiri Kosina 317dde5845aSJiri Kosina /* 318dde5845aSJiri Kosina * Read data value from item. 319dde5845aSJiri Kosina */ 320dde5845aSJiri Kosina 321dde5845aSJiri Kosina static u32 item_udata(struct hid_item *item) 322dde5845aSJiri Kosina { 323dde5845aSJiri Kosina switch (item->size) { 324dde5845aSJiri Kosina case 1: return item->data.u8; 325dde5845aSJiri Kosina case 2: return item->data.u16; 326dde5845aSJiri Kosina case 4: return item->data.u32; 327dde5845aSJiri Kosina } 328dde5845aSJiri Kosina return 0; 329dde5845aSJiri Kosina } 330dde5845aSJiri Kosina 331dde5845aSJiri Kosina static s32 item_sdata(struct hid_item *item) 332dde5845aSJiri Kosina { 333dde5845aSJiri Kosina switch (item->size) { 334dde5845aSJiri Kosina case 1: return item->data.s8; 335dde5845aSJiri Kosina case 2: return item->data.s16; 336dde5845aSJiri Kosina case 4: return item->data.s32; 337dde5845aSJiri Kosina } 338dde5845aSJiri Kosina return 0; 339dde5845aSJiri Kosina } 340dde5845aSJiri Kosina 341dde5845aSJiri Kosina /* 342dde5845aSJiri Kosina * Process a global item. 343dde5845aSJiri Kosina */ 344dde5845aSJiri Kosina 345dde5845aSJiri Kosina static int hid_parser_global(struct hid_parser *parser, struct hid_item *item) 346dde5845aSJiri Kosina { 347ad0e669bSNikolai Kondrashov __s32 raw_value; 348dde5845aSJiri Kosina switch (item->tag) { 349dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_PUSH: 350dde5845aSJiri Kosina 351dde5845aSJiri Kosina if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) { 3528c3d52fcSJiri Kosina hid_err(parser->device, "global environment stack overflow\n"); 353dde5845aSJiri Kosina return -1; 354dde5845aSJiri Kosina } 355dde5845aSJiri Kosina 356dde5845aSJiri Kosina memcpy(parser->global_stack + parser->global_stack_ptr++, 357dde5845aSJiri Kosina &parser->global, sizeof(struct hid_global)); 358dde5845aSJiri Kosina return 0; 359dde5845aSJiri Kosina 360dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_POP: 361dde5845aSJiri Kosina 362dde5845aSJiri Kosina if (!parser->global_stack_ptr) { 3638c3d52fcSJiri Kosina hid_err(parser->device, "global environment stack underflow\n"); 364dde5845aSJiri Kosina return -1; 365dde5845aSJiri Kosina } 366dde5845aSJiri Kosina 367880d29f1SJiri Slaby memcpy(&parser->global, parser->global_stack + 368880d29f1SJiri Slaby --parser->global_stack_ptr, sizeof(struct hid_global)); 369dde5845aSJiri Kosina return 0; 370dde5845aSJiri Kosina 371dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_USAGE_PAGE: 372dde5845aSJiri Kosina parser->global.usage_page = item_udata(item); 373dde5845aSJiri Kosina return 0; 374dde5845aSJiri Kosina 375dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM: 376dde5845aSJiri Kosina parser->global.logical_minimum = item_sdata(item); 377dde5845aSJiri Kosina return 0; 378dde5845aSJiri Kosina 379dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM: 380dde5845aSJiri Kosina if (parser->global.logical_minimum < 0) 381dde5845aSJiri Kosina parser->global.logical_maximum = item_sdata(item); 382dde5845aSJiri Kosina else 383dde5845aSJiri Kosina parser->global.logical_maximum = item_udata(item); 384dde5845aSJiri Kosina return 0; 385dde5845aSJiri Kosina 386dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM: 387dde5845aSJiri Kosina parser->global.physical_minimum = item_sdata(item); 388dde5845aSJiri Kosina return 0; 389dde5845aSJiri Kosina 390dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM: 391dde5845aSJiri Kosina if (parser->global.physical_minimum < 0) 392dde5845aSJiri Kosina parser->global.physical_maximum = item_sdata(item); 393dde5845aSJiri Kosina else 394dde5845aSJiri Kosina parser->global.physical_maximum = item_udata(item); 395dde5845aSJiri Kosina return 0; 396dde5845aSJiri Kosina 397dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT: 398ad0e669bSNikolai Kondrashov /* Many devices provide unit exponent as a two's complement 399ad0e669bSNikolai Kondrashov * nibble due to the common misunderstanding of HID 400ad0e669bSNikolai Kondrashov * specification 1.11, 6.2.2.7 Global Items. Attempt to handle 401ad0e669bSNikolai Kondrashov * both this and the standard encoding. */ 402ad0e669bSNikolai Kondrashov raw_value = item_sdata(item); 40377463838SBenjamin Tissoires if (!(raw_value & 0xfffffff0)) 40477463838SBenjamin Tissoires parser->global.unit_exponent = hid_snto32(raw_value, 4); 40577463838SBenjamin Tissoires else 40677463838SBenjamin Tissoires parser->global.unit_exponent = raw_value; 407dde5845aSJiri Kosina return 0; 408dde5845aSJiri Kosina 409dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_UNIT: 410dde5845aSJiri Kosina parser->global.unit = item_udata(item); 411dde5845aSJiri Kosina return 0; 412dde5845aSJiri Kosina 413dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_REPORT_SIZE: 414880d29f1SJiri Slaby parser->global.report_size = item_udata(item); 41571f6fa90SSong, Hongyan if (parser->global.report_size > 256) { 4168c3d52fcSJiri Kosina hid_err(parser->device, "invalid report_size %d\n", 417880d29f1SJiri Slaby parser->global.report_size); 418dde5845aSJiri Kosina return -1; 419dde5845aSJiri Kosina } 420dde5845aSJiri Kosina return 0; 421dde5845aSJiri Kosina 422dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_REPORT_COUNT: 423880d29f1SJiri Slaby parser->global.report_count = item_udata(item); 424880d29f1SJiri Slaby if (parser->global.report_count > HID_MAX_USAGES) { 4258c3d52fcSJiri Kosina hid_err(parser->device, "invalid report_count %d\n", 426880d29f1SJiri Slaby parser->global.report_count); 427dde5845aSJiri Kosina return -1; 428dde5845aSJiri Kosina } 429dde5845aSJiri Kosina return 0; 430dde5845aSJiri Kosina 431dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_REPORT_ID: 432880d29f1SJiri Slaby parser->global.report_id = item_udata(item); 43343622021SKees Cook if (parser->global.report_id == 0 || 43443622021SKees Cook parser->global.report_id >= HID_MAX_IDS) { 43543622021SKees Cook hid_err(parser->device, "report_id %u is invalid\n", 43643622021SKees Cook parser->global.report_id); 437dde5845aSJiri Kosina return -1; 438dde5845aSJiri Kosina } 439dde5845aSJiri Kosina return 0; 440dde5845aSJiri Kosina 441dde5845aSJiri Kosina default: 4428c3d52fcSJiri Kosina hid_err(parser->device, "unknown global tag 0x%x\n", item->tag); 443dde5845aSJiri Kosina return -1; 444dde5845aSJiri Kosina } 445dde5845aSJiri Kosina } 446dde5845aSJiri Kosina 447dde5845aSJiri Kosina /* 448dde5845aSJiri Kosina * Process a local item. 449dde5845aSJiri Kosina */ 450dde5845aSJiri Kosina 451dde5845aSJiri Kosina static int hid_parser_local(struct hid_parser *parser, struct hid_item *item) 452dde5845aSJiri Kosina { 453dde5845aSJiri Kosina __u32 data; 454dde5845aSJiri Kosina unsigned n; 455ba532198SBenjamin Tissoires __u32 count; 456dde5845aSJiri Kosina 457dde5845aSJiri Kosina data = item_udata(item); 458dde5845aSJiri Kosina 459dde5845aSJiri Kosina switch (item->tag) { 460dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_DELIMITER: 461dde5845aSJiri Kosina 462dde5845aSJiri Kosina if (data) { 463dde5845aSJiri Kosina /* 464dde5845aSJiri Kosina * We treat items before the first delimiter 465dde5845aSJiri Kosina * as global to all usage sets (branch 0). 466dde5845aSJiri Kosina * In the moment we process only these global 467dde5845aSJiri Kosina * items and the first delimiter set. 468dde5845aSJiri Kosina */ 469dde5845aSJiri Kosina if (parser->local.delimiter_depth != 0) { 4708c3d52fcSJiri Kosina hid_err(parser->device, "nested delimiters\n"); 471dde5845aSJiri Kosina return -1; 472dde5845aSJiri Kosina } 473dde5845aSJiri Kosina parser->local.delimiter_depth++; 474dde5845aSJiri Kosina parser->local.delimiter_branch++; 475dde5845aSJiri Kosina } else { 476dde5845aSJiri Kosina if (parser->local.delimiter_depth < 1) { 4778c3d52fcSJiri Kosina hid_err(parser->device, "bogus close delimiter\n"); 478dde5845aSJiri Kosina return -1; 479dde5845aSJiri Kosina } 480dde5845aSJiri Kosina parser->local.delimiter_depth--; 481dde5845aSJiri Kosina } 48238ead6efSPaul Chavent return 0; 483dde5845aSJiri Kosina 484dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_USAGE: 485dde5845aSJiri Kosina 486dde5845aSJiri Kosina if (parser->local.delimiter_branch > 1) { 48758037eb9SJiri Kosina dbg_hid("alternative usage ignored\n"); 488dde5845aSJiri Kosina return 0; 489dde5845aSJiri Kosina } 490dde5845aSJiri Kosina 49158e75155SNicolas Saenz Julienne return hid_add_usage(parser, data, item->size); 492dde5845aSJiri Kosina 493dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM: 494dde5845aSJiri Kosina 495dde5845aSJiri Kosina if (parser->local.delimiter_branch > 1) { 49658037eb9SJiri Kosina dbg_hid("alternative usage ignored\n"); 497dde5845aSJiri Kosina return 0; 498dde5845aSJiri Kosina } 499dde5845aSJiri Kosina 500dde5845aSJiri Kosina parser->local.usage_minimum = data; 501dde5845aSJiri Kosina return 0; 502dde5845aSJiri Kosina 503dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM: 504dde5845aSJiri Kosina 505dde5845aSJiri Kosina if (parser->local.delimiter_branch > 1) { 50658037eb9SJiri Kosina dbg_hid("alternative usage ignored\n"); 507dde5845aSJiri Kosina return 0; 508dde5845aSJiri Kosina } 509dde5845aSJiri Kosina 510ba532198SBenjamin Tissoires count = data - parser->local.usage_minimum; 511ba532198SBenjamin Tissoires if (count + parser->local.usage_index >= HID_MAX_USAGES) { 512ba532198SBenjamin Tissoires /* 513ba532198SBenjamin Tissoires * We do not warn if the name is not set, we are 514ba532198SBenjamin Tissoires * actually pre-scanning the device. 515ba532198SBenjamin Tissoires */ 516ba532198SBenjamin Tissoires if (dev_name(&parser->device->dev)) 517ba532198SBenjamin Tissoires hid_warn(parser->device, 518ba532198SBenjamin Tissoires "ignoring exceeding usage max\n"); 519ba532198SBenjamin Tissoires data = HID_MAX_USAGES - parser->local.usage_index + 520ba532198SBenjamin Tissoires parser->local.usage_minimum - 1; 521ba532198SBenjamin Tissoires if (data <= 0) { 522ba532198SBenjamin Tissoires hid_err(parser->device, 523ba532198SBenjamin Tissoires "no more usage index available\n"); 524ba532198SBenjamin Tissoires return -1; 525ba532198SBenjamin Tissoires } 526ba532198SBenjamin Tissoires } 527ba532198SBenjamin Tissoires 528dde5845aSJiri Kosina for (n = parser->local.usage_minimum; n <= data; n++) 52958e75155SNicolas Saenz Julienne if (hid_add_usage(parser, n, item->size)) { 53058037eb9SJiri Kosina dbg_hid("hid_add_usage failed\n"); 531dde5845aSJiri Kosina return -1; 532dde5845aSJiri Kosina } 533dde5845aSJiri Kosina return 0; 534dde5845aSJiri Kosina 535dde5845aSJiri Kosina default: 536dde5845aSJiri Kosina 53758037eb9SJiri Kosina dbg_hid("unknown local item tag 0x%x\n", item->tag); 538dde5845aSJiri Kosina return 0; 539dde5845aSJiri Kosina } 540dde5845aSJiri Kosina return 0; 541dde5845aSJiri Kosina } 542dde5845aSJiri Kosina 543dde5845aSJiri Kosina /* 54458e75155SNicolas Saenz Julienne * Concatenate Usage Pages into Usages where relevant: 54558e75155SNicolas Saenz Julienne * As per specification, 6.2.2.8: "When the parser encounters a main item it 54658e75155SNicolas Saenz Julienne * concatenates the last declared Usage Page with a Usage to form a complete 54758e75155SNicolas Saenz Julienne * usage value." 54858e75155SNicolas Saenz Julienne */ 54958e75155SNicolas Saenz Julienne 55058e75155SNicolas Saenz Julienne static void hid_concatenate_usage_page(struct hid_parser *parser) 55158e75155SNicolas Saenz Julienne { 55258e75155SNicolas Saenz Julienne int i; 55358e75155SNicolas Saenz Julienne 55458e75155SNicolas Saenz Julienne for (i = 0; i < parser->local.usage_index; i++) 55558e75155SNicolas Saenz Julienne if (parser->local.usage_size[i] <= 2) 55658e75155SNicolas Saenz Julienne parser->local.usage[i] += parser->global.usage_page << 16; 55758e75155SNicolas Saenz Julienne } 55858e75155SNicolas Saenz Julienne 55958e75155SNicolas Saenz Julienne /* 560dde5845aSJiri Kosina * Process a main item. 561dde5845aSJiri Kosina */ 562dde5845aSJiri Kosina 563dde5845aSJiri Kosina static int hid_parser_main(struct hid_parser *parser, struct hid_item *item) 564dde5845aSJiri Kosina { 565dde5845aSJiri Kosina __u32 data; 566dde5845aSJiri Kosina int ret; 567dde5845aSJiri Kosina 56858e75155SNicolas Saenz Julienne hid_concatenate_usage_page(parser); 56958e75155SNicolas Saenz Julienne 570dde5845aSJiri Kosina data = item_udata(item); 571dde5845aSJiri Kosina 572dde5845aSJiri Kosina switch (item->tag) { 573dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION: 574dde5845aSJiri Kosina ret = open_collection(parser, data & 0xff); 575dde5845aSJiri Kosina break; 576dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_END_COLLECTION: 577dde5845aSJiri Kosina ret = close_collection(parser); 578dde5845aSJiri Kosina break; 579dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_INPUT: 580dde5845aSJiri Kosina ret = hid_add_field(parser, HID_INPUT_REPORT, data); 581dde5845aSJiri Kosina break; 582dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_OUTPUT: 583dde5845aSJiri Kosina ret = hid_add_field(parser, HID_OUTPUT_REPORT, data); 584dde5845aSJiri Kosina break; 585dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_FEATURE: 586dde5845aSJiri Kosina ret = hid_add_field(parser, HID_FEATURE_REPORT, data); 587dde5845aSJiri Kosina break; 588dde5845aSJiri Kosina default: 5897cb4774eSHans de Goede hid_warn(parser->device, "unknown main item tag 0x%x\n", item->tag); 590dde5845aSJiri Kosina ret = 0; 591dde5845aSJiri Kosina } 592dde5845aSJiri Kosina 593dde5845aSJiri Kosina memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */ 594dde5845aSJiri Kosina 595dde5845aSJiri Kosina return ret; 596dde5845aSJiri Kosina } 597dde5845aSJiri Kosina 598dde5845aSJiri Kosina /* 599dde5845aSJiri Kosina * Process a reserved item. 600dde5845aSJiri Kosina */ 601dde5845aSJiri Kosina 602dde5845aSJiri Kosina static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item) 603dde5845aSJiri Kosina { 60458037eb9SJiri Kosina dbg_hid("reserved item type, tag 0x%x\n", item->tag); 605dde5845aSJiri Kosina return 0; 606dde5845aSJiri Kosina } 607dde5845aSJiri Kosina 608dde5845aSJiri Kosina /* 609dde5845aSJiri Kosina * Free a report and all registered fields. The field->usage and 610dde5845aSJiri Kosina * field->value table's are allocated behind the field, so we need 611dde5845aSJiri Kosina * only to free(field) itself. 612dde5845aSJiri Kosina */ 613dde5845aSJiri Kosina 614dde5845aSJiri Kosina static void hid_free_report(struct hid_report *report) 615dde5845aSJiri Kosina { 616dde5845aSJiri Kosina unsigned n; 617dde5845aSJiri Kosina 618dde5845aSJiri Kosina for (n = 0; n < report->maxfield; n++) 619dde5845aSJiri Kosina kfree(report->field[n]); 620dde5845aSJiri Kosina kfree(report); 621dde5845aSJiri Kosina } 622dde5845aSJiri Kosina 623dde5845aSJiri Kosina /* 624a7197c2eSHenrik Rydberg * Close report. This function returns the device 625a7197c2eSHenrik Rydberg * state to the point prior to hid_open_report(). 626dde5845aSJiri Kosina */ 627a7197c2eSHenrik Rydberg static void hid_close_report(struct hid_device *device) 628dde5845aSJiri Kosina { 629dde5845aSJiri Kosina unsigned i, j; 630dde5845aSJiri Kosina 631dde5845aSJiri Kosina for (i = 0; i < HID_REPORT_TYPES; i++) { 632dde5845aSJiri Kosina struct hid_report_enum *report_enum = device->report_enum + i; 633dde5845aSJiri Kosina 63443622021SKees Cook for (j = 0; j < HID_MAX_IDS; j++) { 635dde5845aSJiri Kosina struct hid_report *report = report_enum->report_id_hash[j]; 636dde5845aSJiri Kosina if (report) 637dde5845aSJiri Kosina hid_free_report(report); 638dde5845aSJiri Kosina } 639a7197c2eSHenrik Rydberg memset(report_enum, 0, sizeof(*report_enum)); 640a7197c2eSHenrik Rydberg INIT_LIST_HEAD(&report_enum->report_list); 641dde5845aSJiri Kosina } 642dde5845aSJiri Kosina 643dde5845aSJiri Kosina kfree(device->rdesc); 644a7197c2eSHenrik Rydberg device->rdesc = NULL; 645a7197c2eSHenrik Rydberg device->rsize = 0; 646a7197c2eSHenrik Rydberg 647767fe787SJiri Kosina kfree(device->collection); 648a7197c2eSHenrik Rydberg device->collection = NULL; 649a7197c2eSHenrik Rydberg device->collection_size = 0; 650a7197c2eSHenrik Rydberg device->maxcollection = 0; 651a7197c2eSHenrik Rydberg device->maxapplication = 0; 652a7197c2eSHenrik Rydberg 653a7197c2eSHenrik Rydberg device->status &= ~HID_STAT_PARSED; 654a7197c2eSHenrik Rydberg } 655a7197c2eSHenrik Rydberg 656a7197c2eSHenrik Rydberg /* 657a7197c2eSHenrik Rydberg * Free a device structure, all reports, and all fields. 658a7197c2eSHenrik Rydberg */ 659a7197c2eSHenrik Rydberg 660a7197c2eSHenrik Rydberg static void hid_device_release(struct device *dev) 661a7197c2eSHenrik Rydberg { 662ee79a8f8SGeliang Tang struct hid_device *hid = to_hid_device(dev); 663a7197c2eSHenrik Rydberg 664a7197c2eSHenrik Rydberg hid_close_report(hid); 665a7197c2eSHenrik Rydberg kfree(hid->dev_rdesc); 666a7197c2eSHenrik Rydberg kfree(hid); 667dde5845aSJiri Kosina } 668dde5845aSJiri Kosina 669dde5845aSJiri Kosina /* 670dde5845aSJiri Kosina * Fetch a report description item from the data stream. We support long 671dde5845aSJiri Kosina * items, though they are not used yet. 672dde5845aSJiri Kosina */ 673dde5845aSJiri Kosina 674dde5845aSJiri Kosina static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item) 675dde5845aSJiri Kosina { 676dde5845aSJiri Kosina u8 b; 677dde5845aSJiri Kosina 678dde5845aSJiri Kosina if ((end - start) <= 0) 679dde5845aSJiri Kosina return NULL; 680dde5845aSJiri Kosina 681dde5845aSJiri Kosina b = *start++; 682dde5845aSJiri Kosina 683dde5845aSJiri Kosina item->type = (b >> 2) & 3; 684dde5845aSJiri Kosina item->tag = (b >> 4) & 15; 685dde5845aSJiri Kosina 686dde5845aSJiri Kosina if (item->tag == HID_ITEM_TAG_LONG) { 687dde5845aSJiri Kosina 688dde5845aSJiri Kosina item->format = HID_ITEM_FORMAT_LONG; 689dde5845aSJiri Kosina 690dde5845aSJiri Kosina if ((end - start) < 2) 691dde5845aSJiri Kosina return NULL; 692dde5845aSJiri Kosina 693dde5845aSJiri Kosina item->size = *start++; 694dde5845aSJiri Kosina item->tag = *start++; 695dde5845aSJiri Kosina 696dde5845aSJiri Kosina if ((end - start) < item->size) 697dde5845aSJiri Kosina return NULL; 698dde5845aSJiri Kosina 699dde5845aSJiri Kosina item->data.longdata = start; 700dde5845aSJiri Kosina start += item->size; 701dde5845aSJiri Kosina return start; 702dde5845aSJiri Kosina } 703dde5845aSJiri Kosina 704dde5845aSJiri Kosina item->format = HID_ITEM_FORMAT_SHORT; 705dde5845aSJiri Kosina item->size = b & 3; 706dde5845aSJiri Kosina 707dde5845aSJiri Kosina switch (item->size) { 708dde5845aSJiri Kosina case 0: 709dde5845aSJiri Kosina return start; 710dde5845aSJiri Kosina 711dde5845aSJiri Kosina case 1: 712dde5845aSJiri Kosina if ((end - start) < 1) 713dde5845aSJiri Kosina return NULL; 714dde5845aSJiri Kosina item->data.u8 = *start++; 715dde5845aSJiri Kosina return start; 716dde5845aSJiri Kosina 717dde5845aSJiri Kosina case 2: 718dde5845aSJiri Kosina if ((end - start) < 2) 719dde5845aSJiri Kosina return NULL; 720c105068fSHarvey Harrison item->data.u16 = get_unaligned_le16(start); 721dde5845aSJiri Kosina start = (__u8 *)((__le16 *)start + 1); 722dde5845aSJiri Kosina return start; 723dde5845aSJiri Kosina 724dde5845aSJiri Kosina case 3: 725dde5845aSJiri Kosina item->size++; 726dde5845aSJiri Kosina if ((end - start) < 4) 727dde5845aSJiri Kosina return NULL; 728c105068fSHarvey Harrison item->data.u32 = get_unaligned_le32(start); 729dde5845aSJiri Kosina start = (__u8 *)((__le32 *)start + 1); 730dde5845aSJiri Kosina return start; 731dde5845aSJiri Kosina } 732dde5845aSJiri Kosina 733dde5845aSJiri Kosina return NULL; 734dde5845aSJiri Kosina } 735dde5845aSJiri Kosina 7363dc8fc08SBenjamin Tissoires static void hid_scan_input_usage(struct hid_parser *parser, u32 usage) 737734c6609SHenrik Rydberg { 7383dc8fc08SBenjamin Tissoires struct hid_device *hid = parser->device; 7393dc8fc08SBenjamin Tissoires 7404fa3a583SHenrik Rydberg if (usage == HID_DG_CONTACTID) 7414fa3a583SHenrik Rydberg hid->group = HID_GROUP_MULTITOUCH; 742734c6609SHenrik Rydberg } 743734c6609SHenrik Rydberg 744f961bd35SBenjamin Tissoires static void hid_scan_feature_usage(struct hid_parser *parser, u32 usage) 745f961bd35SBenjamin Tissoires { 746f961bd35SBenjamin Tissoires if (usage == 0xff0000c5 && parser->global.report_count == 256 && 747f961bd35SBenjamin Tissoires parser->global.report_size == 8) 748f961bd35SBenjamin Tissoires parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8; 749f961bd35SBenjamin Tissoires } 750f961bd35SBenjamin Tissoires 7513dc8fc08SBenjamin Tissoires static void hid_scan_collection(struct hid_parser *parser, unsigned type) 7523dc8fc08SBenjamin Tissoires { 7533dc8fc08SBenjamin Tissoires struct hid_device *hid = parser->device; 754e39f2d59SAndrew Duggan int i; 7553dc8fc08SBenjamin Tissoires 7563dc8fc08SBenjamin Tissoires if (((parser->global.usage_page << 16) == HID_UP_SENSOR) && 7573dc8fc08SBenjamin Tissoires type == HID_COLLECTION_PHYSICAL) 7583dc8fc08SBenjamin Tissoires hid->group = HID_GROUP_SENSOR_HUB; 759be3b1634SAlan Wu 760be3b1634SAlan Wu if (hid->vendor == USB_VENDOR_ID_MICROSOFT && 7610a76ac80SDennis Chen hid->product == USB_DEVICE_ID_MS_POWER_COVER && 762be3b1634SAlan Wu hid->group == HID_GROUP_MULTITOUCH) 763be3b1634SAlan Wu hid->group = HID_GROUP_GENERIC; 764e39f2d59SAndrew Duggan 765e39f2d59SAndrew Duggan if ((parser->global.usage_page << 16) == HID_UP_GENDESK) 766e39f2d59SAndrew Duggan for (i = 0; i < parser->local.usage_index; i++) 767e39f2d59SAndrew Duggan if (parser->local.usage[i] == HID_GD_POINTER) 768e39f2d59SAndrew Duggan parser->scan_flags |= HID_SCAN_FLAG_GD_POINTER; 769e39f2d59SAndrew Duggan 770e39f2d59SAndrew Duggan if ((parser->global.usage_page << 16) >= HID_UP_MSVENDOR) 771e39f2d59SAndrew Duggan parser->scan_flags |= HID_SCAN_FLAG_VENDOR_SPECIFIC; 7723dc8fc08SBenjamin Tissoires } 7733dc8fc08SBenjamin Tissoires 7743dc8fc08SBenjamin Tissoires static int hid_scan_main(struct hid_parser *parser, struct hid_item *item) 7753dc8fc08SBenjamin Tissoires { 7763dc8fc08SBenjamin Tissoires __u32 data; 7773dc8fc08SBenjamin Tissoires int i; 7783dc8fc08SBenjamin Tissoires 77958e75155SNicolas Saenz Julienne hid_concatenate_usage_page(parser); 78058e75155SNicolas Saenz Julienne 7813dc8fc08SBenjamin Tissoires data = item_udata(item); 7823dc8fc08SBenjamin Tissoires 7833dc8fc08SBenjamin Tissoires switch (item->tag) { 7843dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION: 7853dc8fc08SBenjamin Tissoires hid_scan_collection(parser, data & 0xff); 7863dc8fc08SBenjamin Tissoires break; 7873dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_END_COLLECTION: 7883dc8fc08SBenjamin Tissoires break; 7893dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_INPUT: 790e24d0d39SBenjamin Tissoires /* ignore constant inputs, they will be ignored by hid-input */ 791e24d0d39SBenjamin Tissoires if (data & HID_MAIN_ITEM_CONSTANT) 792e24d0d39SBenjamin Tissoires break; 7933dc8fc08SBenjamin Tissoires for (i = 0; i < parser->local.usage_index; i++) 7943dc8fc08SBenjamin Tissoires hid_scan_input_usage(parser, parser->local.usage[i]); 7953dc8fc08SBenjamin Tissoires break; 7963dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_OUTPUT: 7973dc8fc08SBenjamin Tissoires break; 7983dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_FEATURE: 799f961bd35SBenjamin Tissoires for (i = 0; i < parser->local.usage_index; i++) 800f961bd35SBenjamin Tissoires hid_scan_feature_usage(parser, parser->local.usage[i]); 8013dc8fc08SBenjamin Tissoires break; 8023dc8fc08SBenjamin Tissoires } 8033dc8fc08SBenjamin Tissoires 8043dc8fc08SBenjamin Tissoires /* Reset the local parser environment */ 8053dc8fc08SBenjamin Tissoires memset(&parser->local, 0, sizeof(parser->local)); 8063dc8fc08SBenjamin Tissoires 8073dc8fc08SBenjamin Tissoires return 0; 8083dc8fc08SBenjamin Tissoires } 8093dc8fc08SBenjamin Tissoires 810734c6609SHenrik Rydberg /* 811734c6609SHenrik Rydberg * Scan a report descriptor before the device is added to the bus. 812734c6609SHenrik Rydberg * Sets device groups and other properties that determine what driver 813734c6609SHenrik Rydberg * to load. 814734c6609SHenrik Rydberg */ 815734c6609SHenrik Rydberg static int hid_scan_report(struct hid_device *hid) 816734c6609SHenrik Rydberg { 8173dc8fc08SBenjamin Tissoires struct hid_parser *parser; 8183dc8fc08SBenjamin Tissoires struct hid_item item; 819734c6609SHenrik Rydberg __u8 *start = hid->dev_rdesc; 820734c6609SHenrik Rydberg __u8 *end = start + hid->dev_rsize; 8213dc8fc08SBenjamin Tissoires static int (*dispatch_type[])(struct hid_parser *parser, 8223dc8fc08SBenjamin Tissoires struct hid_item *item) = { 8233dc8fc08SBenjamin Tissoires hid_scan_main, 8243dc8fc08SBenjamin Tissoires hid_parser_global, 8253dc8fc08SBenjamin Tissoires hid_parser_local, 8263dc8fc08SBenjamin Tissoires hid_parser_reserved 8273dc8fc08SBenjamin Tissoires }; 828734c6609SHenrik Rydberg 8293dc8fc08SBenjamin Tissoires parser = vzalloc(sizeof(struct hid_parser)); 8303dc8fc08SBenjamin Tissoires if (!parser) 8313dc8fc08SBenjamin Tissoires return -ENOMEM; 8323dc8fc08SBenjamin Tissoires 8333dc8fc08SBenjamin Tissoires parser->device = hid; 834734c6609SHenrik Rydberg hid->group = HID_GROUP_GENERIC; 835734c6609SHenrik Rydberg 8363dc8fc08SBenjamin Tissoires /* 8373dc8fc08SBenjamin Tissoires * The parsing is simpler than the one in hid_open_report() as we should 8383dc8fc08SBenjamin Tissoires * be robust against hid errors. Those errors will be raised by 8393dc8fc08SBenjamin Tissoires * hid_open_report() anyway. 8403dc8fc08SBenjamin Tissoires */ 8413dc8fc08SBenjamin Tissoires while ((start = fetch_item(start, end, &item)) != NULL) 8423dc8fc08SBenjamin Tissoires dispatch_type[item.type](parser, &item); 8433dc8fc08SBenjamin Tissoires 844f961bd35SBenjamin Tissoires /* 845f961bd35SBenjamin Tissoires * Handle special flags set during scanning. 846f961bd35SBenjamin Tissoires */ 847f961bd35SBenjamin Tissoires if ((parser->scan_flags & HID_SCAN_FLAG_MT_WIN_8) && 848f961bd35SBenjamin Tissoires (hid->group == HID_GROUP_MULTITOUCH)) 849f961bd35SBenjamin Tissoires hid->group = HID_GROUP_MULTITOUCH_WIN_8; 850f961bd35SBenjamin Tissoires 851ba391e5aSBenjamin Tissoires /* 852ba391e5aSBenjamin Tissoires * Vendor specific handlings 853ba391e5aSBenjamin Tissoires */ 85429b47391SBenjamin Tissoires switch (hid->vendor) { 85529b47391SBenjamin Tissoires case USB_VENDOR_ID_WACOM: 85629b47391SBenjamin Tissoires hid->group = HID_GROUP_WACOM; 85729b47391SBenjamin Tissoires break; 858c241c5eeSBenjamin Tissoires case USB_VENDOR_ID_SYNAPTICS: 85984379d83SJiri Kosina if (hid->group == HID_GROUP_GENERIC) 860e39f2d59SAndrew Duggan if ((parser->scan_flags & HID_SCAN_FLAG_VENDOR_SPECIFIC) 861e39f2d59SAndrew Duggan && (parser->scan_flags & HID_SCAN_FLAG_GD_POINTER)) 862e39f2d59SAndrew Duggan /* 863e39f2d59SAndrew Duggan * hid-rmi should take care of them, 864e39f2d59SAndrew Duggan * not hid-generic 865e39f2d59SAndrew Duggan */ 866c241c5eeSBenjamin Tissoires hid->group = HID_GROUP_RMI; 867c241c5eeSBenjamin Tissoires break; 86829b47391SBenjamin Tissoires } 86929b47391SBenjamin Tissoires 87008a8a7cfSBenjamin Tissoires kfree(parser->collection_stack); 8713dc8fc08SBenjamin Tissoires vfree(parser); 872734c6609SHenrik Rydberg return 0; 873734c6609SHenrik Rydberg } 874734c6609SHenrik Rydberg 87585cdaf52SJiri Slaby /** 87685cdaf52SJiri Slaby * hid_parse_report - parse device report 87785cdaf52SJiri Slaby * 87885cdaf52SJiri Slaby * @device: hid device 87985cdaf52SJiri Slaby * @start: report start 88085cdaf52SJiri Slaby * @size: report size 88185cdaf52SJiri Slaby * 882a7197c2eSHenrik Rydberg * Allocate the device report as read by the bus driver. This function should 883a7197c2eSHenrik Rydberg * only be called from parse() in ll drivers. 884a7197c2eSHenrik Rydberg */ 885a7197c2eSHenrik Rydberg int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size) 886a7197c2eSHenrik Rydberg { 887a7197c2eSHenrik Rydberg hid->dev_rdesc = kmemdup(start, size, GFP_KERNEL); 888a7197c2eSHenrik Rydberg if (!hid->dev_rdesc) 889a7197c2eSHenrik Rydberg return -ENOMEM; 890a7197c2eSHenrik Rydberg hid->dev_rsize = size; 891a7197c2eSHenrik Rydberg return 0; 892a7197c2eSHenrik Rydberg } 893a7197c2eSHenrik Rydberg EXPORT_SYMBOL_GPL(hid_parse_report); 894a7197c2eSHenrik Rydberg 895331415ffSKees Cook static const char * const hid_report_names[] = { 896331415ffSKees Cook "HID_INPUT_REPORT", 897331415ffSKees Cook "HID_OUTPUT_REPORT", 898331415ffSKees Cook "HID_FEATURE_REPORT", 899331415ffSKees Cook }; 900331415ffSKees Cook /** 901331415ffSKees Cook * hid_validate_values - validate existing device report's value indexes 902331415ffSKees Cook * 903331415ffSKees Cook * @device: hid device 904331415ffSKees Cook * @type: which report type to examine 905331415ffSKees Cook * @id: which report ID to examine (0 for first) 906331415ffSKees Cook * @field_index: which report field to examine 907331415ffSKees Cook * @report_counts: expected number of values 908331415ffSKees Cook * 909331415ffSKees Cook * Validate the number of values in a given field of a given report, after 910331415ffSKees Cook * parsing. 911331415ffSKees Cook */ 912331415ffSKees Cook struct hid_report *hid_validate_values(struct hid_device *hid, 913331415ffSKees Cook unsigned int type, unsigned int id, 914331415ffSKees Cook unsigned int field_index, 915331415ffSKees Cook unsigned int report_counts) 916331415ffSKees Cook { 917331415ffSKees Cook struct hid_report *report; 918331415ffSKees Cook 919331415ffSKees Cook if (type > HID_FEATURE_REPORT) { 920331415ffSKees Cook hid_err(hid, "invalid HID report type %u\n", type); 921331415ffSKees Cook return NULL; 922331415ffSKees Cook } 923331415ffSKees Cook 924331415ffSKees Cook if (id >= HID_MAX_IDS) { 925331415ffSKees Cook hid_err(hid, "invalid HID report id %u\n", id); 926331415ffSKees Cook return NULL; 927331415ffSKees Cook } 928331415ffSKees Cook 929331415ffSKees Cook /* 930331415ffSKees Cook * Explicitly not using hid_get_report() here since it depends on 931331415ffSKees Cook * ->numbered being checked, which may not always be the case when 932331415ffSKees Cook * drivers go to access report values. 933331415ffSKees Cook */ 9341b15d2e5SKees Cook if (id == 0) { 9351b15d2e5SKees Cook /* 9361b15d2e5SKees Cook * Validating on id 0 means we should examine the first 9371b15d2e5SKees Cook * report in the list. 9381b15d2e5SKees Cook */ 9391b15d2e5SKees Cook report = list_entry( 9401b15d2e5SKees Cook hid->report_enum[type].report_list.next, 9411b15d2e5SKees Cook struct hid_report, list); 9421b15d2e5SKees Cook } else { 943331415ffSKees Cook report = hid->report_enum[type].report_id_hash[id]; 9441b15d2e5SKees Cook } 945331415ffSKees Cook if (!report) { 946331415ffSKees Cook hid_err(hid, "missing %s %u\n", hid_report_names[type], id); 947331415ffSKees Cook return NULL; 948331415ffSKees Cook } 949331415ffSKees Cook if (report->maxfield <= field_index) { 950331415ffSKees Cook hid_err(hid, "not enough fields in %s %u\n", 951331415ffSKees Cook hid_report_names[type], id); 952331415ffSKees Cook return NULL; 953331415ffSKees Cook } 954331415ffSKees Cook if (report->field[field_index]->report_count < report_counts) { 955331415ffSKees Cook hid_err(hid, "not enough values in %s %u field %u\n", 956331415ffSKees Cook hid_report_names[type], id, field_index); 957331415ffSKees Cook return NULL; 958331415ffSKees Cook } 959331415ffSKees Cook return report; 960331415ffSKees Cook } 961331415ffSKees Cook EXPORT_SYMBOL_GPL(hid_validate_values); 962331415ffSKees Cook 9635a4abb36SPeter Hutterer static int hid_calculate_multiplier(struct hid_device *hid, 9645a4abb36SPeter Hutterer struct hid_field *multiplier) 9655a4abb36SPeter Hutterer { 9665a4abb36SPeter Hutterer int m; 9675a4abb36SPeter Hutterer __s32 v = *multiplier->value; 9685a4abb36SPeter Hutterer __s32 lmin = multiplier->logical_minimum; 9695a4abb36SPeter Hutterer __s32 lmax = multiplier->logical_maximum; 9705a4abb36SPeter Hutterer __s32 pmin = multiplier->physical_minimum; 9715a4abb36SPeter Hutterer __s32 pmax = multiplier->physical_maximum; 9725a4abb36SPeter Hutterer 9735a4abb36SPeter Hutterer /* 9745a4abb36SPeter Hutterer * "Because OS implementations will generally divide the control's 9755a4abb36SPeter Hutterer * reported count by the Effective Resolution Multiplier, designers 9765a4abb36SPeter Hutterer * should take care not to establish a potential Effective 9775a4abb36SPeter Hutterer * Resolution Multiplier of zero." 9785a4abb36SPeter Hutterer * HID Usage Table, v1.12, Section 4.3.1, p31 9795a4abb36SPeter Hutterer */ 9805a4abb36SPeter Hutterer if (lmax - lmin == 0) 9815a4abb36SPeter Hutterer return 1; 9825a4abb36SPeter Hutterer /* 9835a4abb36SPeter Hutterer * Handling the unit exponent is left as an exercise to whoever 9845a4abb36SPeter Hutterer * finds a device where that exponent is not 0. 9855a4abb36SPeter Hutterer */ 9865a4abb36SPeter Hutterer m = ((v - lmin)/(lmax - lmin) * (pmax - pmin) + pmin); 9875a4abb36SPeter Hutterer if (unlikely(multiplier->unit_exponent != 0)) { 9885a4abb36SPeter Hutterer hid_warn(hid, 9895a4abb36SPeter Hutterer "unsupported Resolution Multiplier unit exponent %d\n", 9905a4abb36SPeter Hutterer multiplier->unit_exponent); 9915a4abb36SPeter Hutterer } 9925a4abb36SPeter Hutterer 9935a4abb36SPeter Hutterer /* There are no devices with an effective multiplier > 255 */ 9945a4abb36SPeter Hutterer if (unlikely(m == 0 || m > 255 || m < -255)) { 9955a4abb36SPeter Hutterer hid_warn(hid, "unsupported Resolution Multiplier %d\n", m); 9965a4abb36SPeter Hutterer m = 1; 9975a4abb36SPeter Hutterer } 9985a4abb36SPeter Hutterer 9995a4abb36SPeter Hutterer return m; 10005a4abb36SPeter Hutterer } 10015a4abb36SPeter Hutterer 10025a4abb36SPeter Hutterer static void hid_apply_multiplier_to_field(struct hid_device *hid, 10035a4abb36SPeter Hutterer struct hid_field *field, 10045a4abb36SPeter Hutterer struct hid_collection *multiplier_collection, 10055a4abb36SPeter Hutterer int effective_multiplier) 10065a4abb36SPeter Hutterer { 10075a4abb36SPeter Hutterer struct hid_collection *collection; 10085a4abb36SPeter Hutterer struct hid_usage *usage; 10095a4abb36SPeter Hutterer int i; 10105a4abb36SPeter Hutterer 10115a4abb36SPeter Hutterer /* 10125a4abb36SPeter Hutterer * If multiplier_collection is NULL, the multiplier applies 10135a4abb36SPeter Hutterer * to all fields in the report. 10145a4abb36SPeter Hutterer * Otherwise, it is the Logical Collection the multiplier applies to 10155a4abb36SPeter Hutterer * but our field may be in a subcollection of that collection. 10165a4abb36SPeter Hutterer */ 10175a4abb36SPeter Hutterer for (i = 0; i < field->maxusage; i++) { 10185a4abb36SPeter Hutterer usage = &field->usage[i]; 10195a4abb36SPeter Hutterer 10205a4abb36SPeter Hutterer collection = &hid->collection[usage->collection_index]; 1021ee46967fSPeter Hutterer while (collection->parent_idx != -1 && 1022ee46967fSPeter Hutterer collection != multiplier_collection) 1023ee46967fSPeter Hutterer collection = &hid->collection[collection->parent_idx]; 10245a4abb36SPeter Hutterer 1025ee46967fSPeter Hutterer if (collection->parent_idx != -1 || 1026ee46967fSPeter Hutterer multiplier_collection == NULL) 10275a4abb36SPeter Hutterer usage->resolution_multiplier = effective_multiplier; 10285a4abb36SPeter Hutterer 10295a4abb36SPeter Hutterer } 10305a4abb36SPeter Hutterer } 10315a4abb36SPeter Hutterer 10325a4abb36SPeter Hutterer static void hid_apply_multiplier(struct hid_device *hid, 10335a4abb36SPeter Hutterer struct hid_field *multiplier) 10345a4abb36SPeter Hutterer { 10355a4abb36SPeter Hutterer struct hid_report_enum *rep_enum; 10365a4abb36SPeter Hutterer struct hid_report *rep; 10375a4abb36SPeter Hutterer struct hid_field *field; 10385a4abb36SPeter Hutterer struct hid_collection *multiplier_collection; 10395a4abb36SPeter Hutterer int effective_multiplier; 10405a4abb36SPeter Hutterer int i; 10415a4abb36SPeter Hutterer 10425a4abb36SPeter Hutterer /* 10435a4abb36SPeter Hutterer * "The Resolution Multiplier control must be contained in the same 10445a4abb36SPeter Hutterer * Logical Collection as the control(s) to which it is to be applied. 10455a4abb36SPeter Hutterer * If no Resolution Multiplier is defined, then the Resolution 10465a4abb36SPeter Hutterer * Multiplier defaults to 1. If more than one control exists in a 10475a4abb36SPeter Hutterer * Logical Collection, the Resolution Multiplier is associated with 10485a4abb36SPeter Hutterer * all controls in the collection. If no Logical Collection is 10495a4abb36SPeter Hutterer * defined, the Resolution Multiplier is associated with all 10505a4abb36SPeter Hutterer * controls in the report." 10515a4abb36SPeter Hutterer * HID Usage Table, v1.12, Section 4.3.1, p30 10525a4abb36SPeter Hutterer * 10535a4abb36SPeter Hutterer * Thus, search from the current collection upwards until we find a 10545a4abb36SPeter Hutterer * logical collection. Then search all fields for that same parent 10555a4abb36SPeter Hutterer * collection. Those are the fields the multiplier applies to. 10565a4abb36SPeter Hutterer * 10575a4abb36SPeter Hutterer * If we have more than one multiplier, it will overwrite the 10585a4abb36SPeter Hutterer * applicable fields later. 10595a4abb36SPeter Hutterer */ 10605a4abb36SPeter Hutterer multiplier_collection = &hid->collection[multiplier->usage->collection_index]; 1061ee46967fSPeter Hutterer while (multiplier_collection->parent_idx != -1 && 10625a4abb36SPeter Hutterer multiplier_collection->type != HID_COLLECTION_LOGICAL) 1063ee46967fSPeter Hutterer multiplier_collection = &hid->collection[multiplier_collection->parent_idx]; 10645a4abb36SPeter Hutterer 10655a4abb36SPeter Hutterer effective_multiplier = hid_calculate_multiplier(hid, multiplier); 10665a4abb36SPeter Hutterer 10675a4abb36SPeter Hutterer rep_enum = &hid->report_enum[HID_INPUT_REPORT]; 10685a4abb36SPeter Hutterer list_for_each_entry(rep, &rep_enum->report_list, list) { 10695a4abb36SPeter Hutterer for (i = 0; i < rep->maxfield; i++) { 10705a4abb36SPeter Hutterer field = rep->field[i]; 10715a4abb36SPeter Hutterer hid_apply_multiplier_to_field(hid, field, 10725a4abb36SPeter Hutterer multiplier_collection, 10735a4abb36SPeter Hutterer effective_multiplier); 10745a4abb36SPeter Hutterer } 10755a4abb36SPeter Hutterer } 10765a4abb36SPeter Hutterer } 10775a4abb36SPeter Hutterer 10785a4abb36SPeter Hutterer /* 10795a4abb36SPeter Hutterer * hid_setup_resolution_multiplier - set up all resolution multipliers 10805a4abb36SPeter Hutterer * 10815a4abb36SPeter Hutterer * @device: hid device 10825a4abb36SPeter Hutterer * 10835a4abb36SPeter Hutterer * Search for all Resolution Multiplier Feature Reports and apply their 10845a4abb36SPeter Hutterer * value to all matching Input items. This only updates the internal struct 10855a4abb36SPeter Hutterer * fields. 10865a4abb36SPeter Hutterer * 10875a4abb36SPeter Hutterer * The Resolution Multiplier is applied by the hardware. If the multiplier 10885a4abb36SPeter Hutterer * is anything other than 1, the hardware will send pre-multiplied events 10895a4abb36SPeter Hutterer * so that the same physical interaction generates an accumulated 10905a4abb36SPeter Hutterer * accumulated_value = value * * multiplier 10915a4abb36SPeter Hutterer * This may be achieved by sending 10925a4abb36SPeter Hutterer * - "value * multiplier" for each event, or 10935a4abb36SPeter Hutterer * - "value" but "multiplier" times as frequently, or 10945a4abb36SPeter Hutterer * - a combination of the above 10955a4abb36SPeter Hutterer * The only guarantee is that the same physical interaction always generates 10965a4abb36SPeter Hutterer * an accumulated 'value * multiplier'. 10975a4abb36SPeter Hutterer * 10985a4abb36SPeter Hutterer * This function must be called before any event processing and after 10995a4abb36SPeter Hutterer * any SetRequest to the Resolution Multiplier. 11005a4abb36SPeter Hutterer */ 11015a4abb36SPeter Hutterer void hid_setup_resolution_multiplier(struct hid_device *hid) 11025a4abb36SPeter Hutterer { 11035a4abb36SPeter Hutterer struct hid_report_enum *rep_enum; 11045a4abb36SPeter Hutterer struct hid_report *rep; 11055a4abb36SPeter Hutterer struct hid_usage *usage; 11065a4abb36SPeter Hutterer int i, j; 11075a4abb36SPeter Hutterer 11085a4abb36SPeter Hutterer rep_enum = &hid->report_enum[HID_FEATURE_REPORT]; 11095a4abb36SPeter Hutterer list_for_each_entry(rep, &rep_enum->report_list, list) { 11105a4abb36SPeter Hutterer for (i = 0; i < rep->maxfield; i++) { 11115a4abb36SPeter Hutterer /* Ignore if report count is out of bounds. */ 11125a4abb36SPeter Hutterer if (rep->field[i]->report_count < 1) 11135a4abb36SPeter Hutterer continue; 11145a4abb36SPeter Hutterer 11155a4abb36SPeter Hutterer for (j = 0; j < rep->field[i]->maxusage; j++) { 11165a4abb36SPeter Hutterer usage = &rep->field[i]->usage[j]; 11175a4abb36SPeter Hutterer if (usage->hid == HID_GD_RESOLUTION_MULTIPLIER) 11185a4abb36SPeter Hutterer hid_apply_multiplier(hid, 11195a4abb36SPeter Hutterer rep->field[i]); 11205a4abb36SPeter Hutterer } 11215a4abb36SPeter Hutterer } 11225a4abb36SPeter Hutterer } 11235a4abb36SPeter Hutterer } 11245a4abb36SPeter Hutterer EXPORT_SYMBOL_GPL(hid_setup_resolution_multiplier); 11255a4abb36SPeter Hutterer 1126a7197c2eSHenrik Rydberg /** 1127a7197c2eSHenrik Rydberg * hid_open_report - open a driver-specific device report 1128a7197c2eSHenrik Rydberg * 1129a7197c2eSHenrik Rydberg * @device: hid device 1130a7197c2eSHenrik Rydberg * 1131dde5845aSJiri Kosina * Parse a report description into a hid_device structure. Reports are 1132dde5845aSJiri Kosina * enumerated, fields are attached to these reports. 113385cdaf52SJiri Slaby * 0 returned on success, otherwise nonzero error value. 1134a7197c2eSHenrik Rydberg * 1135a7197c2eSHenrik Rydberg * This function (or the equivalent hid_parse() macro) should only be 1136a7197c2eSHenrik Rydberg * called from probe() in drivers, before starting the device. 1137dde5845aSJiri Kosina */ 1138a7197c2eSHenrik Rydberg int hid_open_report(struct hid_device *device) 1139dde5845aSJiri Kosina { 1140dde5845aSJiri Kosina struct hid_parser *parser; 1141dde5845aSJiri Kosina struct hid_item item; 1142a7197c2eSHenrik Rydberg unsigned int size; 1143a7197c2eSHenrik Rydberg __u8 *start; 114486e6b77eSKevin Daughtridge __u8 *buf; 1145dde5845aSJiri Kosina __u8 *end; 114685cdaf52SJiri Slaby int ret; 1147dde5845aSJiri Kosina static int (*dispatch_type[])(struct hid_parser *parser, 1148dde5845aSJiri Kosina struct hid_item *item) = { 1149dde5845aSJiri Kosina hid_parser_main, 1150dde5845aSJiri Kosina hid_parser_global, 1151dde5845aSJiri Kosina hid_parser_local, 1152dde5845aSJiri Kosina hid_parser_reserved 1153dde5845aSJiri Kosina }; 1154dde5845aSJiri Kosina 1155a7197c2eSHenrik Rydberg if (WARN_ON(device->status & HID_STAT_PARSED)) 1156a7197c2eSHenrik Rydberg return -EBUSY; 1157a7197c2eSHenrik Rydberg 1158a7197c2eSHenrik Rydberg start = device->dev_rdesc; 1159a7197c2eSHenrik Rydberg if (WARN_ON(!start)) 1160a7197c2eSHenrik Rydberg return -ENODEV; 1161a7197c2eSHenrik Rydberg size = device->dev_rsize; 1162a7197c2eSHenrik Rydberg 116386e6b77eSKevin Daughtridge buf = kmemdup(start, size, GFP_KERNEL); 116486e6b77eSKevin Daughtridge if (buf == NULL) 116585cdaf52SJiri Slaby return -ENOMEM; 116686e6b77eSKevin Daughtridge 116786e6b77eSKevin Daughtridge if (device->driver->report_fixup) 116886e6b77eSKevin Daughtridge start = device->driver->report_fixup(device, buf, &size); 116986e6b77eSKevin Daughtridge else 117086e6b77eSKevin Daughtridge start = buf; 117186e6b77eSKevin Daughtridge 117286e6b77eSKevin Daughtridge start = kmemdup(start, size, GFP_KERNEL); 117386e6b77eSKevin Daughtridge kfree(buf); 117486e6b77eSKevin Daughtridge if (start == NULL) 117586e6b77eSKevin Daughtridge return -ENOMEM; 117686e6b77eSKevin Daughtridge 117786e6b77eSKevin Daughtridge device->rdesc = start; 1178dde5845aSJiri Kosina device->rsize = size; 1179dde5845aSJiri Kosina 1180fe258020SJoe Perches parser = vzalloc(sizeof(struct hid_parser)); 118185cdaf52SJiri Slaby if (!parser) { 118285cdaf52SJiri Slaby ret = -ENOMEM; 1183b034ed50SGustavo A. R. Silva goto alloc_err; 1184dde5845aSJiri Kosina } 118585cdaf52SJiri Slaby 1186dde5845aSJiri Kosina parser->device = device; 1187dde5845aSJiri Kosina 1188dde5845aSJiri Kosina end = start + size; 1189a7197c2eSHenrik Rydberg 1190a7197c2eSHenrik Rydberg device->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS, 1191a7197c2eSHenrik Rydberg sizeof(struct hid_collection), GFP_KERNEL); 1192a7197c2eSHenrik Rydberg if (!device->collection) { 1193a7197c2eSHenrik Rydberg ret = -ENOMEM; 1194a7197c2eSHenrik Rydberg goto err; 1195a7197c2eSHenrik Rydberg } 1196a7197c2eSHenrik Rydberg device->collection_size = HID_DEFAULT_NUM_COLLECTIONS; 1197a7197c2eSHenrik Rydberg 119885cdaf52SJiri Slaby ret = -EINVAL; 1199dde5845aSJiri Kosina while ((start = fetch_item(start, end, &item)) != NULL) { 1200dde5845aSJiri Kosina 1201dde5845aSJiri Kosina if (item.format != HID_ITEM_FORMAT_SHORT) { 12028c3d52fcSJiri Kosina hid_err(device, "unexpected long global item\n"); 120385cdaf52SJiri Slaby goto err; 1204dde5845aSJiri Kosina } 1205dde5845aSJiri Kosina 1206dde5845aSJiri Kosina if (dispatch_type[item.type](parser, &item)) { 12078c3d52fcSJiri Kosina hid_err(device, "item %u %u %u %u parsing failed\n", 12084291ee30SJoe Perches item.format, (unsigned)item.size, 12094291ee30SJoe Perches (unsigned)item.type, (unsigned)item.tag); 121085cdaf52SJiri Slaby goto err; 1211dde5845aSJiri Kosina } 1212dde5845aSJiri Kosina 1213dde5845aSJiri Kosina if (start == end) { 1214dde5845aSJiri Kosina if (parser->collection_stack_ptr) { 12158c3d52fcSJiri Kosina hid_err(device, "unbalanced collection at end of report description\n"); 121685cdaf52SJiri Slaby goto err; 1217dde5845aSJiri Kosina } 1218dde5845aSJiri Kosina if (parser->local.delimiter_depth) { 12198c3d52fcSJiri Kosina hid_err(device, "unbalanced delimiter at end of report description\n"); 122085cdaf52SJiri Slaby goto err; 1221dde5845aSJiri Kosina } 12225a4abb36SPeter Hutterer 12235a4abb36SPeter Hutterer /* 12245a4abb36SPeter Hutterer * fetch initial values in case the device's 12255a4abb36SPeter Hutterer * default multiplier isn't the recommended 1 12265a4abb36SPeter Hutterer */ 12275a4abb36SPeter Hutterer hid_setup_resolution_multiplier(device); 12285a4abb36SPeter Hutterer 1229b2dd9f2eSStefan Agner kfree(parser->collection_stack); 123047a80edbSJiri Kosina vfree(parser); 1231a7197c2eSHenrik Rydberg device->status |= HID_STAT_PARSED; 12325a4abb36SPeter Hutterer 123385cdaf52SJiri Slaby return 0; 1234dde5845aSJiri Kosina } 1235dde5845aSJiri Kosina } 1236dde5845aSJiri Kosina 12378c3d52fcSJiri Kosina hid_err(device, "item fetching failed at offset %d\n", (int)(end - start)); 123885cdaf52SJiri Slaby err: 1239b2dd9f2eSStefan Agner kfree(parser->collection_stack); 1240b034ed50SGustavo A. R. Silva alloc_err: 124147a80edbSJiri Kosina vfree(parser); 1242a7197c2eSHenrik Rydberg hid_close_report(device); 124385cdaf52SJiri Slaby return ret; 1244dde5845aSJiri Kosina } 1245a7197c2eSHenrik Rydberg EXPORT_SYMBOL_GPL(hid_open_report); 1246dde5845aSJiri Kosina 1247dde5845aSJiri Kosina /* 1248dde5845aSJiri Kosina * Convert a signed n-bit integer to signed 32-bit integer. Common 1249dde5845aSJiri Kosina * cases are done through the compiler, the screwed things has to be 1250dde5845aSJiri Kosina * done by hand. 1251dde5845aSJiri Kosina */ 1252dde5845aSJiri Kosina 1253dde5845aSJiri Kosina static s32 snto32(__u32 value, unsigned n) 1254dde5845aSJiri Kosina { 1255dde5845aSJiri Kosina switch (n) { 1256dde5845aSJiri Kosina case 8: return ((__s8)value); 1257dde5845aSJiri Kosina case 16: return ((__s16)value); 1258dde5845aSJiri Kosina case 32: return ((__s32)value); 1259dde5845aSJiri Kosina } 126008585e43SAndy Shevchenko return value & (1 << (n - 1)) ? value | (~0U << n) : value; 1261dde5845aSJiri Kosina } 1262dde5845aSJiri Kosina 126377463838SBenjamin Tissoires s32 hid_snto32(__u32 value, unsigned n) 126477463838SBenjamin Tissoires { 126577463838SBenjamin Tissoires return snto32(value, n); 126677463838SBenjamin Tissoires } 126777463838SBenjamin Tissoires EXPORT_SYMBOL_GPL(hid_snto32); 126877463838SBenjamin Tissoires 1269dde5845aSJiri Kosina /* 1270dde5845aSJiri Kosina * Convert a signed 32-bit integer to a signed n-bit integer. 1271dde5845aSJiri Kosina */ 1272dde5845aSJiri Kosina 1273dde5845aSJiri Kosina static u32 s32ton(__s32 value, unsigned n) 1274dde5845aSJiri Kosina { 1275dde5845aSJiri Kosina s32 a = value >> (n - 1); 1276dde5845aSJiri Kosina if (a && a != -1) 1277dde5845aSJiri Kosina return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1; 1278dde5845aSJiri Kosina return value & ((1 << n) - 1); 1279dde5845aSJiri Kosina } 1280dde5845aSJiri Kosina 1281dde5845aSJiri Kosina /* 1282dde5845aSJiri Kosina * Extract/implement a data field from/to a little endian report (bit array). 1283dde5845aSJiri Kosina * 1284dde5845aSJiri Kosina * Code sort-of follows HID spec: 12855137b354SDmitry Torokhov * http://www.usb.org/developers/hidpage/HID1_11.pdf 1286dde5845aSJiri Kosina * 1287dde5845aSJiri Kosina * While the USB HID spec allows unlimited length bit fields in "report 1288dde5845aSJiri Kosina * descriptors", most devices never use more than 16 bits. 1289dde5845aSJiri Kosina * One model of UPS is claimed to report "LINEV" as a 32-bit field. 1290dde5845aSJiri Kosina * Search linux-kernel and linux-usb-devel archives for "hid-core extract". 1291dde5845aSJiri Kosina */ 1292dde5845aSJiri Kosina 12935137b354SDmitry Torokhov static u32 __extract(u8 *report, unsigned offset, int n) 12945137b354SDmitry Torokhov { 12955137b354SDmitry Torokhov unsigned int idx = offset / 8; 12965137b354SDmitry Torokhov unsigned int bit_nr = 0; 12975137b354SDmitry Torokhov unsigned int bit_shift = offset % 8; 12985137b354SDmitry Torokhov int bits_to_copy = 8 - bit_shift; 12995137b354SDmitry Torokhov u32 value = 0; 13005137b354SDmitry Torokhov u32 mask = n < 32 ? (1U << n) - 1 : ~0U; 13015137b354SDmitry Torokhov 13025137b354SDmitry Torokhov while (n > 0) { 13035137b354SDmitry Torokhov value |= ((u32)report[idx] >> bit_shift) << bit_nr; 13045137b354SDmitry Torokhov n -= bits_to_copy; 13055137b354SDmitry Torokhov bit_nr += bits_to_copy; 13065137b354SDmitry Torokhov bits_to_copy = 8; 13075137b354SDmitry Torokhov bit_shift = 0; 13085137b354SDmitry Torokhov idx++; 13095137b354SDmitry Torokhov } 13105137b354SDmitry Torokhov 13115137b354SDmitry Torokhov return value & mask; 13125137b354SDmitry Torokhov } 13135137b354SDmitry Torokhov 13145137b354SDmitry Torokhov u32 hid_field_extract(const struct hid_device *hid, u8 *report, 13154291ee30SJoe Perches unsigned offset, unsigned n) 1316dde5845aSJiri Kosina { 1317*15fc1b5cSBenjamin Tissoires if (n > 32) { 1318*15fc1b5cSBenjamin Tissoires hid_warn(hid, "hid_field_extract() called with n (%d) > 32! (%s)\n", 1319c4124c9bSJiri Kosina n, current->comm); 1320*15fc1b5cSBenjamin Tissoires n = 32; 13215137b354SDmitry Torokhov } 1322dde5845aSJiri Kosina 13235137b354SDmitry Torokhov return __extract(report, offset, n); 1324dde5845aSJiri Kosina } 132504fba786SGoffredo Baroncelli EXPORT_SYMBOL_GPL(hid_field_extract); 1326dde5845aSJiri Kosina 1327dde5845aSJiri Kosina /* 1328dde5845aSJiri Kosina * "implement" : set bits in a little endian bit stream. 1329dde5845aSJiri Kosina * Same concepts as "extract" (see comments above). 1330dde5845aSJiri Kosina * The data mangled in the bit stream remains in little endian 1331dde5845aSJiri Kosina * order the whole time. It make more sense to talk about 1332dde5845aSJiri Kosina * endianness of register values by considering a register 13335137b354SDmitry Torokhov * a "cached" copy of the little endian bit stream. 1334dde5845aSJiri Kosina */ 1335dde5845aSJiri Kosina 13365137b354SDmitry Torokhov static void __implement(u8 *report, unsigned offset, int n, u32 value) 13375137b354SDmitry Torokhov { 13385137b354SDmitry Torokhov unsigned int idx = offset / 8; 13395137b354SDmitry Torokhov unsigned int bit_shift = offset % 8; 13405137b354SDmitry Torokhov int bits_to_set = 8 - bit_shift; 13415137b354SDmitry Torokhov 13425137b354SDmitry Torokhov while (n - bits_to_set >= 0) { 134395d1c895SDmitry Torokhov report[idx] &= ~(0xff << bit_shift); 13445137b354SDmitry Torokhov report[idx] |= value << bit_shift; 13455137b354SDmitry Torokhov value >>= bits_to_set; 13465137b354SDmitry Torokhov n -= bits_to_set; 13475137b354SDmitry Torokhov bits_to_set = 8; 13485137b354SDmitry Torokhov bit_shift = 0; 13495137b354SDmitry Torokhov idx++; 13505137b354SDmitry Torokhov } 13515137b354SDmitry Torokhov 13525137b354SDmitry Torokhov /* last nibble */ 13535137b354SDmitry Torokhov if (n) { 135495d1c895SDmitry Torokhov u8 bit_mask = ((1U << n) - 1); 135595d1c895SDmitry Torokhov report[idx] &= ~(bit_mask << bit_shift); 135695d1c895SDmitry Torokhov report[idx] |= value << bit_shift; 13575137b354SDmitry Torokhov } 13585137b354SDmitry Torokhov } 13595137b354SDmitry Torokhov 13605137b354SDmitry Torokhov static void implement(const struct hid_device *hid, u8 *report, 13615137b354SDmitry Torokhov unsigned offset, unsigned n, u32 value) 13625137b354SDmitry Torokhov { 136395d1c895SDmitry Torokhov if (unlikely(n > 32)) { 13644291ee30SJoe Perches hid_warn(hid, "%s() called with n (%d) > 32! (%s)\n", 13654291ee30SJoe Perches __func__, n, current->comm); 13665137b354SDmitry Torokhov n = 32; 136795d1c895SDmitry Torokhov } else if (n < 32) { 136895d1c895SDmitry Torokhov u32 m = (1U << n) - 1; 1369dde5845aSJiri Kosina 137095d1c895SDmitry Torokhov if (unlikely(value > m)) { 137195d1c895SDmitry Torokhov hid_warn(hid, 137295d1c895SDmitry Torokhov "%s() called with too large value %d (n: %d)! (%s)\n", 137395d1c895SDmitry Torokhov __func__, value, n, current->comm); 137495d1c895SDmitry Torokhov WARN_ON(1); 1375dde5845aSJiri Kosina value &= m; 137695d1c895SDmitry Torokhov } 137795d1c895SDmitry Torokhov } 1378dde5845aSJiri Kosina 13795137b354SDmitry Torokhov __implement(report, offset, n, value); 1380dde5845aSJiri Kosina } 1381dde5845aSJiri Kosina 1382dde5845aSJiri Kosina /* 1383dde5845aSJiri Kosina * Search an array for a value. 1384dde5845aSJiri Kosina */ 1385dde5845aSJiri Kosina 138616ee4cc8SJoe Perches static int search(__s32 *array, __s32 value, unsigned n) 1387dde5845aSJiri Kosina { 1388dde5845aSJiri Kosina while (n--) { 1389dde5845aSJiri Kosina if (*array++ == value) 1390dde5845aSJiri Kosina return 0; 1391dde5845aSJiri Kosina } 1392dde5845aSJiri Kosina return -1; 1393dde5845aSJiri Kosina } 1394dde5845aSJiri Kosina 139585cdaf52SJiri Slaby /** 139685cdaf52SJiri Slaby * hid_match_report - check if driver's raw_event should be called 139785cdaf52SJiri Slaby * 139885cdaf52SJiri Slaby * @hid: hid device 139985cdaf52SJiri Slaby * @report_type: type to match against 140085cdaf52SJiri Slaby * 140185cdaf52SJiri Slaby * compare hid->driver->report_table->report_type to report->type 140285cdaf52SJiri Slaby */ 140385cdaf52SJiri Slaby static int hid_match_report(struct hid_device *hid, struct hid_report *report) 1404dde5845aSJiri Kosina { 140585cdaf52SJiri Slaby const struct hid_report_id *id = hid->driver->report_table; 140685cdaf52SJiri Slaby 140785cdaf52SJiri Slaby if (!id) /* NULL means all */ 140885cdaf52SJiri Slaby return 1; 140985cdaf52SJiri Slaby 141085cdaf52SJiri Slaby for (; id->report_type != HID_TERMINATOR; id++) 141185cdaf52SJiri Slaby if (id->report_type == HID_ANY_ID || 141285cdaf52SJiri Slaby id->report_type == report->type) 141385cdaf52SJiri Slaby return 1; 141485cdaf52SJiri Slaby return 0; 141585cdaf52SJiri Slaby } 141685cdaf52SJiri Slaby 141785cdaf52SJiri Slaby /** 141885cdaf52SJiri Slaby * hid_match_usage - check if driver's event should be called 141985cdaf52SJiri Slaby * 142085cdaf52SJiri Slaby * @hid: hid device 142185cdaf52SJiri Slaby * @usage: usage to match against 142285cdaf52SJiri Slaby * 142385cdaf52SJiri Slaby * compare hid->driver->usage_table->usage_{type,code} to 142485cdaf52SJiri Slaby * usage->usage_{type,code} 142585cdaf52SJiri Slaby */ 142685cdaf52SJiri Slaby static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage) 142785cdaf52SJiri Slaby { 142885cdaf52SJiri Slaby const struct hid_usage_id *id = hid->driver->usage_table; 142985cdaf52SJiri Slaby 143085cdaf52SJiri Slaby if (!id) /* NULL means all */ 143185cdaf52SJiri Slaby return 1; 143285cdaf52SJiri Slaby 143385cdaf52SJiri Slaby for (; id->usage_type != HID_ANY_ID - 1; id++) 143485cdaf52SJiri Slaby if ((id->usage_hid == HID_ANY_ID || 143585cdaf52SJiri Slaby id->usage_hid == usage->hid) && 143685cdaf52SJiri Slaby (id->usage_type == HID_ANY_ID || 143785cdaf52SJiri Slaby id->usage_type == usage->type) && 143885cdaf52SJiri Slaby (id->usage_code == HID_ANY_ID || 143985cdaf52SJiri Slaby id->usage_code == usage->code)) 144085cdaf52SJiri Slaby return 1; 144185cdaf52SJiri Slaby return 0; 144285cdaf52SJiri Slaby } 144385cdaf52SJiri Slaby 144485cdaf52SJiri Slaby static void hid_process_event(struct hid_device *hid, struct hid_field *field, 144585cdaf52SJiri Slaby struct hid_usage *usage, __s32 value, int interrupt) 144685cdaf52SJiri Slaby { 144785cdaf52SJiri Slaby struct hid_driver *hdrv = hid->driver; 144885cdaf52SJiri Slaby int ret; 144985cdaf52SJiri Slaby 14509bfc8da0SHenrik Rydberg if (!list_empty(&hid->debug_list)) 1451cd667ce2SJiri Kosina hid_dump_input(hid, usage, value); 145285cdaf52SJiri Slaby 145385cdaf52SJiri Slaby if (hdrv && hdrv->event && hid_match_usage(hid, usage)) { 145485cdaf52SJiri Slaby ret = hdrv->event(hid, field, usage, value); 145585cdaf52SJiri Slaby if (ret != 0) { 145685cdaf52SJiri Slaby if (ret < 0) 14578c3d52fcSJiri Kosina hid_err(hid, "%s's event failed with %d\n", 145885cdaf52SJiri Slaby hdrv->name, ret); 145985cdaf52SJiri Slaby return; 146085cdaf52SJiri Slaby } 146185cdaf52SJiri Slaby } 146285cdaf52SJiri Slaby 1463dde5845aSJiri Kosina if (hid->claimed & HID_CLAIMED_INPUT) 1464dde5845aSJiri Kosina hidinput_hid_event(hid, field, usage, value); 1465aa938f79SJiri Kosina if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event) 1466aa938f79SJiri Kosina hid->hiddev_hid_event(hid, field, usage, value); 1467dde5845aSJiri Kosina } 1468dde5845aSJiri Kosina 1469dde5845aSJiri Kosina /* 1470dde5845aSJiri Kosina * Analyse a received field, and fetch the data from it. The field 1471dde5845aSJiri Kosina * content is stored for next report processing (we do differential 1472dde5845aSJiri Kosina * reporting to the layer). 1473dde5845aSJiri Kosina */ 1474dde5845aSJiri Kosina 1475abdff0f7SAdrian Bunk static void hid_input_field(struct hid_device *hid, struct hid_field *field, 1476abdff0f7SAdrian Bunk __u8 *data, int interrupt) 1477dde5845aSJiri Kosina { 1478dde5845aSJiri Kosina unsigned n; 1479dde5845aSJiri Kosina unsigned count = field->report_count; 1480dde5845aSJiri Kosina unsigned offset = field->report_offset; 1481dde5845aSJiri Kosina unsigned size = field->report_size; 1482dde5845aSJiri Kosina __s32 min = field->logical_minimum; 1483dde5845aSJiri Kosina __s32 max = field->logical_maximum; 1484dde5845aSJiri Kosina __s32 *value; 1485dde5845aSJiri Kosina 14866da2ec56SKees Cook value = kmalloc_array(count, sizeof(__s32), GFP_ATOMIC); 1487a3789a17SJoe Perches if (!value) 1488dde5845aSJiri Kosina return; 1489dde5845aSJiri Kosina 1490dde5845aSJiri Kosina for (n = 0; n < count; n++) { 1491dde5845aSJiri Kosina 14924291ee30SJoe Perches value[n] = min < 0 ? 149304fba786SGoffredo Baroncelli snto32(hid_field_extract(hid, data, offset + n * size, 149404fba786SGoffredo Baroncelli size), size) : 149504fba786SGoffredo Baroncelli hid_field_extract(hid, data, offset + n * size, size); 1496dde5845aSJiri Kosina 14974291ee30SJoe Perches /* Ignore report if ErrorRollOver */ 14984291ee30SJoe Perches if (!(field->flags & HID_MAIN_ITEM_VARIABLE) && 14994291ee30SJoe Perches value[n] >= min && value[n] <= max && 150050220deaSBenjamin Tissoires value[n] - min < field->maxusage && 15014291ee30SJoe Perches field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1) 1502dde5845aSJiri Kosina goto exit; 1503dde5845aSJiri Kosina } 1504dde5845aSJiri Kosina 1505dde5845aSJiri Kosina for (n = 0; n < count; n++) { 1506dde5845aSJiri Kosina 1507dde5845aSJiri Kosina if (HID_MAIN_ITEM_VARIABLE & field->flags) { 1508dde5845aSJiri Kosina hid_process_event(hid, field, &field->usage[n], value[n], interrupt); 1509dde5845aSJiri Kosina continue; 1510dde5845aSJiri Kosina } 1511dde5845aSJiri Kosina 1512dde5845aSJiri Kosina if (field->value[n] >= min && field->value[n] <= max 151350220deaSBenjamin Tissoires && field->value[n] - min < field->maxusage 1514dde5845aSJiri Kosina && field->usage[field->value[n] - min].hid 1515dde5845aSJiri Kosina && search(value, field->value[n], count)) 1516dde5845aSJiri Kosina hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt); 1517dde5845aSJiri Kosina 1518dde5845aSJiri Kosina if (value[n] >= min && value[n] <= max 151950220deaSBenjamin Tissoires && value[n] - min < field->maxusage 1520dde5845aSJiri Kosina && field->usage[value[n] - min].hid 1521dde5845aSJiri Kosina && search(field->value, value[n], count)) 1522dde5845aSJiri Kosina hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt); 1523dde5845aSJiri Kosina } 1524dde5845aSJiri Kosina 1525dde5845aSJiri Kosina memcpy(field->value, value, count * sizeof(__s32)); 1526dde5845aSJiri Kosina exit: 1527dde5845aSJiri Kosina kfree(value); 1528dde5845aSJiri Kosina } 1529dde5845aSJiri Kosina 1530dde5845aSJiri Kosina /* 1531dde5845aSJiri Kosina * Output the field into the report. 1532dde5845aSJiri Kosina */ 1533dde5845aSJiri Kosina 15344291ee30SJoe Perches static void hid_output_field(const struct hid_device *hid, 15354291ee30SJoe Perches struct hid_field *field, __u8 *data) 1536dde5845aSJiri Kosina { 1537dde5845aSJiri Kosina unsigned count = field->report_count; 1538dde5845aSJiri Kosina unsigned offset = field->report_offset; 1539dde5845aSJiri Kosina unsigned size = field->report_size; 1540dde5845aSJiri Kosina unsigned n; 1541dde5845aSJiri Kosina 1542dde5845aSJiri Kosina for (n = 0; n < count; n++) { 1543dde5845aSJiri Kosina if (field->logical_minimum < 0) /* signed values */ 15444291ee30SJoe Perches implement(hid, data, offset + n * size, size, 15454291ee30SJoe Perches s32ton(field->value[n], size)); 1546dde5845aSJiri Kosina else /* unsigned values */ 15474291ee30SJoe Perches implement(hid, data, offset + n * size, size, 15484291ee30SJoe Perches field->value[n]); 1549dde5845aSJiri Kosina } 1550dde5845aSJiri Kosina } 1551dde5845aSJiri Kosina 1552dde5845aSJiri Kosina /* 155327ce4050SJiri Kosina * Create a report. 'data' has to be allocated using 155427ce4050SJiri Kosina * hid_alloc_report_buf() so that it has proper size. 1555dde5845aSJiri Kosina */ 1556dde5845aSJiri Kosina 1557229695e5SJiri Kosina void hid_output_report(struct hid_report *report, __u8 *data) 1558dde5845aSJiri Kosina { 1559dde5845aSJiri Kosina unsigned n; 1560dde5845aSJiri Kosina 1561dde5845aSJiri Kosina if (report->id > 0) 1562dde5845aSJiri Kosina *data++ = report->id; 1563dde5845aSJiri Kosina 156475c28df8SPete Zaitcev memset(data, 0, ((report->size - 1) >> 3) + 1); 1565dde5845aSJiri Kosina for (n = 0; n < report->maxfield; n++) 15664291ee30SJoe Perches hid_output_field(report->device, report->field[n], data); 1567dde5845aSJiri Kosina } 1568229695e5SJiri Kosina EXPORT_SYMBOL_GPL(hid_output_report); 1569dde5845aSJiri Kosina 1570dde5845aSJiri Kosina /* 157127ce4050SJiri Kosina * Allocator for buffer that is going to be passed to hid_output_report() 157227ce4050SJiri Kosina */ 157327ce4050SJiri Kosina u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags) 157427ce4050SJiri Kosina { 157527ce4050SJiri Kosina /* 157627ce4050SJiri Kosina * 7 extra bytes are necessary to achieve proper functionality 157727ce4050SJiri Kosina * of implement() working on 8 byte chunks 157827ce4050SJiri Kosina */ 157927ce4050SJiri Kosina 15806de0b13cSAaron Ma u32 len = hid_report_len(report) + 7; 158127ce4050SJiri Kosina 158227ce4050SJiri Kosina return kmalloc(len, flags); 158327ce4050SJiri Kosina } 158427ce4050SJiri Kosina EXPORT_SYMBOL_GPL(hid_alloc_report_buf); 158527ce4050SJiri Kosina 158627ce4050SJiri Kosina /* 1587dde5845aSJiri Kosina * Set a field value. The report this field belongs to has to be 1588dde5845aSJiri Kosina * created and transferred to the device, to set this value in the 1589dde5845aSJiri Kosina * device. 1590dde5845aSJiri Kosina */ 1591dde5845aSJiri Kosina 1592dde5845aSJiri Kosina int hid_set_field(struct hid_field *field, unsigned offset, __s32 value) 1593dde5845aSJiri Kosina { 1594be67b68dSKees Cook unsigned size; 1595be67b68dSKees Cook 1596be67b68dSKees Cook if (!field) 1597be67b68dSKees Cook return -1; 1598be67b68dSKees Cook 1599be67b68dSKees Cook size = field->report_size; 1600dde5845aSJiri Kosina 1601cd667ce2SJiri Kosina hid_dump_input(field->report->device, field->usage + offset, value); 1602dde5845aSJiri Kosina 1603dde5845aSJiri Kosina if (offset >= field->report_count) { 16048c3d52fcSJiri Kosina hid_err(field->report->device, "offset (%d) exceeds report_count (%d)\n", 16058c3d52fcSJiri Kosina offset, field->report_count); 1606dde5845aSJiri Kosina return -1; 1607dde5845aSJiri Kosina } 1608dde5845aSJiri Kosina if (field->logical_minimum < 0) { 1609dde5845aSJiri Kosina if (value != snto32(s32ton(value, size), size)) { 16108c3d52fcSJiri Kosina hid_err(field->report->device, "value %d is out of range\n", value); 1611dde5845aSJiri Kosina return -1; 1612dde5845aSJiri Kosina } 1613dde5845aSJiri Kosina } 1614dde5845aSJiri Kosina field->value[offset] = value; 1615dde5845aSJiri Kosina return 0; 1616dde5845aSJiri Kosina } 1617229695e5SJiri Kosina EXPORT_SYMBOL_GPL(hid_set_field); 1618dde5845aSJiri Kosina 161985cdaf52SJiri Slaby static struct hid_report *hid_get_report(struct hid_report_enum *report_enum, 162085cdaf52SJiri Slaby const u8 *data) 162185cdaf52SJiri Slaby { 162285cdaf52SJiri Slaby struct hid_report *report; 162385cdaf52SJiri Slaby unsigned int n = 0; /* Normally report number is 0 */ 162485cdaf52SJiri Slaby 162585cdaf52SJiri Slaby /* Device uses numbered reports, data[0] is report number */ 162685cdaf52SJiri Slaby if (report_enum->numbered) 162785cdaf52SJiri Slaby n = *data; 162885cdaf52SJiri Slaby 162985cdaf52SJiri Slaby report = report_enum->report_id_hash[n]; 163085cdaf52SJiri Slaby if (report == NULL) 163185cdaf52SJiri Slaby dbg_hid("undefined report_id %u received\n", n); 163285cdaf52SJiri Slaby 163385cdaf52SJiri Slaby return report; 163485cdaf52SJiri Slaby } 163585cdaf52SJiri Slaby 16364fa5a7f7SBenjamin Tissoires /* 16374fa5a7f7SBenjamin Tissoires * Implement a generic .request() callback, using .raw_request() 16384fa5a7f7SBenjamin Tissoires * DO NOT USE in hid drivers directly, but through hid_hw_request instead. 16394fa5a7f7SBenjamin Tissoires */ 1640d43c17eaSBenjamin Tissoires int __hid_request(struct hid_device *hid, struct hid_report *report, 16414fa5a7f7SBenjamin Tissoires int reqtype) 16424fa5a7f7SBenjamin Tissoires { 16434fa5a7f7SBenjamin Tissoires char *buf; 16444fa5a7f7SBenjamin Tissoires int ret; 16456de0b13cSAaron Ma u32 len; 16464fa5a7f7SBenjamin Tissoires 16474fa5a7f7SBenjamin Tissoires buf = hid_alloc_report_buf(report, GFP_KERNEL); 16484fa5a7f7SBenjamin Tissoires if (!buf) 1649d43c17eaSBenjamin Tissoires return -ENOMEM; 16504fa5a7f7SBenjamin Tissoires 16514fa5a7f7SBenjamin Tissoires len = hid_report_len(report); 16524fa5a7f7SBenjamin Tissoires 16534fa5a7f7SBenjamin Tissoires if (reqtype == HID_REQ_SET_REPORT) 16544fa5a7f7SBenjamin Tissoires hid_output_report(report, buf); 16554fa5a7f7SBenjamin Tissoires 16564fa5a7f7SBenjamin Tissoires ret = hid->ll_driver->raw_request(hid, report->id, buf, len, 16574fa5a7f7SBenjamin Tissoires report->type, reqtype); 16584fa5a7f7SBenjamin Tissoires if (ret < 0) { 16594fa5a7f7SBenjamin Tissoires dbg_hid("unable to complete request: %d\n", ret); 16604fa5a7f7SBenjamin Tissoires goto out; 16614fa5a7f7SBenjamin Tissoires } 16624fa5a7f7SBenjamin Tissoires 16634fa5a7f7SBenjamin Tissoires if (reqtype == HID_REQ_GET_REPORT) 16644fa5a7f7SBenjamin Tissoires hid_input_report(hid, report->type, buf, ret, 0); 16654fa5a7f7SBenjamin Tissoires 1666d43c17eaSBenjamin Tissoires ret = 0; 1667d43c17eaSBenjamin Tissoires 16684fa5a7f7SBenjamin Tissoires out: 16694fa5a7f7SBenjamin Tissoires kfree(buf); 1670d43c17eaSBenjamin Tissoires return ret; 16714fa5a7f7SBenjamin Tissoires } 16724fa5a7f7SBenjamin Tissoires EXPORT_SYMBOL_GPL(__hid_request); 16734fa5a7f7SBenjamin Tissoires 16746de0b13cSAaron Ma int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size, 167585cdaf52SJiri Slaby int interrupt) 1676aa8de2f0SJiri Kosina { 1677aa8de2f0SJiri Kosina struct hid_report_enum *report_enum = hid->report_enum + type; 1678aa8de2f0SJiri Kosina struct hid_report *report; 16796d85d037SBenjamin Tissoires struct hid_driver *hdrv; 168085cdaf52SJiri Slaby unsigned int a; 16816de0b13cSAaron Ma u32 rsize, csize = size; 168285cdaf52SJiri Slaby u8 *cdata = data; 1683b6787242SJiri Kosina int ret = 0; 1684aa8de2f0SJiri Kosina 168585cdaf52SJiri Slaby report = hid_get_report(report_enum, data); 168685cdaf52SJiri Slaby if (!report) 1687b6787242SJiri Kosina goto out; 1688aa8de2f0SJiri Kosina 168985cdaf52SJiri Slaby if (report_enum->numbered) { 169085cdaf52SJiri Slaby cdata++; 169185cdaf52SJiri Slaby csize--; 1692aa8de2f0SJiri Kosina } 1693aa8de2f0SJiri Kosina 1694aa8de2f0SJiri Kosina rsize = ((report->size - 1) >> 3) + 1; 1695aa8de2f0SJiri Kosina 1696966922f2SArmando Visconti if (rsize > HID_MAX_BUFFER_SIZE) 1697966922f2SArmando Visconti rsize = HID_MAX_BUFFER_SIZE; 1698966922f2SArmando Visconti 169985cdaf52SJiri Slaby if (csize < rsize) { 170085cdaf52SJiri Slaby dbg_hid("report %d is too short, (%d < %d)\n", report->id, 170185cdaf52SJiri Slaby csize, rsize); 170285cdaf52SJiri Slaby memset(cdata + csize, 0, rsize - csize); 1703aa8de2f0SJiri Kosina } 1704aa8de2f0SJiri Kosina 1705aa8de2f0SJiri Kosina if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event) 1706aa8de2f0SJiri Kosina hid->hiddev_report_event(hid, report); 1707b6787242SJiri Kosina if (hid->claimed & HID_CLAIMED_HIDRAW) { 1708b6787242SJiri Kosina ret = hidraw_report_event(hid, data, size); 1709b6787242SJiri Kosina if (ret) 1710b6787242SJiri Kosina goto out; 1711b6787242SJiri Kosina } 1712aa8de2f0SJiri Kosina 1713cc6b54aaSBenjamin Tissoires if (hid->claimed != HID_CLAIMED_HIDRAW && report->maxfield) { 171485cdaf52SJiri Slaby for (a = 0; a < report->maxfield; a++) 171585cdaf52SJiri Slaby hid_input_field(hid, report->field[a], cdata, interrupt); 17166d85d037SBenjamin Tissoires hdrv = hid->driver; 17176d85d037SBenjamin Tissoires if (hdrv && hdrv->report) 17186d85d037SBenjamin Tissoires hdrv->report(hid, report); 1719b94e3c94SMatthieu CASTET } 1720aa8de2f0SJiri Kosina 1721aa8de2f0SJiri Kosina if (hid->claimed & HID_CLAIMED_INPUT) 1722aa8de2f0SJiri Kosina hidinput_report_event(hid, report); 1723b6787242SJiri Kosina out: 1724b6787242SJiri Kosina return ret; 172585cdaf52SJiri Slaby } 172685cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_report_raw_event); 172785cdaf52SJiri Slaby 172885cdaf52SJiri Slaby /** 172985cdaf52SJiri Slaby * hid_input_report - report data from lower layer (usb, bt...) 173085cdaf52SJiri Slaby * 173185cdaf52SJiri Slaby * @hid: hid device 173285cdaf52SJiri Slaby * @type: HID report type (HID_*_REPORT) 173385cdaf52SJiri Slaby * @data: report contents 173485cdaf52SJiri Slaby * @size: size of data parameter 1735ff9b00a2SJiri Kosina * @interrupt: distinguish between interrupt and control transfers 173685cdaf52SJiri Slaby * 173785cdaf52SJiri Slaby * This is data entry for lower layers. 173885cdaf52SJiri Slaby */ 17396de0b13cSAaron Ma int hid_input_report(struct hid_device *hid, int type, u8 *data, u32 size, int interrupt) 174085cdaf52SJiri Slaby { 174176c317d6SJulia Lawall struct hid_report_enum *report_enum; 174276c317d6SJulia Lawall struct hid_driver *hdrv; 174385cdaf52SJiri Slaby struct hid_report *report; 174445dc1ac7SJiri Kosina int ret = 0; 174585cdaf52SJiri Slaby 17464ea54542SDavid Herrmann if (!hid) 174785cdaf52SJiri Slaby return -ENODEV; 17484ea54542SDavid Herrmann 1749c849a614SAndrew de los Reyes if (down_trylock(&hid->driver_input_lock)) 17504ea54542SDavid Herrmann return -EBUSY; 17514ea54542SDavid Herrmann 17524ea54542SDavid Herrmann if (!hid->driver) { 17534ea54542SDavid Herrmann ret = -ENODEV; 17544ea54542SDavid Herrmann goto unlock; 17554ea54542SDavid Herrmann } 175676c317d6SJulia Lawall report_enum = hid->report_enum + type; 175776c317d6SJulia Lawall hdrv = hid->driver; 175885cdaf52SJiri Slaby 175985cdaf52SJiri Slaby if (!size) { 176085cdaf52SJiri Slaby dbg_hid("empty report\n"); 17614ea54542SDavid Herrmann ret = -1; 17624ea54542SDavid Herrmann goto unlock; 176385cdaf52SJiri Slaby } 176485cdaf52SJiri Slaby 1765b94e3c94SMatthieu CASTET /* Avoid unnecessary overhead if debugfs is disabled */ 1766a5f04b9dSBenjamin Tissoires if (!list_empty(&hid->debug_list)) 1767a5f04b9dSBenjamin Tissoires hid_dump_report(hid, type, data, size); 1768b94e3c94SMatthieu CASTET 1769f77e347bSJiri Kosina report = hid_get_report(report_enum, data); 1770f77e347bSJiri Kosina 17714ea54542SDavid Herrmann if (!report) { 17724ea54542SDavid Herrmann ret = -1; 17734ea54542SDavid Herrmann goto unlock; 17744ea54542SDavid Herrmann } 1775f77e347bSJiri Kosina 177685cdaf52SJiri Slaby if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) { 177785cdaf52SJiri Slaby ret = hdrv->raw_event(hid, report, data, size); 1778556483e2SFelix Rueegg if (ret < 0) 17794ea54542SDavid Herrmann goto unlock; 17804ea54542SDavid Herrmann } 178185cdaf52SJiri Slaby 1782b6787242SJiri Kosina ret = hid_report_raw_event(hid, type, data, size, interrupt); 1783aa8de2f0SJiri Kosina 17844ea54542SDavid Herrmann unlock: 1785c849a614SAndrew de los Reyes up(&hid->driver_input_lock); 178645dc1ac7SJiri Kosina return ret; 1787aa8de2f0SJiri Kosina } 1788aa8de2f0SJiri Kosina EXPORT_SYMBOL_GPL(hid_input_report); 1789aa8de2f0SJiri Kosina 1790d5d3e202SBenjamin Tissoires bool hid_match_one_id(const struct hid_device *hdev, 17910f37cd03SJiri Kosina const struct hid_device_id *id) 17920f37cd03SJiri Kosina { 17937431fb76SHenrik Rydberg return (id->bus == HID_BUS_ANY || id->bus == hdev->bus) && 17944d53b801SHenrik Rydberg (id->group == HID_GROUP_ANY || id->group == hdev->group) && 17950f37cd03SJiri Kosina (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) && 17960f37cd03SJiri Kosina (id->product == HID_ANY_ID || id->product == hdev->product); 17970f37cd03SJiri Kosina } 17980f37cd03SJiri Kosina 1799d5d3e202SBenjamin Tissoires const struct hid_device_id *hid_match_id(const struct hid_device *hdev, 18000f37cd03SJiri Kosina const struct hid_device_id *id) 18010f37cd03SJiri Kosina { 18020f37cd03SJiri Kosina for (; id->bus; id++) 18030f37cd03SJiri Kosina if (hid_match_one_id(hdev, id)) 18040f37cd03SJiri Kosina return id; 18050f37cd03SJiri Kosina 18060f37cd03SJiri Kosina return NULL; 18070f37cd03SJiri Kosina } 18080f37cd03SJiri Kosina 18090f37cd03SJiri Kosina static const struct hid_device_id hid_hiddev_list[] = { 1810c0bd6a42SRichard Hughes { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) }, 1811c0bd6a42SRichard Hughes { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) }, 18120f37cd03SJiri Kosina { } 18130f37cd03SJiri Kosina }; 18140f37cd03SJiri Kosina 18150f37cd03SJiri Kosina static bool hid_hiddev(struct hid_device *hdev) 18160f37cd03SJiri Kosina { 18170f37cd03SJiri Kosina return !!hid_match_id(hdev, hid_hiddev_list); 18180f37cd03SJiri Kosina } 18190f37cd03SJiri Kosina 18206d3bfb74SAlan Ott 18216d3bfb74SAlan Ott static ssize_t 18226d3bfb74SAlan Ott read_report_descriptor(struct file *filp, struct kobject *kobj, 18236d3bfb74SAlan Ott struct bin_attribute *attr, 18246d3bfb74SAlan Ott char *buf, loff_t off, size_t count) 18256d3bfb74SAlan Ott { 18262cf83833SGeliang Tang struct device *dev = kobj_to_dev(kobj); 1827ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 18286d3bfb74SAlan Ott 18296d3bfb74SAlan Ott if (off >= hdev->rsize) 18306d3bfb74SAlan Ott return 0; 18316d3bfb74SAlan Ott 18326d3bfb74SAlan Ott if (off + count > hdev->rsize) 18336d3bfb74SAlan Ott count = hdev->rsize - off; 18346d3bfb74SAlan Ott 18356d3bfb74SAlan Ott memcpy(buf, hdev->rdesc + off, count); 18366d3bfb74SAlan Ott 18376d3bfb74SAlan Ott return count; 18386d3bfb74SAlan Ott } 18396d3bfb74SAlan Ott 1840a877417eSOlivier Gay static ssize_t 1841a877417eSOlivier Gay show_country(struct device *dev, struct device_attribute *attr, 1842a877417eSOlivier Gay char *buf) 1843a877417eSOlivier Gay { 1844ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 1845a877417eSOlivier Gay 1846a877417eSOlivier Gay return sprintf(buf, "%02x\n", hdev->country & 0xff); 1847a877417eSOlivier Gay } 1848a877417eSOlivier Gay 18496d3bfb74SAlan Ott static struct bin_attribute dev_bin_attr_report_desc = { 18506d3bfb74SAlan Ott .attr = { .name = "report_descriptor", .mode = 0444 }, 18516d3bfb74SAlan Ott .read = read_report_descriptor, 18526d3bfb74SAlan Ott .size = HID_MAX_DESCRIPTOR_SIZE, 18536d3bfb74SAlan Ott }; 18546d3bfb74SAlan Ott 1855ad8378edSBhumika Goyal static const struct device_attribute dev_attr_country = { 1856a877417eSOlivier Gay .attr = { .name = "country", .mode = 0444 }, 1857a877417eSOlivier Gay .show = show_country, 1858a877417eSOlivier Gay }; 1859a877417eSOlivier Gay 186093c10132SJiri Slaby int hid_connect(struct hid_device *hdev, unsigned int connect_mask) 186193c10132SJiri Slaby { 186293c10132SJiri Slaby static const char *types[] = { "Device", "Pointer", "Mouse", "Device", 186393c10132SJiri Slaby "Joystick", "Gamepad", "Keyboard", "Keypad", 186493c10132SJiri Slaby "Multi-Axis Controller" 186593c10132SJiri Slaby }; 186693c10132SJiri Slaby const char *type, *bus; 186779b568b9SRichard Purdie char buf[64] = ""; 186893c10132SJiri Slaby unsigned int i; 186993c10132SJiri Slaby int len; 18706d3bfb74SAlan Ott int ret; 187193c10132SJiri Slaby 1872b5e5a37eSBastien Nocera if (hdev->quirks & HID_QUIRK_HIDDEV_FORCE) 1873b5e5a37eSBastien Nocera connect_mask |= (HID_CONNECT_HIDDEV_FORCE | HID_CONNECT_HIDDEV); 18743a343ee4SDaniel Mack if (hdev->quirks & HID_QUIRK_HIDINPUT_FORCE) 18753a343ee4SDaniel Mack connect_mask |= HID_CONNECT_HIDINPUT_FORCE; 187693c10132SJiri Slaby if (hdev->bus != BUS_USB) 187793c10132SJiri Slaby connect_mask &= ~HID_CONNECT_HIDDEV; 18780f37cd03SJiri Kosina if (hid_hiddev(hdev)) 18790f37cd03SJiri Kosina connect_mask |= HID_CONNECT_HIDDEV_FORCE; 188093c10132SJiri Slaby 188193c10132SJiri Slaby if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev, 188293c10132SJiri Slaby connect_mask & HID_CONNECT_HIDINPUT_FORCE)) 188393c10132SJiri Slaby hdev->claimed |= HID_CLAIMED_INPUT; 1884b77c3920SBenjamin Tissoires 188593c10132SJiri Slaby if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect && 188693c10132SJiri Slaby !hdev->hiddev_connect(hdev, 188793c10132SJiri Slaby connect_mask & HID_CONNECT_HIDDEV_FORCE)) 188893c10132SJiri Slaby hdev->claimed |= HID_CLAIMED_HIDDEV; 188993c10132SJiri Slaby if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev)) 189093c10132SJiri Slaby hdev->claimed |= HID_CLAIMED_HIDRAW; 189193c10132SJiri Slaby 18927704ac93SBenjamin Tissoires if (connect_mask & HID_CONNECT_DRIVER) 18937704ac93SBenjamin Tissoires hdev->claimed |= HID_CLAIMED_DRIVER; 18947704ac93SBenjamin Tissoires 18954bc19f62SDavid Herrmann /* Drivers with the ->raw_event callback set are not required to connect 18964bc19f62SDavid Herrmann * to any other listener. */ 18974bc19f62SDavid Herrmann if (!hdev->claimed && !hdev->driver->raw_event) { 18984bc19f62SDavid Herrmann hid_err(hdev, "device has no listeners, quitting\n"); 189993c10132SJiri Slaby return -ENODEV; 190093c10132SJiri Slaby } 190193c10132SJiri Slaby 190293c10132SJiri Slaby if ((hdev->claimed & HID_CLAIMED_INPUT) && 190393c10132SJiri Slaby (connect_mask & HID_CONNECT_FF) && hdev->ff_init) 190493c10132SJiri Slaby hdev->ff_init(hdev); 190593c10132SJiri Slaby 190693c10132SJiri Slaby len = 0; 190793c10132SJiri Slaby if (hdev->claimed & HID_CLAIMED_INPUT) 190893c10132SJiri Slaby len += sprintf(buf + len, "input"); 190993c10132SJiri Slaby if (hdev->claimed & HID_CLAIMED_HIDDEV) 191093c10132SJiri Slaby len += sprintf(buf + len, "%shiddev%d", len ? "," : "", 1911733aca90SJaejoong Kim ((struct hiddev *)hdev->hiddev)->minor); 191293c10132SJiri Slaby if (hdev->claimed & HID_CLAIMED_HIDRAW) 191393c10132SJiri Slaby len += sprintf(buf + len, "%shidraw%d", len ? "," : "", 191493c10132SJiri Slaby ((struct hidraw *)hdev->hidraw)->minor); 191593c10132SJiri Slaby 191693c10132SJiri Slaby type = "Device"; 191793c10132SJiri Slaby for (i = 0; i < hdev->maxcollection; i++) { 191893c10132SJiri Slaby struct hid_collection *col = &hdev->collection[i]; 191993c10132SJiri Slaby if (col->type == HID_COLLECTION_APPLICATION && 192093c10132SJiri Slaby (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK && 192193c10132SJiri Slaby (col->usage & 0xffff) < ARRAY_SIZE(types)) { 192293c10132SJiri Slaby type = types[col->usage & 0xffff]; 192393c10132SJiri Slaby break; 192493c10132SJiri Slaby } 192593c10132SJiri Slaby } 192693c10132SJiri Slaby 192793c10132SJiri Slaby switch (hdev->bus) { 192893c10132SJiri Slaby case BUS_USB: 192993c10132SJiri Slaby bus = "USB"; 193093c10132SJiri Slaby break; 193193c10132SJiri Slaby case BUS_BLUETOOTH: 193293c10132SJiri Slaby bus = "BLUETOOTH"; 193393c10132SJiri Slaby break; 193406780727SDaniel Martin case BUS_I2C: 193506780727SDaniel Martin bus = "I2C"; 193606780727SDaniel Martin break; 193793c10132SJiri Slaby default: 193893c10132SJiri Slaby bus = "<UNKNOWN>"; 193993c10132SJiri Slaby } 194093c10132SJiri Slaby 1941a877417eSOlivier Gay ret = device_create_file(&hdev->dev, &dev_attr_country); 1942a877417eSOlivier Gay if (ret) 1943a877417eSOlivier Gay hid_warn(hdev, 1944a877417eSOlivier Gay "can't create sysfs country code attribute err: %d\n", ret); 1945a877417eSOlivier Gay 19464291ee30SJoe Perches hid_info(hdev, "%s: %s HID v%x.%02x %s [%s] on %s\n", 194793c10132SJiri Slaby buf, bus, hdev->version >> 8, hdev->version & 0xff, 194893c10132SJiri Slaby type, hdev->name, hdev->phys); 194993c10132SJiri Slaby 195093c10132SJiri Slaby return 0; 195193c10132SJiri Slaby } 195293c10132SJiri Slaby EXPORT_SYMBOL_GPL(hid_connect); 195393c10132SJiri Slaby 1954c4c259bcSJiri Kosina void hid_disconnect(struct hid_device *hdev) 1955c4c259bcSJiri Kosina { 1956a877417eSOlivier Gay device_remove_file(&hdev->dev, &dev_attr_country); 1957c4c259bcSJiri Kosina if (hdev->claimed & HID_CLAIMED_INPUT) 1958c4c259bcSJiri Kosina hidinput_disconnect(hdev); 1959c4c259bcSJiri Kosina if (hdev->claimed & HID_CLAIMED_HIDDEV) 1960c4c259bcSJiri Kosina hdev->hiddev_disconnect(hdev); 1961c4c259bcSJiri Kosina if (hdev->claimed & HID_CLAIMED_HIDRAW) 1962c4c259bcSJiri Kosina hidraw_disconnect(hdev); 19639c5c6ed7SBenjamin Tissoires hdev->claimed = 0; 1964c4c259bcSJiri Kosina } 1965c4c259bcSJiri Kosina EXPORT_SYMBOL_GPL(hid_disconnect); 1966c4c259bcSJiri Kosina 1967aaac082dSDmitry Torokhov /** 1968aaac082dSDmitry Torokhov * hid_hw_start - start underlying HW 1969aaac082dSDmitry Torokhov * @hdev: hid device 1970aaac082dSDmitry Torokhov * @connect_mask: which outputs to connect, see HID_CONNECT_* 1971aaac082dSDmitry Torokhov * 1972aaac082dSDmitry Torokhov * Call this in probe function *after* hid_parse. This will setup HW 1973aaac082dSDmitry Torokhov * buffers and start the device (if not defeirred to device open). 1974aaac082dSDmitry Torokhov * hid_hw_stop must be called if this was successful. 1975aaac082dSDmitry Torokhov */ 1976aaac082dSDmitry Torokhov int hid_hw_start(struct hid_device *hdev, unsigned int connect_mask) 1977aaac082dSDmitry Torokhov { 1978aaac082dSDmitry Torokhov int error; 1979aaac082dSDmitry Torokhov 1980aaac082dSDmitry Torokhov error = hdev->ll_driver->start(hdev); 1981aaac082dSDmitry Torokhov if (error) 1982aaac082dSDmitry Torokhov return error; 1983aaac082dSDmitry Torokhov 1984aaac082dSDmitry Torokhov if (connect_mask) { 1985aaac082dSDmitry Torokhov error = hid_connect(hdev, connect_mask); 1986aaac082dSDmitry Torokhov if (error) { 1987aaac082dSDmitry Torokhov hdev->ll_driver->stop(hdev); 1988aaac082dSDmitry Torokhov return error; 1989aaac082dSDmitry Torokhov } 1990aaac082dSDmitry Torokhov } 1991aaac082dSDmitry Torokhov 1992aaac082dSDmitry Torokhov return 0; 1993aaac082dSDmitry Torokhov } 1994aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_start); 1995aaac082dSDmitry Torokhov 1996aaac082dSDmitry Torokhov /** 1997aaac082dSDmitry Torokhov * hid_hw_stop - stop underlying HW 1998aaac082dSDmitry Torokhov * @hdev: hid device 1999aaac082dSDmitry Torokhov * 2000aaac082dSDmitry Torokhov * This is usually called from remove function or from probe when something 2001aaac082dSDmitry Torokhov * failed and hid_hw_start was called already. 2002aaac082dSDmitry Torokhov */ 2003aaac082dSDmitry Torokhov void hid_hw_stop(struct hid_device *hdev) 2004aaac082dSDmitry Torokhov { 2005aaac082dSDmitry Torokhov hid_disconnect(hdev); 2006aaac082dSDmitry Torokhov hdev->ll_driver->stop(hdev); 2007aaac082dSDmitry Torokhov } 2008aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_stop); 2009aaac082dSDmitry Torokhov 2010aaac082dSDmitry Torokhov /** 2011aaac082dSDmitry Torokhov * hid_hw_open - signal underlying HW to start delivering events 2012aaac082dSDmitry Torokhov * @hdev: hid device 2013aaac082dSDmitry Torokhov * 2014aaac082dSDmitry Torokhov * Tell underlying HW to start delivering events from the device. 2015aaac082dSDmitry Torokhov * This function should be called sometime after successful call 2016d6c70a86SHisao Tanabe * to hid_hw_start(). 2017aaac082dSDmitry Torokhov */ 2018aaac082dSDmitry Torokhov int hid_hw_open(struct hid_device *hdev) 2019aaac082dSDmitry Torokhov { 2020aaac082dSDmitry Torokhov int ret; 2021aaac082dSDmitry Torokhov 2022aaac082dSDmitry Torokhov ret = mutex_lock_killable(&hdev->ll_open_lock); 2023aaac082dSDmitry Torokhov if (ret) 2024aaac082dSDmitry Torokhov return ret; 2025aaac082dSDmitry Torokhov 2026aaac082dSDmitry Torokhov if (!hdev->ll_open_count++) { 2027aaac082dSDmitry Torokhov ret = hdev->ll_driver->open(hdev); 2028aaac082dSDmitry Torokhov if (ret) 2029aaac082dSDmitry Torokhov hdev->ll_open_count--; 2030aaac082dSDmitry Torokhov } 2031aaac082dSDmitry Torokhov 2032aaac082dSDmitry Torokhov mutex_unlock(&hdev->ll_open_lock); 2033aaac082dSDmitry Torokhov return ret; 2034aaac082dSDmitry Torokhov } 2035aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_open); 2036aaac082dSDmitry Torokhov 2037aaac082dSDmitry Torokhov /** 2038aaac082dSDmitry Torokhov * hid_hw_close - signal underlaying HW to stop delivering events 2039aaac082dSDmitry Torokhov * 2040aaac082dSDmitry Torokhov * @hdev: hid device 2041aaac082dSDmitry Torokhov * 2042aaac082dSDmitry Torokhov * This function indicates that we are not interested in the events 2043aaac082dSDmitry Torokhov * from this device anymore. Delivery of events may or may not stop, 2044aaac082dSDmitry Torokhov * depending on the number of users still outstanding. 2045aaac082dSDmitry Torokhov */ 2046aaac082dSDmitry Torokhov void hid_hw_close(struct hid_device *hdev) 2047aaac082dSDmitry Torokhov { 2048aaac082dSDmitry Torokhov mutex_lock(&hdev->ll_open_lock); 2049aaac082dSDmitry Torokhov if (!--hdev->ll_open_count) 2050aaac082dSDmitry Torokhov hdev->ll_driver->close(hdev); 2051aaac082dSDmitry Torokhov mutex_unlock(&hdev->ll_open_lock); 2052aaac082dSDmitry Torokhov } 2053aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_close); 2054aaac082dSDmitry Torokhov 20553a6f82f7SJiri Slaby struct hid_dynid { 20563a6f82f7SJiri Slaby struct list_head list; 20573a6f82f7SJiri Slaby struct hid_device_id id; 20583a6f82f7SJiri Slaby }; 20593a6f82f7SJiri Slaby 20603a6f82f7SJiri Slaby /** 20613a6f82f7SJiri Slaby * store_new_id - add a new HID device ID to this driver and re-probe devices 20623a6f82f7SJiri Slaby * @driver: target device driver 20633a6f82f7SJiri Slaby * @buf: buffer for scanning device ID data 20643a6f82f7SJiri Slaby * @count: input size 20653a6f82f7SJiri Slaby * 20663a6f82f7SJiri Slaby * Adds a new dynamic hid device ID to this driver, 20673a6f82f7SJiri Slaby * and causes the driver to probe for all devices again. 20683a6f82f7SJiri Slaby */ 2069c2810325SGreg Kroah-Hartman static ssize_t new_id_store(struct device_driver *drv, const char *buf, 20703a6f82f7SJiri Slaby size_t count) 20713a6f82f7SJiri Slaby { 2072ba91a967SGeliang Tang struct hid_driver *hdrv = to_hid_driver(drv); 20733a6f82f7SJiri Slaby struct hid_dynid *dynid; 20743a6f82f7SJiri Slaby __u32 bus, vendor, product; 20753a6f82f7SJiri Slaby unsigned long driver_data = 0; 20763a6f82f7SJiri Slaby int ret; 20773a6f82f7SJiri Slaby 20783a6f82f7SJiri Slaby ret = sscanf(buf, "%x %x %x %lx", 20793a6f82f7SJiri Slaby &bus, &vendor, &product, &driver_data); 20803a6f82f7SJiri Slaby if (ret < 3) 20813a6f82f7SJiri Slaby return -EINVAL; 20823a6f82f7SJiri Slaby 20833a6f82f7SJiri Slaby dynid = kzalloc(sizeof(*dynid), GFP_KERNEL); 20843a6f82f7SJiri Slaby if (!dynid) 20853a6f82f7SJiri Slaby return -ENOMEM; 20863a6f82f7SJiri Slaby 20873a6f82f7SJiri Slaby dynid->id.bus = bus; 20884d53b801SHenrik Rydberg dynid->id.group = HID_GROUP_ANY; 20893a6f82f7SJiri Slaby dynid->id.vendor = vendor; 20903a6f82f7SJiri Slaby dynid->id.product = product; 20913a6f82f7SJiri Slaby dynid->id.driver_data = driver_data; 20923a6f82f7SJiri Slaby 20933a6f82f7SJiri Slaby spin_lock(&hdrv->dyn_lock); 20943a6f82f7SJiri Slaby list_add_tail(&dynid->list, &hdrv->dyn_list); 20953a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 20963a6f82f7SJiri Slaby 20973a6f82f7SJiri Slaby ret = driver_attach(&hdrv->driver); 20983a6f82f7SJiri Slaby 20993a6f82f7SJiri Slaby return ret ? : count; 21003a6f82f7SJiri Slaby } 2101c2810325SGreg Kroah-Hartman static DRIVER_ATTR_WO(new_id); 2102c2810325SGreg Kroah-Hartman 2103c2810325SGreg Kroah-Hartman static struct attribute *hid_drv_attrs[] = { 2104c2810325SGreg Kroah-Hartman &driver_attr_new_id.attr, 2105c2810325SGreg Kroah-Hartman NULL, 2106c2810325SGreg Kroah-Hartman }; 2107c2810325SGreg Kroah-Hartman ATTRIBUTE_GROUPS(hid_drv); 21083a6f82f7SJiri Slaby 21093a6f82f7SJiri Slaby static void hid_free_dynids(struct hid_driver *hdrv) 21103a6f82f7SJiri Slaby { 21113a6f82f7SJiri Slaby struct hid_dynid *dynid, *n; 21123a6f82f7SJiri Slaby 21133a6f82f7SJiri Slaby spin_lock(&hdrv->dyn_lock); 21143a6f82f7SJiri Slaby list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) { 21153a6f82f7SJiri Slaby list_del(&dynid->list); 21163a6f82f7SJiri Slaby kfree(dynid); 21173a6f82f7SJiri Slaby } 21183a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 21193a6f82f7SJiri Slaby } 21203a6f82f7SJiri Slaby 2121e04a0442SBenjamin Tissoires const struct hid_device_id *hid_match_device(struct hid_device *hdev, 21223a6f82f7SJiri Slaby struct hid_driver *hdrv) 21233a6f82f7SJiri Slaby { 21243a6f82f7SJiri Slaby struct hid_dynid *dynid; 21253a6f82f7SJiri Slaby 21263a6f82f7SJiri Slaby spin_lock(&hdrv->dyn_lock); 21273a6f82f7SJiri Slaby list_for_each_entry(dynid, &hdrv->dyn_list, list) { 21283a6f82f7SJiri Slaby if (hid_match_one_id(hdev, &dynid->id)) { 21293a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 21303a6f82f7SJiri Slaby return &dynid->id; 21313a6f82f7SJiri Slaby } 21323a6f82f7SJiri Slaby } 21333a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 21343a6f82f7SJiri Slaby 21353a6f82f7SJiri Slaby return hid_match_id(hdev, hdrv->id_table); 21363a6f82f7SJiri Slaby } 2137e04a0442SBenjamin Tissoires EXPORT_SYMBOL_GPL(hid_match_device); 21383a6f82f7SJiri Slaby 213985cdaf52SJiri Slaby static int hid_bus_match(struct device *dev, struct device_driver *drv) 214085cdaf52SJiri Slaby { 2141ba91a967SGeliang Tang struct hid_driver *hdrv = to_hid_driver(drv); 2142ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 214385cdaf52SJiri Slaby 2144070748edSHenrik Rydberg return hid_match_device(hdev, hdrv) != NULL; 214585cdaf52SJiri Slaby } 214685cdaf52SJiri Slaby 21471a8861f1SDaniel M. Lambea /** 21481a8861f1SDaniel M. Lambea * hid_compare_device_paths - check if both devices share the same path 21491a8861f1SDaniel M. Lambea * @hdev_a: hid device 21501a8861f1SDaniel M. Lambea * @hdev_b: hid device 21511a8861f1SDaniel M. Lambea * @separator: char to use as separator 21521a8861f1SDaniel M. Lambea * 21531a8861f1SDaniel M. Lambea * Check if two devices share the same path up to the last occurrence of 21541a8861f1SDaniel M. Lambea * the separator char. Both paths must exist (i.e., zero-length paths 21551a8861f1SDaniel M. Lambea * don't match). 21561a8861f1SDaniel M. Lambea */ 21571a8861f1SDaniel M. Lambea bool hid_compare_device_paths(struct hid_device *hdev_a, 21581a8861f1SDaniel M. Lambea struct hid_device *hdev_b, char separator) 21591a8861f1SDaniel M. Lambea { 21601a8861f1SDaniel M. Lambea int n1 = strrchr(hdev_a->phys, separator) - hdev_a->phys; 21611a8861f1SDaniel M. Lambea int n2 = strrchr(hdev_b->phys, separator) - hdev_b->phys; 21621a8861f1SDaniel M. Lambea 21631a8861f1SDaniel M. Lambea if (n1 != n2 || n1 <= 0 || n2 <= 0) 21641a8861f1SDaniel M. Lambea return false; 21651a8861f1SDaniel M. Lambea 21661a8861f1SDaniel M. Lambea return !strncmp(hdev_a->phys, hdev_b->phys, n1); 21671a8861f1SDaniel M. Lambea } 21681a8861f1SDaniel M. Lambea EXPORT_SYMBOL_GPL(hid_compare_device_paths); 21691a8861f1SDaniel M. Lambea 217085cdaf52SJiri Slaby static int hid_device_probe(struct device *dev) 217185cdaf52SJiri Slaby { 2172ba91a967SGeliang Tang struct hid_driver *hdrv = to_hid_driver(dev->driver); 2173ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 217485cdaf52SJiri Slaby const struct hid_device_id *id; 217585cdaf52SJiri Slaby int ret = 0; 217685cdaf52SJiri Slaby 2177c849a614SAndrew de los Reyes if (down_interruptible(&hdev->driver_input_lock)) { 2178c849a614SAndrew de los Reyes ret = -EINTR; 21796f68f0acSBinoy Jayan goto end; 2180c849a614SAndrew de los Reyes } 2181c849a614SAndrew de los Reyes hdev->io_started = false; 21824ea54542SDavid Herrmann 21838f732850SBenjamin Tissoires clear_bit(ffs(HID_STAT_REPROBED), &hdev->status); 21848f732850SBenjamin Tissoires 218585cdaf52SJiri Slaby if (!hdev->driver) { 21863a6f82f7SJiri Slaby id = hid_match_device(hdev, hdrv); 2187ba623a77SDan Carpenter if (id == NULL) { 2188ba623a77SDan Carpenter ret = -ENODEV; 2189ba623a77SDan Carpenter goto unlock; 2190ba623a77SDan Carpenter } 2191c500c971SJiri Slaby 2192e04a0442SBenjamin Tissoires if (hdrv->match) { 2193e04a0442SBenjamin Tissoires if (!hdrv->match(hdev, hid_ignore_special_drivers)) { 2194e04a0442SBenjamin Tissoires ret = -ENODEV; 2195e04a0442SBenjamin Tissoires goto unlock; 2196e04a0442SBenjamin Tissoires } 2197e04a0442SBenjamin Tissoires } else { 2198e04a0442SBenjamin Tissoires /* 2199e04a0442SBenjamin Tissoires * hid-generic implements .match(), so if 2200e04a0442SBenjamin Tissoires * hid_ignore_special_drivers is set, we can safely 2201e04a0442SBenjamin Tissoires * return. 2202e04a0442SBenjamin Tissoires */ 2203e04a0442SBenjamin Tissoires if (hid_ignore_special_drivers) { 2204e04a0442SBenjamin Tissoires ret = -ENODEV; 2205e04a0442SBenjamin Tissoires goto unlock; 2206e04a0442SBenjamin Tissoires } 2207e04a0442SBenjamin Tissoires } 2208e04a0442SBenjamin Tissoires 22092904e68fSBenjamin Tissoires /* reset the quirks that has been previously set */ 22102904e68fSBenjamin Tissoires hdev->quirks = hid_lookup_quirk(hdev); 221185cdaf52SJiri Slaby hdev->driver = hdrv; 2212c500c971SJiri Slaby if (hdrv->probe) { 2213c500c971SJiri Slaby ret = hdrv->probe(hdev, id); 2214c500c971SJiri Slaby } else { /* default probe */ 2215a7197c2eSHenrik Rydberg ret = hid_open_report(hdev); 2216c500c971SJiri Slaby if (!ret) 221793c10132SJiri Slaby ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT); 2218c500c971SJiri Slaby } 2219a7197c2eSHenrik Rydberg if (ret) { 2220a7197c2eSHenrik Rydberg hid_close_report(hdev); 2221c500c971SJiri Slaby hdev->driver = NULL; 222285cdaf52SJiri Slaby } 2223a7197c2eSHenrik Rydberg } 2224ba623a77SDan Carpenter unlock: 2225c849a614SAndrew de los Reyes if (!hdev->io_started) 2226c849a614SAndrew de los Reyes up(&hdev->driver_input_lock); 22276f68f0acSBinoy Jayan end: 222885cdaf52SJiri Slaby return ret; 222985cdaf52SJiri Slaby } 223085cdaf52SJiri Slaby 223185cdaf52SJiri Slaby static int hid_device_remove(struct device *dev) 223285cdaf52SJiri Slaby { 2233ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 22344ea54542SDavid Herrmann struct hid_driver *hdrv; 2235c849a614SAndrew de los Reyes int ret = 0; 223685cdaf52SJiri Slaby 2237c849a614SAndrew de los Reyes if (down_interruptible(&hdev->driver_input_lock)) { 2238c849a614SAndrew de los Reyes ret = -EINTR; 22396f68f0acSBinoy Jayan goto end; 2240c849a614SAndrew de los Reyes } 2241c849a614SAndrew de los Reyes hdev->io_started = false; 22424ea54542SDavid Herrmann 22434ea54542SDavid Herrmann hdrv = hdev->driver; 224485cdaf52SJiri Slaby if (hdrv) { 224585cdaf52SJiri Slaby if (hdrv->remove) 224685cdaf52SJiri Slaby hdrv->remove(hdev); 2247c500c971SJiri Slaby else /* default remove */ 2248c500c971SJiri Slaby hid_hw_stop(hdev); 2249a7197c2eSHenrik Rydberg hid_close_report(hdev); 225085cdaf52SJiri Slaby hdev->driver = NULL; 225185cdaf52SJiri Slaby } 225285cdaf52SJiri Slaby 2253c849a614SAndrew de los Reyes if (!hdev->io_started) 2254c849a614SAndrew de los Reyes up(&hdev->driver_input_lock); 22556f68f0acSBinoy Jayan end: 2256c849a614SAndrew de los Reyes return ret; 225785cdaf52SJiri Slaby } 225885cdaf52SJiri Slaby 22594d53b801SHenrik Rydberg static ssize_t modalias_show(struct device *dev, struct device_attribute *a, 22604d53b801SHenrik Rydberg char *buf) 22614d53b801SHenrik Rydberg { 22624d53b801SHenrik Rydberg struct hid_device *hdev = container_of(dev, struct hid_device, dev); 22634d53b801SHenrik Rydberg 2264dfa0c5faSRasmus Villemoes return scnprintf(buf, PAGE_SIZE, "hid:b%04Xg%04Xv%08Xp%08X\n", 22654d53b801SHenrik Rydberg hdev->bus, hdev->group, hdev->vendor, hdev->product); 22664d53b801SHenrik Rydberg } 22670d4260e0SGreg Kroah-Hartman static DEVICE_ATTR_RO(modalias); 22684d53b801SHenrik Rydberg 22690d4260e0SGreg Kroah-Hartman static struct attribute *hid_dev_attrs[] = { 22700d4260e0SGreg Kroah-Hartman &dev_attr_modalias.attr, 22710d4260e0SGreg Kroah-Hartman NULL, 22724d53b801SHenrik Rydberg }; 227354f32fd5SAndy Lutomirski static struct bin_attribute *hid_dev_bin_attrs[] = { 227454f32fd5SAndy Lutomirski &dev_bin_attr_report_desc, 227554f32fd5SAndy Lutomirski NULL 227654f32fd5SAndy Lutomirski }; 227754f32fd5SAndy Lutomirski static const struct attribute_group hid_dev_group = { 227854f32fd5SAndy Lutomirski .attrs = hid_dev_attrs, 227954f32fd5SAndy Lutomirski .bin_attrs = hid_dev_bin_attrs, 228054f32fd5SAndy Lutomirski }; 228154f32fd5SAndy Lutomirski __ATTRIBUTE_GROUPS(hid_dev); 22824d53b801SHenrik Rydberg 228385cdaf52SJiri Slaby static int hid_uevent(struct device *dev, struct kobj_uevent_env *env) 228485cdaf52SJiri Slaby { 2285ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 228685cdaf52SJiri Slaby 228785cdaf52SJiri Slaby if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X", 228885cdaf52SJiri Slaby hdev->bus, hdev->vendor, hdev->product)) 228985cdaf52SJiri Slaby return -ENOMEM; 229085cdaf52SJiri Slaby 229185cdaf52SJiri Slaby if (add_uevent_var(env, "HID_NAME=%s", hdev->name)) 229285cdaf52SJiri Slaby return -ENOMEM; 229385cdaf52SJiri Slaby 229485cdaf52SJiri Slaby if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys)) 229585cdaf52SJiri Slaby return -ENOMEM; 229685cdaf52SJiri Slaby 229785cdaf52SJiri Slaby if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq)) 229885cdaf52SJiri Slaby return -ENOMEM; 229985cdaf52SJiri Slaby 23004d53b801SHenrik Rydberg if (add_uevent_var(env, "MODALIAS=hid:b%04Xg%04Xv%08Xp%08X", 23014d53b801SHenrik Rydberg hdev->bus, hdev->group, hdev->vendor, hdev->product)) 230285cdaf52SJiri Slaby return -ENOMEM; 230385cdaf52SJiri Slaby 230485cdaf52SJiri Slaby return 0; 230585cdaf52SJiri Slaby } 230685cdaf52SJiri Slaby 2307e04a0442SBenjamin Tissoires struct bus_type hid_bus_type = { 230885cdaf52SJiri Slaby .name = "hid", 23090d4260e0SGreg Kroah-Hartman .dev_groups = hid_dev_groups, 2310c2810325SGreg Kroah-Hartman .drv_groups = hid_drv_groups, 231185cdaf52SJiri Slaby .match = hid_bus_match, 231285cdaf52SJiri Slaby .probe = hid_device_probe, 231385cdaf52SJiri Slaby .remove = hid_device_remove, 231485cdaf52SJiri Slaby .uevent = hid_uevent, 231585cdaf52SJiri Slaby }; 2316d5d3e202SBenjamin Tissoires EXPORT_SYMBOL(hid_bus_type); 2317d458a9dfSJiri Slaby 231885cdaf52SJiri Slaby int hid_add_device(struct hid_device *hdev) 231985cdaf52SJiri Slaby { 232085cdaf52SJiri Slaby static atomic_t id = ATOMIC_INIT(0); 232185cdaf52SJiri Slaby int ret; 232285cdaf52SJiri Slaby 232385cdaf52SJiri Slaby if (WARN_ON(hdev->status & HID_STAT_ADDED)) 232485cdaf52SJiri Slaby return -EBUSY; 232585cdaf52SJiri Slaby 2326d5d3e202SBenjamin Tissoires hdev->quirks = hid_lookup_quirk(hdev); 2327d5d3e202SBenjamin Tissoires 2328d458a9dfSJiri Slaby /* we need to kill them here, otherwise they will stay allocated to 2329d458a9dfSJiri Slaby * wait for coming driver */ 23304529eefaSLamarque V. Souza if (hid_ignore(hdev)) 2331d458a9dfSJiri Slaby return -ENODEV; 2332d458a9dfSJiri Slaby 2333a7197c2eSHenrik Rydberg /* 23343c86726cSBenjamin Tissoires * Check for the mandatory transport channel. 23353c86726cSBenjamin Tissoires */ 23363c86726cSBenjamin Tissoires if (!hdev->ll_driver->raw_request) { 23373c86726cSBenjamin Tissoires hid_err(hdev, "transport driver missing .raw_request()\n"); 23383c86726cSBenjamin Tissoires return -EINVAL; 23393c86726cSBenjamin Tissoires } 23403c86726cSBenjamin Tissoires 23413c86726cSBenjamin Tissoires /* 2342a7197c2eSHenrik Rydberg * Read the device report descriptor once and use as template 2343a7197c2eSHenrik Rydberg * for the driver-specific modifications. 2344a7197c2eSHenrik Rydberg */ 2345a7197c2eSHenrik Rydberg ret = hdev->ll_driver->parse(hdev); 2346a7197c2eSHenrik Rydberg if (ret) 2347a7197c2eSHenrik Rydberg return ret; 2348a7197c2eSHenrik Rydberg if (!hdev->dev_rdesc) 2349a7197c2eSHenrik Rydberg return -ENODEV; 2350a7197c2eSHenrik Rydberg 2351734c6609SHenrik Rydberg /* 2352734c6609SHenrik Rydberg * Scan generic devices for group information 2353734c6609SHenrik Rydberg */ 23544392bf33SBenjamin Tissoires if (hid_ignore_special_drivers) { 23554392bf33SBenjamin Tissoires hdev->group = HID_GROUP_GENERIC; 23564392bf33SBenjamin Tissoires } else if (!hdev->group && 23576e65d9d5SBenjamin Tissoires !(hdev->quirks & HID_QUIRK_HAVE_SPECIAL_DRIVER)) { 2358734c6609SHenrik Rydberg ret = hid_scan_report(hdev); 2359734c6609SHenrik Rydberg if (ret) 2360734c6609SHenrik Rydberg hid_warn(hdev, "bad device descriptor (%d)\n", ret); 2361734c6609SHenrik Rydberg } 2362734c6609SHenrik Rydberg 23636bbe586fSKay Sievers /* XXX hack, any other cleaner solution after the driver core 23646bbe586fSKay Sievers * is converted to allow more than 20 bytes as the device name? */ 23656bbe586fSKay Sievers dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus, 236685cdaf52SJiri Slaby hdev->vendor, hdev->product, atomic_inc_return(&id)); 236785cdaf52SJiri Slaby 2368a025a18fSHans de Goede /* 2369a025a18fSHans de Goede * Try loading the module for the device before the add, so that we do 2370a025a18fSHans de Goede * not first have hid-generic binding only to have it replaced 2371a025a18fSHans de Goede * immediately afterwards with a specialized driver. 2372a025a18fSHans de Goede */ 23734ceabaf7SHans de Goede if (!current_is_async()) 23744ceabaf7SHans de Goede request_module("hid:b%04Xg%04Xv%08Xp%08X", hdev->bus, 23754ceabaf7SHans de Goede hdev->group, hdev->vendor, hdev->product); 2376a025a18fSHans de Goede 23774da361b6SBruno Prémont hid_debug_register(hdev, dev_name(&hdev->dev)); 237885cdaf52SJiri Slaby ret = device_add(&hdev->dev); 237985cdaf52SJiri Slaby if (!ret) 238085cdaf52SJiri Slaby hdev->status |= HID_STAT_ADDED; 23814da361b6SBruno Prémont else 23824da361b6SBruno Prémont hid_debug_unregister(hdev); 2383a635f9ddSJiri Kosina 238485cdaf52SJiri Slaby return ret; 238585cdaf52SJiri Slaby } 238685cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_add_device); 238785cdaf52SJiri Slaby 238885cdaf52SJiri Slaby /** 238985cdaf52SJiri Slaby * hid_allocate_device - allocate new hid device descriptor 239085cdaf52SJiri Slaby * 239185cdaf52SJiri Slaby * Allocate and initialize hid device, so that hid_destroy_device might be 239285cdaf52SJiri Slaby * used to free it. 239385cdaf52SJiri Slaby * 239485cdaf52SJiri Slaby * New hid_device pointer is returned on success, otherwise ERR_PTR encoded 239585cdaf52SJiri Slaby * error value. 239685cdaf52SJiri Slaby */ 239785cdaf52SJiri Slaby struct hid_device *hid_allocate_device(void) 239885cdaf52SJiri Slaby { 239985cdaf52SJiri Slaby struct hid_device *hdev; 240085cdaf52SJiri Slaby int ret = -ENOMEM; 240185cdaf52SJiri Slaby 240285cdaf52SJiri Slaby hdev = kzalloc(sizeof(*hdev), GFP_KERNEL); 240385cdaf52SJiri Slaby if (hdev == NULL) 240485cdaf52SJiri Slaby return ERR_PTR(ret); 240585cdaf52SJiri Slaby 240685cdaf52SJiri Slaby device_initialize(&hdev->dev); 240785cdaf52SJiri Slaby hdev->dev.release = hid_device_release; 240885cdaf52SJiri Slaby hdev->dev.bus = &hid_bus_type; 240964bebefcSFu, Zhonghui device_enable_async_suspend(&hdev->dev); 241085cdaf52SJiri Slaby 2411a7197c2eSHenrik Rydberg hid_close_report(hdev); 241285cdaf52SJiri Slaby 2413cd667ce2SJiri Kosina init_waitqueue_head(&hdev->debug_wait); 2414cd667ce2SJiri Kosina INIT_LIST_HEAD(&hdev->debug_list); 24151deb9d34SJiri Kosina spin_lock_init(&hdev->debug_list_lock); 2416c849a614SAndrew de los Reyes sema_init(&hdev->driver_input_lock, 1); 2417aaac082dSDmitry Torokhov mutex_init(&hdev->ll_open_lock); 2418cd667ce2SJiri Kosina 241985cdaf52SJiri Slaby return hdev; 242085cdaf52SJiri Slaby } 242185cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_allocate_device); 242285cdaf52SJiri Slaby 242385cdaf52SJiri Slaby static void hid_remove_device(struct hid_device *hdev) 242485cdaf52SJiri Slaby { 242585cdaf52SJiri Slaby if (hdev->status & HID_STAT_ADDED) { 242685cdaf52SJiri Slaby device_del(&hdev->dev); 2427a635f9ddSJiri Kosina hid_debug_unregister(hdev); 242885cdaf52SJiri Slaby hdev->status &= ~HID_STAT_ADDED; 242985cdaf52SJiri Slaby } 2430a7197c2eSHenrik Rydberg kfree(hdev->dev_rdesc); 2431a7197c2eSHenrik Rydberg hdev->dev_rdesc = NULL; 2432a7197c2eSHenrik Rydberg hdev->dev_rsize = 0; 243385cdaf52SJiri Slaby } 243485cdaf52SJiri Slaby 243585cdaf52SJiri Slaby /** 243685cdaf52SJiri Slaby * hid_destroy_device - free previously allocated device 243785cdaf52SJiri Slaby * 243885cdaf52SJiri Slaby * @hdev: hid device 243985cdaf52SJiri Slaby * 244085cdaf52SJiri Slaby * If you allocate hid_device through hid_allocate_device, you should ever 244185cdaf52SJiri Slaby * free by this function. 244285cdaf52SJiri Slaby */ 244385cdaf52SJiri Slaby void hid_destroy_device(struct hid_device *hdev) 244485cdaf52SJiri Slaby { 244585cdaf52SJiri Slaby hid_remove_device(hdev); 244685cdaf52SJiri Slaby put_device(&hdev->dev); 244785cdaf52SJiri Slaby } 244885cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_destroy_device); 244985cdaf52SJiri Slaby 2450e04a0442SBenjamin Tissoires 2451c17a7476SBenjamin Tissoires static int __hid_bus_reprobe_drivers(struct device *dev, void *data) 2452e04a0442SBenjamin Tissoires { 2453c17a7476SBenjamin Tissoires struct hid_driver *hdrv = data; 2454c17a7476SBenjamin Tissoires struct hid_device *hdev = to_hid_device(dev); 2455c17a7476SBenjamin Tissoires 2456c17a7476SBenjamin Tissoires if (hdev->driver == hdrv && 24578f732850SBenjamin Tissoires !hdrv->match(hdev, hid_ignore_special_drivers) && 24588f732850SBenjamin Tissoires !test_and_set_bit(ffs(HID_STAT_REPROBED), &hdev->status)) 2459c17a7476SBenjamin Tissoires return device_reprobe(dev); 2460c17a7476SBenjamin Tissoires 2461c17a7476SBenjamin Tissoires return 0; 2462c17a7476SBenjamin Tissoires } 2463c17a7476SBenjamin Tissoires 2464c17a7476SBenjamin Tissoires static int __hid_bus_driver_added(struct device_driver *drv, void *data) 2465c17a7476SBenjamin Tissoires { 2466e04a0442SBenjamin Tissoires struct hid_driver *hdrv = to_hid_driver(drv); 2467e04a0442SBenjamin Tissoires 2468c17a7476SBenjamin Tissoires if (hdrv->match) { 2469c17a7476SBenjamin Tissoires bus_for_each_dev(&hid_bus_type, NULL, hdrv, 2470c17a7476SBenjamin Tissoires __hid_bus_reprobe_drivers); 2471c17a7476SBenjamin Tissoires } 2472e04a0442SBenjamin Tissoires 2473e04a0442SBenjamin Tissoires return 0; 2474e04a0442SBenjamin Tissoires } 2475e04a0442SBenjamin Tissoires 2476e04a0442SBenjamin Tissoires static int __bus_removed_driver(struct device_driver *drv, void *data) 2477e04a0442SBenjamin Tissoires { 2478c17a7476SBenjamin Tissoires return bus_rescan_devices(&hid_bus_type); 2479e04a0442SBenjamin Tissoires } 2480e04a0442SBenjamin Tissoires 248185cdaf52SJiri Slaby int __hid_register_driver(struct hid_driver *hdrv, struct module *owner, 248285cdaf52SJiri Slaby const char *mod_name) 248385cdaf52SJiri Slaby { 2484c17a7476SBenjamin Tissoires int ret; 2485c17a7476SBenjamin Tissoires 248685cdaf52SJiri Slaby hdrv->driver.name = hdrv->name; 248785cdaf52SJiri Slaby hdrv->driver.bus = &hid_bus_type; 248885cdaf52SJiri Slaby hdrv->driver.owner = owner; 248985cdaf52SJiri Slaby hdrv->driver.mod_name = mod_name; 249085cdaf52SJiri Slaby 24913a6f82f7SJiri Slaby INIT_LIST_HEAD(&hdrv->dyn_list); 24923a6f82f7SJiri Slaby spin_lock_init(&hdrv->dyn_lock); 24933a6f82f7SJiri Slaby 2494c17a7476SBenjamin Tissoires ret = driver_register(&hdrv->driver); 2495e04a0442SBenjamin Tissoires 2496c17a7476SBenjamin Tissoires if (ret == 0) 2497c17a7476SBenjamin Tissoires bus_for_each_drv(&hid_bus_type, NULL, NULL, 2498c17a7476SBenjamin Tissoires __hid_bus_driver_added); 2499c17a7476SBenjamin Tissoires 2500c17a7476SBenjamin Tissoires return ret; 250185cdaf52SJiri Slaby } 250285cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(__hid_register_driver); 250385cdaf52SJiri Slaby 250485cdaf52SJiri Slaby void hid_unregister_driver(struct hid_driver *hdrv) 250585cdaf52SJiri Slaby { 250685cdaf52SJiri Slaby driver_unregister(&hdrv->driver); 25073a6f82f7SJiri Slaby hid_free_dynids(hdrv); 2508e04a0442SBenjamin Tissoires 2509e04a0442SBenjamin Tissoires bus_for_each_drv(&hid_bus_type, NULL, hdrv, __bus_removed_driver); 251085cdaf52SJiri Slaby } 251185cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_unregister_driver); 251285cdaf52SJiri Slaby 25130361a28dSOliver Neukum int hid_check_keys_pressed(struct hid_device *hid) 25140361a28dSOliver Neukum { 25150361a28dSOliver Neukum struct hid_input *hidinput; 25160361a28dSOliver Neukum int i; 25170361a28dSOliver Neukum 2518e5288eb5SJiri Kosina if (!(hid->claimed & HID_CLAIMED_INPUT)) 2519e5288eb5SJiri Kosina return 0; 2520e5288eb5SJiri Kosina 25210361a28dSOliver Neukum list_for_each_entry(hidinput, &hid->inputs, list) { 25220361a28dSOliver Neukum for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++) 25230361a28dSOliver Neukum if (hidinput->input->key[i]) 25240361a28dSOliver Neukum return 1; 25250361a28dSOliver Neukum } 25260361a28dSOliver Neukum 25270361a28dSOliver Neukum return 0; 25280361a28dSOliver Neukum } 25290361a28dSOliver Neukum 25300361a28dSOliver Neukum EXPORT_SYMBOL_GPL(hid_check_keys_pressed); 25310361a28dSOliver Neukum 253286166b7bSJiri Kosina static int __init hid_init(void) 253386166b7bSJiri Kosina { 253485cdaf52SJiri Slaby int ret; 253585cdaf52SJiri Slaby 2536a635f9ddSJiri Kosina if (hid_debug) 25374291ee30SJoe Perches pr_warn("hid_debug is now used solely for parser and driver debugging.\n" 25384291ee30SJoe Perches "debugfs is now used for inspecting the device (report descriptor, reports)\n"); 2539a635f9ddSJiri Kosina 254085cdaf52SJiri Slaby ret = bus_register(&hid_bus_type); 254185cdaf52SJiri Slaby if (ret) { 25424291ee30SJoe Perches pr_err("can't register hid bus\n"); 254385cdaf52SJiri Slaby goto err; 254485cdaf52SJiri Slaby } 254585cdaf52SJiri Slaby 254685cdaf52SJiri Slaby ret = hidraw_init(); 254785cdaf52SJiri Slaby if (ret) 254885cdaf52SJiri Slaby goto err_bus; 254985cdaf52SJiri Slaby 2550a635f9ddSJiri Kosina hid_debug_init(); 2551a635f9ddSJiri Kosina 255285cdaf52SJiri Slaby return 0; 255385cdaf52SJiri Slaby err_bus: 255485cdaf52SJiri Slaby bus_unregister(&hid_bus_type); 255585cdaf52SJiri Slaby err: 255685cdaf52SJiri Slaby return ret; 255786166b7bSJiri Kosina } 255886166b7bSJiri Kosina 255986166b7bSJiri Kosina static void __exit hid_exit(void) 256086166b7bSJiri Kosina { 2561a635f9ddSJiri Kosina hid_debug_exit(); 256286166b7bSJiri Kosina hidraw_exit(); 256385cdaf52SJiri Slaby bus_unregister(&hid_bus_type); 2564d5d3e202SBenjamin Tissoires hid_quirks_exit(HID_BUS_ANY); 256586166b7bSJiri Kosina } 256686166b7bSJiri Kosina 256786166b7bSJiri Kosina module_init(hid_init); 256886166b7bSJiri Kosina module_exit(hid_exit); 256986166b7bSJiri Kosina 257088adb72bSJiri Kosina MODULE_AUTHOR("Andreas Gal"); 257188adb72bSJiri Kosina MODULE_AUTHOR("Vojtech Pavlik"); 257288adb72bSJiri Kosina MODULE_AUTHOR("Jiri Kosina"); 25737021b600SGrant Grundler MODULE_LICENSE("GPL"); 2574