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> 33dde5845aSJiri Kosina 34dde5845aSJiri Kosina #include <linux/hid.h> 35dde5845aSJiri Kosina #include <linux/hiddev.h> 36c080d89aSJiri Kosina #include <linux/hid-debug.h> 3786166b7bSJiri Kosina #include <linux/hidraw.h> 38dde5845aSJiri Kosina 395f22a799SJiri Slaby #include "hid-ids.h" 405f22a799SJiri Slaby 41dde5845aSJiri Kosina /* 42dde5845aSJiri Kosina * Version Information 43dde5845aSJiri Kosina */ 44dde5845aSJiri Kosina 4553149801SJiri Kosina #define DRIVER_DESC "HID core driver" 46dde5845aSJiri Kosina 4758037eb9SJiri Kosina int hid_debug = 0; 48377e10fbSAnssi Hannula module_param_named(debug, hid_debug, int, 0600); 49cd667ce2SJiri Kosina MODULE_PARM_DESC(debug, "toggle HID debugging messages"); 5058037eb9SJiri Kosina EXPORT_SYMBOL_GPL(hid_debug); 5158037eb9SJiri Kosina 526b1968d5SJiri Kosina static int hid_ignore_special_drivers = 0; 536b1968d5SJiri Kosina module_param_named(ignore_special_drivers, hid_ignore_special_drivers, int, 0600); 54643727a9SHans Petter Selasky MODULE_PARM_DESC(ignore_special_drivers, "Ignore any special drivers and handle all devices by generic driver"); 556b1968d5SJiri Kosina 56dde5845aSJiri Kosina /* 57dde5845aSJiri Kosina * Register a new report for a device. 58dde5845aSJiri Kosina */ 59dde5845aSJiri Kosina 60f07b3c1dSBenjamin Tissoires struct hid_report *hid_register_report(struct hid_device *device, 61f07b3c1dSBenjamin Tissoires unsigned int type, unsigned int id, 62f07b3c1dSBenjamin Tissoires unsigned int application) 63dde5845aSJiri Kosina { 64dde5845aSJiri Kosina struct hid_report_enum *report_enum = device->report_enum + type; 65dde5845aSJiri Kosina struct hid_report *report; 66dde5845aSJiri Kosina 6743622021SKees Cook if (id >= HID_MAX_IDS) 6843622021SKees Cook return NULL; 69dde5845aSJiri Kosina if (report_enum->report_id_hash[id]) 70dde5845aSJiri Kosina return report_enum->report_id_hash[id]; 71dde5845aSJiri Kosina 72a3789a17SJoe Perches report = kzalloc(sizeof(struct hid_report), GFP_KERNEL); 73a3789a17SJoe Perches if (!report) 74dde5845aSJiri Kosina return NULL; 75dde5845aSJiri Kosina 76dde5845aSJiri Kosina if (id != 0) 77dde5845aSJiri Kosina report_enum->numbered = 1; 78dde5845aSJiri Kosina 79dde5845aSJiri Kosina report->id = id; 80dde5845aSJiri Kosina report->type = type; 81dde5845aSJiri Kosina report->size = 0; 82dde5845aSJiri Kosina report->device = device; 83f07b3c1dSBenjamin Tissoires report->application = application; 84dde5845aSJiri Kosina report_enum->report_id_hash[id] = report; 85dde5845aSJiri Kosina 86dde5845aSJiri Kosina list_add_tail(&report->list, &report_enum->report_list); 87dde5845aSJiri Kosina 88dde5845aSJiri Kosina return report; 89dde5845aSJiri Kosina } 9090a006abSMichael Poole EXPORT_SYMBOL_GPL(hid_register_report); 91dde5845aSJiri Kosina 92dde5845aSJiri Kosina /* 93dde5845aSJiri Kosina * Register a new field for this report. 94dde5845aSJiri Kosina */ 95dde5845aSJiri Kosina 96dde5845aSJiri Kosina static struct hid_field *hid_register_field(struct hid_report *report, unsigned usages, unsigned values) 97dde5845aSJiri Kosina { 98dde5845aSJiri Kosina struct hid_field *field; 99dde5845aSJiri Kosina 100dde5845aSJiri Kosina if (report->maxfield == HID_MAX_FIELDS) { 1018c3d52fcSJiri Kosina hid_err(report->device, "too many fields in report\n"); 102dde5845aSJiri Kosina return NULL; 103dde5845aSJiri Kosina } 104dde5845aSJiri Kosina 105a3789a17SJoe Perches field = kzalloc((sizeof(struct hid_field) + 106a3789a17SJoe Perches usages * sizeof(struct hid_usage) + 107a3789a17SJoe Perches values * sizeof(unsigned)), GFP_KERNEL); 108a3789a17SJoe Perches if (!field) 109a3789a17SJoe Perches return NULL; 110dde5845aSJiri Kosina 111dde5845aSJiri Kosina field->index = report->maxfield++; 112dde5845aSJiri Kosina report->field[field->index] = field; 113dde5845aSJiri Kosina field->usage = (struct hid_usage *)(field + 1); 114282bfd4cSJiri Slaby field->value = (s32 *)(field->usage + usages); 115dde5845aSJiri Kosina field->report = report; 116dde5845aSJiri Kosina 117dde5845aSJiri Kosina return field; 118dde5845aSJiri Kosina } 119dde5845aSJiri Kosina 120dde5845aSJiri Kosina /* 121dde5845aSJiri Kosina * Open a collection. The type/usage is pushed on the stack. 122dde5845aSJiri Kosina */ 123dde5845aSJiri Kosina 124dde5845aSJiri Kosina static int open_collection(struct hid_parser *parser, unsigned type) 125dde5845aSJiri Kosina { 126dde5845aSJiri Kosina struct hid_collection *collection; 127dde5845aSJiri Kosina unsigned usage; 128*ee46967fSPeter Hutterer int collection_index; 129dde5845aSJiri Kosina 130dde5845aSJiri Kosina usage = parser->local.usage[0]; 131dde5845aSJiri Kosina 13208a8a7cfSBenjamin Tissoires if (parser->collection_stack_ptr == parser->collection_stack_size) { 13308a8a7cfSBenjamin Tissoires unsigned int *collection_stack; 13408a8a7cfSBenjamin Tissoires unsigned int new_size = parser->collection_stack_size + 13508a8a7cfSBenjamin Tissoires HID_COLLECTION_STACK_SIZE; 13608a8a7cfSBenjamin Tissoires 13708a8a7cfSBenjamin Tissoires collection_stack = krealloc(parser->collection_stack, 13808a8a7cfSBenjamin Tissoires new_size * sizeof(unsigned int), 13908a8a7cfSBenjamin Tissoires GFP_KERNEL); 14008a8a7cfSBenjamin Tissoires if (!collection_stack) 14108a8a7cfSBenjamin Tissoires return -ENOMEM; 14208a8a7cfSBenjamin Tissoires 14308a8a7cfSBenjamin Tissoires parser->collection_stack = collection_stack; 14408a8a7cfSBenjamin Tissoires parser->collection_stack_size = new_size; 145dde5845aSJiri Kosina } 146dde5845aSJiri Kosina 147dde5845aSJiri Kosina if (parser->device->maxcollection == parser->device->collection_size) { 1486da2ec56SKees Cook collection = kmalloc( 1496da2ec56SKees Cook array3_size(sizeof(struct hid_collection), 1506da2ec56SKees Cook parser->device->collection_size, 1516da2ec56SKees Cook 2), 1526da2ec56SKees Cook GFP_KERNEL); 153dde5845aSJiri Kosina if (collection == NULL) { 1548c3d52fcSJiri Kosina hid_err(parser->device, "failed to reallocate collection array\n"); 155a6fbaacfSSachin Kamat return -ENOMEM; 156dde5845aSJiri Kosina } 157dde5845aSJiri Kosina memcpy(collection, parser->device->collection, 158dde5845aSJiri Kosina sizeof(struct hid_collection) * 159dde5845aSJiri Kosina parser->device->collection_size); 160dde5845aSJiri Kosina memset(collection + parser->device->collection_size, 0, 161dde5845aSJiri Kosina sizeof(struct hid_collection) * 162dde5845aSJiri Kosina parser->device->collection_size); 163dde5845aSJiri Kosina kfree(parser->device->collection); 164dde5845aSJiri Kosina parser->device->collection = collection; 165dde5845aSJiri Kosina parser->device->collection_size *= 2; 166dde5845aSJiri Kosina } 167dde5845aSJiri Kosina 168dde5845aSJiri Kosina parser->collection_stack[parser->collection_stack_ptr++] = 169dde5845aSJiri Kosina parser->device->maxcollection; 170dde5845aSJiri Kosina 171*ee46967fSPeter Hutterer collection_index = parser->device->maxcollection++; 172*ee46967fSPeter Hutterer collection = parser->device->collection + collection_index; 173dde5845aSJiri Kosina collection->type = type; 174dde5845aSJiri Kosina collection->usage = usage; 175dde5845aSJiri Kosina collection->level = parser->collection_stack_ptr - 1; 176*ee46967fSPeter Hutterer collection->parent_idx = parser->active_collection_idx; 177*ee46967fSPeter Hutterer parser->active_collection_idx = collection_index; 178dde5845aSJiri Kosina 179dde5845aSJiri Kosina if (type == HID_COLLECTION_APPLICATION) 180dde5845aSJiri Kosina parser->device->maxapplication++; 181dde5845aSJiri Kosina 182dde5845aSJiri Kosina return 0; 183dde5845aSJiri Kosina } 184dde5845aSJiri Kosina 185dde5845aSJiri Kosina /* 186dde5845aSJiri Kosina * Close a collection. 187dde5845aSJiri Kosina */ 188dde5845aSJiri Kosina 189dde5845aSJiri Kosina static int close_collection(struct hid_parser *parser) 190dde5845aSJiri Kosina { 191dde5845aSJiri Kosina if (!parser->collection_stack_ptr) { 1928c3d52fcSJiri Kosina hid_err(parser->device, "collection stack underflow\n"); 193a6fbaacfSSachin Kamat return -EINVAL; 194dde5845aSJiri Kosina } 195dde5845aSJiri Kosina parser->collection_stack_ptr--; 196*ee46967fSPeter Hutterer if (parser->active_collection_idx != -1) { 197*ee46967fSPeter Hutterer struct hid_device *device = parser->device; 198*ee46967fSPeter Hutterer struct hid_collection *c; 199*ee46967fSPeter Hutterer 200*ee46967fSPeter Hutterer c = &device->collection[parser->active_collection_idx]; 201*ee46967fSPeter Hutterer parser->active_collection_idx = c->parent_idx; 202*ee46967fSPeter Hutterer } 203dde5845aSJiri Kosina return 0; 204dde5845aSJiri Kosina } 205dde5845aSJiri Kosina 206dde5845aSJiri Kosina /* 207dde5845aSJiri Kosina * Climb up the stack, search for the specified collection type 208dde5845aSJiri Kosina * and return the usage. 209dde5845aSJiri Kosina */ 210dde5845aSJiri Kosina 211dde5845aSJiri Kosina static unsigned hid_lookup_collection(struct hid_parser *parser, unsigned type) 212dde5845aSJiri Kosina { 213504499f2SJoe Perches struct hid_collection *collection = parser->device->collection; 214dde5845aSJiri Kosina int n; 215504499f2SJoe Perches 216504499f2SJoe Perches for (n = parser->collection_stack_ptr - 1; n >= 0; n--) { 217504499f2SJoe Perches unsigned index = parser->collection_stack[n]; 218504499f2SJoe Perches if (collection[index].type == type) 219504499f2SJoe Perches return collection[index].usage; 220504499f2SJoe Perches } 221dde5845aSJiri Kosina return 0; /* we know nothing about this usage type */ 222dde5845aSJiri Kosina } 223dde5845aSJiri Kosina 224dde5845aSJiri Kosina /* 225dde5845aSJiri Kosina * Add a usage to the temporary parser table. 226dde5845aSJiri Kosina */ 227dde5845aSJiri Kosina 228dde5845aSJiri Kosina static int hid_add_usage(struct hid_parser *parser, unsigned usage) 229dde5845aSJiri Kosina { 230dde5845aSJiri Kosina if (parser->local.usage_index >= HID_MAX_USAGES) { 2318c3d52fcSJiri Kosina hid_err(parser->device, "usage index exceeded\n"); 232dde5845aSJiri Kosina return -1; 233dde5845aSJiri Kosina } 234dde5845aSJiri Kosina parser->local.usage[parser->local.usage_index] = usage; 235dde5845aSJiri Kosina parser->local.collection_index[parser->local.usage_index] = 236dde5845aSJiri Kosina parser->collection_stack_ptr ? 237dde5845aSJiri Kosina parser->collection_stack[parser->collection_stack_ptr - 1] : 0; 238dde5845aSJiri Kosina parser->local.usage_index++; 239dde5845aSJiri Kosina return 0; 240dde5845aSJiri Kosina } 241dde5845aSJiri Kosina 242dde5845aSJiri Kosina /* 243dde5845aSJiri Kosina * Register a new field for this report. 244dde5845aSJiri Kosina */ 245dde5845aSJiri Kosina 246dde5845aSJiri Kosina static int hid_add_field(struct hid_parser *parser, unsigned report_type, unsigned flags) 247dde5845aSJiri Kosina { 248dde5845aSJiri Kosina struct hid_report *report; 249dde5845aSJiri Kosina struct hid_field *field; 250f07b3c1dSBenjamin Tissoires unsigned int usages; 251f07b3c1dSBenjamin Tissoires unsigned int offset; 252f07b3c1dSBenjamin Tissoires unsigned int i; 253f07b3c1dSBenjamin Tissoires unsigned int application; 254dde5845aSJiri Kosina 255f07b3c1dSBenjamin Tissoires application = hid_lookup_collection(parser, HID_COLLECTION_APPLICATION); 256f07b3c1dSBenjamin Tissoires 257f07b3c1dSBenjamin Tissoires report = hid_register_report(parser->device, report_type, 258f07b3c1dSBenjamin Tissoires parser->global.report_id, application); 259a3789a17SJoe Perches if (!report) { 2608c3d52fcSJiri Kosina hid_err(parser->device, "hid_register_report failed\n"); 261dde5845aSJiri Kosina return -1; 262dde5845aSJiri Kosina } 263dde5845aSJiri Kosina 264bb2e1976SJiri Kosina /* Handle both signed and unsigned cases properly */ 2650cd516c2Ssrinivas pandruvada if ((parser->global.logical_minimum < 0 && 2660cd516c2Ssrinivas pandruvada parser->global.logical_maximum < 2670cd516c2Ssrinivas pandruvada parser->global.logical_minimum) || 2680cd516c2Ssrinivas pandruvada (parser->global.logical_minimum >= 0 && 2690cd516c2Ssrinivas pandruvada (__u32)parser->global.logical_maximum < 2700cd516c2Ssrinivas pandruvada (__u32)parser->global.logical_minimum)) { 2710cd516c2Ssrinivas pandruvada dbg_hid("logical range invalid 0x%x 0x%x\n", 2720cd516c2Ssrinivas pandruvada parser->global.logical_minimum, 2730cd516c2Ssrinivas pandruvada parser->global.logical_maximum); 274dde5845aSJiri Kosina return -1; 275dde5845aSJiri Kosina } 276dde5845aSJiri Kosina 277dde5845aSJiri Kosina offset = report->size; 278dde5845aSJiri Kosina report->size += parser->global.report_size * parser->global.report_count; 279dde5845aSJiri Kosina 280dde5845aSJiri Kosina if (!parser->local.usage_index) /* Ignore padding fields */ 281dde5845aSJiri Kosina return 0; 282dde5845aSJiri Kosina 283cc6b54aaSBenjamin Tissoires usages = max_t(unsigned, parser->local.usage_index, 284cc6b54aaSBenjamin Tissoires parser->global.report_count); 285dde5845aSJiri Kosina 286a3789a17SJoe Perches field = hid_register_field(report, usages, parser->global.report_count); 287a3789a17SJoe Perches if (!field) 288dde5845aSJiri Kosina return 0; 289dde5845aSJiri Kosina 290dde5845aSJiri Kosina field->physical = hid_lookup_collection(parser, HID_COLLECTION_PHYSICAL); 291dde5845aSJiri Kosina field->logical = hid_lookup_collection(parser, HID_COLLECTION_LOGICAL); 292f07b3c1dSBenjamin Tissoires field->application = application; 293dde5845aSJiri Kosina 294dde5845aSJiri Kosina for (i = 0; i < usages; i++) { 295cc6b54aaSBenjamin Tissoires unsigned j = i; 296dde5845aSJiri Kosina /* Duplicate the last usage we parsed if we have excess values */ 297dde5845aSJiri Kosina if (i >= parser->local.usage_index) 298dde5845aSJiri Kosina j = parser->local.usage_index - 1; 299dde5845aSJiri Kosina field->usage[i].hid = parser->local.usage[j]; 300dde5845aSJiri Kosina field->usage[i].collection_index = 301dde5845aSJiri Kosina parser->local.collection_index[j]; 302cc6b54aaSBenjamin Tissoires field->usage[i].usage_index = i; 3035a4abb36SPeter Hutterer field->usage[i].resolution_multiplier = 1; 304dde5845aSJiri Kosina } 305dde5845aSJiri Kosina 306dde5845aSJiri Kosina field->maxusage = usages; 307dde5845aSJiri Kosina field->flags = flags; 308dde5845aSJiri Kosina field->report_offset = offset; 309dde5845aSJiri Kosina field->report_type = report_type; 310dde5845aSJiri Kosina field->report_size = parser->global.report_size; 311dde5845aSJiri Kosina field->report_count = parser->global.report_count; 312dde5845aSJiri Kosina field->logical_minimum = parser->global.logical_minimum; 313dde5845aSJiri Kosina field->logical_maximum = parser->global.logical_maximum; 314dde5845aSJiri Kosina field->physical_minimum = parser->global.physical_minimum; 315dde5845aSJiri Kosina field->physical_maximum = parser->global.physical_maximum; 316dde5845aSJiri Kosina field->unit_exponent = parser->global.unit_exponent; 317dde5845aSJiri Kosina field->unit = parser->global.unit; 318dde5845aSJiri Kosina 319dde5845aSJiri Kosina return 0; 320dde5845aSJiri Kosina } 321dde5845aSJiri Kosina 322dde5845aSJiri Kosina /* 323dde5845aSJiri Kosina * Read data value from item. 324dde5845aSJiri Kosina */ 325dde5845aSJiri Kosina 326dde5845aSJiri Kosina static u32 item_udata(struct hid_item *item) 327dde5845aSJiri Kosina { 328dde5845aSJiri Kosina switch (item->size) { 329dde5845aSJiri Kosina case 1: return item->data.u8; 330dde5845aSJiri Kosina case 2: return item->data.u16; 331dde5845aSJiri Kosina case 4: return item->data.u32; 332dde5845aSJiri Kosina } 333dde5845aSJiri Kosina return 0; 334dde5845aSJiri Kosina } 335dde5845aSJiri Kosina 336dde5845aSJiri Kosina static s32 item_sdata(struct hid_item *item) 337dde5845aSJiri Kosina { 338dde5845aSJiri Kosina switch (item->size) { 339dde5845aSJiri Kosina case 1: return item->data.s8; 340dde5845aSJiri Kosina case 2: return item->data.s16; 341dde5845aSJiri Kosina case 4: return item->data.s32; 342dde5845aSJiri Kosina } 343dde5845aSJiri Kosina return 0; 344dde5845aSJiri Kosina } 345dde5845aSJiri Kosina 346dde5845aSJiri Kosina /* 347dde5845aSJiri Kosina * Process a global item. 348dde5845aSJiri Kosina */ 349dde5845aSJiri Kosina 350dde5845aSJiri Kosina static int hid_parser_global(struct hid_parser *parser, struct hid_item *item) 351dde5845aSJiri Kosina { 352ad0e669bSNikolai Kondrashov __s32 raw_value; 353dde5845aSJiri Kosina switch (item->tag) { 354dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_PUSH: 355dde5845aSJiri Kosina 356dde5845aSJiri Kosina if (parser->global_stack_ptr == HID_GLOBAL_STACK_SIZE) { 3578c3d52fcSJiri Kosina hid_err(parser->device, "global environment stack overflow\n"); 358dde5845aSJiri Kosina return -1; 359dde5845aSJiri Kosina } 360dde5845aSJiri Kosina 361dde5845aSJiri Kosina memcpy(parser->global_stack + parser->global_stack_ptr++, 362dde5845aSJiri Kosina &parser->global, sizeof(struct hid_global)); 363dde5845aSJiri Kosina return 0; 364dde5845aSJiri Kosina 365dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_POP: 366dde5845aSJiri Kosina 367dde5845aSJiri Kosina if (!parser->global_stack_ptr) { 3688c3d52fcSJiri Kosina hid_err(parser->device, "global environment stack underflow\n"); 369dde5845aSJiri Kosina return -1; 370dde5845aSJiri Kosina } 371dde5845aSJiri Kosina 372880d29f1SJiri Slaby memcpy(&parser->global, parser->global_stack + 373880d29f1SJiri Slaby --parser->global_stack_ptr, sizeof(struct hid_global)); 374dde5845aSJiri Kosina return 0; 375dde5845aSJiri Kosina 376dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_USAGE_PAGE: 377dde5845aSJiri Kosina parser->global.usage_page = item_udata(item); 378dde5845aSJiri Kosina return 0; 379dde5845aSJiri Kosina 380dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM: 381dde5845aSJiri Kosina parser->global.logical_minimum = item_sdata(item); 382dde5845aSJiri Kosina return 0; 383dde5845aSJiri Kosina 384dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM: 385dde5845aSJiri Kosina if (parser->global.logical_minimum < 0) 386dde5845aSJiri Kosina parser->global.logical_maximum = item_sdata(item); 387dde5845aSJiri Kosina else 388dde5845aSJiri Kosina parser->global.logical_maximum = item_udata(item); 389dde5845aSJiri Kosina return 0; 390dde5845aSJiri Kosina 391dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM: 392dde5845aSJiri Kosina parser->global.physical_minimum = item_sdata(item); 393dde5845aSJiri Kosina return 0; 394dde5845aSJiri Kosina 395dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM: 396dde5845aSJiri Kosina if (parser->global.physical_minimum < 0) 397dde5845aSJiri Kosina parser->global.physical_maximum = item_sdata(item); 398dde5845aSJiri Kosina else 399dde5845aSJiri Kosina parser->global.physical_maximum = item_udata(item); 400dde5845aSJiri Kosina return 0; 401dde5845aSJiri Kosina 402dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT: 403ad0e669bSNikolai Kondrashov /* Many devices provide unit exponent as a two's complement 404ad0e669bSNikolai Kondrashov * nibble due to the common misunderstanding of HID 405ad0e669bSNikolai Kondrashov * specification 1.11, 6.2.2.7 Global Items. Attempt to handle 406ad0e669bSNikolai Kondrashov * both this and the standard encoding. */ 407ad0e669bSNikolai Kondrashov raw_value = item_sdata(item); 40877463838SBenjamin Tissoires if (!(raw_value & 0xfffffff0)) 40977463838SBenjamin Tissoires parser->global.unit_exponent = hid_snto32(raw_value, 4); 41077463838SBenjamin Tissoires else 41177463838SBenjamin Tissoires parser->global.unit_exponent = raw_value; 412dde5845aSJiri Kosina return 0; 413dde5845aSJiri Kosina 414dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_UNIT: 415dde5845aSJiri Kosina parser->global.unit = item_udata(item); 416dde5845aSJiri Kosina return 0; 417dde5845aSJiri Kosina 418dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_REPORT_SIZE: 419880d29f1SJiri Slaby parser->global.report_size = item_udata(item); 42071f6fa90SSong, Hongyan if (parser->global.report_size > 256) { 4218c3d52fcSJiri Kosina hid_err(parser->device, "invalid report_size %d\n", 422880d29f1SJiri Slaby parser->global.report_size); 423dde5845aSJiri Kosina return -1; 424dde5845aSJiri Kosina } 425dde5845aSJiri Kosina return 0; 426dde5845aSJiri Kosina 427dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_REPORT_COUNT: 428880d29f1SJiri Slaby parser->global.report_count = item_udata(item); 429880d29f1SJiri Slaby if (parser->global.report_count > HID_MAX_USAGES) { 4308c3d52fcSJiri Kosina hid_err(parser->device, "invalid report_count %d\n", 431880d29f1SJiri Slaby parser->global.report_count); 432dde5845aSJiri Kosina return -1; 433dde5845aSJiri Kosina } 434dde5845aSJiri Kosina return 0; 435dde5845aSJiri Kosina 436dde5845aSJiri Kosina case HID_GLOBAL_ITEM_TAG_REPORT_ID: 437880d29f1SJiri Slaby parser->global.report_id = item_udata(item); 43843622021SKees Cook if (parser->global.report_id == 0 || 43943622021SKees Cook parser->global.report_id >= HID_MAX_IDS) { 44043622021SKees Cook hid_err(parser->device, "report_id %u is invalid\n", 44143622021SKees Cook parser->global.report_id); 442dde5845aSJiri Kosina return -1; 443dde5845aSJiri Kosina } 444dde5845aSJiri Kosina return 0; 445dde5845aSJiri Kosina 446dde5845aSJiri Kosina default: 4478c3d52fcSJiri Kosina hid_err(parser->device, "unknown global tag 0x%x\n", item->tag); 448dde5845aSJiri Kosina return -1; 449dde5845aSJiri Kosina } 450dde5845aSJiri Kosina } 451dde5845aSJiri Kosina 452dde5845aSJiri Kosina /* 453dde5845aSJiri Kosina * Process a local item. 454dde5845aSJiri Kosina */ 455dde5845aSJiri Kosina 456dde5845aSJiri Kosina static int hid_parser_local(struct hid_parser *parser, struct hid_item *item) 457dde5845aSJiri Kosina { 458dde5845aSJiri Kosina __u32 data; 459dde5845aSJiri Kosina unsigned n; 460ba532198SBenjamin Tissoires __u32 count; 461dde5845aSJiri Kosina 462dde5845aSJiri Kosina data = item_udata(item); 463dde5845aSJiri Kosina 464dde5845aSJiri Kosina switch (item->tag) { 465dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_DELIMITER: 466dde5845aSJiri Kosina 467dde5845aSJiri Kosina if (data) { 468dde5845aSJiri Kosina /* 469dde5845aSJiri Kosina * We treat items before the first delimiter 470dde5845aSJiri Kosina * as global to all usage sets (branch 0). 471dde5845aSJiri Kosina * In the moment we process only these global 472dde5845aSJiri Kosina * items and the first delimiter set. 473dde5845aSJiri Kosina */ 474dde5845aSJiri Kosina if (parser->local.delimiter_depth != 0) { 4758c3d52fcSJiri Kosina hid_err(parser->device, "nested delimiters\n"); 476dde5845aSJiri Kosina return -1; 477dde5845aSJiri Kosina } 478dde5845aSJiri Kosina parser->local.delimiter_depth++; 479dde5845aSJiri Kosina parser->local.delimiter_branch++; 480dde5845aSJiri Kosina } else { 481dde5845aSJiri Kosina if (parser->local.delimiter_depth < 1) { 4828c3d52fcSJiri Kosina hid_err(parser->device, "bogus close delimiter\n"); 483dde5845aSJiri Kosina return -1; 484dde5845aSJiri Kosina } 485dde5845aSJiri Kosina parser->local.delimiter_depth--; 486dde5845aSJiri Kosina } 48738ead6efSPaul Chavent return 0; 488dde5845aSJiri Kosina 489dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_USAGE: 490dde5845aSJiri Kosina 491dde5845aSJiri Kosina if (parser->local.delimiter_branch > 1) { 49258037eb9SJiri Kosina dbg_hid("alternative usage ignored\n"); 493dde5845aSJiri Kosina return 0; 494dde5845aSJiri Kosina } 495dde5845aSJiri Kosina 496dde5845aSJiri Kosina if (item->size <= 2) 497dde5845aSJiri Kosina data = (parser->global.usage_page << 16) + data; 498dde5845aSJiri Kosina 499dde5845aSJiri Kosina return hid_add_usage(parser, data); 500dde5845aSJiri Kosina 501dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM: 502dde5845aSJiri Kosina 503dde5845aSJiri Kosina if (parser->local.delimiter_branch > 1) { 50458037eb9SJiri Kosina dbg_hid("alternative usage ignored\n"); 505dde5845aSJiri Kosina return 0; 506dde5845aSJiri Kosina } 507dde5845aSJiri Kosina 508dde5845aSJiri Kosina if (item->size <= 2) 509dde5845aSJiri Kosina data = (parser->global.usage_page << 16) + data; 510dde5845aSJiri Kosina 511dde5845aSJiri Kosina parser->local.usage_minimum = data; 512dde5845aSJiri Kosina return 0; 513dde5845aSJiri Kosina 514dde5845aSJiri Kosina case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM: 515dde5845aSJiri Kosina 516dde5845aSJiri Kosina if (parser->local.delimiter_branch > 1) { 51758037eb9SJiri Kosina dbg_hid("alternative usage ignored\n"); 518dde5845aSJiri Kosina return 0; 519dde5845aSJiri Kosina } 520dde5845aSJiri Kosina 521dde5845aSJiri Kosina if (item->size <= 2) 522dde5845aSJiri Kosina data = (parser->global.usage_page << 16) + data; 523dde5845aSJiri Kosina 524ba532198SBenjamin Tissoires count = data - parser->local.usage_minimum; 525ba532198SBenjamin Tissoires if (count + parser->local.usage_index >= HID_MAX_USAGES) { 526ba532198SBenjamin Tissoires /* 527ba532198SBenjamin Tissoires * We do not warn if the name is not set, we are 528ba532198SBenjamin Tissoires * actually pre-scanning the device. 529ba532198SBenjamin Tissoires */ 530ba532198SBenjamin Tissoires if (dev_name(&parser->device->dev)) 531ba532198SBenjamin Tissoires hid_warn(parser->device, 532ba532198SBenjamin Tissoires "ignoring exceeding usage max\n"); 533ba532198SBenjamin Tissoires data = HID_MAX_USAGES - parser->local.usage_index + 534ba532198SBenjamin Tissoires parser->local.usage_minimum - 1; 535ba532198SBenjamin Tissoires if (data <= 0) { 536ba532198SBenjamin Tissoires hid_err(parser->device, 537ba532198SBenjamin Tissoires "no more usage index available\n"); 538ba532198SBenjamin Tissoires return -1; 539ba532198SBenjamin Tissoires } 540ba532198SBenjamin Tissoires } 541ba532198SBenjamin Tissoires 542dde5845aSJiri Kosina for (n = parser->local.usage_minimum; n <= data; n++) 543dde5845aSJiri Kosina if (hid_add_usage(parser, n)) { 54458037eb9SJiri Kosina dbg_hid("hid_add_usage failed\n"); 545dde5845aSJiri Kosina return -1; 546dde5845aSJiri Kosina } 547dde5845aSJiri Kosina return 0; 548dde5845aSJiri Kosina 549dde5845aSJiri Kosina default: 550dde5845aSJiri Kosina 55158037eb9SJiri Kosina dbg_hid("unknown local item tag 0x%x\n", item->tag); 552dde5845aSJiri Kosina return 0; 553dde5845aSJiri Kosina } 554dde5845aSJiri Kosina return 0; 555dde5845aSJiri Kosina } 556dde5845aSJiri Kosina 557dde5845aSJiri Kosina /* 558dde5845aSJiri Kosina * Process a main item. 559dde5845aSJiri Kosina */ 560dde5845aSJiri Kosina 561dde5845aSJiri Kosina static int hid_parser_main(struct hid_parser *parser, struct hid_item *item) 562dde5845aSJiri Kosina { 563dde5845aSJiri Kosina __u32 data; 564dde5845aSJiri Kosina int ret; 565dde5845aSJiri Kosina 566dde5845aSJiri Kosina data = item_udata(item); 567dde5845aSJiri Kosina 568dde5845aSJiri Kosina switch (item->tag) { 569dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION: 570dde5845aSJiri Kosina ret = open_collection(parser, data & 0xff); 571dde5845aSJiri Kosina break; 572dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_END_COLLECTION: 573dde5845aSJiri Kosina ret = close_collection(parser); 574dde5845aSJiri Kosina break; 575dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_INPUT: 576dde5845aSJiri Kosina ret = hid_add_field(parser, HID_INPUT_REPORT, data); 577dde5845aSJiri Kosina break; 578dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_OUTPUT: 579dde5845aSJiri Kosina ret = hid_add_field(parser, HID_OUTPUT_REPORT, data); 580dde5845aSJiri Kosina break; 581dde5845aSJiri Kosina case HID_MAIN_ITEM_TAG_FEATURE: 582dde5845aSJiri Kosina ret = hid_add_field(parser, HID_FEATURE_REPORT, data); 583dde5845aSJiri Kosina break; 584dde5845aSJiri Kosina default: 5857cb4774eSHans de Goede hid_warn(parser->device, "unknown main item tag 0x%x\n", item->tag); 586dde5845aSJiri Kosina ret = 0; 587dde5845aSJiri Kosina } 588dde5845aSJiri Kosina 589dde5845aSJiri Kosina memset(&parser->local, 0, sizeof(parser->local)); /* Reset the local parser environment */ 590dde5845aSJiri Kosina 591dde5845aSJiri Kosina return ret; 592dde5845aSJiri Kosina } 593dde5845aSJiri Kosina 594dde5845aSJiri Kosina /* 595dde5845aSJiri Kosina * Process a reserved item. 596dde5845aSJiri Kosina */ 597dde5845aSJiri Kosina 598dde5845aSJiri Kosina static int hid_parser_reserved(struct hid_parser *parser, struct hid_item *item) 599dde5845aSJiri Kosina { 60058037eb9SJiri Kosina dbg_hid("reserved item type, tag 0x%x\n", item->tag); 601dde5845aSJiri Kosina return 0; 602dde5845aSJiri Kosina } 603dde5845aSJiri Kosina 604dde5845aSJiri Kosina /* 605dde5845aSJiri Kosina * Free a report and all registered fields. The field->usage and 606dde5845aSJiri Kosina * field->value table's are allocated behind the field, so we need 607dde5845aSJiri Kosina * only to free(field) itself. 608dde5845aSJiri Kosina */ 609dde5845aSJiri Kosina 610dde5845aSJiri Kosina static void hid_free_report(struct hid_report *report) 611dde5845aSJiri Kosina { 612dde5845aSJiri Kosina unsigned n; 613dde5845aSJiri Kosina 614dde5845aSJiri Kosina for (n = 0; n < report->maxfield; n++) 615dde5845aSJiri Kosina kfree(report->field[n]); 616dde5845aSJiri Kosina kfree(report); 617dde5845aSJiri Kosina } 618dde5845aSJiri Kosina 619dde5845aSJiri Kosina /* 620a7197c2eSHenrik Rydberg * Close report. This function returns the device 621a7197c2eSHenrik Rydberg * state to the point prior to hid_open_report(). 622dde5845aSJiri Kosina */ 623a7197c2eSHenrik Rydberg static void hid_close_report(struct hid_device *device) 624dde5845aSJiri Kosina { 625dde5845aSJiri Kosina unsigned i, j; 626dde5845aSJiri Kosina 627dde5845aSJiri Kosina for (i = 0; i < HID_REPORT_TYPES; i++) { 628dde5845aSJiri Kosina struct hid_report_enum *report_enum = device->report_enum + i; 629dde5845aSJiri Kosina 63043622021SKees Cook for (j = 0; j < HID_MAX_IDS; j++) { 631dde5845aSJiri Kosina struct hid_report *report = report_enum->report_id_hash[j]; 632dde5845aSJiri Kosina if (report) 633dde5845aSJiri Kosina hid_free_report(report); 634dde5845aSJiri Kosina } 635a7197c2eSHenrik Rydberg memset(report_enum, 0, sizeof(*report_enum)); 636a7197c2eSHenrik Rydberg INIT_LIST_HEAD(&report_enum->report_list); 637dde5845aSJiri Kosina } 638dde5845aSJiri Kosina 639dde5845aSJiri Kosina kfree(device->rdesc); 640a7197c2eSHenrik Rydberg device->rdesc = NULL; 641a7197c2eSHenrik Rydberg device->rsize = 0; 642a7197c2eSHenrik Rydberg 643767fe787SJiri Kosina kfree(device->collection); 644a7197c2eSHenrik Rydberg device->collection = NULL; 645a7197c2eSHenrik Rydberg device->collection_size = 0; 646a7197c2eSHenrik Rydberg device->maxcollection = 0; 647a7197c2eSHenrik Rydberg device->maxapplication = 0; 648a7197c2eSHenrik Rydberg 649a7197c2eSHenrik Rydberg device->status &= ~HID_STAT_PARSED; 650a7197c2eSHenrik Rydberg } 651a7197c2eSHenrik Rydberg 652a7197c2eSHenrik Rydberg /* 653a7197c2eSHenrik Rydberg * Free a device structure, all reports, and all fields. 654a7197c2eSHenrik Rydberg */ 655a7197c2eSHenrik Rydberg 656a7197c2eSHenrik Rydberg static void hid_device_release(struct device *dev) 657a7197c2eSHenrik Rydberg { 658ee79a8f8SGeliang Tang struct hid_device *hid = to_hid_device(dev); 659a7197c2eSHenrik Rydberg 660a7197c2eSHenrik Rydberg hid_close_report(hid); 661a7197c2eSHenrik Rydberg kfree(hid->dev_rdesc); 662a7197c2eSHenrik Rydberg kfree(hid); 663dde5845aSJiri Kosina } 664dde5845aSJiri Kosina 665dde5845aSJiri Kosina /* 666dde5845aSJiri Kosina * Fetch a report description item from the data stream. We support long 667dde5845aSJiri Kosina * items, though they are not used yet. 668dde5845aSJiri Kosina */ 669dde5845aSJiri Kosina 670dde5845aSJiri Kosina static u8 *fetch_item(__u8 *start, __u8 *end, struct hid_item *item) 671dde5845aSJiri Kosina { 672dde5845aSJiri Kosina u8 b; 673dde5845aSJiri Kosina 674dde5845aSJiri Kosina if ((end - start) <= 0) 675dde5845aSJiri Kosina return NULL; 676dde5845aSJiri Kosina 677dde5845aSJiri Kosina b = *start++; 678dde5845aSJiri Kosina 679dde5845aSJiri Kosina item->type = (b >> 2) & 3; 680dde5845aSJiri Kosina item->tag = (b >> 4) & 15; 681dde5845aSJiri Kosina 682dde5845aSJiri Kosina if (item->tag == HID_ITEM_TAG_LONG) { 683dde5845aSJiri Kosina 684dde5845aSJiri Kosina item->format = HID_ITEM_FORMAT_LONG; 685dde5845aSJiri Kosina 686dde5845aSJiri Kosina if ((end - start) < 2) 687dde5845aSJiri Kosina return NULL; 688dde5845aSJiri Kosina 689dde5845aSJiri Kosina item->size = *start++; 690dde5845aSJiri Kosina item->tag = *start++; 691dde5845aSJiri Kosina 692dde5845aSJiri Kosina if ((end - start) < item->size) 693dde5845aSJiri Kosina return NULL; 694dde5845aSJiri Kosina 695dde5845aSJiri Kosina item->data.longdata = start; 696dde5845aSJiri Kosina start += item->size; 697dde5845aSJiri Kosina return start; 698dde5845aSJiri Kosina } 699dde5845aSJiri Kosina 700dde5845aSJiri Kosina item->format = HID_ITEM_FORMAT_SHORT; 701dde5845aSJiri Kosina item->size = b & 3; 702dde5845aSJiri Kosina 703dde5845aSJiri Kosina switch (item->size) { 704dde5845aSJiri Kosina case 0: 705dde5845aSJiri Kosina return start; 706dde5845aSJiri Kosina 707dde5845aSJiri Kosina case 1: 708dde5845aSJiri Kosina if ((end - start) < 1) 709dde5845aSJiri Kosina return NULL; 710dde5845aSJiri Kosina item->data.u8 = *start++; 711dde5845aSJiri Kosina return start; 712dde5845aSJiri Kosina 713dde5845aSJiri Kosina case 2: 714dde5845aSJiri Kosina if ((end - start) < 2) 715dde5845aSJiri Kosina return NULL; 716c105068fSHarvey Harrison item->data.u16 = get_unaligned_le16(start); 717dde5845aSJiri Kosina start = (__u8 *)((__le16 *)start + 1); 718dde5845aSJiri Kosina return start; 719dde5845aSJiri Kosina 720dde5845aSJiri Kosina case 3: 721dde5845aSJiri Kosina item->size++; 722dde5845aSJiri Kosina if ((end - start) < 4) 723dde5845aSJiri Kosina return NULL; 724c105068fSHarvey Harrison item->data.u32 = get_unaligned_le32(start); 725dde5845aSJiri Kosina start = (__u8 *)((__le32 *)start + 1); 726dde5845aSJiri Kosina return start; 727dde5845aSJiri Kosina } 728dde5845aSJiri Kosina 729dde5845aSJiri Kosina return NULL; 730dde5845aSJiri Kosina } 731dde5845aSJiri Kosina 7323dc8fc08SBenjamin Tissoires static void hid_scan_input_usage(struct hid_parser *parser, u32 usage) 733734c6609SHenrik Rydberg { 7343dc8fc08SBenjamin Tissoires struct hid_device *hid = parser->device; 7353dc8fc08SBenjamin Tissoires 7364fa3a583SHenrik Rydberg if (usage == HID_DG_CONTACTID) 7374fa3a583SHenrik Rydberg hid->group = HID_GROUP_MULTITOUCH; 738734c6609SHenrik Rydberg } 739734c6609SHenrik Rydberg 740f961bd35SBenjamin Tissoires static void hid_scan_feature_usage(struct hid_parser *parser, u32 usage) 741f961bd35SBenjamin Tissoires { 742f961bd35SBenjamin Tissoires if (usage == 0xff0000c5 && parser->global.report_count == 256 && 743f961bd35SBenjamin Tissoires parser->global.report_size == 8) 744f961bd35SBenjamin Tissoires parser->scan_flags |= HID_SCAN_FLAG_MT_WIN_8; 745f961bd35SBenjamin Tissoires } 746f961bd35SBenjamin Tissoires 7473dc8fc08SBenjamin Tissoires static void hid_scan_collection(struct hid_parser *parser, unsigned type) 7483dc8fc08SBenjamin Tissoires { 7493dc8fc08SBenjamin Tissoires struct hid_device *hid = parser->device; 750e39f2d59SAndrew Duggan int i; 7513dc8fc08SBenjamin Tissoires 7523dc8fc08SBenjamin Tissoires if (((parser->global.usage_page << 16) == HID_UP_SENSOR) && 7533dc8fc08SBenjamin Tissoires type == HID_COLLECTION_PHYSICAL) 7543dc8fc08SBenjamin Tissoires hid->group = HID_GROUP_SENSOR_HUB; 755be3b1634SAlan Wu 756be3b1634SAlan Wu if (hid->vendor == USB_VENDOR_ID_MICROSOFT && 7570a76ac80SDennis Chen hid->product == USB_DEVICE_ID_MS_POWER_COVER && 758be3b1634SAlan Wu hid->group == HID_GROUP_MULTITOUCH) 759be3b1634SAlan Wu hid->group = HID_GROUP_GENERIC; 760e39f2d59SAndrew Duggan 761e39f2d59SAndrew Duggan if ((parser->global.usage_page << 16) == HID_UP_GENDESK) 762e39f2d59SAndrew Duggan for (i = 0; i < parser->local.usage_index; i++) 763e39f2d59SAndrew Duggan if (parser->local.usage[i] == HID_GD_POINTER) 764e39f2d59SAndrew Duggan parser->scan_flags |= HID_SCAN_FLAG_GD_POINTER; 765e39f2d59SAndrew Duggan 766e39f2d59SAndrew Duggan if ((parser->global.usage_page << 16) >= HID_UP_MSVENDOR) 767e39f2d59SAndrew Duggan parser->scan_flags |= HID_SCAN_FLAG_VENDOR_SPECIFIC; 7683dc8fc08SBenjamin Tissoires } 7693dc8fc08SBenjamin Tissoires 7703dc8fc08SBenjamin Tissoires static int hid_scan_main(struct hid_parser *parser, struct hid_item *item) 7713dc8fc08SBenjamin Tissoires { 7723dc8fc08SBenjamin Tissoires __u32 data; 7733dc8fc08SBenjamin Tissoires int i; 7743dc8fc08SBenjamin Tissoires 7753dc8fc08SBenjamin Tissoires data = item_udata(item); 7763dc8fc08SBenjamin Tissoires 7773dc8fc08SBenjamin Tissoires switch (item->tag) { 7783dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_BEGIN_COLLECTION: 7793dc8fc08SBenjamin Tissoires hid_scan_collection(parser, data & 0xff); 7803dc8fc08SBenjamin Tissoires break; 7813dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_END_COLLECTION: 7823dc8fc08SBenjamin Tissoires break; 7833dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_INPUT: 784e24d0d39SBenjamin Tissoires /* ignore constant inputs, they will be ignored by hid-input */ 785e24d0d39SBenjamin Tissoires if (data & HID_MAIN_ITEM_CONSTANT) 786e24d0d39SBenjamin Tissoires break; 7873dc8fc08SBenjamin Tissoires for (i = 0; i < parser->local.usage_index; i++) 7883dc8fc08SBenjamin Tissoires hid_scan_input_usage(parser, parser->local.usage[i]); 7893dc8fc08SBenjamin Tissoires break; 7903dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_OUTPUT: 7913dc8fc08SBenjamin Tissoires break; 7923dc8fc08SBenjamin Tissoires case HID_MAIN_ITEM_TAG_FEATURE: 793f961bd35SBenjamin Tissoires for (i = 0; i < parser->local.usage_index; i++) 794f961bd35SBenjamin Tissoires hid_scan_feature_usage(parser, parser->local.usage[i]); 7953dc8fc08SBenjamin Tissoires break; 7963dc8fc08SBenjamin Tissoires } 7973dc8fc08SBenjamin Tissoires 7983dc8fc08SBenjamin Tissoires /* Reset the local parser environment */ 7993dc8fc08SBenjamin Tissoires memset(&parser->local, 0, sizeof(parser->local)); 8003dc8fc08SBenjamin Tissoires 8013dc8fc08SBenjamin Tissoires return 0; 8023dc8fc08SBenjamin Tissoires } 8033dc8fc08SBenjamin Tissoires 804734c6609SHenrik Rydberg /* 805734c6609SHenrik Rydberg * Scan a report descriptor before the device is added to the bus. 806734c6609SHenrik Rydberg * Sets device groups and other properties that determine what driver 807734c6609SHenrik Rydberg * to load. 808734c6609SHenrik Rydberg */ 809734c6609SHenrik Rydberg static int hid_scan_report(struct hid_device *hid) 810734c6609SHenrik Rydberg { 8113dc8fc08SBenjamin Tissoires struct hid_parser *parser; 8123dc8fc08SBenjamin Tissoires struct hid_item item; 813734c6609SHenrik Rydberg __u8 *start = hid->dev_rdesc; 814734c6609SHenrik Rydberg __u8 *end = start + hid->dev_rsize; 8153dc8fc08SBenjamin Tissoires static int (*dispatch_type[])(struct hid_parser *parser, 8163dc8fc08SBenjamin Tissoires struct hid_item *item) = { 8173dc8fc08SBenjamin Tissoires hid_scan_main, 8183dc8fc08SBenjamin Tissoires hid_parser_global, 8193dc8fc08SBenjamin Tissoires hid_parser_local, 8203dc8fc08SBenjamin Tissoires hid_parser_reserved 8213dc8fc08SBenjamin Tissoires }; 822734c6609SHenrik Rydberg 8233dc8fc08SBenjamin Tissoires parser = vzalloc(sizeof(struct hid_parser)); 8243dc8fc08SBenjamin Tissoires if (!parser) 8253dc8fc08SBenjamin Tissoires return -ENOMEM; 8263dc8fc08SBenjamin Tissoires 8273dc8fc08SBenjamin Tissoires parser->device = hid; 828*ee46967fSPeter Hutterer parser->active_collection_idx = -1; 829734c6609SHenrik Rydberg hid->group = HID_GROUP_GENERIC; 830734c6609SHenrik Rydberg 8313dc8fc08SBenjamin Tissoires /* 8323dc8fc08SBenjamin Tissoires * The parsing is simpler than the one in hid_open_report() as we should 8333dc8fc08SBenjamin Tissoires * be robust against hid errors. Those errors will be raised by 8343dc8fc08SBenjamin Tissoires * hid_open_report() anyway. 8353dc8fc08SBenjamin Tissoires */ 8363dc8fc08SBenjamin Tissoires while ((start = fetch_item(start, end, &item)) != NULL) 8373dc8fc08SBenjamin Tissoires dispatch_type[item.type](parser, &item); 8383dc8fc08SBenjamin Tissoires 839f961bd35SBenjamin Tissoires /* 840f961bd35SBenjamin Tissoires * Handle special flags set during scanning. 841f961bd35SBenjamin Tissoires */ 842f961bd35SBenjamin Tissoires if ((parser->scan_flags & HID_SCAN_FLAG_MT_WIN_8) && 843f961bd35SBenjamin Tissoires (hid->group == HID_GROUP_MULTITOUCH)) 844f961bd35SBenjamin Tissoires hid->group = HID_GROUP_MULTITOUCH_WIN_8; 845f961bd35SBenjamin Tissoires 846ba391e5aSBenjamin Tissoires /* 847ba391e5aSBenjamin Tissoires * Vendor specific handlings 848ba391e5aSBenjamin Tissoires */ 84929b47391SBenjamin Tissoires switch (hid->vendor) { 85029b47391SBenjamin Tissoires case USB_VENDOR_ID_WACOM: 85129b47391SBenjamin Tissoires hid->group = HID_GROUP_WACOM; 85229b47391SBenjamin Tissoires break; 853c241c5eeSBenjamin Tissoires case USB_VENDOR_ID_SYNAPTICS: 85484379d83SJiri Kosina if (hid->group == HID_GROUP_GENERIC) 855e39f2d59SAndrew Duggan if ((parser->scan_flags & HID_SCAN_FLAG_VENDOR_SPECIFIC) 856e39f2d59SAndrew Duggan && (parser->scan_flags & HID_SCAN_FLAG_GD_POINTER)) 857e39f2d59SAndrew Duggan /* 858e39f2d59SAndrew Duggan * hid-rmi should take care of them, 859e39f2d59SAndrew Duggan * not hid-generic 860e39f2d59SAndrew Duggan */ 861c241c5eeSBenjamin Tissoires hid->group = HID_GROUP_RMI; 862c241c5eeSBenjamin Tissoires break; 86329b47391SBenjamin Tissoires } 86429b47391SBenjamin Tissoires 86508a8a7cfSBenjamin Tissoires kfree(parser->collection_stack); 8663dc8fc08SBenjamin Tissoires vfree(parser); 867734c6609SHenrik Rydberg return 0; 868734c6609SHenrik Rydberg } 869734c6609SHenrik Rydberg 87085cdaf52SJiri Slaby /** 87185cdaf52SJiri Slaby * hid_parse_report - parse device report 87285cdaf52SJiri Slaby * 87385cdaf52SJiri Slaby * @device: hid device 87485cdaf52SJiri Slaby * @start: report start 87585cdaf52SJiri Slaby * @size: report size 87685cdaf52SJiri Slaby * 877a7197c2eSHenrik Rydberg * Allocate the device report as read by the bus driver. This function should 878a7197c2eSHenrik Rydberg * only be called from parse() in ll drivers. 879a7197c2eSHenrik Rydberg */ 880a7197c2eSHenrik Rydberg int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size) 881a7197c2eSHenrik Rydberg { 882a7197c2eSHenrik Rydberg hid->dev_rdesc = kmemdup(start, size, GFP_KERNEL); 883a7197c2eSHenrik Rydberg if (!hid->dev_rdesc) 884a7197c2eSHenrik Rydberg return -ENOMEM; 885a7197c2eSHenrik Rydberg hid->dev_rsize = size; 886a7197c2eSHenrik Rydberg return 0; 887a7197c2eSHenrik Rydberg } 888a7197c2eSHenrik Rydberg EXPORT_SYMBOL_GPL(hid_parse_report); 889a7197c2eSHenrik Rydberg 890331415ffSKees Cook static const char * const hid_report_names[] = { 891331415ffSKees Cook "HID_INPUT_REPORT", 892331415ffSKees Cook "HID_OUTPUT_REPORT", 893331415ffSKees Cook "HID_FEATURE_REPORT", 894331415ffSKees Cook }; 895331415ffSKees Cook /** 896331415ffSKees Cook * hid_validate_values - validate existing device report's value indexes 897331415ffSKees Cook * 898331415ffSKees Cook * @device: hid device 899331415ffSKees Cook * @type: which report type to examine 900331415ffSKees Cook * @id: which report ID to examine (0 for first) 901331415ffSKees Cook * @field_index: which report field to examine 902331415ffSKees Cook * @report_counts: expected number of values 903331415ffSKees Cook * 904331415ffSKees Cook * Validate the number of values in a given field of a given report, after 905331415ffSKees Cook * parsing. 906331415ffSKees Cook */ 907331415ffSKees Cook struct hid_report *hid_validate_values(struct hid_device *hid, 908331415ffSKees Cook unsigned int type, unsigned int id, 909331415ffSKees Cook unsigned int field_index, 910331415ffSKees Cook unsigned int report_counts) 911331415ffSKees Cook { 912331415ffSKees Cook struct hid_report *report; 913331415ffSKees Cook 914331415ffSKees Cook if (type > HID_FEATURE_REPORT) { 915331415ffSKees Cook hid_err(hid, "invalid HID report type %u\n", type); 916331415ffSKees Cook return NULL; 917331415ffSKees Cook } 918331415ffSKees Cook 919331415ffSKees Cook if (id >= HID_MAX_IDS) { 920331415ffSKees Cook hid_err(hid, "invalid HID report id %u\n", id); 921331415ffSKees Cook return NULL; 922331415ffSKees Cook } 923331415ffSKees Cook 924331415ffSKees Cook /* 925331415ffSKees Cook * Explicitly not using hid_get_report() here since it depends on 926331415ffSKees Cook * ->numbered being checked, which may not always be the case when 927331415ffSKees Cook * drivers go to access report values. 928331415ffSKees Cook */ 9291b15d2e5SKees Cook if (id == 0) { 9301b15d2e5SKees Cook /* 9311b15d2e5SKees Cook * Validating on id 0 means we should examine the first 9321b15d2e5SKees Cook * report in the list. 9331b15d2e5SKees Cook */ 9341b15d2e5SKees Cook report = list_entry( 9351b15d2e5SKees Cook hid->report_enum[type].report_list.next, 9361b15d2e5SKees Cook struct hid_report, list); 9371b15d2e5SKees Cook } else { 938331415ffSKees Cook report = hid->report_enum[type].report_id_hash[id]; 9391b15d2e5SKees Cook } 940331415ffSKees Cook if (!report) { 941331415ffSKees Cook hid_err(hid, "missing %s %u\n", hid_report_names[type], id); 942331415ffSKees Cook return NULL; 943331415ffSKees Cook } 944331415ffSKees Cook if (report->maxfield <= field_index) { 945331415ffSKees Cook hid_err(hid, "not enough fields in %s %u\n", 946331415ffSKees Cook hid_report_names[type], id); 947331415ffSKees Cook return NULL; 948331415ffSKees Cook } 949331415ffSKees Cook if (report->field[field_index]->report_count < report_counts) { 950331415ffSKees Cook hid_err(hid, "not enough values in %s %u field %u\n", 951331415ffSKees Cook hid_report_names[type], id, field_index); 952331415ffSKees Cook return NULL; 953331415ffSKees Cook } 954331415ffSKees Cook return report; 955331415ffSKees Cook } 956331415ffSKees Cook EXPORT_SYMBOL_GPL(hid_validate_values); 957331415ffSKees Cook 9585a4abb36SPeter Hutterer static int hid_calculate_multiplier(struct hid_device *hid, 9595a4abb36SPeter Hutterer struct hid_field *multiplier) 9605a4abb36SPeter Hutterer { 9615a4abb36SPeter Hutterer int m; 9625a4abb36SPeter Hutterer __s32 v = *multiplier->value; 9635a4abb36SPeter Hutterer __s32 lmin = multiplier->logical_minimum; 9645a4abb36SPeter Hutterer __s32 lmax = multiplier->logical_maximum; 9655a4abb36SPeter Hutterer __s32 pmin = multiplier->physical_minimum; 9665a4abb36SPeter Hutterer __s32 pmax = multiplier->physical_maximum; 9675a4abb36SPeter Hutterer 9685a4abb36SPeter Hutterer /* 9695a4abb36SPeter Hutterer * "Because OS implementations will generally divide the control's 9705a4abb36SPeter Hutterer * reported count by the Effective Resolution Multiplier, designers 9715a4abb36SPeter Hutterer * should take care not to establish a potential Effective 9725a4abb36SPeter Hutterer * Resolution Multiplier of zero." 9735a4abb36SPeter Hutterer * HID Usage Table, v1.12, Section 4.3.1, p31 9745a4abb36SPeter Hutterer */ 9755a4abb36SPeter Hutterer if (lmax - lmin == 0) 9765a4abb36SPeter Hutterer return 1; 9775a4abb36SPeter Hutterer /* 9785a4abb36SPeter Hutterer * Handling the unit exponent is left as an exercise to whoever 9795a4abb36SPeter Hutterer * finds a device where that exponent is not 0. 9805a4abb36SPeter Hutterer */ 9815a4abb36SPeter Hutterer m = ((v - lmin)/(lmax - lmin) * (pmax - pmin) + pmin); 9825a4abb36SPeter Hutterer if (unlikely(multiplier->unit_exponent != 0)) { 9835a4abb36SPeter Hutterer hid_warn(hid, 9845a4abb36SPeter Hutterer "unsupported Resolution Multiplier unit exponent %d\n", 9855a4abb36SPeter Hutterer multiplier->unit_exponent); 9865a4abb36SPeter Hutterer } 9875a4abb36SPeter Hutterer 9885a4abb36SPeter Hutterer /* There are no devices with an effective multiplier > 255 */ 9895a4abb36SPeter Hutterer if (unlikely(m == 0 || m > 255 || m < -255)) { 9905a4abb36SPeter Hutterer hid_warn(hid, "unsupported Resolution Multiplier %d\n", m); 9915a4abb36SPeter Hutterer m = 1; 9925a4abb36SPeter Hutterer } 9935a4abb36SPeter Hutterer 9945a4abb36SPeter Hutterer return m; 9955a4abb36SPeter Hutterer } 9965a4abb36SPeter Hutterer 9975a4abb36SPeter Hutterer static void hid_apply_multiplier_to_field(struct hid_device *hid, 9985a4abb36SPeter Hutterer struct hid_field *field, 9995a4abb36SPeter Hutterer struct hid_collection *multiplier_collection, 10005a4abb36SPeter Hutterer int effective_multiplier) 10015a4abb36SPeter Hutterer { 10025a4abb36SPeter Hutterer struct hid_collection *collection; 10035a4abb36SPeter Hutterer struct hid_usage *usage; 10045a4abb36SPeter Hutterer int i; 10055a4abb36SPeter Hutterer 10065a4abb36SPeter Hutterer /* 10075a4abb36SPeter Hutterer * If multiplier_collection is NULL, the multiplier applies 10085a4abb36SPeter Hutterer * to all fields in the report. 10095a4abb36SPeter Hutterer * Otherwise, it is the Logical Collection the multiplier applies to 10105a4abb36SPeter Hutterer * but our field may be in a subcollection of that collection. 10115a4abb36SPeter Hutterer */ 10125a4abb36SPeter Hutterer for (i = 0; i < field->maxusage; i++) { 10135a4abb36SPeter Hutterer usage = &field->usage[i]; 10145a4abb36SPeter Hutterer 10155a4abb36SPeter Hutterer collection = &hid->collection[usage->collection_index]; 1016*ee46967fSPeter Hutterer while (collection->parent_idx != -1 && 1017*ee46967fSPeter Hutterer collection != multiplier_collection) 1018*ee46967fSPeter Hutterer collection = &hid->collection[collection->parent_idx]; 10195a4abb36SPeter Hutterer 1020*ee46967fSPeter Hutterer if (collection->parent_idx != -1 || 1021*ee46967fSPeter Hutterer multiplier_collection == NULL) 10225a4abb36SPeter Hutterer usage->resolution_multiplier = effective_multiplier; 10235a4abb36SPeter Hutterer 10245a4abb36SPeter Hutterer } 10255a4abb36SPeter Hutterer } 10265a4abb36SPeter Hutterer 10275a4abb36SPeter Hutterer static void hid_apply_multiplier(struct hid_device *hid, 10285a4abb36SPeter Hutterer struct hid_field *multiplier) 10295a4abb36SPeter Hutterer { 10305a4abb36SPeter Hutterer struct hid_report_enum *rep_enum; 10315a4abb36SPeter Hutterer struct hid_report *rep; 10325a4abb36SPeter Hutterer struct hid_field *field; 10335a4abb36SPeter Hutterer struct hid_collection *multiplier_collection; 10345a4abb36SPeter Hutterer int effective_multiplier; 10355a4abb36SPeter Hutterer int i; 10365a4abb36SPeter Hutterer 10375a4abb36SPeter Hutterer /* 10385a4abb36SPeter Hutterer * "The Resolution Multiplier control must be contained in the same 10395a4abb36SPeter Hutterer * Logical Collection as the control(s) to which it is to be applied. 10405a4abb36SPeter Hutterer * If no Resolution Multiplier is defined, then the Resolution 10415a4abb36SPeter Hutterer * Multiplier defaults to 1. If more than one control exists in a 10425a4abb36SPeter Hutterer * Logical Collection, the Resolution Multiplier is associated with 10435a4abb36SPeter Hutterer * all controls in the collection. If no Logical Collection is 10445a4abb36SPeter Hutterer * defined, the Resolution Multiplier is associated with all 10455a4abb36SPeter Hutterer * controls in the report." 10465a4abb36SPeter Hutterer * HID Usage Table, v1.12, Section 4.3.1, p30 10475a4abb36SPeter Hutterer * 10485a4abb36SPeter Hutterer * Thus, search from the current collection upwards until we find a 10495a4abb36SPeter Hutterer * logical collection. Then search all fields for that same parent 10505a4abb36SPeter Hutterer * collection. Those are the fields the multiplier applies to. 10515a4abb36SPeter Hutterer * 10525a4abb36SPeter Hutterer * If we have more than one multiplier, it will overwrite the 10535a4abb36SPeter Hutterer * applicable fields later. 10545a4abb36SPeter Hutterer */ 10555a4abb36SPeter Hutterer multiplier_collection = &hid->collection[multiplier->usage->collection_index]; 1056*ee46967fSPeter Hutterer while (multiplier_collection->parent_idx != -1 && 10575a4abb36SPeter Hutterer multiplier_collection->type != HID_COLLECTION_LOGICAL) 1058*ee46967fSPeter Hutterer multiplier_collection = &hid->collection[multiplier_collection->parent_idx]; 10595a4abb36SPeter Hutterer 10605a4abb36SPeter Hutterer effective_multiplier = hid_calculate_multiplier(hid, multiplier); 10615a4abb36SPeter Hutterer 10625a4abb36SPeter Hutterer rep_enum = &hid->report_enum[HID_INPUT_REPORT]; 10635a4abb36SPeter Hutterer list_for_each_entry(rep, &rep_enum->report_list, list) { 10645a4abb36SPeter Hutterer for (i = 0; i < rep->maxfield; i++) { 10655a4abb36SPeter Hutterer field = rep->field[i]; 10665a4abb36SPeter Hutterer hid_apply_multiplier_to_field(hid, field, 10675a4abb36SPeter Hutterer multiplier_collection, 10685a4abb36SPeter Hutterer effective_multiplier); 10695a4abb36SPeter Hutterer } 10705a4abb36SPeter Hutterer } 10715a4abb36SPeter Hutterer } 10725a4abb36SPeter Hutterer 10735a4abb36SPeter Hutterer /* 10745a4abb36SPeter Hutterer * hid_setup_resolution_multiplier - set up all resolution multipliers 10755a4abb36SPeter Hutterer * 10765a4abb36SPeter Hutterer * @device: hid device 10775a4abb36SPeter Hutterer * 10785a4abb36SPeter Hutterer * Search for all Resolution Multiplier Feature Reports and apply their 10795a4abb36SPeter Hutterer * value to all matching Input items. This only updates the internal struct 10805a4abb36SPeter Hutterer * fields. 10815a4abb36SPeter Hutterer * 10825a4abb36SPeter Hutterer * The Resolution Multiplier is applied by the hardware. If the multiplier 10835a4abb36SPeter Hutterer * is anything other than 1, the hardware will send pre-multiplied events 10845a4abb36SPeter Hutterer * so that the same physical interaction generates an accumulated 10855a4abb36SPeter Hutterer * accumulated_value = value * * multiplier 10865a4abb36SPeter Hutterer * This may be achieved by sending 10875a4abb36SPeter Hutterer * - "value * multiplier" for each event, or 10885a4abb36SPeter Hutterer * - "value" but "multiplier" times as frequently, or 10895a4abb36SPeter Hutterer * - a combination of the above 10905a4abb36SPeter Hutterer * The only guarantee is that the same physical interaction always generates 10915a4abb36SPeter Hutterer * an accumulated 'value * multiplier'. 10925a4abb36SPeter Hutterer * 10935a4abb36SPeter Hutterer * This function must be called before any event processing and after 10945a4abb36SPeter Hutterer * any SetRequest to the Resolution Multiplier. 10955a4abb36SPeter Hutterer */ 10965a4abb36SPeter Hutterer void hid_setup_resolution_multiplier(struct hid_device *hid) 10975a4abb36SPeter Hutterer { 10985a4abb36SPeter Hutterer struct hid_report_enum *rep_enum; 10995a4abb36SPeter Hutterer struct hid_report *rep; 11005a4abb36SPeter Hutterer struct hid_usage *usage; 11015a4abb36SPeter Hutterer int i, j; 11025a4abb36SPeter Hutterer 11035a4abb36SPeter Hutterer rep_enum = &hid->report_enum[HID_FEATURE_REPORT]; 11045a4abb36SPeter Hutterer list_for_each_entry(rep, &rep_enum->report_list, list) { 11055a4abb36SPeter Hutterer for (i = 0; i < rep->maxfield; i++) { 11065a4abb36SPeter Hutterer /* Ignore if report count is out of bounds. */ 11075a4abb36SPeter Hutterer if (rep->field[i]->report_count < 1) 11085a4abb36SPeter Hutterer continue; 11095a4abb36SPeter Hutterer 11105a4abb36SPeter Hutterer for (j = 0; j < rep->field[i]->maxusage; j++) { 11115a4abb36SPeter Hutterer usage = &rep->field[i]->usage[j]; 11125a4abb36SPeter Hutterer if (usage->hid == HID_GD_RESOLUTION_MULTIPLIER) 11135a4abb36SPeter Hutterer hid_apply_multiplier(hid, 11145a4abb36SPeter Hutterer rep->field[i]); 11155a4abb36SPeter Hutterer } 11165a4abb36SPeter Hutterer } 11175a4abb36SPeter Hutterer } 11185a4abb36SPeter Hutterer } 11195a4abb36SPeter Hutterer EXPORT_SYMBOL_GPL(hid_setup_resolution_multiplier); 11205a4abb36SPeter Hutterer 1121a7197c2eSHenrik Rydberg /** 1122a7197c2eSHenrik Rydberg * hid_open_report - open a driver-specific device report 1123a7197c2eSHenrik Rydberg * 1124a7197c2eSHenrik Rydberg * @device: hid device 1125a7197c2eSHenrik Rydberg * 1126dde5845aSJiri Kosina * Parse a report description into a hid_device structure. Reports are 1127dde5845aSJiri Kosina * enumerated, fields are attached to these reports. 112885cdaf52SJiri Slaby * 0 returned on success, otherwise nonzero error value. 1129a7197c2eSHenrik Rydberg * 1130a7197c2eSHenrik Rydberg * This function (or the equivalent hid_parse() macro) should only be 1131a7197c2eSHenrik Rydberg * called from probe() in drivers, before starting the device. 1132dde5845aSJiri Kosina */ 1133a7197c2eSHenrik Rydberg int hid_open_report(struct hid_device *device) 1134dde5845aSJiri Kosina { 1135dde5845aSJiri Kosina struct hid_parser *parser; 1136dde5845aSJiri Kosina struct hid_item item; 1137a7197c2eSHenrik Rydberg unsigned int size; 1138a7197c2eSHenrik Rydberg __u8 *start; 113986e6b77eSKevin Daughtridge __u8 *buf; 1140dde5845aSJiri Kosina __u8 *end; 114185cdaf52SJiri Slaby int ret; 1142dde5845aSJiri Kosina static int (*dispatch_type[])(struct hid_parser *parser, 1143dde5845aSJiri Kosina struct hid_item *item) = { 1144dde5845aSJiri Kosina hid_parser_main, 1145dde5845aSJiri Kosina hid_parser_global, 1146dde5845aSJiri Kosina hid_parser_local, 1147dde5845aSJiri Kosina hid_parser_reserved 1148dde5845aSJiri Kosina }; 1149dde5845aSJiri Kosina 1150a7197c2eSHenrik Rydberg if (WARN_ON(device->status & HID_STAT_PARSED)) 1151a7197c2eSHenrik Rydberg return -EBUSY; 1152a7197c2eSHenrik Rydberg 1153a7197c2eSHenrik Rydberg start = device->dev_rdesc; 1154a7197c2eSHenrik Rydberg if (WARN_ON(!start)) 1155a7197c2eSHenrik Rydberg return -ENODEV; 1156a7197c2eSHenrik Rydberg size = device->dev_rsize; 1157a7197c2eSHenrik Rydberg 115886e6b77eSKevin Daughtridge buf = kmemdup(start, size, GFP_KERNEL); 115986e6b77eSKevin Daughtridge if (buf == NULL) 116085cdaf52SJiri Slaby return -ENOMEM; 116186e6b77eSKevin Daughtridge 116286e6b77eSKevin Daughtridge if (device->driver->report_fixup) 116386e6b77eSKevin Daughtridge start = device->driver->report_fixup(device, buf, &size); 116486e6b77eSKevin Daughtridge else 116586e6b77eSKevin Daughtridge start = buf; 116686e6b77eSKevin Daughtridge 116786e6b77eSKevin Daughtridge start = kmemdup(start, size, GFP_KERNEL); 116886e6b77eSKevin Daughtridge kfree(buf); 116986e6b77eSKevin Daughtridge if (start == NULL) 117086e6b77eSKevin Daughtridge return -ENOMEM; 117186e6b77eSKevin Daughtridge 117286e6b77eSKevin Daughtridge device->rdesc = start; 1173dde5845aSJiri Kosina device->rsize = size; 1174dde5845aSJiri Kosina 1175fe258020SJoe Perches parser = vzalloc(sizeof(struct hid_parser)); 117685cdaf52SJiri Slaby if (!parser) { 117785cdaf52SJiri Slaby ret = -ENOMEM; 1178b034ed50SGustavo A. R. Silva goto alloc_err; 1179dde5845aSJiri Kosina } 118085cdaf52SJiri Slaby 1181dde5845aSJiri Kosina parser->device = device; 1182*ee46967fSPeter Hutterer parser->active_collection_idx = -1; 1183dde5845aSJiri Kosina 1184dde5845aSJiri Kosina end = start + size; 1185a7197c2eSHenrik Rydberg 1186a7197c2eSHenrik Rydberg device->collection = kcalloc(HID_DEFAULT_NUM_COLLECTIONS, 1187a7197c2eSHenrik Rydberg sizeof(struct hid_collection), GFP_KERNEL); 1188a7197c2eSHenrik Rydberg if (!device->collection) { 1189a7197c2eSHenrik Rydberg ret = -ENOMEM; 1190a7197c2eSHenrik Rydberg goto err; 1191a7197c2eSHenrik Rydberg } 1192a7197c2eSHenrik Rydberg device->collection_size = HID_DEFAULT_NUM_COLLECTIONS; 1193a7197c2eSHenrik Rydberg 119485cdaf52SJiri Slaby ret = -EINVAL; 1195dde5845aSJiri Kosina while ((start = fetch_item(start, end, &item)) != NULL) { 1196dde5845aSJiri Kosina 1197dde5845aSJiri Kosina if (item.format != HID_ITEM_FORMAT_SHORT) { 11988c3d52fcSJiri Kosina hid_err(device, "unexpected long global item\n"); 119985cdaf52SJiri Slaby goto err; 1200dde5845aSJiri Kosina } 1201dde5845aSJiri Kosina 1202dde5845aSJiri Kosina if (dispatch_type[item.type](parser, &item)) { 12038c3d52fcSJiri Kosina hid_err(device, "item %u %u %u %u parsing failed\n", 12044291ee30SJoe Perches item.format, (unsigned)item.size, 12054291ee30SJoe Perches (unsigned)item.type, (unsigned)item.tag); 120685cdaf52SJiri Slaby goto err; 1207dde5845aSJiri Kosina } 1208dde5845aSJiri Kosina 1209dde5845aSJiri Kosina if (start == end) { 1210dde5845aSJiri Kosina if (parser->collection_stack_ptr) { 12118c3d52fcSJiri Kosina hid_err(device, "unbalanced collection at end of report description\n"); 121285cdaf52SJiri Slaby goto err; 1213dde5845aSJiri Kosina } 1214dde5845aSJiri Kosina if (parser->local.delimiter_depth) { 12158c3d52fcSJiri Kosina hid_err(device, "unbalanced delimiter at end of report description\n"); 121685cdaf52SJiri Slaby goto err; 1217dde5845aSJiri Kosina } 12185a4abb36SPeter Hutterer 12195a4abb36SPeter Hutterer /* 12205a4abb36SPeter Hutterer * fetch initial values in case the device's 12215a4abb36SPeter Hutterer * default multiplier isn't the recommended 1 12225a4abb36SPeter Hutterer */ 12235a4abb36SPeter Hutterer hid_setup_resolution_multiplier(device); 12245a4abb36SPeter Hutterer 1225b2dd9f2eSStefan Agner kfree(parser->collection_stack); 122647a80edbSJiri Kosina vfree(parser); 1227a7197c2eSHenrik Rydberg device->status |= HID_STAT_PARSED; 12285a4abb36SPeter Hutterer 122985cdaf52SJiri Slaby return 0; 1230dde5845aSJiri Kosina } 1231dde5845aSJiri Kosina } 1232dde5845aSJiri Kosina 12338c3d52fcSJiri Kosina hid_err(device, "item fetching failed at offset %d\n", (int)(end - start)); 123485cdaf52SJiri Slaby err: 1235b2dd9f2eSStefan Agner kfree(parser->collection_stack); 1236b034ed50SGustavo A. R. Silva alloc_err: 123747a80edbSJiri Kosina vfree(parser); 1238a7197c2eSHenrik Rydberg hid_close_report(device); 123985cdaf52SJiri Slaby return ret; 1240dde5845aSJiri Kosina } 1241a7197c2eSHenrik Rydberg EXPORT_SYMBOL_GPL(hid_open_report); 1242dde5845aSJiri Kosina 1243dde5845aSJiri Kosina /* 1244dde5845aSJiri Kosina * Convert a signed n-bit integer to signed 32-bit integer. Common 1245dde5845aSJiri Kosina * cases are done through the compiler, the screwed things has to be 1246dde5845aSJiri Kosina * done by hand. 1247dde5845aSJiri Kosina */ 1248dde5845aSJiri Kosina 1249dde5845aSJiri Kosina static s32 snto32(__u32 value, unsigned n) 1250dde5845aSJiri Kosina { 1251dde5845aSJiri Kosina switch (n) { 1252dde5845aSJiri Kosina case 8: return ((__s8)value); 1253dde5845aSJiri Kosina case 16: return ((__s16)value); 1254dde5845aSJiri Kosina case 32: return ((__s32)value); 1255dde5845aSJiri Kosina } 125608585e43SAndy Shevchenko return value & (1 << (n - 1)) ? value | (~0U << n) : value; 1257dde5845aSJiri Kosina } 1258dde5845aSJiri Kosina 125977463838SBenjamin Tissoires s32 hid_snto32(__u32 value, unsigned n) 126077463838SBenjamin Tissoires { 126177463838SBenjamin Tissoires return snto32(value, n); 126277463838SBenjamin Tissoires } 126377463838SBenjamin Tissoires EXPORT_SYMBOL_GPL(hid_snto32); 126477463838SBenjamin Tissoires 1265dde5845aSJiri Kosina /* 1266dde5845aSJiri Kosina * Convert a signed 32-bit integer to a signed n-bit integer. 1267dde5845aSJiri Kosina */ 1268dde5845aSJiri Kosina 1269dde5845aSJiri Kosina static u32 s32ton(__s32 value, unsigned n) 1270dde5845aSJiri Kosina { 1271dde5845aSJiri Kosina s32 a = value >> (n - 1); 1272dde5845aSJiri Kosina if (a && a != -1) 1273dde5845aSJiri Kosina return value < 0 ? 1 << (n - 1) : (1 << (n - 1)) - 1; 1274dde5845aSJiri Kosina return value & ((1 << n) - 1); 1275dde5845aSJiri Kosina } 1276dde5845aSJiri Kosina 1277dde5845aSJiri Kosina /* 1278dde5845aSJiri Kosina * Extract/implement a data field from/to a little endian report (bit array). 1279dde5845aSJiri Kosina * 1280dde5845aSJiri Kosina * Code sort-of follows HID spec: 12815137b354SDmitry Torokhov * http://www.usb.org/developers/hidpage/HID1_11.pdf 1282dde5845aSJiri Kosina * 1283dde5845aSJiri Kosina * While the USB HID spec allows unlimited length bit fields in "report 1284dde5845aSJiri Kosina * descriptors", most devices never use more than 16 bits. 1285dde5845aSJiri Kosina * One model of UPS is claimed to report "LINEV" as a 32-bit field. 1286dde5845aSJiri Kosina * Search linux-kernel and linux-usb-devel archives for "hid-core extract". 1287dde5845aSJiri Kosina */ 1288dde5845aSJiri Kosina 12895137b354SDmitry Torokhov static u32 __extract(u8 *report, unsigned offset, int n) 12905137b354SDmitry Torokhov { 12915137b354SDmitry Torokhov unsigned int idx = offset / 8; 12925137b354SDmitry Torokhov unsigned int bit_nr = 0; 12935137b354SDmitry Torokhov unsigned int bit_shift = offset % 8; 12945137b354SDmitry Torokhov int bits_to_copy = 8 - bit_shift; 12955137b354SDmitry Torokhov u32 value = 0; 12965137b354SDmitry Torokhov u32 mask = n < 32 ? (1U << n) - 1 : ~0U; 12975137b354SDmitry Torokhov 12985137b354SDmitry Torokhov while (n > 0) { 12995137b354SDmitry Torokhov value |= ((u32)report[idx] >> bit_shift) << bit_nr; 13005137b354SDmitry Torokhov n -= bits_to_copy; 13015137b354SDmitry Torokhov bit_nr += bits_to_copy; 13025137b354SDmitry Torokhov bits_to_copy = 8; 13035137b354SDmitry Torokhov bit_shift = 0; 13045137b354SDmitry Torokhov idx++; 13055137b354SDmitry Torokhov } 13065137b354SDmitry Torokhov 13075137b354SDmitry Torokhov return value & mask; 13085137b354SDmitry Torokhov } 13095137b354SDmitry Torokhov 13105137b354SDmitry Torokhov u32 hid_field_extract(const struct hid_device *hid, u8 *report, 13114291ee30SJoe Perches unsigned offset, unsigned n) 1312dde5845aSJiri Kosina { 13135137b354SDmitry Torokhov if (n > 32) { 131404fba786SGoffredo Baroncelli hid_warn(hid, "hid_field_extract() called with n (%d) > 32! (%s)\n", 1315c4124c9bSJiri Kosina n, current->comm); 13165137b354SDmitry Torokhov n = 32; 13175137b354SDmitry Torokhov } 1318dde5845aSJiri Kosina 13195137b354SDmitry Torokhov return __extract(report, offset, n); 1320dde5845aSJiri Kosina } 132104fba786SGoffredo Baroncelli EXPORT_SYMBOL_GPL(hid_field_extract); 1322dde5845aSJiri Kosina 1323dde5845aSJiri Kosina /* 1324dde5845aSJiri Kosina * "implement" : set bits in a little endian bit stream. 1325dde5845aSJiri Kosina * Same concepts as "extract" (see comments above). 1326dde5845aSJiri Kosina * The data mangled in the bit stream remains in little endian 1327dde5845aSJiri Kosina * order the whole time. It make more sense to talk about 1328dde5845aSJiri Kosina * endianness of register values by considering a register 13295137b354SDmitry Torokhov * a "cached" copy of the little endian bit stream. 1330dde5845aSJiri Kosina */ 1331dde5845aSJiri Kosina 13325137b354SDmitry Torokhov static void __implement(u8 *report, unsigned offset, int n, u32 value) 13335137b354SDmitry Torokhov { 13345137b354SDmitry Torokhov unsigned int idx = offset / 8; 13355137b354SDmitry Torokhov unsigned int bit_shift = offset % 8; 13365137b354SDmitry Torokhov int bits_to_set = 8 - bit_shift; 13375137b354SDmitry Torokhov 13385137b354SDmitry Torokhov while (n - bits_to_set >= 0) { 133995d1c895SDmitry Torokhov report[idx] &= ~(0xff << bit_shift); 13405137b354SDmitry Torokhov report[idx] |= value << bit_shift; 13415137b354SDmitry Torokhov value >>= bits_to_set; 13425137b354SDmitry Torokhov n -= bits_to_set; 13435137b354SDmitry Torokhov bits_to_set = 8; 13445137b354SDmitry Torokhov bit_shift = 0; 13455137b354SDmitry Torokhov idx++; 13465137b354SDmitry Torokhov } 13475137b354SDmitry Torokhov 13485137b354SDmitry Torokhov /* last nibble */ 13495137b354SDmitry Torokhov if (n) { 135095d1c895SDmitry Torokhov u8 bit_mask = ((1U << n) - 1); 135195d1c895SDmitry Torokhov report[idx] &= ~(bit_mask << bit_shift); 135295d1c895SDmitry Torokhov report[idx] |= value << bit_shift; 13535137b354SDmitry Torokhov } 13545137b354SDmitry Torokhov } 13555137b354SDmitry Torokhov 13565137b354SDmitry Torokhov static void implement(const struct hid_device *hid, u8 *report, 13575137b354SDmitry Torokhov unsigned offset, unsigned n, u32 value) 13585137b354SDmitry Torokhov { 135995d1c895SDmitry Torokhov if (unlikely(n > 32)) { 13604291ee30SJoe Perches hid_warn(hid, "%s() called with n (%d) > 32! (%s)\n", 13614291ee30SJoe Perches __func__, n, current->comm); 13625137b354SDmitry Torokhov n = 32; 136395d1c895SDmitry Torokhov } else if (n < 32) { 136495d1c895SDmitry Torokhov u32 m = (1U << n) - 1; 1365dde5845aSJiri Kosina 136695d1c895SDmitry Torokhov if (unlikely(value > m)) { 136795d1c895SDmitry Torokhov hid_warn(hid, 136895d1c895SDmitry Torokhov "%s() called with too large value %d (n: %d)! (%s)\n", 136995d1c895SDmitry Torokhov __func__, value, n, current->comm); 137095d1c895SDmitry Torokhov WARN_ON(1); 1371dde5845aSJiri Kosina value &= m; 137295d1c895SDmitry Torokhov } 137395d1c895SDmitry Torokhov } 1374dde5845aSJiri Kosina 13755137b354SDmitry Torokhov __implement(report, offset, n, value); 1376dde5845aSJiri Kosina } 1377dde5845aSJiri Kosina 1378dde5845aSJiri Kosina /* 1379dde5845aSJiri Kosina * Search an array for a value. 1380dde5845aSJiri Kosina */ 1381dde5845aSJiri Kosina 138216ee4cc8SJoe Perches static int search(__s32 *array, __s32 value, unsigned n) 1383dde5845aSJiri Kosina { 1384dde5845aSJiri Kosina while (n--) { 1385dde5845aSJiri Kosina if (*array++ == value) 1386dde5845aSJiri Kosina return 0; 1387dde5845aSJiri Kosina } 1388dde5845aSJiri Kosina return -1; 1389dde5845aSJiri Kosina } 1390dde5845aSJiri Kosina 139185cdaf52SJiri Slaby /** 139285cdaf52SJiri Slaby * hid_match_report - check if driver's raw_event should be called 139385cdaf52SJiri Slaby * 139485cdaf52SJiri Slaby * @hid: hid device 139585cdaf52SJiri Slaby * @report_type: type to match against 139685cdaf52SJiri Slaby * 139785cdaf52SJiri Slaby * compare hid->driver->report_table->report_type to report->type 139885cdaf52SJiri Slaby */ 139985cdaf52SJiri Slaby static int hid_match_report(struct hid_device *hid, struct hid_report *report) 1400dde5845aSJiri Kosina { 140185cdaf52SJiri Slaby const struct hid_report_id *id = hid->driver->report_table; 140285cdaf52SJiri Slaby 140385cdaf52SJiri Slaby if (!id) /* NULL means all */ 140485cdaf52SJiri Slaby return 1; 140585cdaf52SJiri Slaby 140685cdaf52SJiri Slaby for (; id->report_type != HID_TERMINATOR; id++) 140785cdaf52SJiri Slaby if (id->report_type == HID_ANY_ID || 140885cdaf52SJiri Slaby id->report_type == report->type) 140985cdaf52SJiri Slaby return 1; 141085cdaf52SJiri Slaby return 0; 141185cdaf52SJiri Slaby } 141285cdaf52SJiri Slaby 141385cdaf52SJiri Slaby /** 141485cdaf52SJiri Slaby * hid_match_usage - check if driver's event should be called 141585cdaf52SJiri Slaby * 141685cdaf52SJiri Slaby * @hid: hid device 141785cdaf52SJiri Slaby * @usage: usage to match against 141885cdaf52SJiri Slaby * 141985cdaf52SJiri Slaby * compare hid->driver->usage_table->usage_{type,code} to 142085cdaf52SJiri Slaby * usage->usage_{type,code} 142185cdaf52SJiri Slaby */ 142285cdaf52SJiri Slaby static int hid_match_usage(struct hid_device *hid, struct hid_usage *usage) 142385cdaf52SJiri Slaby { 142485cdaf52SJiri Slaby const struct hid_usage_id *id = hid->driver->usage_table; 142585cdaf52SJiri Slaby 142685cdaf52SJiri Slaby if (!id) /* NULL means all */ 142785cdaf52SJiri Slaby return 1; 142885cdaf52SJiri Slaby 142985cdaf52SJiri Slaby for (; id->usage_type != HID_ANY_ID - 1; id++) 143085cdaf52SJiri Slaby if ((id->usage_hid == HID_ANY_ID || 143185cdaf52SJiri Slaby id->usage_hid == usage->hid) && 143285cdaf52SJiri Slaby (id->usage_type == HID_ANY_ID || 143385cdaf52SJiri Slaby id->usage_type == usage->type) && 143485cdaf52SJiri Slaby (id->usage_code == HID_ANY_ID || 143585cdaf52SJiri Slaby id->usage_code == usage->code)) 143685cdaf52SJiri Slaby return 1; 143785cdaf52SJiri Slaby return 0; 143885cdaf52SJiri Slaby } 143985cdaf52SJiri Slaby 144085cdaf52SJiri Slaby static void hid_process_event(struct hid_device *hid, struct hid_field *field, 144185cdaf52SJiri Slaby struct hid_usage *usage, __s32 value, int interrupt) 144285cdaf52SJiri Slaby { 144385cdaf52SJiri Slaby struct hid_driver *hdrv = hid->driver; 144485cdaf52SJiri Slaby int ret; 144585cdaf52SJiri Slaby 14469bfc8da0SHenrik Rydberg if (!list_empty(&hid->debug_list)) 1447cd667ce2SJiri Kosina hid_dump_input(hid, usage, value); 144885cdaf52SJiri Slaby 144985cdaf52SJiri Slaby if (hdrv && hdrv->event && hid_match_usage(hid, usage)) { 145085cdaf52SJiri Slaby ret = hdrv->event(hid, field, usage, value); 145185cdaf52SJiri Slaby if (ret != 0) { 145285cdaf52SJiri Slaby if (ret < 0) 14538c3d52fcSJiri Kosina hid_err(hid, "%s's event failed with %d\n", 145485cdaf52SJiri Slaby hdrv->name, ret); 145585cdaf52SJiri Slaby return; 145685cdaf52SJiri Slaby } 145785cdaf52SJiri Slaby } 145885cdaf52SJiri Slaby 1459dde5845aSJiri Kosina if (hid->claimed & HID_CLAIMED_INPUT) 1460dde5845aSJiri Kosina hidinput_hid_event(hid, field, usage, value); 1461aa938f79SJiri Kosina if (hid->claimed & HID_CLAIMED_HIDDEV && interrupt && hid->hiddev_hid_event) 1462aa938f79SJiri Kosina hid->hiddev_hid_event(hid, field, usage, value); 1463dde5845aSJiri Kosina } 1464dde5845aSJiri Kosina 1465dde5845aSJiri Kosina /* 1466dde5845aSJiri Kosina * Analyse a received field, and fetch the data from it. The field 1467dde5845aSJiri Kosina * content is stored for next report processing (we do differential 1468dde5845aSJiri Kosina * reporting to the layer). 1469dde5845aSJiri Kosina */ 1470dde5845aSJiri Kosina 1471abdff0f7SAdrian Bunk static void hid_input_field(struct hid_device *hid, struct hid_field *field, 1472abdff0f7SAdrian Bunk __u8 *data, int interrupt) 1473dde5845aSJiri Kosina { 1474dde5845aSJiri Kosina unsigned n; 1475dde5845aSJiri Kosina unsigned count = field->report_count; 1476dde5845aSJiri Kosina unsigned offset = field->report_offset; 1477dde5845aSJiri Kosina unsigned size = field->report_size; 1478dde5845aSJiri Kosina __s32 min = field->logical_minimum; 1479dde5845aSJiri Kosina __s32 max = field->logical_maximum; 1480dde5845aSJiri Kosina __s32 *value; 1481dde5845aSJiri Kosina 14826da2ec56SKees Cook value = kmalloc_array(count, sizeof(__s32), GFP_ATOMIC); 1483a3789a17SJoe Perches if (!value) 1484dde5845aSJiri Kosina return; 1485dde5845aSJiri Kosina 1486dde5845aSJiri Kosina for (n = 0; n < count; n++) { 1487dde5845aSJiri Kosina 14884291ee30SJoe Perches value[n] = min < 0 ? 148904fba786SGoffredo Baroncelli snto32(hid_field_extract(hid, data, offset + n * size, 149004fba786SGoffredo Baroncelli size), size) : 149104fba786SGoffredo Baroncelli hid_field_extract(hid, data, offset + n * size, size); 1492dde5845aSJiri Kosina 14934291ee30SJoe Perches /* Ignore report if ErrorRollOver */ 14944291ee30SJoe Perches if (!(field->flags & HID_MAIN_ITEM_VARIABLE) && 14954291ee30SJoe Perches value[n] >= min && value[n] <= max && 149650220deaSBenjamin Tissoires value[n] - min < field->maxusage && 14974291ee30SJoe Perches field->usage[value[n] - min].hid == HID_UP_KEYBOARD + 1) 1498dde5845aSJiri Kosina goto exit; 1499dde5845aSJiri Kosina } 1500dde5845aSJiri Kosina 1501dde5845aSJiri Kosina for (n = 0; n < count; n++) { 1502dde5845aSJiri Kosina 1503dde5845aSJiri Kosina if (HID_MAIN_ITEM_VARIABLE & field->flags) { 1504dde5845aSJiri Kosina hid_process_event(hid, field, &field->usage[n], value[n], interrupt); 1505dde5845aSJiri Kosina continue; 1506dde5845aSJiri Kosina } 1507dde5845aSJiri Kosina 1508dde5845aSJiri Kosina if (field->value[n] >= min && field->value[n] <= max 150950220deaSBenjamin Tissoires && field->value[n] - min < field->maxusage 1510dde5845aSJiri Kosina && field->usage[field->value[n] - min].hid 1511dde5845aSJiri Kosina && search(value, field->value[n], count)) 1512dde5845aSJiri Kosina hid_process_event(hid, field, &field->usage[field->value[n] - min], 0, interrupt); 1513dde5845aSJiri Kosina 1514dde5845aSJiri Kosina if (value[n] >= min && value[n] <= max 151550220deaSBenjamin Tissoires && value[n] - min < field->maxusage 1516dde5845aSJiri Kosina && field->usage[value[n] - min].hid 1517dde5845aSJiri Kosina && search(field->value, value[n], count)) 1518dde5845aSJiri Kosina hid_process_event(hid, field, &field->usage[value[n] - min], 1, interrupt); 1519dde5845aSJiri Kosina } 1520dde5845aSJiri Kosina 1521dde5845aSJiri Kosina memcpy(field->value, value, count * sizeof(__s32)); 1522dde5845aSJiri Kosina exit: 1523dde5845aSJiri Kosina kfree(value); 1524dde5845aSJiri Kosina } 1525dde5845aSJiri Kosina 1526dde5845aSJiri Kosina /* 1527dde5845aSJiri Kosina * Output the field into the report. 1528dde5845aSJiri Kosina */ 1529dde5845aSJiri Kosina 15304291ee30SJoe Perches static void hid_output_field(const struct hid_device *hid, 15314291ee30SJoe Perches struct hid_field *field, __u8 *data) 1532dde5845aSJiri Kosina { 1533dde5845aSJiri Kosina unsigned count = field->report_count; 1534dde5845aSJiri Kosina unsigned offset = field->report_offset; 1535dde5845aSJiri Kosina unsigned size = field->report_size; 1536dde5845aSJiri Kosina unsigned n; 1537dde5845aSJiri Kosina 1538dde5845aSJiri Kosina for (n = 0; n < count; n++) { 1539dde5845aSJiri Kosina if (field->logical_minimum < 0) /* signed values */ 15404291ee30SJoe Perches implement(hid, data, offset + n * size, size, 15414291ee30SJoe Perches s32ton(field->value[n], size)); 1542dde5845aSJiri Kosina else /* unsigned values */ 15434291ee30SJoe Perches implement(hid, data, offset + n * size, size, 15444291ee30SJoe Perches field->value[n]); 1545dde5845aSJiri Kosina } 1546dde5845aSJiri Kosina } 1547dde5845aSJiri Kosina 1548dde5845aSJiri Kosina /* 154927ce4050SJiri Kosina * Create a report. 'data' has to be allocated using 155027ce4050SJiri Kosina * hid_alloc_report_buf() so that it has proper size. 1551dde5845aSJiri Kosina */ 1552dde5845aSJiri Kosina 1553229695e5SJiri Kosina void hid_output_report(struct hid_report *report, __u8 *data) 1554dde5845aSJiri Kosina { 1555dde5845aSJiri Kosina unsigned n; 1556dde5845aSJiri Kosina 1557dde5845aSJiri Kosina if (report->id > 0) 1558dde5845aSJiri Kosina *data++ = report->id; 1559dde5845aSJiri Kosina 156075c28df8SPete Zaitcev memset(data, 0, ((report->size - 1) >> 3) + 1); 1561dde5845aSJiri Kosina for (n = 0; n < report->maxfield; n++) 15624291ee30SJoe Perches hid_output_field(report->device, report->field[n], data); 1563dde5845aSJiri Kosina } 1564229695e5SJiri Kosina EXPORT_SYMBOL_GPL(hid_output_report); 1565dde5845aSJiri Kosina 1566dde5845aSJiri Kosina /* 156727ce4050SJiri Kosina * Allocator for buffer that is going to be passed to hid_output_report() 156827ce4050SJiri Kosina */ 156927ce4050SJiri Kosina u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags) 157027ce4050SJiri Kosina { 157127ce4050SJiri Kosina /* 157227ce4050SJiri Kosina * 7 extra bytes are necessary to achieve proper functionality 157327ce4050SJiri Kosina * of implement() working on 8 byte chunks 157427ce4050SJiri Kosina */ 157527ce4050SJiri Kosina 15766de0b13cSAaron Ma u32 len = hid_report_len(report) + 7; 157727ce4050SJiri Kosina 157827ce4050SJiri Kosina return kmalloc(len, flags); 157927ce4050SJiri Kosina } 158027ce4050SJiri Kosina EXPORT_SYMBOL_GPL(hid_alloc_report_buf); 158127ce4050SJiri Kosina 158227ce4050SJiri Kosina /* 1583dde5845aSJiri Kosina * Set a field value. The report this field belongs to has to be 1584dde5845aSJiri Kosina * created and transferred to the device, to set this value in the 1585dde5845aSJiri Kosina * device. 1586dde5845aSJiri Kosina */ 1587dde5845aSJiri Kosina 1588dde5845aSJiri Kosina int hid_set_field(struct hid_field *field, unsigned offset, __s32 value) 1589dde5845aSJiri Kosina { 1590be67b68dSKees Cook unsigned size; 1591be67b68dSKees Cook 1592be67b68dSKees Cook if (!field) 1593be67b68dSKees Cook return -1; 1594be67b68dSKees Cook 1595be67b68dSKees Cook size = field->report_size; 1596dde5845aSJiri Kosina 1597cd667ce2SJiri Kosina hid_dump_input(field->report->device, field->usage + offset, value); 1598dde5845aSJiri Kosina 1599dde5845aSJiri Kosina if (offset >= field->report_count) { 16008c3d52fcSJiri Kosina hid_err(field->report->device, "offset (%d) exceeds report_count (%d)\n", 16018c3d52fcSJiri Kosina offset, field->report_count); 1602dde5845aSJiri Kosina return -1; 1603dde5845aSJiri Kosina } 1604dde5845aSJiri Kosina if (field->logical_minimum < 0) { 1605dde5845aSJiri Kosina if (value != snto32(s32ton(value, size), size)) { 16068c3d52fcSJiri Kosina hid_err(field->report->device, "value %d is out of range\n", value); 1607dde5845aSJiri Kosina return -1; 1608dde5845aSJiri Kosina } 1609dde5845aSJiri Kosina } 1610dde5845aSJiri Kosina field->value[offset] = value; 1611dde5845aSJiri Kosina return 0; 1612dde5845aSJiri Kosina } 1613229695e5SJiri Kosina EXPORT_SYMBOL_GPL(hid_set_field); 1614dde5845aSJiri Kosina 161585cdaf52SJiri Slaby static struct hid_report *hid_get_report(struct hid_report_enum *report_enum, 161685cdaf52SJiri Slaby const u8 *data) 161785cdaf52SJiri Slaby { 161885cdaf52SJiri Slaby struct hid_report *report; 161985cdaf52SJiri Slaby unsigned int n = 0; /* Normally report number is 0 */ 162085cdaf52SJiri Slaby 162185cdaf52SJiri Slaby /* Device uses numbered reports, data[0] is report number */ 162285cdaf52SJiri Slaby if (report_enum->numbered) 162385cdaf52SJiri Slaby n = *data; 162485cdaf52SJiri Slaby 162585cdaf52SJiri Slaby report = report_enum->report_id_hash[n]; 162685cdaf52SJiri Slaby if (report == NULL) 162785cdaf52SJiri Slaby dbg_hid("undefined report_id %u received\n", n); 162885cdaf52SJiri Slaby 162985cdaf52SJiri Slaby return report; 163085cdaf52SJiri Slaby } 163185cdaf52SJiri Slaby 16324fa5a7f7SBenjamin Tissoires /* 16334fa5a7f7SBenjamin Tissoires * Implement a generic .request() callback, using .raw_request() 16344fa5a7f7SBenjamin Tissoires * DO NOT USE in hid drivers directly, but through hid_hw_request instead. 16354fa5a7f7SBenjamin Tissoires */ 16364fa5a7f7SBenjamin Tissoires void __hid_request(struct hid_device *hid, struct hid_report *report, 16374fa5a7f7SBenjamin Tissoires int reqtype) 16384fa5a7f7SBenjamin Tissoires { 16394fa5a7f7SBenjamin Tissoires char *buf; 16404fa5a7f7SBenjamin Tissoires int ret; 16416de0b13cSAaron Ma u32 len; 16424fa5a7f7SBenjamin Tissoires 16434fa5a7f7SBenjamin Tissoires buf = hid_alloc_report_buf(report, GFP_KERNEL); 16444fa5a7f7SBenjamin Tissoires if (!buf) 16454fa5a7f7SBenjamin Tissoires return; 16464fa5a7f7SBenjamin Tissoires 16474fa5a7f7SBenjamin Tissoires len = hid_report_len(report); 16484fa5a7f7SBenjamin Tissoires 16494fa5a7f7SBenjamin Tissoires if (reqtype == HID_REQ_SET_REPORT) 16504fa5a7f7SBenjamin Tissoires hid_output_report(report, buf); 16514fa5a7f7SBenjamin Tissoires 16524fa5a7f7SBenjamin Tissoires ret = hid->ll_driver->raw_request(hid, report->id, buf, len, 16534fa5a7f7SBenjamin Tissoires report->type, reqtype); 16544fa5a7f7SBenjamin Tissoires if (ret < 0) { 16554fa5a7f7SBenjamin Tissoires dbg_hid("unable to complete request: %d\n", ret); 16564fa5a7f7SBenjamin Tissoires goto out; 16574fa5a7f7SBenjamin Tissoires } 16584fa5a7f7SBenjamin Tissoires 16594fa5a7f7SBenjamin Tissoires if (reqtype == HID_REQ_GET_REPORT) 16604fa5a7f7SBenjamin Tissoires hid_input_report(hid, report->type, buf, ret, 0); 16614fa5a7f7SBenjamin Tissoires 16624fa5a7f7SBenjamin Tissoires out: 16634fa5a7f7SBenjamin Tissoires kfree(buf); 16644fa5a7f7SBenjamin Tissoires } 16654fa5a7f7SBenjamin Tissoires EXPORT_SYMBOL_GPL(__hid_request); 16664fa5a7f7SBenjamin Tissoires 16676de0b13cSAaron Ma int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size, 166885cdaf52SJiri Slaby int interrupt) 1669aa8de2f0SJiri Kosina { 1670aa8de2f0SJiri Kosina struct hid_report_enum *report_enum = hid->report_enum + type; 1671aa8de2f0SJiri Kosina struct hid_report *report; 16726d85d037SBenjamin Tissoires struct hid_driver *hdrv; 167385cdaf52SJiri Slaby unsigned int a; 16746de0b13cSAaron Ma u32 rsize, csize = size; 167585cdaf52SJiri Slaby u8 *cdata = data; 1676b6787242SJiri Kosina int ret = 0; 1677aa8de2f0SJiri Kosina 167885cdaf52SJiri Slaby report = hid_get_report(report_enum, data); 167985cdaf52SJiri Slaby if (!report) 1680b6787242SJiri Kosina goto out; 1681aa8de2f0SJiri Kosina 168285cdaf52SJiri Slaby if (report_enum->numbered) { 168385cdaf52SJiri Slaby cdata++; 168485cdaf52SJiri Slaby csize--; 1685aa8de2f0SJiri Kosina } 1686aa8de2f0SJiri Kosina 1687aa8de2f0SJiri Kosina rsize = ((report->size - 1) >> 3) + 1; 1688aa8de2f0SJiri Kosina 1689966922f2SArmando Visconti if (rsize > HID_MAX_BUFFER_SIZE) 1690966922f2SArmando Visconti rsize = HID_MAX_BUFFER_SIZE; 1691966922f2SArmando Visconti 169285cdaf52SJiri Slaby if (csize < rsize) { 169385cdaf52SJiri Slaby dbg_hid("report %d is too short, (%d < %d)\n", report->id, 169485cdaf52SJiri Slaby csize, rsize); 169585cdaf52SJiri Slaby memset(cdata + csize, 0, rsize - csize); 1696aa8de2f0SJiri Kosina } 1697aa8de2f0SJiri Kosina 1698aa8de2f0SJiri Kosina if ((hid->claimed & HID_CLAIMED_HIDDEV) && hid->hiddev_report_event) 1699aa8de2f0SJiri Kosina hid->hiddev_report_event(hid, report); 1700b6787242SJiri Kosina if (hid->claimed & HID_CLAIMED_HIDRAW) { 1701b6787242SJiri Kosina ret = hidraw_report_event(hid, data, size); 1702b6787242SJiri Kosina if (ret) 1703b6787242SJiri Kosina goto out; 1704b6787242SJiri Kosina } 1705aa8de2f0SJiri Kosina 1706cc6b54aaSBenjamin Tissoires if (hid->claimed != HID_CLAIMED_HIDRAW && report->maxfield) { 170785cdaf52SJiri Slaby for (a = 0; a < report->maxfield; a++) 170885cdaf52SJiri Slaby hid_input_field(hid, report->field[a], cdata, interrupt); 17096d85d037SBenjamin Tissoires hdrv = hid->driver; 17106d85d037SBenjamin Tissoires if (hdrv && hdrv->report) 17116d85d037SBenjamin Tissoires hdrv->report(hid, report); 1712b94e3c94SMatthieu CASTET } 1713aa8de2f0SJiri Kosina 1714aa8de2f0SJiri Kosina if (hid->claimed & HID_CLAIMED_INPUT) 1715aa8de2f0SJiri Kosina hidinput_report_event(hid, report); 1716b6787242SJiri Kosina out: 1717b6787242SJiri Kosina return ret; 171885cdaf52SJiri Slaby } 171985cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_report_raw_event); 172085cdaf52SJiri Slaby 172185cdaf52SJiri Slaby /** 172285cdaf52SJiri Slaby * hid_input_report - report data from lower layer (usb, bt...) 172385cdaf52SJiri Slaby * 172485cdaf52SJiri Slaby * @hid: hid device 172585cdaf52SJiri Slaby * @type: HID report type (HID_*_REPORT) 172685cdaf52SJiri Slaby * @data: report contents 172785cdaf52SJiri Slaby * @size: size of data parameter 1728ff9b00a2SJiri Kosina * @interrupt: distinguish between interrupt and control transfers 172985cdaf52SJiri Slaby * 173085cdaf52SJiri Slaby * This is data entry for lower layers. 173185cdaf52SJiri Slaby */ 17326de0b13cSAaron Ma int hid_input_report(struct hid_device *hid, int type, u8 *data, u32 size, int interrupt) 173385cdaf52SJiri Slaby { 173476c317d6SJulia Lawall struct hid_report_enum *report_enum; 173576c317d6SJulia Lawall struct hid_driver *hdrv; 173685cdaf52SJiri Slaby struct hid_report *report; 173745dc1ac7SJiri Kosina int ret = 0; 173885cdaf52SJiri Slaby 17394ea54542SDavid Herrmann if (!hid) 174085cdaf52SJiri Slaby return -ENODEV; 17414ea54542SDavid Herrmann 1742c849a614SAndrew de los Reyes if (down_trylock(&hid->driver_input_lock)) 17434ea54542SDavid Herrmann return -EBUSY; 17444ea54542SDavid Herrmann 17454ea54542SDavid Herrmann if (!hid->driver) { 17464ea54542SDavid Herrmann ret = -ENODEV; 17474ea54542SDavid Herrmann goto unlock; 17484ea54542SDavid Herrmann } 174976c317d6SJulia Lawall report_enum = hid->report_enum + type; 175076c317d6SJulia Lawall hdrv = hid->driver; 175185cdaf52SJiri Slaby 175285cdaf52SJiri Slaby if (!size) { 175385cdaf52SJiri Slaby dbg_hid("empty report\n"); 17544ea54542SDavid Herrmann ret = -1; 17554ea54542SDavid Herrmann goto unlock; 175685cdaf52SJiri Slaby } 175785cdaf52SJiri Slaby 1758b94e3c94SMatthieu CASTET /* Avoid unnecessary overhead if debugfs is disabled */ 1759a5f04b9dSBenjamin Tissoires if (!list_empty(&hid->debug_list)) 1760a5f04b9dSBenjamin Tissoires hid_dump_report(hid, type, data, size); 1761b94e3c94SMatthieu CASTET 1762f77e347bSJiri Kosina report = hid_get_report(report_enum, data); 1763f77e347bSJiri Kosina 17644ea54542SDavid Herrmann if (!report) { 17654ea54542SDavid Herrmann ret = -1; 17664ea54542SDavid Herrmann goto unlock; 17674ea54542SDavid Herrmann } 1768f77e347bSJiri Kosina 176985cdaf52SJiri Slaby if (hdrv && hdrv->raw_event && hid_match_report(hid, report)) { 177085cdaf52SJiri Slaby ret = hdrv->raw_event(hid, report, data, size); 1771556483e2SFelix Rueegg if (ret < 0) 17724ea54542SDavid Herrmann goto unlock; 17734ea54542SDavid Herrmann } 177485cdaf52SJiri Slaby 1775b6787242SJiri Kosina ret = hid_report_raw_event(hid, type, data, size, interrupt); 1776aa8de2f0SJiri Kosina 17774ea54542SDavid Herrmann unlock: 1778c849a614SAndrew de los Reyes up(&hid->driver_input_lock); 177945dc1ac7SJiri Kosina return ret; 1780aa8de2f0SJiri Kosina } 1781aa8de2f0SJiri Kosina EXPORT_SYMBOL_GPL(hid_input_report); 1782aa8de2f0SJiri Kosina 1783d5d3e202SBenjamin Tissoires bool hid_match_one_id(const struct hid_device *hdev, 17840f37cd03SJiri Kosina const struct hid_device_id *id) 17850f37cd03SJiri Kosina { 17867431fb76SHenrik Rydberg return (id->bus == HID_BUS_ANY || id->bus == hdev->bus) && 17874d53b801SHenrik Rydberg (id->group == HID_GROUP_ANY || id->group == hdev->group) && 17880f37cd03SJiri Kosina (id->vendor == HID_ANY_ID || id->vendor == hdev->vendor) && 17890f37cd03SJiri Kosina (id->product == HID_ANY_ID || id->product == hdev->product); 17900f37cd03SJiri Kosina } 17910f37cd03SJiri Kosina 1792d5d3e202SBenjamin Tissoires const struct hid_device_id *hid_match_id(const struct hid_device *hdev, 17930f37cd03SJiri Kosina const struct hid_device_id *id) 17940f37cd03SJiri Kosina { 17950f37cd03SJiri Kosina for (; id->bus; id++) 17960f37cd03SJiri Kosina if (hid_match_one_id(hdev, id)) 17970f37cd03SJiri Kosina return id; 17980f37cd03SJiri Kosina 17990f37cd03SJiri Kosina return NULL; 18000f37cd03SJiri Kosina } 18010f37cd03SJiri Kosina 18020f37cd03SJiri Kosina static const struct hid_device_id hid_hiddev_list[] = { 1803c0bd6a42SRichard Hughes { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS) }, 1804c0bd6a42SRichard Hughes { HID_USB_DEVICE(USB_VENDOR_ID_MGE, USB_DEVICE_ID_MGE_UPS1) }, 18050f37cd03SJiri Kosina { } 18060f37cd03SJiri Kosina }; 18070f37cd03SJiri Kosina 18080f37cd03SJiri Kosina static bool hid_hiddev(struct hid_device *hdev) 18090f37cd03SJiri Kosina { 18100f37cd03SJiri Kosina return !!hid_match_id(hdev, hid_hiddev_list); 18110f37cd03SJiri Kosina } 18120f37cd03SJiri Kosina 18136d3bfb74SAlan Ott 18146d3bfb74SAlan Ott static ssize_t 18156d3bfb74SAlan Ott read_report_descriptor(struct file *filp, struct kobject *kobj, 18166d3bfb74SAlan Ott struct bin_attribute *attr, 18176d3bfb74SAlan Ott char *buf, loff_t off, size_t count) 18186d3bfb74SAlan Ott { 18192cf83833SGeliang Tang struct device *dev = kobj_to_dev(kobj); 1820ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 18216d3bfb74SAlan Ott 18226d3bfb74SAlan Ott if (off >= hdev->rsize) 18236d3bfb74SAlan Ott return 0; 18246d3bfb74SAlan Ott 18256d3bfb74SAlan Ott if (off + count > hdev->rsize) 18266d3bfb74SAlan Ott count = hdev->rsize - off; 18276d3bfb74SAlan Ott 18286d3bfb74SAlan Ott memcpy(buf, hdev->rdesc + off, count); 18296d3bfb74SAlan Ott 18306d3bfb74SAlan Ott return count; 18316d3bfb74SAlan Ott } 18326d3bfb74SAlan Ott 1833a877417eSOlivier Gay static ssize_t 1834a877417eSOlivier Gay show_country(struct device *dev, struct device_attribute *attr, 1835a877417eSOlivier Gay char *buf) 1836a877417eSOlivier Gay { 1837ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 1838a877417eSOlivier Gay 1839a877417eSOlivier Gay return sprintf(buf, "%02x\n", hdev->country & 0xff); 1840a877417eSOlivier Gay } 1841a877417eSOlivier Gay 18426d3bfb74SAlan Ott static struct bin_attribute dev_bin_attr_report_desc = { 18436d3bfb74SAlan Ott .attr = { .name = "report_descriptor", .mode = 0444 }, 18446d3bfb74SAlan Ott .read = read_report_descriptor, 18456d3bfb74SAlan Ott .size = HID_MAX_DESCRIPTOR_SIZE, 18466d3bfb74SAlan Ott }; 18476d3bfb74SAlan Ott 1848ad8378edSBhumika Goyal static const struct device_attribute dev_attr_country = { 1849a877417eSOlivier Gay .attr = { .name = "country", .mode = 0444 }, 1850a877417eSOlivier Gay .show = show_country, 1851a877417eSOlivier Gay }; 1852a877417eSOlivier Gay 185393c10132SJiri Slaby int hid_connect(struct hid_device *hdev, unsigned int connect_mask) 185493c10132SJiri Slaby { 185593c10132SJiri Slaby static const char *types[] = { "Device", "Pointer", "Mouse", "Device", 185693c10132SJiri Slaby "Joystick", "Gamepad", "Keyboard", "Keypad", 185793c10132SJiri Slaby "Multi-Axis Controller" 185893c10132SJiri Slaby }; 185993c10132SJiri Slaby const char *type, *bus; 186079b568b9SRichard Purdie char buf[64] = ""; 186193c10132SJiri Slaby unsigned int i; 186293c10132SJiri Slaby int len; 18636d3bfb74SAlan Ott int ret; 186493c10132SJiri Slaby 1865b5e5a37eSBastien Nocera if (hdev->quirks & HID_QUIRK_HIDDEV_FORCE) 1866b5e5a37eSBastien Nocera connect_mask |= (HID_CONNECT_HIDDEV_FORCE | HID_CONNECT_HIDDEV); 18673a343ee4SDaniel Mack if (hdev->quirks & HID_QUIRK_HIDINPUT_FORCE) 18683a343ee4SDaniel Mack connect_mask |= HID_CONNECT_HIDINPUT_FORCE; 186993c10132SJiri Slaby if (hdev->bus != BUS_USB) 187093c10132SJiri Slaby connect_mask &= ~HID_CONNECT_HIDDEV; 18710f37cd03SJiri Kosina if (hid_hiddev(hdev)) 18720f37cd03SJiri Kosina connect_mask |= HID_CONNECT_HIDDEV_FORCE; 187393c10132SJiri Slaby 187493c10132SJiri Slaby if ((connect_mask & HID_CONNECT_HIDINPUT) && !hidinput_connect(hdev, 187593c10132SJiri Slaby connect_mask & HID_CONNECT_HIDINPUT_FORCE)) 187693c10132SJiri Slaby hdev->claimed |= HID_CLAIMED_INPUT; 1877b77c3920SBenjamin Tissoires 187893c10132SJiri Slaby if ((connect_mask & HID_CONNECT_HIDDEV) && hdev->hiddev_connect && 187993c10132SJiri Slaby !hdev->hiddev_connect(hdev, 188093c10132SJiri Slaby connect_mask & HID_CONNECT_HIDDEV_FORCE)) 188193c10132SJiri Slaby hdev->claimed |= HID_CLAIMED_HIDDEV; 188293c10132SJiri Slaby if ((connect_mask & HID_CONNECT_HIDRAW) && !hidraw_connect(hdev)) 188393c10132SJiri Slaby hdev->claimed |= HID_CLAIMED_HIDRAW; 188493c10132SJiri Slaby 18857704ac93SBenjamin Tissoires if (connect_mask & HID_CONNECT_DRIVER) 18867704ac93SBenjamin Tissoires hdev->claimed |= HID_CLAIMED_DRIVER; 18877704ac93SBenjamin Tissoires 18884bc19f62SDavid Herrmann /* Drivers with the ->raw_event callback set are not required to connect 18894bc19f62SDavid Herrmann * to any other listener. */ 18904bc19f62SDavid Herrmann if (!hdev->claimed && !hdev->driver->raw_event) { 18914bc19f62SDavid Herrmann hid_err(hdev, "device has no listeners, quitting\n"); 189293c10132SJiri Slaby return -ENODEV; 189393c10132SJiri Slaby } 189493c10132SJiri Slaby 189593c10132SJiri Slaby if ((hdev->claimed & HID_CLAIMED_INPUT) && 189693c10132SJiri Slaby (connect_mask & HID_CONNECT_FF) && hdev->ff_init) 189793c10132SJiri Slaby hdev->ff_init(hdev); 189893c10132SJiri Slaby 189993c10132SJiri Slaby len = 0; 190093c10132SJiri Slaby if (hdev->claimed & HID_CLAIMED_INPUT) 190193c10132SJiri Slaby len += sprintf(buf + len, "input"); 190293c10132SJiri Slaby if (hdev->claimed & HID_CLAIMED_HIDDEV) 190393c10132SJiri Slaby len += sprintf(buf + len, "%shiddev%d", len ? "," : "", 1904733aca90SJaejoong Kim ((struct hiddev *)hdev->hiddev)->minor); 190593c10132SJiri Slaby if (hdev->claimed & HID_CLAIMED_HIDRAW) 190693c10132SJiri Slaby len += sprintf(buf + len, "%shidraw%d", len ? "," : "", 190793c10132SJiri Slaby ((struct hidraw *)hdev->hidraw)->minor); 190893c10132SJiri Slaby 190993c10132SJiri Slaby type = "Device"; 191093c10132SJiri Slaby for (i = 0; i < hdev->maxcollection; i++) { 191193c10132SJiri Slaby struct hid_collection *col = &hdev->collection[i]; 191293c10132SJiri Slaby if (col->type == HID_COLLECTION_APPLICATION && 191393c10132SJiri Slaby (col->usage & HID_USAGE_PAGE) == HID_UP_GENDESK && 191493c10132SJiri Slaby (col->usage & 0xffff) < ARRAY_SIZE(types)) { 191593c10132SJiri Slaby type = types[col->usage & 0xffff]; 191693c10132SJiri Slaby break; 191793c10132SJiri Slaby } 191893c10132SJiri Slaby } 191993c10132SJiri Slaby 192093c10132SJiri Slaby switch (hdev->bus) { 192193c10132SJiri Slaby case BUS_USB: 192293c10132SJiri Slaby bus = "USB"; 192393c10132SJiri Slaby break; 192493c10132SJiri Slaby case BUS_BLUETOOTH: 192593c10132SJiri Slaby bus = "BLUETOOTH"; 192693c10132SJiri Slaby break; 192706780727SDaniel Martin case BUS_I2C: 192806780727SDaniel Martin bus = "I2C"; 192906780727SDaniel Martin break; 193093c10132SJiri Slaby default: 193193c10132SJiri Slaby bus = "<UNKNOWN>"; 193293c10132SJiri Slaby } 193393c10132SJiri Slaby 1934a877417eSOlivier Gay ret = device_create_file(&hdev->dev, &dev_attr_country); 1935a877417eSOlivier Gay if (ret) 1936a877417eSOlivier Gay hid_warn(hdev, 1937a877417eSOlivier Gay "can't create sysfs country code attribute err: %d\n", ret); 1938a877417eSOlivier Gay 19394291ee30SJoe Perches hid_info(hdev, "%s: %s HID v%x.%02x %s [%s] on %s\n", 194093c10132SJiri Slaby buf, bus, hdev->version >> 8, hdev->version & 0xff, 194193c10132SJiri Slaby type, hdev->name, hdev->phys); 194293c10132SJiri Slaby 194393c10132SJiri Slaby return 0; 194493c10132SJiri Slaby } 194593c10132SJiri Slaby EXPORT_SYMBOL_GPL(hid_connect); 194693c10132SJiri Slaby 1947c4c259bcSJiri Kosina void hid_disconnect(struct hid_device *hdev) 1948c4c259bcSJiri Kosina { 1949a877417eSOlivier Gay device_remove_file(&hdev->dev, &dev_attr_country); 1950c4c259bcSJiri Kosina if (hdev->claimed & HID_CLAIMED_INPUT) 1951c4c259bcSJiri Kosina hidinput_disconnect(hdev); 1952c4c259bcSJiri Kosina if (hdev->claimed & HID_CLAIMED_HIDDEV) 1953c4c259bcSJiri Kosina hdev->hiddev_disconnect(hdev); 1954c4c259bcSJiri Kosina if (hdev->claimed & HID_CLAIMED_HIDRAW) 1955c4c259bcSJiri Kosina hidraw_disconnect(hdev); 19569c5c6ed7SBenjamin Tissoires hdev->claimed = 0; 1957c4c259bcSJiri Kosina } 1958c4c259bcSJiri Kosina EXPORT_SYMBOL_GPL(hid_disconnect); 1959c4c259bcSJiri Kosina 1960aaac082dSDmitry Torokhov /** 1961aaac082dSDmitry Torokhov * hid_hw_start - start underlying HW 1962aaac082dSDmitry Torokhov * @hdev: hid device 1963aaac082dSDmitry Torokhov * @connect_mask: which outputs to connect, see HID_CONNECT_* 1964aaac082dSDmitry Torokhov * 1965aaac082dSDmitry Torokhov * Call this in probe function *after* hid_parse. This will setup HW 1966aaac082dSDmitry Torokhov * buffers and start the device (if not defeirred to device open). 1967aaac082dSDmitry Torokhov * hid_hw_stop must be called if this was successful. 1968aaac082dSDmitry Torokhov */ 1969aaac082dSDmitry Torokhov int hid_hw_start(struct hid_device *hdev, unsigned int connect_mask) 1970aaac082dSDmitry Torokhov { 1971aaac082dSDmitry Torokhov int error; 1972aaac082dSDmitry Torokhov 1973aaac082dSDmitry Torokhov error = hdev->ll_driver->start(hdev); 1974aaac082dSDmitry Torokhov if (error) 1975aaac082dSDmitry Torokhov return error; 1976aaac082dSDmitry Torokhov 1977aaac082dSDmitry Torokhov if (connect_mask) { 1978aaac082dSDmitry Torokhov error = hid_connect(hdev, connect_mask); 1979aaac082dSDmitry Torokhov if (error) { 1980aaac082dSDmitry Torokhov hdev->ll_driver->stop(hdev); 1981aaac082dSDmitry Torokhov return error; 1982aaac082dSDmitry Torokhov } 1983aaac082dSDmitry Torokhov } 1984aaac082dSDmitry Torokhov 1985aaac082dSDmitry Torokhov return 0; 1986aaac082dSDmitry Torokhov } 1987aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_start); 1988aaac082dSDmitry Torokhov 1989aaac082dSDmitry Torokhov /** 1990aaac082dSDmitry Torokhov * hid_hw_stop - stop underlying HW 1991aaac082dSDmitry Torokhov * @hdev: hid device 1992aaac082dSDmitry Torokhov * 1993aaac082dSDmitry Torokhov * This is usually called from remove function or from probe when something 1994aaac082dSDmitry Torokhov * failed and hid_hw_start was called already. 1995aaac082dSDmitry Torokhov */ 1996aaac082dSDmitry Torokhov void hid_hw_stop(struct hid_device *hdev) 1997aaac082dSDmitry Torokhov { 1998aaac082dSDmitry Torokhov hid_disconnect(hdev); 1999aaac082dSDmitry Torokhov hdev->ll_driver->stop(hdev); 2000aaac082dSDmitry Torokhov } 2001aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_stop); 2002aaac082dSDmitry Torokhov 2003aaac082dSDmitry Torokhov /** 2004aaac082dSDmitry Torokhov * hid_hw_open - signal underlying HW to start delivering events 2005aaac082dSDmitry Torokhov * @hdev: hid device 2006aaac082dSDmitry Torokhov * 2007aaac082dSDmitry Torokhov * Tell underlying HW to start delivering events from the device. 2008aaac082dSDmitry Torokhov * This function should be called sometime after successful call 2009d6c70a86SHisao Tanabe * to hid_hw_start(). 2010aaac082dSDmitry Torokhov */ 2011aaac082dSDmitry Torokhov int hid_hw_open(struct hid_device *hdev) 2012aaac082dSDmitry Torokhov { 2013aaac082dSDmitry Torokhov int ret; 2014aaac082dSDmitry Torokhov 2015aaac082dSDmitry Torokhov ret = mutex_lock_killable(&hdev->ll_open_lock); 2016aaac082dSDmitry Torokhov if (ret) 2017aaac082dSDmitry Torokhov return ret; 2018aaac082dSDmitry Torokhov 2019aaac082dSDmitry Torokhov if (!hdev->ll_open_count++) { 2020aaac082dSDmitry Torokhov ret = hdev->ll_driver->open(hdev); 2021aaac082dSDmitry Torokhov if (ret) 2022aaac082dSDmitry Torokhov hdev->ll_open_count--; 2023aaac082dSDmitry Torokhov } 2024aaac082dSDmitry Torokhov 2025aaac082dSDmitry Torokhov mutex_unlock(&hdev->ll_open_lock); 2026aaac082dSDmitry Torokhov return ret; 2027aaac082dSDmitry Torokhov } 2028aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_open); 2029aaac082dSDmitry Torokhov 2030aaac082dSDmitry Torokhov /** 2031aaac082dSDmitry Torokhov * hid_hw_close - signal underlaying HW to stop delivering events 2032aaac082dSDmitry Torokhov * 2033aaac082dSDmitry Torokhov * @hdev: hid device 2034aaac082dSDmitry Torokhov * 2035aaac082dSDmitry Torokhov * This function indicates that we are not interested in the events 2036aaac082dSDmitry Torokhov * from this device anymore. Delivery of events may or may not stop, 2037aaac082dSDmitry Torokhov * depending on the number of users still outstanding. 2038aaac082dSDmitry Torokhov */ 2039aaac082dSDmitry Torokhov void hid_hw_close(struct hid_device *hdev) 2040aaac082dSDmitry Torokhov { 2041aaac082dSDmitry Torokhov mutex_lock(&hdev->ll_open_lock); 2042aaac082dSDmitry Torokhov if (!--hdev->ll_open_count) 2043aaac082dSDmitry Torokhov hdev->ll_driver->close(hdev); 2044aaac082dSDmitry Torokhov mutex_unlock(&hdev->ll_open_lock); 2045aaac082dSDmitry Torokhov } 2046aaac082dSDmitry Torokhov EXPORT_SYMBOL_GPL(hid_hw_close); 2047aaac082dSDmitry Torokhov 20483a6f82f7SJiri Slaby struct hid_dynid { 20493a6f82f7SJiri Slaby struct list_head list; 20503a6f82f7SJiri Slaby struct hid_device_id id; 20513a6f82f7SJiri Slaby }; 20523a6f82f7SJiri Slaby 20533a6f82f7SJiri Slaby /** 20543a6f82f7SJiri Slaby * store_new_id - add a new HID device ID to this driver and re-probe devices 20553a6f82f7SJiri Slaby * @driver: target device driver 20563a6f82f7SJiri Slaby * @buf: buffer for scanning device ID data 20573a6f82f7SJiri Slaby * @count: input size 20583a6f82f7SJiri Slaby * 20593a6f82f7SJiri Slaby * Adds a new dynamic hid device ID to this driver, 20603a6f82f7SJiri Slaby * and causes the driver to probe for all devices again. 20613a6f82f7SJiri Slaby */ 2062c2810325SGreg Kroah-Hartman static ssize_t new_id_store(struct device_driver *drv, const char *buf, 20633a6f82f7SJiri Slaby size_t count) 20643a6f82f7SJiri Slaby { 2065ba91a967SGeliang Tang struct hid_driver *hdrv = to_hid_driver(drv); 20663a6f82f7SJiri Slaby struct hid_dynid *dynid; 20673a6f82f7SJiri Slaby __u32 bus, vendor, product; 20683a6f82f7SJiri Slaby unsigned long driver_data = 0; 20693a6f82f7SJiri Slaby int ret; 20703a6f82f7SJiri Slaby 20713a6f82f7SJiri Slaby ret = sscanf(buf, "%x %x %x %lx", 20723a6f82f7SJiri Slaby &bus, &vendor, &product, &driver_data); 20733a6f82f7SJiri Slaby if (ret < 3) 20743a6f82f7SJiri Slaby return -EINVAL; 20753a6f82f7SJiri Slaby 20763a6f82f7SJiri Slaby dynid = kzalloc(sizeof(*dynid), GFP_KERNEL); 20773a6f82f7SJiri Slaby if (!dynid) 20783a6f82f7SJiri Slaby return -ENOMEM; 20793a6f82f7SJiri Slaby 20803a6f82f7SJiri Slaby dynid->id.bus = bus; 20814d53b801SHenrik Rydberg dynid->id.group = HID_GROUP_ANY; 20823a6f82f7SJiri Slaby dynid->id.vendor = vendor; 20833a6f82f7SJiri Slaby dynid->id.product = product; 20843a6f82f7SJiri Slaby dynid->id.driver_data = driver_data; 20853a6f82f7SJiri Slaby 20863a6f82f7SJiri Slaby spin_lock(&hdrv->dyn_lock); 20873a6f82f7SJiri Slaby list_add_tail(&dynid->list, &hdrv->dyn_list); 20883a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 20893a6f82f7SJiri Slaby 20903a6f82f7SJiri Slaby ret = driver_attach(&hdrv->driver); 20913a6f82f7SJiri Slaby 20923a6f82f7SJiri Slaby return ret ? : count; 20933a6f82f7SJiri Slaby } 2094c2810325SGreg Kroah-Hartman static DRIVER_ATTR_WO(new_id); 2095c2810325SGreg Kroah-Hartman 2096c2810325SGreg Kroah-Hartman static struct attribute *hid_drv_attrs[] = { 2097c2810325SGreg Kroah-Hartman &driver_attr_new_id.attr, 2098c2810325SGreg Kroah-Hartman NULL, 2099c2810325SGreg Kroah-Hartman }; 2100c2810325SGreg Kroah-Hartman ATTRIBUTE_GROUPS(hid_drv); 21013a6f82f7SJiri Slaby 21023a6f82f7SJiri Slaby static void hid_free_dynids(struct hid_driver *hdrv) 21033a6f82f7SJiri Slaby { 21043a6f82f7SJiri Slaby struct hid_dynid *dynid, *n; 21053a6f82f7SJiri Slaby 21063a6f82f7SJiri Slaby spin_lock(&hdrv->dyn_lock); 21073a6f82f7SJiri Slaby list_for_each_entry_safe(dynid, n, &hdrv->dyn_list, list) { 21083a6f82f7SJiri Slaby list_del(&dynid->list); 21093a6f82f7SJiri Slaby kfree(dynid); 21103a6f82f7SJiri Slaby } 21113a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 21123a6f82f7SJiri Slaby } 21133a6f82f7SJiri Slaby 2114e04a0442SBenjamin Tissoires const struct hid_device_id *hid_match_device(struct hid_device *hdev, 21153a6f82f7SJiri Slaby struct hid_driver *hdrv) 21163a6f82f7SJiri Slaby { 21173a6f82f7SJiri Slaby struct hid_dynid *dynid; 21183a6f82f7SJiri Slaby 21193a6f82f7SJiri Slaby spin_lock(&hdrv->dyn_lock); 21203a6f82f7SJiri Slaby list_for_each_entry(dynid, &hdrv->dyn_list, list) { 21213a6f82f7SJiri Slaby if (hid_match_one_id(hdev, &dynid->id)) { 21223a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 21233a6f82f7SJiri Slaby return &dynid->id; 21243a6f82f7SJiri Slaby } 21253a6f82f7SJiri Slaby } 21263a6f82f7SJiri Slaby spin_unlock(&hdrv->dyn_lock); 21273a6f82f7SJiri Slaby 21283a6f82f7SJiri Slaby return hid_match_id(hdev, hdrv->id_table); 21293a6f82f7SJiri Slaby } 2130e04a0442SBenjamin Tissoires EXPORT_SYMBOL_GPL(hid_match_device); 21313a6f82f7SJiri Slaby 213285cdaf52SJiri Slaby static int hid_bus_match(struct device *dev, struct device_driver *drv) 213385cdaf52SJiri Slaby { 2134ba91a967SGeliang Tang struct hid_driver *hdrv = to_hid_driver(drv); 2135ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 213685cdaf52SJiri Slaby 2137070748edSHenrik Rydberg return hid_match_device(hdev, hdrv) != NULL; 213885cdaf52SJiri Slaby } 213985cdaf52SJiri Slaby 21401a8861f1SDaniel M. Lambea /** 21411a8861f1SDaniel M. Lambea * hid_compare_device_paths - check if both devices share the same path 21421a8861f1SDaniel M. Lambea * @hdev_a: hid device 21431a8861f1SDaniel M. Lambea * @hdev_b: hid device 21441a8861f1SDaniel M. Lambea * @separator: char to use as separator 21451a8861f1SDaniel M. Lambea * 21461a8861f1SDaniel M. Lambea * Check if two devices share the same path up to the last occurrence of 21471a8861f1SDaniel M. Lambea * the separator char. Both paths must exist (i.e., zero-length paths 21481a8861f1SDaniel M. Lambea * don't match). 21491a8861f1SDaniel M. Lambea */ 21501a8861f1SDaniel M. Lambea bool hid_compare_device_paths(struct hid_device *hdev_a, 21511a8861f1SDaniel M. Lambea struct hid_device *hdev_b, char separator) 21521a8861f1SDaniel M. Lambea { 21531a8861f1SDaniel M. Lambea int n1 = strrchr(hdev_a->phys, separator) - hdev_a->phys; 21541a8861f1SDaniel M. Lambea int n2 = strrchr(hdev_b->phys, separator) - hdev_b->phys; 21551a8861f1SDaniel M. Lambea 21561a8861f1SDaniel M. Lambea if (n1 != n2 || n1 <= 0 || n2 <= 0) 21571a8861f1SDaniel M. Lambea return false; 21581a8861f1SDaniel M. Lambea 21591a8861f1SDaniel M. Lambea return !strncmp(hdev_a->phys, hdev_b->phys, n1); 21601a8861f1SDaniel M. Lambea } 21611a8861f1SDaniel M. Lambea EXPORT_SYMBOL_GPL(hid_compare_device_paths); 21621a8861f1SDaniel M. Lambea 216385cdaf52SJiri Slaby static int hid_device_probe(struct device *dev) 216485cdaf52SJiri Slaby { 2165ba91a967SGeliang Tang struct hid_driver *hdrv = to_hid_driver(dev->driver); 2166ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 216785cdaf52SJiri Slaby const struct hid_device_id *id; 216885cdaf52SJiri Slaby int ret = 0; 216985cdaf52SJiri Slaby 2170c849a614SAndrew de los Reyes if (down_interruptible(&hdev->driver_input_lock)) { 2171c849a614SAndrew de los Reyes ret = -EINTR; 21726f68f0acSBinoy Jayan goto end; 2173c849a614SAndrew de los Reyes } 2174c849a614SAndrew de los Reyes hdev->io_started = false; 21754ea54542SDavid Herrmann 21768f732850SBenjamin Tissoires clear_bit(ffs(HID_STAT_REPROBED), &hdev->status); 21778f732850SBenjamin Tissoires 217885cdaf52SJiri Slaby if (!hdev->driver) { 21793a6f82f7SJiri Slaby id = hid_match_device(hdev, hdrv); 2180ba623a77SDan Carpenter if (id == NULL) { 2181ba623a77SDan Carpenter ret = -ENODEV; 2182ba623a77SDan Carpenter goto unlock; 2183ba623a77SDan Carpenter } 2184c500c971SJiri Slaby 2185e04a0442SBenjamin Tissoires if (hdrv->match) { 2186e04a0442SBenjamin Tissoires if (!hdrv->match(hdev, hid_ignore_special_drivers)) { 2187e04a0442SBenjamin Tissoires ret = -ENODEV; 2188e04a0442SBenjamin Tissoires goto unlock; 2189e04a0442SBenjamin Tissoires } 2190e04a0442SBenjamin Tissoires } else { 2191e04a0442SBenjamin Tissoires /* 2192e04a0442SBenjamin Tissoires * hid-generic implements .match(), so if 2193e04a0442SBenjamin Tissoires * hid_ignore_special_drivers is set, we can safely 2194e04a0442SBenjamin Tissoires * return. 2195e04a0442SBenjamin Tissoires */ 2196e04a0442SBenjamin Tissoires if (hid_ignore_special_drivers) { 2197e04a0442SBenjamin Tissoires ret = -ENODEV; 2198e04a0442SBenjamin Tissoires goto unlock; 2199e04a0442SBenjamin Tissoires } 2200e04a0442SBenjamin Tissoires } 2201e04a0442SBenjamin Tissoires 22022904e68fSBenjamin Tissoires /* reset the quirks that has been previously set */ 22032904e68fSBenjamin Tissoires hdev->quirks = hid_lookup_quirk(hdev); 220485cdaf52SJiri Slaby hdev->driver = hdrv; 2205c500c971SJiri Slaby if (hdrv->probe) { 2206c500c971SJiri Slaby ret = hdrv->probe(hdev, id); 2207c500c971SJiri Slaby } else { /* default probe */ 2208a7197c2eSHenrik Rydberg ret = hid_open_report(hdev); 2209c500c971SJiri Slaby if (!ret) 221093c10132SJiri Slaby ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT); 2211c500c971SJiri Slaby } 2212a7197c2eSHenrik Rydberg if (ret) { 2213a7197c2eSHenrik Rydberg hid_close_report(hdev); 2214c500c971SJiri Slaby hdev->driver = NULL; 221585cdaf52SJiri Slaby } 2216a7197c2eSHenrik Rydberg } 2217ba623a77SDan Carpenter unlock: 2218c849a614SAndrew de los Reyes if (!hdev->io_started) 2219c849a614SAndrew de los Reyes up(&hdev->driver_input_lock); 22206f68f0acSBinoy Jayan end: 222185cdaf52SJiri Slaby return ret; 222285cdaf52SJiri Slaby } 222385cdaf52SJiri Slaby 222485cdaf52SJiri Slaby static int hid_device_remove(struct device *dev) 222585cdaf52SJiri Slaby { 2226ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 22274ea54542SDavid Herrmann struct hid_driver *hdrv; 2228c849a614SAndrew de los Reyes int ret = 0; 222985cdaf52SJiri Slaby 2230c849a614SAndrew de los Reyes if (down_interruptible(&hdev->driver_input_lock)) { 2231c849a614SAndrew de los Reyes ret = -EINTR; 22326f68f0acSBinoy Jayan goto end; 2233c849a614SAndrew de los Reyes } 2234c849a614SAndrew de los Reyes hdev->io_started = false; 22354ea54542SDavid Herrmann 22364ea54542SDavid Herrmann hdrv = hdev->driver; 223785cdaf52SJiri Slaby if (hdrv) { 223885cdaf52SJiri Slaby if (hdrv->remove) 223985cdaf52SJiri Slaby hdrv->remove(hdev); 2240c500c971SJiri Slaby else /* default remove */ 2241c500c971SJiri Slaby hid_hw_stop(hdev); 2242a7197c2eSHenrik Rydberg hid_close_report(hdev); 224385cdaf52SJiri Slaby hdev->driver = NULL; 224485cdaf52SJiri Slaby } 224585cdaf52SJiri Slaby 2246c849a614SAndrew de los Reyes if (!hdev->io_started) 2247c849a614SAndrew de los Reyes up(&hdev->driver_input_lock); 22486f68f0acSBinoy Jayan end: 2249c849a614SAndrew de los Reyes return ret; 225085cdaf52SJiri Slaby } 225185cdaf52SJiri Slaby 22524d53b801SHenrik Rydberg static ssize_t modalias_show(struct device *dev, struct device_attribute *a, 22534d53b801SHenrik Rydberg char *buf) 22544d53b801SHenrik Rydberg { 22554d53b801SHenrik Rydberg struct hid_device *hdev = container_of(dev, struct hid_device, dev); 22564d53b801SHenrik Rydberg 2257dfa0c5faSRasmus Villemoes return scnprintf(buf, PAGE_SIZE, "hid:b%04Xg%04Xv%08Xp%08X\n", 22584d53b801SHenrik Rydberg hdev->bus, hdev->group, hdev->vendor, hdev->product); 22594d53b801SHenrik Rydberg } 22600d4260e0SGreg Kroah-Hartman static DEVICE_ATTR_RO(modalias); 22614d53b801SHenrik Rydberg 22620d4260e0SGreg Kroah-Hartman static struct attribute *hid_dev_attrs[] = { 22630d4260e0SGreg Kroah-Hartman &dev_attr_modalias.attr, 22640d4260e0SGreg Kroah-Hartman NULL, 22654d53b801SHenrik Rydberg }; 226654f32fd5SAndy Lutomirski static struct bin_attribute *hid_dev_bin_attrs[] = { 226754f32fd5SAndy Lutomirski &dev_bin_attr_report_desc, 226854f32fd5SAndy Lutomirski NULL 226954f32fd5SAndy Lutomirski }; 227054f32fd5SAndy Lutomirski static const struct attribute_group hid_dev_group = { 227154f32fd5SAndy Lutomirski .attrs = hid_dev_attrs, 227254f32fd5SAndy Lutomirski .bin_attrs = hid_dev_bin_attrs, 227354f32fd5SAndy Lutomirski }; 227454f32fd5SAndy Lutomirski __ATTRIBUTE_GROUPS(hid_dev); 22754d53b801SHenrik Rydberg 227685cdaf52SJiri Slaby static int hid_uevent(struct device *dev, struct kobj_uevent_env *env) 227785cdaf52SJiri Slaby { 2278ee79a8f8SGeliang Tang struct hid_device *hdev = to_hid_device(dev); 227985cdaf52SJiri Slaby 228085cdaf52SJiri Slaby if (add_uevent_var(env, "HID_ID=%04X:%08X:%08X", 228185cdaf52SJiri Slaby hdev->bus, hdev->vendor, hdev->product)) 228285cdaf52SJiri Slaby return -ENOMEM; 228385cdaf52SJiri Slaby 228485cdaf52SJiri Slaby if (add_uevent_var(env, "HID_NAME=%s", hdev->name)) 228585cdaf52SJiri Slaby return -ENOMEM; 228685cdaf52SJiri Slaby 228785cdaf52SJiri Slaby if (add_uevent_var(env, "HID_PHYS=%s", hdev->phys)) 228885cdaf52SJiri Slaby return -ENOMEM; 228985cdaf52SJiri Slaby 229085cdaf52SJiri Slaby if (add_uevent_var(env, "HID_UNIQ=%s", hdev->uniq)) 229185cdaf52SJiri Slaby return -ENOMEM; 229285cdaf52SJiri Slaby 22934d53b801SHenrik Rydberg if (add_uevent_var(env, "MODALIAS=hid:b%04Xg%04Xv%08Xp%08X", 22944d53b801SHenrik Rydberg hdev->bus, hdev->group, hdev->vendor, hdev->product)) 229585cdaf52SJiri Slaby return -ENOMEM; 229685cdaf52SJiri Slaby 229785cdaf52SJiri Slaby return 0; 229885cdaf52SJiri Slaby } 229985cdaf52SJiri Slaby 2300e04a0442SBenjamin Tissoires struct bus_type hid_bus_type = { 230185cdaf52SJiri Slaby .name = "hid", 23020d4260e0SGreg Kroah-Hartman .dev_groups = hid_dev_groups, 2303c2810325SGreg Kroah-Hartman .drv_groups = hid_drv_groups, 230485cdaf52SJiri Slaby .match = hid_bus_match, 230585cdaf52SJiri Slaby .probe = hid_device_probe, 230685cdaf52SJiri Slaby .remove = hid_device_remove, 230785cdaf52SJiri Slaby .uevent = hid_uevent, 230885cdaf52SJiri Slaby }; 2309d5d3e202SBenjamin Tissoires EXPORT_SYMBOL(hid_bus_type); 2310d458a9dfSJiri Slaby 231185cdaf52SJiri Slaby int hid_add_device(struct hid_device *hdev) 231285cdaf52SJiri Slaby { 231385cdaf52SJiri Slaby static atomic_t id = ATOMIC_INIT(0); 231485cdaf52SJiri Slaby int ret; 231585cdaf52SJiri Slaby 231685cdaf52SJiri Slaby if (WARN_ON(hdev->status & HID_STAT_ADDED)) 231785cdaf52SJiri Slaby return -EBUSY; 231885cdaf52SJiri Slaby 2319d5d3e202SBenjamin Tissoires hdev->quirks = hid_lookup_quirk(hdev); 2320d5d3e202SBenjamin Tissoires 2321d458a9dfSJiri Slaby /* we need to kill them here, otherwise they will stay allocated to 2322d458a9dfSJiri Slaby * wait for coming driver */ 23234529eefaSLamarque V. Souza if (hid_ignore(hdev)) 2324d458a9dfSJiri Slaby return -ENODEV; 2325d458a9dfSJiri Slaby 2326a7197c2eSHenrik Rydberg /* 23273c86726cSBenjamin Tissoires * Check for the mandatory transport channel. 23283c86726cSBenjamin Tissoires */ 23293c86726cSBenjamin Tissoires if (!hdev->ll_driver->raw_request) { 23303c86726cSBenjamin Tissoires hid_err(hdev, "transport driver missing .raw_request()\n"); 23313c86726cSBenjamin Tissoires return -EINVAL; 23323c86726cSBenjamin Tissoires } 23333c86726cSBenjamin Tissoires 23343c86726cSBenjamin Tissoires /* 2335a7197c2eSHenrik Rydberg * Read the device report descriptor once and use as template 2336a7197c2eSHenrik Rydberg * for the driver-specific modifications. 2337a7197c2eSHenrik Rydberg */ 2338a7197c2eSHenrik Rydberg ret = hdev->ll_driver->parse(hdev); 2339a7197c2eSHenrik Rydberg if (ret) 2340a7197c2eSHenrik Rydberg return ret; 2341a7197c2eSHenrik Rydberg if (!hdev->dev_rdesc) 2342a7197c2eSHenrik Rydberg return -ENODEV; 2343a7197c2eSHenrik Rydberg 2344734c6609SHenrik Rydberg /* 2345734c6609SHenrik Rydberg * Scan generic devices for group information 2346734c6609SHenrik Rydberg */ 23474392bf33SBenjamin Tissoires if (hid_ignore_special_drivers) { 23484392bf33SBenjamin Tissoires hdev->group = HID_GROUP_GENERIC; 23494392bf33SBenjamin Tissoires } else if (!hdev->group && 23506e65d9d5SBenjamin Tissoires !(hdev->quirks & HID_QUIRK_HAVE_SPECIAL_DRIVER)) { 2351734c6609SHenrik Rydberg ret = hid_scan_report(hdev); 2352734c6609SHenrik Rydberg if (ret) 2353734c6609SHenrik Rydberg hid_warn(hdev, "bad device descriptor (%d)\n", ret); 2354734c6609SHenrik Rydberg } 2355734c6609SHenrik Rydberg 23566bbe586fSKay Sievers /* XXX hack, any other cleaner solution after the driver core 23576bbe586fSKay Sievers * is converted to allow more than 20 bytes as the device name? */ 23586bbe586fSKay Sievers dev_set_name(&hdev->dev, "%04X:%04X:%04X.%04X", hdev->bus, 235985cdaf52SJiri Slaby hdev->vendor, hdev->product, atomic_inc_return(&id)); 236085cdaf52SJiri Slaby 23614da361b6SBruno Prémont hid_debug_register(hdev, dev_name(&hdev->dev)); 236285cdaf52SJiri Slaby ret = device_add(&hdev->dev); 236385cdaf52SJiri Slaby if (!ret) 236485cdaf52SJiri Slaby hdev->status |= HID_STAT_ADDED; 23654da361b6SBruno Prémont else 23664da361b6SBruno Prémont hid_debug_unregister(hdev); 2367a635f9ddSJiri Kosina 236885cdaf52SJiri Slaby return ret; 236985cdaf52SJiri Slaby } 237085cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_add_device); 237185cdaf52SJiri Slaby 237285cdaf52SJiri Slaby /** 237385cdaf52SJiri Slaby * hid_allocate_device - allocate new hid device descriptor 237485cdaf52SJiri Slaby * 237585cdaf52SJiri Slaby * Allocate and initialize hid device, so that hid_destroy_device might be 237685cdaf52SJiri Slaby * used to free it. 237785cdaf52SJiri Slaby * 237885cdaf52SJiri Slaby * New hid_device pointer is returned on success, otherwise ERR_PTR encoded 237985cdaf52SJiri Slaby * error value. 238085cdaf52SJiri Slaby */ 238185cdaf52SJiri Slaby struct hid_device *hid_allocate_device(void) 238285cdaf52SJiri Slaby { 238385cdaf52SJiri Slaby struct hid_device *hdev; 238485cdaf52SJiri Slaby int ret = -ENOMEM; 238585cdaf52SJiri Slaby 238685cdaf52SJiri Slaby hdev = kzalloc(sizeof(*hdev), GFP_KERNEL); 238785cdaf52SJiri Slaby if (hdev == NULL) 238885cdaf52SJiri Slaby return ERR_PTR(ret); 238985cdaf52SJiri Slaby 239085cdaf52SJiri Slaby device_initialize(&hdev->dev); 239185cdaf52SJiri Slaby hdev->dev.release = hid_device_release; 239285cdaf52SJiri Slaby hdev->dev.bus = &hid_bus_type; 239364bebefcSFu, Zhonghui device_enable_async_suspend(&hdev->dev); 239485cdaf52SJiri Slaby 2395a7197c2eSHenrik Rydberg hid_close_report(hdev); 239685cdaf52SJiri Slaby 2397cd667ce2SJiri Kosina init_waitqueue_head(&hdev->debug_wait); 2398cd667ce2SJiri Kosina INIT_LIST_HEAD(&hdev->debug_list); 23991deb9d34SJiri Kosina spin_lock_init(&hdev->debug_list_lock); 2400c849a614SAndrew de los Reyes sema_init(&hdev->driver_input_lock, 1); 2401aaac082dSDmitry Torokhov mutex_init(&hdev->ll_open_lock); 2402cd667ce2SJiri Kosina 240385cdaf52SJiri Slaby return hdev; 240485cdaf52SJiri Slaby } 240585cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_allocate_device); 240685cdaf52SJiri Slaby 240785cdaf52SJiri Slaby static void hid_remove_device(struct hid_device *hdev) 240885cdaf52SJiri Slaby { 240985cdaf52SJiri Slaby if (hdev->status & HID_STAT_ADDED) { 241085cdaf52SJiri Slaby device_del(&hdev->dev); 2411a635f9ddSJiri Kosina hid_debug_unregister(hdev); 241285cdaf52SJiri Slaby hdev->status &= ~HID_STAT_ADDED; 241385cdaf52SJiri Slaby } 2414a7197c2eSHenrik Rydberg kfree(hdev->dev_rdesc); 2415a7197c2eSHenrik Rydberg hdev->dev_rdesc = NULL; 2416a7197c2eSHenrik Rydberg hdev->dev_rsize = 0; 241785cdaf52SJiri Slaby } 241885cdaf52SJiri Slaby 241985cdaf52SJiri Slaby /** 242085cdaf52SJiri Slaby * hid_destroy_device - free previously allocated device 242185cdaf52SJiri Slaby * 242285cdaf52SJiri Slaby * @hdev: hid device 242385cdaf52SJiri Slaby * 242485cdaf52SJiri Slaby * If you allocate hid_device through hid_allocate_device, you should ever 242585cdaf52SJiri Slaby * free by this function. 242685cdaf52SJiri Slaby */ 242785cdaf52SJiri Slaby void hid_destroy_device(struct hid_device *hdev) 242885cdaf52SJiri Slaby { 242985cdaf52SJiri Slaby hid_remove_device(hdev); 243085cdaf52SJiri Slaby put_device(&hdev->dev); 243185cdaf52SJiri Slaby } 243285cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_destroy_device); 243385cdaf52SJiri Slaby 2434e04a0442SBenjamin Tissoires 2435c17a7476SBenjamin Tissoires static int __hid_bus_reprobe_drivers(struct device *dev, void *data) 2436e04a0442SBenjamin Tissoires { 2437c17a7476SBenjamin Tissoires struct hid_driver *hdrv = data; 2438c17a7476SBenjamin Tissoires struct hid_device *hdev = to_hid_device(dev); 2439c17a7476SBenjamin Tissoires 2440c17a7476SBenjamin Tissoires if (hdev->driver == hdrv && 24418f732850SBenjamin Tissoires !hdrv->match(hdev, hid_ignore_special_drivers) && 24428f732850SBenjamin Tissoires !test_and_set_bit(ffs(HID_STAT_REPROBED), &hdev->status)) 2443c17a7476SBenjamin Tissoires return device_reprobe(dev); 2444c17a7476SBenjamin Tissoires 2445c17a7476SBenjamin Tissoires return 0; 2446c17a7476SBenjamin Tissoires } 2447c17a7476SBenjamin Tissoires 2448c17a7476SBenjamin Tissoires static int __hid_bus_driver_added(struct device_driver *drv, void *data) 2449c17a7476SBenjamin Tissoires { 2450e04a0442SBenjamin Tissoires struct hid_driver *hdrv = to_hid_driver(drv); 2451e04a0442SBenjamin Tissoires 2452c17a7476SBenjamin Tissoires if (hdrv->match) { 2453c17a7476SBenjamin Tissoires bus_for_each_dev(&hid_bus_type, NULL, hdrv, 2454c17a7476SBenjamin Tissoires __hid_bus_reprobe_drivers); 2455c17a7476SBenjamin Tissoires } 2456e04a0442SBenjamin Tissoires 2457e04a0442SBenjamin Tissoires return 0; 2458e04a0442SBenjamin Tissoires } 2459e04a0442SBenjamin Tissoires 2460e04a0442SBenjamin Tissoires static int __bus_removed_driver(struct device_driver *drv, void *data) 2461e04a0442SBenjamin Tissoires { 2462c17a7476SBenjamin Tissoires return bus_rescan_devices(&hid_bus_type); 2463e04a0442SBenjamin Tissoires } 2464e04a0442SBenjamin Tissoires 246585cdaf52SJiri Slaby int __hid_register_driver(struct hid_driver *hdrv, struct module *owner, 246685cdaf52SJiri Slaby const char *mod_name) 246785cdaf52SJiri Slaby { 2468c17a7476SBenjamin Tissoires int ret; 2469c17a7476SBenjamin Tissoires 247085cdaf52SJiri Slaby hdrv->driver.name = hdrv->name; 247185cdaf52SJiri Slaby hdrv->driver.bus = &hid_bus_type; 247285cdaf52SJiri Slaby hdrv->driver.owner = owner; 247385cdaf52SJiri Slaby hdrv->driver.mod_name = mod_name; 247485cdaf52SJiri Slaby 24753a6f82f7SJiri Slaby INIT_LIST_HEAD(&hdrv->dyn_list); 24763a6f82f7SJiri Slaby spin_lock_init(&hdrv->dyn_lock); 24773a6f82f7SJiri Slaby 2478c17a7476SBenjamin Tissoires ret = driver_register(&hdrv->driver); 2479e04a0442SBenjamin Tissoires 2480c17a7476SBenjamin Tissoires if (ret == 0) 2481c17a7476SBenjamin Tissoires bus_for_each_drv(&hid_bus_type, NULL, NULL, 2482c17a7476SBenjamin Tissoires __hid_bus_driver_added); 2483c17a7476SBenjamin Tissoires 2484c17a7476SBenjamin Tissoires return ret; 248585cdaf52SJiri Slaby } 248685cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(__hid_register_driver); 248785cdaf52SJiri Slaby 248885cdaf52SJiri Slaby void hid_unregister_driver(struct hid_driver *hdrv) 248985cdaf52SJiri Slaby { 249085cdaf52SJiri Slaby driver_unregister(&hdrv->driver); 24913a6f82f7SJiri Slaby hid_free_dynids(hdrv); 2492e04a0442SBenjamin Tissoires 2493e04a0442SBenjamin Tissoires bus_for_each_drv(&hid_bus_type, NULL, hdrv, __bus_removed_driver); 249485cdaf52SJiri Slaby } 249585cdaf52SJiri Slaby EXPORT_SYMBOL_GPL(hid_unregister_driver); 249685cdaf52SJiri Slaby 24970361a28dSOliver Neukum int hid_check_keys_pressed(struct hid_device *hid) 24980361a28dSOliver Neukum { 24990361a28dSOliver Neukum struct hid_input *hidinput; 25000361a28dSOliver Neukum int i; 25010361a28dSOliver Neukum 2502e5288eb5SJiri Kosina if (!(hid->claimed & HID_CLAIMED_INPUT)) 2503e5288eb5SJiri Kosina return 0; 2504e5288eb5SJiri Kosina 25050361a28dSOliver Neukum list_for_each_entry(hidinput, &hid->inputs, list) { 25060361a28dSOliver Neukum for (i = 0; i < BITS_TO_LONGS(KEY_MAX); i++) 25070361a28dSOliver Neukum if (hidinput->input->key[i]) 25080361a28dSOliver Neukum return 1; 25090361a28dSOliver Neukum } 25100361a28dSOliver Neukum 25110361a28dSOliver Neukum return 0; 25120361a28dSOliver Neukum } 25130361a28dSOliver Neukum 25140361a28dSOliver Neukum EXPORT_SYMBOL_GPL(hid_check_keys_pressed); 25150361a28dSOliver Neukum 251686166b7bSJiri Kosina static int __init hid_init(void) 251786166b7bSJiri Kosina { 251885cdaf52SJiri Slaby int ret; 251985cdaf52SJiri Slaby 2520a635f9ddSJiri Kosina if (hid_debug) 25214291ee30SJoe Perches pr_warn("hid_debug is now used solely for parser and driver debugging.\n" 25224291ee30SJoe Perches "debugfs is now used for inspecting the device (report descriptor, reports)\n"); 2523a635f9ddSJiri Kosina 252485cdaf52SJiri Slaby ret = bus_register(&hid_bus_type); 252585cdaf52SJiri Slaby if (ret) { 25264291ee30SJoe Perches pr_err("can't register hid bus\n"); 252785cdaf52SJiri Slaby goto err; 252885cdaf52SJiri Slaby } 252985cdaf52SJiri Slaby 253085cdaf52SJiri Slaby ret = hidraw_init(); 253185cdaf52SJiri Slaby if (ret) 253285cdaf52SJiri Slaby goto err_bus; 253385cdaf52SJiri Slaby 2534a635f9ddSJiri Kosina hid_debug_init(); 2535a635f9ddSJiri Kosina 253685cdaf52SJiri Slaby return 0; 253785cdaf52SJiri Slaby err_bus: 253885cdaf52SJiri Slaby bus_unregister(&hid_bus_type); 253985cdaf52SJiri Slaby err: 254085cdaf52SJiri Slaby return ret; 254186166b7bSJiri Kosina } 254286166b7bSJiri Kosina 254386166b7bSJiri Kosina static void __exit hid_exit(void) 254486166b7bSJiri Kosina { 2545a635f9ddSJiri Kosina hid_debug_exit(); 254686166b7bSJiri Kosina hidraw_exit(); 254785cdaf52SJiri Slaby bus_unregister(&hid_bus_type); 2548d5d3e202SBenjamin Tissoires hid_quirks_exit(HID_BUS_ANY); 254986166b7bSJiri Kosina } 255086166b7bSJiri Kosina 255186166b7bSJiri Kosina module_init(hid_init); 255286166b7bSJiri Kosina module_exit(hid_exit); 255386166b7bSJiri Kosina 255488adb72bSJiri Kosina MODULE_AUTHOR("Andreas Gal"); 255588adb72bSJiri Kosina MODULE_AUTHOR("Vojtech Pavlik"); 255688adb72bSJiri Kosina MODULE_AUTHOR("Jiri Kosina"); 25577021b600SGrant Grundler MODULE_LICENSE("GPL"); 2558