drivers/hid/hid-sensor-hub.c

   1 /*
   2  * HID Sensors Driver
   3  * Copyright (c) 2012, Intel Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  17  *
  18  */
  19
  20 #include <linux/device.h>
  21 #include <linux/hid.h>
  22 #include <linux/module.h>
  23 #include <linux/slab.h>
  24 #include <linux/mfd/core.h>
  25 #include <linux/list.h>
  26 #include <linux/hid-sensor-ids.h>
  27 #include <linux/hid-sensor-hub.h>
  28 #include "hid-ids.h"
  29
  30 #define HID_SENSOR_HUB_ENUM_QUIRK       0x01
  31
  32 /**
  33  * struct sensor_hub_data - Hold a instance data for a HID hub device
  34  * @hsdev:              Stored hid instance for current hub device.
  35  * @mutex:              Mutex to serialize synchronous request.
  36  * @lock:               Spin lock to protect pending request structure.
  37  * @dyn_callback_list:  Holds callback function
  38  * @dyn_callback_lock:  spin lock to protect callback list
  39  * @hid_sensor_hub_client_devs: Stores all MFD cells for a hub instance.
  40  * @hid_sensor_client_cnt: Number of MFD cells, (no of sensors attached).
  41  * @ref_cnt:            Number of MFD clients have opened this device
  42  */
  43 struct sensor_hub_data {
  44         struct mutex mutex;
  45         spinlock_t lock;
  46         struct list_head dyn_callback_list;
  47         spinlock_t dyn_callback_lock;
  48         struct mfd_cell *hid_sensor_hub_client_devs;
  49         int hid_sensor_client_cnt;
  50         unsigned long quirks;
  51         int ref_cnt;
  52 };
  53
  54 /**
  55  * struct hid_sensor_hub_callbacks_list - Stores callback list
  56  * @list:               list head.
  57  * @usage_id:           usage id for a physical device.
  58  * @usage_callback:     Stores registered callback functions.
  59  * @priv:               Private data for a physical device.
  60  */
  61 struct hid_sensor_hub_callbacks_list {
  62         struct list_head list;
  63         u32 usage_id;
  64         struct hid_sensor_hub_device *hsdev;
  65         struct hid_sensor_hub_callbacks *usage_callback;
  66         void *priv;
  67 };
  68
  69 static struct hid_report *sensor_hub_report(int id, struct hid_device *hdev,
  70                                                 int dir)
  71 {
  72         struct hid_report *report;
  73
  74         list_for_each_entry(report, &hdev->report_enum[dir].report_list, list) {
  75                 if (report->id == id)
  76                         return report;
  77         }
  78         hid_warn(hdev, "No report with id 0x%x found\n", id);
  79
  80         return NULL;
  81 }
  82
  83 static int sensor_hub_get_physical_device_count(struct hid_device *hdev)
  84 {
  85         int i;
  86         int count = 0;
  87
  88         for (i = 0; i < hdev->maxcollection; ++i) {
  89                 struct hid_collection *collection = &hdev->collection[i];
  90                 if (collection->type == HID_COLLECTION_PHYSICAL ||
  91                     collection->type == HID_COLLECTION_APPLICATION)
  92                         ++count;
  93         }
  94
  95         return count;
  96 }
  97
  98 static void sensor_hub_fill_attr_info(
  99                 struct hid_sensor_hub_attribute_info *info,
 100                 s32 index, s32 report_id, struct hid_field *field)
 101 {
 102         info->index = index;
 103         info->report_id = report_id;
 104         info->units = field->unit;
 105         info->unit_expo = field->unit_exponent;
 106         info->size = (field->report_size * field->report_count)/8;
 107         info->logical_minimum = field->logical_minimum;
 108         info->logical_maximum = field->logical_maximum;
 109 }
 110
 111 static struct hid_sensor_hub_callbacks *sensor_hub_get_callback(
 112                                         struct hid_device *hdev,
 113                                         u32 usage_id,
 114                                         int collection_index,
 115                                         struct hid_sensor_hub_device **hsdev,
 116                                         void **priv)
 117 {
 118         struct hid_sensor_hub_callbacks_list *callback;
 119         struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
 120         unsigned long flags;
 121
 122         spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
 123         list_for_each_entry(callback, &pdata->dyn_callback_list, list)
 124                 if ((callback->usage_id == usage_id ||
 125                      callback->usage_id == HID_USAGE_SENSOR_COLLECTION) &&
 126                         (collection_index >=
 127                                 callback->hsdev->start_collection_index) &&
 128                         (collection_index <
 129                                 callback->hsdev->end_collection_index)) {
 130                         *priv = callback->priv;
 131                         *hsdev = callback->hsdev;
 132                         spin_unlock_irqrestore(&pdata->dyn_callback_lock,
 133                                                flags);
 134                         return callback->usage_callback;
 135                 }
 136         spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 137
 138         return NULL;
 139 }
 140
 141 int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
 142                         u32 usage_id,
 143                         struct hid_sensor_hub_callbacks *usage_callback)
 144 {
 145         struct hid_sensor_hub_callbacks_list *callback;
 146         struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
 147         unsigned long flags;
 148
 149         spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
 150         list_for_each_entry(callback, &pdata->dyn_callback_list, list)
 151                 if (callback->usage_id == usage_id &&
 152                                                 callback->hsdev == hsdev) {
 153                         spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 154                         return -EINVAL;
 155                 }
 156         callback = kzalloc(sizeof(*callback), GFP_ATOMIC);
 157         if (!callback) {
 158                 spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 159                 return -ENOMEM;
 160         }
 161         callback->hsdev = hsdev;
 162         callback->usage_callback = usage_callback;
 163         callback->usage_id = usage_id;
 164         callback->priv = NULL;
 165         /*
 166          * If there is a handler registered for the collection type, then
 167          * it will handle all reports for sensors in this collection. If
 168          * there is also an individual sensor handler registration, then
 169          * we want to make sure that the reports are directed to collection
 170          * handler, as this may be a fusion sensor. So add collection handlers
 171          * to the beginning of the list, so that they are matched first.
 172          */
 173         if (usage_id == HID_USAGE_SENSOR_COLLECTION)
 174                 list_add(&callback->list, &pdata->dyn_callback_list);
 175         else
 176                 list_add_tail(&callback->list, &pdata->dyn_callback_list);
 177         spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 178
 179         return 0;
 180 }
 181 EXPORT_SYMBOL_GPL(sensor_hub_register_callback);
 182
 183 int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
 184                                 u32 usage_id)
 185 {
 186         struct hid_sensor_hub_callbacks_list *callback;
 187         struct sensor_hub_data *pdata = hid_get_drvdata(hsdev->hdev);
 188         unsigned long flags;
 189
 190         spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
 191         list_for_each_entry(callback, &pdata->dyn_callback_list, list)
 192                 if (callback->usage_id == usage_id &&
 193                                                 callback->hsdev == hsdev) {
 194                         list_del(&callback->list);
 195                         kfree(callback);
 196                         break;
 197                 }
 198         spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 199
 200         return 0;
 201 }
 202 EXPORT_SYMBOL_GPL(sensor_hub_remove_callback);
 203
 204 int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
 205                            u32 field_index, int buffer_size, void *buffer)
 206 {
 207         struct hid_report *report;
 208         struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
 209         __s32 *buf32 = buffer;
 210         int i = 0;
 211         int remaining_bytes;
 212         __s32 value;
 213         int ret = 0;
 214
 215         mutex_lock(&data->mutex);
 216         report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
 217         if (!report || (field_index >= report->maxfield)) {
 218                 ret = -EINVAL;
 219                 goto done_proc;
 220         }
 221
 222         remaining_bytes = buffer_size % sizeof(__s32);
 223         buffer_size = buffer_size / sizeof(__s32);
 224         if (buffer_size) {
 225                 for (i = 0; i < buffer_size; ++i) {
 226                         ret = hid_set_field(report->field[field_index], i,
 227                                             (__force __s32)cpu_to_le32(*buf32));
 228                         if (ret)
 229                                 goto done_proc;
 230
 231                         ++buf32;
 232                 }
 233         }
 234         if (remaining_bytes) {
 235                 value = 0;
 236                 memcpy(&value, (u8 *)buf32, remaining_bytes);
 237                 ret = hid_set_field(report->field[field_index], i,
 238                                     (__force __s32)cpu_to_le32(value));
 239                 if (ret)
 240                         goto done_proc;
 241         }
 242         hid_hw_request(hsdev->hdev, report, HID_REQ_SET_REPORT);
 243         hid_hw_wait(hsdev->hdev);
 244
 245 done_proc:
 246         mutex_unlock(&data->mutex);
 247
 248         return ret;
 249 }
 250 EXPORT_SYMBOL_GPL(sensor_hub_set_feature);
 251
 252 int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
 253                            u32 field_index, int buffer_size, void *buffer)
 254 {
 255         struct hid_report *report;
 256         struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
 257         int report_size;
 258         int ret = 0;
 259         u8 *val_ptr;
 260         int buffer_index = 0;
 261         int i;
 262
 263         memset(buffer, 0, buffer_size);
 264
 265         mutex_lock(&data->mutex);
 266         report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
 267         if (!report || (field_index >= report->maxfield) ||
 268             report->field[field_index]->report_count < 1) {
 269                 ret = -EINVAL;
 270                 goto done_proc;
 271         }
 272         hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
 273         hid_hw_wait(hsdev->hdev);
 274
 275         /* calculate number of bytes required to read this field */
 276         report_size = DIV_ROUND_UP(report->field[field_index]->report_size,
 277                                    8) *
 278                                    report->field[field_index]->report_count;
 279         if (!report_size) {
 280                 ret = -EINVAL;
 281                 goto done_proc;
 282         }
 283         ret = min(report_size, buffer_size);
 284
 285         val_ptr = (u8 *)report->field[field_index]->value;
 286         for (i = 0; i < report->field[field_index]->report_count; ++i) {
 287                 if (buffer_index >= ret)
 288                         break;
 289
 290                 memcpy(&((u8 *)buffer)[buffer_index], val_ptr,
 291                        report->field[field_index]->report_size / 8);
 292                 val_ptr += sizeof(__s32);
 293                 buffer_index += (report->field[field_index]->report_size / 8);
 294         }
 295
 296 done_proc:
 297         mutex_unlock(&data->mutex);
 298
 299         return ret;
 300 }
 301 EXPORT_SYMBOL_GPL(sensor_hub_get_feature);
 302
 303
 304 int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
 305                                         u32 usage_id,
 306                                         u32 attr_usage_id, u32 report_id,
 307                                         enum sensor_hub_read_flags flag)
 308 {
 309         struct sensor_hub_data *data = hid_get_drvdata(hsdev->hdev);
 310         unsigned long flags;
 311         struct hid_report *report;
 312         int ret_val = 0;
 313
 314         report = sensor_hub_report(report_id, hsdev->hdev,
 315                                    HID_INPUT_REPORT);
 316         if (!report)
 317                 return -EINVAL;
 318
 319         mutex_lock(hsdev->mutex_ptr);
 320         if (flag == SENSOR_HUB_SYNC) {
 321                 memset(&hsdev->pending, 0, sizeof(hsdev->pending));
 322                 init_completion(&hsdev->pending.ready);
 323                 hsdev->pending.usage_id = usage_id;
 324                 hsdev->pending.attr_usage_id = attr_usage_id;
 325                 hsdev->pending.raw_size = 0;
 326
 327                 spin_lock_irqsave(&data->lock, flags);
 328                 hsdev->pending.status = true;
 329                 spin_unlock_irqrestore(&data->lock, flags);
 330         }
 331         mutex_lock(&data->mutex);
 332         hid_hw_request(hsdev->hdev, report, HID_REQ_GET_REPORT);
 333         mutex_unlock(&data->mutex);
 334         if (flag == SENSOR_HUB_SYNC) {
 335                 wait_for_completion_interruptible_timeout(
 336                                                 &hsdev->pending.ready, HZ*5);
 337                 switch (hsdev->pending.raw_size) {
 338                 case 1:
 339                         ret_val = *(u8 *)hsdev->pending.raw_data;
 340                         break;
 341                 case 2:
 342                         ret_val = *(u16 *)hsdev->pending.raw_data;
 343                         break;
 344                 case 4:
 345                         ret_val = *(u32 *)hsdev->pending.raw_data;
 346                         break;
 347                 default:
 348                         ret_val = 0;
 349                 }
 350                 kfree(hsdev->pending.raw_data);
 351                 hsdev->pending.status = false;
 352         }
 353         mutex_unlock(hsdev->mutex_ptr);
 354
 355         return ret_val;
 356 }
 357 EXPORT_SYMBOL_GPL(sensor_hub_input_attr_get_raw_value);
 358
 359 int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
 360                                 u32 report_id, int field_index, u32 usage_id)
 361 {
 362         struct hid_report *report;
 363         struct hid_field *field;
 364         int i;
 365
 366         report = sensor_hub_report(report_id, hsdev->hdev, HID_FEATURE_REPORT);
 367         if (!report || (field_index >= report->maxfield))
 368                 goto done_proc;
 369
 370         field = report->field[field_index];
 371         for (i = 0; i < field->maxusage; ++i) {
 372                 if (field->usage[i].hid == usage_id)
 373                         return field->usage[i].usage_index;
 374         }
 375
 376 done_proc:
 377         return -EINVAL;
 378 }
 379 EXPORT_SYMBOL_GPL(hid_sensor_get_usage_index);
 380
 381 int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
 382                                 u8 type,
 383                                 u32 usage_id,
 384                                 u32 attr_usage_id,
 385                                 struct hid_sensor_hub_attribute_info *info)
 386 {
 387         int ret = -1;
 388         int i;
 389         struct hid_report *report;
 390         struct hid_field *field;
 391         struct hid_report_enum *report_enum;
 392         struct hid_device *hdev = hsdev->hdev;
 393
 394         /* Initialize with defaults */
 395         info->usage_id = usage_id;
 396         info->attrib_id = attr_usage_id;
 397         info->report_id = -1;
 398         info->index = -1;
 399         info->units = -1;
 400         info->unit_expo = -1;
 401
 402         report_enum = &hdev->report_enum[type];
 403         list_for_each_entry(report, &report_enum->report_list, list) {
 404                 for (i = 0; i < report->maxfield; ++i) {
 405                         field = report->field[i];
 406                         if (field->maxusage) {
 407                                 if (field->physical == usage_id &&
 408                                         (field->logical == attr_usage_id ||
 409                                         field->usage[0].hid ==
 410                                                         attr_usage_id) &&
 411                                         (field->usage[0].collection_index >=
 412                                         hsdev->start_collection_index) &&
 413                                         (field->usage[0].collection_index <
 414                                         hsdev->end_collection_index)) {
 415
 416                                         sensor_hub_fill_attr_info(info, i,
 417                                                                 report->id,
 418                                                                 field);
 419                                         ret = 0;
 420                                         break;
 421                                 }
 422                         }
 423                 }
 424
 425         }
 426
 427         return ret;
 428 }
 429 EXPORT_SYMBOL_GPL(sensor_hub_input_get_attribute_info);
 430
 431 #ifdef CONFIG_PM
 432 static int sensor_hub_suspend(struct hid_device *hdev, pm_message_t message)
 433 {
 434         struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
 435         struct hid_sensor_hub_callbacks_list *callback;
 436         unsigned long flags;
 437
 438         hid_dbg(hdev, " sensor_hub_suspend\n");
 439         spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
 440         list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
 441                 if (callback->usage_callback->suspend)
 442                         callback->usage_callback->suspend(
 443                                         callback->hsdev, callback->priv);
 444         }
 445         spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 446
 447         return 0;
 448 }
 449
 450 static int sensor_hub_resume(struct hid_device *hdev)
 451 {
 452         struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
 453         struct hid_sensor_hub_callbacks_list *callback;
 454         unsigned long flags;
 455
 456         hid_dbg(hdev, " sensor_hub_resume\n");
 457         spin_lock_irqsave(&pdata->dyn_callback_lock, flags);
 458         list_for_each_entry(callback, &pdata->dyn_callback_list, list) {
 459                 if (callback->usage_callback->resume)
 460                         callback->usage_callback->resume(
 461                                         callback->hsdev, callback->priv);
 462         }
 463         spin_unlock_irqrestore(&pdata->dyn_callback_lock, flags);
 464
 465         return 0;
 466 }
 467
 468 static int sensor_hub_reset_resume(struct hid_device *hdev)
 469 {
 470         return 0;
 471 }
 472 #endif
 473
 474 /*
 475  * Handle raw report as sent by device
 476  */
 477 static int sensor_hub_raw_event(struct hid_device *hdev,
 478                 struct hid_report *report, u8 *raw_data, int size)
 479 {
 480         int i;
 481         u8 *ptr;
 482         int sz;
 483         struct sensor_hub_data *pdata = hid_get_drvdata(hdev);
 484         unsigned long flags;
 485         struct hid_sensor_hub_callbacks *callback = NULL;
 486         struct hid_collection *collection = NULL;
 487         void *priv = NULL;
 488         struct hid_sensor_hub_device *hsdev = NULL;
 489
 490         hid_dbg(hdev, "sensor_hub_raw_event report id:0x%x size:%d type:%d\n",
 491                          report->id, size, report->type);
 492         hid_dbg(hdev, "maxfield:%d\n", report->maxfield);
 493         if (report->type != HID_INPUT_REPORT)
 494                 return 1;
 495
 496         ptr = raw_data;
 497         if (report->id)
 498                 ptr++; /* Skip report id */
 499
 500         spin_lock_irqsave(&pdata->lock, flags);
 501
 502         for (i = 0; i < report->maxfield; ++i) {
 503                 hid_dbg(hdev, "%d collection_index:%x hid:%x sz:%x\n",
 504                                 i, report->field[i]->usage->collection_index,
 505                                 report->field[i]->usage->hid,
 506                                 (report->field[i]->report_size *
 507                                         report->field[i]->report_count)/8);
 508                 sz = (report->field[i]->report_size *
 509                                         report->field[i]->report_count)/8;
 510                 collection = &hdev->collection[
 511                                 report->field[i]->usage->collection_index];
 512                 hid_dbg(hdev, "collection->usage %x\n",
 513                                         collection->usage);
 514
 515                 callback = sensor_hub_get_callback(hdev,
 516                                 report->field[i]->physical,
 517                                 report->field[i]->usage[0].collection_index,
 518                                 &hsdev, &priv);
 519                 if (!callback) {
 520                         ptr += sz;
 521                         continue;
 522                 }
 523                 if (hsdev->pending.status && (hsdev->pending.attr_usage_id ==
 524                                               report->field[i]->usage->hid ||
 525                                               hsdev->pending.attr_usage_id ==
 526                                               report->field[i]->logical)) {
 527                         hid_dbg(hdev, "data was pending ...\n");
 528                         hsdev->pending.raw_data = kmemdup(ptr, sz, GFP_ATOMIC);
 529                         if (hsdev->pending.raw_data)
 530                                 hsdev->pending.raw_size = sz;
 531                         else
 532                                 hsdev->pending.raw_size = 0;
 533                         complete(&hsdev->pending.ready);
 534                 }
 535                 if (callback->capture_sample) {
 536                         if (report->field[i]->logical)
 537                                 callback->capture_sample(hsdev,
 538                                         report->field[i]->logical, sz, ptr,
 539                                         callback->pdev);
 540                         else
 541                                 callback->capture_sample(hsdev,
 542                                         report->field[i]->usage->hid, sz, ptr,
 543                                         callback->pdev);
 544                 }
 545                 ptr += sz;
 546         }
 547         if (callback && collection && callback->send_event)
 548                 callback->send_event(hsdev, collection->usage,
 549                                 callback->pdev);
 550         spin_unlock_irqrestore(&pdata->lock, flags);
 551
 552         return 1;
 553 }
 554
 555 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev)
 556 {
 557         int ret = 0;
 558         struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
 559
 560         mutex_lock(&data->mutex);
 561         if (!data->ref_cnt) {
 562                 ret = hid_hw_open(hsdev->hdev);
 563                 if (ret) {
 564                         hid_err(hsdev->hdev, "failed to open hid device\n");
 565                         mutex_unlock(&data->mutex);
 566                         return ret;
 567                 }
 568         }
 569         data->ref_cnt++;
 570         mutex_unlock(&data->mutex);
 571
 572         return ret;
 573 }
 574 EXPORT_SYMBOL_GPL(sensor_hub_device_open);
 575
 576 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev)
 577 {
 578         struct sensor_hub_data *data =  hid_get_drvdata(hsdev->hdev);
 579
 580         mutex_lock(&data->mutex);
 581         data->ref_cnt--;
 582         if (!data->ref_cnt)
 583                 hid_hw_close(hsdev->hdev);
 584         mutex_unlock(&data->mutex);
 585 }
 586 EXPORT_SYMBOL_GPL(sensor_hub_device_close);
 587
 588 static __u8 *sensor_hub_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 589                 unsigned int *rsize)
 590 {
 591         int index;
 592         struct sensor_hub_data *sd =  hid_get_drvdata(hdev);
 593         unsigned char report_block[] = {
 594                                 0x0a,  0x16, 0x03, 0x15, 0x00, 0x25, 0x05};
 595         unsigned char power_block[] = {
 596                                 0x0a,  0x19, 0x03, 0x15, 0x00, 0x25, 0x05};
 597
 598         if (!(sd->quirks & HID_SENSOR_HUB_ENUM_QUIRK)) {
 599                 hid_dbg(hdev, "No Enum quirks\n");
 600                 return rdesc;
 601         }
 602
 603         /* Looks for power and report state usage id and force to 1 */
 604         for (index = 0; index < *rsize; ++index) {
 605                 if (((*rsize - index) > sizeof(report_block)) &&
 606                         !memcmp(&rdesc[index], report_block,
 607                                                 sizeof(report_block))) {
 608                         rdesc[index + 4] = 0x01;
 609                         index += sizeof(report_block);
 610                 }
 611                 if (((*rsize - index) > sizeof(power_block)) &&
 612                         !memcmp(&rdesc[index], power_block,
 613                                                 sizeof(power_block))) {
 614                         rdesc[index + 4] = 0x01;
 615                         index += sizeof(power_block);
 616                 }
 617         }
 618
 619         /* Checks if the report descriptor of Thinkpad Helix 2 has a logical
 620          * minimum for magnetic flux axis greater than the maximum */
 621         if (hdev->product == USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA &&
 622                 *rsize == 2558 && rdesc[913] == 0x17 && rdesc[914] == 0x40 &&
 623                 rdesc[915] == 0x81 && rdesc[916] == 0x08 &&
 624                 rdesc[917] == 0x00 && rdesc[918] == 0x27 &&
 625                 rdesc[921] == 0x07 && rdesc[922] == 0x00) {
 626                 /* Sets negative logical minimum for mag x, y and z */
 627                 rdesc[914] = rdesc[935] = rdesc[956] = 0xc0;
 628                 rdesc[915] = rdesc[936] = rdesc[957] = 0x7e;
 629                 rdesc[916] = rdesc[937] = rdesc[958] = 0xf7;
 630                 rdesc[917] = rdesc[938] = rdesc[959] = 0xff;
 631         }
 632
 633         return rdesc;
 634 }
 635
 636 static int sensor_hub_probe(struct hid_device *hdev,
 637                                 const struct hid_device_id *id)
 638 {
 639         int ret;
 640         struct sensor_hub_data *sd;
 641         int i;
 642         char *name;
 643         int dev_cnt;
 644         struct hid_sensor_hub_device *hsdev;
 645         struct hid_sensor_hub_device *last_hsdev = NULL;
 646         struct hid_sensor_hub_device *collection_hsdev = NULL;
 647
 648         sd = devm_kzalloc(&hdev->dev, sizeof(*sd), GFP_KERNEL);
 649         if (!sd) {
 650                 hid_err(hdev, "cannot allocate Sensor data\n");
 651                 return -ENOMEM;
 652         }
 653
 654         hid_set_drvdata(hdev, sd);
 655         sd->quirks = id->driver_data;
 656
 657         spin_lock_init(&sd->lock);
 658         spin_lock_init(&sd->dyn_callback_lock);
 659         mutex_init(&sd->mutex);
 660         ret = hid_parse(hdev);
 661         if (ret) {
 662                 hid_err(hdev, "parse failed\n");
 663                 return ret;
 664         }
 665         INIT_LIST_HEAD(&hdev->inputs);
 666
 667         ret = hid_hw_start(hdev, 0);
 668         if (ret) {
 669                 hid_err(hdev, "hw start failed\n");
 670                 return ret;
 671         }
 672         INIT_LIST_HEAD(&sd->dyn_callback_list);
 673         sd->hid_sensor_client_cnt = 0;
 674
 675         dev_cnt = sensor_hub_get_physical_device_count(hdev);
 676         if (dev_cnt > HID_MAX_PHY_DEVICES) {
 677                 hid_err(hdev, "Invalid Physical device count\n");
 678                 ret = -EINVAL;
 679                 goto err_stop_hw;
 680         }
 681         sd->hid_sensor_hub_client_devs = devm_kzalloc(&hdev->dev, dev_cnt *
 682                                                       sizeof(struct mfd_cell),
 683                                                       GFP_KERNEL);
 684         if (sd->hid_sensor_hub_client_devs == NULL) {
 685                 hid_err(hdev, "Failed to allocate memory for mfd cells\n");
 686                 ret = -ENOMEM;
 687                 goto err_stop_hw;
 688         }
 689
 690         for (i = 0; i < hdev->maxcollection; ++i) {
 691                 struct hid_collection *collection = &hdev->collection[i];
 692
 693                 if (collection->type == HID_COLLECTION_PHYSICAL ||
 694                     collection->type == HID_COLLECTION_APPLICATION) {
 695
 696                         hsdev = devm_kzalloc(&hdev->dev, sizeof(*hsdev),
 697                                              GFP_KERNEL);
 698                         if (!hsdev) {
 699                                 hid_err(hdev, "cannot allocate hid_sensor_hub_device\n");
 700                                 ret = -ENOMEM;
 701                                 goto err_stop_hw;
 702                         }
 703                         hsdev->hdev = hdev;
 704                         hsdev->vendor_id = hdev->vendor;
 705                         hsdev->product_id = hdev->product;
 706                         hsdev->usage = collection->usage;
 707                         hsdev->mutex_ptr = devm_kzalloc(&hdev->dev,
 708                                                         sizeof(struct mutex),
 709                                                         GFP_KERNEL);
 710                         if (!hsdev->mutex_ptr) {
 711                                 ret = -ENOMEM;
 712                                 goto err_stop_hw;
 713                         }
 714                         mutex_init(hsdev->mutex_ptr);
 715                         hsdev->start_collection_index = i;
 716                         if (last_hsdev)
 717                                 last_hsdev->end_collection_index = i;
 718                         last_hsdev = hsdev;
 719                         name = devm_kasprintf(&hdev->dev, GFP_KERNEL,
 720                                               "HID-SENSOR-%x",
 721                                               collection->usage);
 722                         if (name == NULL) {
 723                                 hid_err(hdev, "Failed MFD device name\n");
 724                                 ret = -ENOMEM;
 725                                 goto err_stop_hw;
 726                         }
 727                         sd->hid_sensor_hub_client_devs[
 728                                 sd->hid_sensor_client_cnt].name = name;
 729                         sd->hid_sensor_hub_client_devs[
 730                                 sd->hid_sensor_client_cnt].platform_data =
 731                                                         hsdev;
 732                         sd->hid_sensor_hub_client_devs[
 733                                 sd->hid_sensor_client_cnt].pdata_size =
 734                                                         sizeof(*hsdev);
 735                         hid_dbg(hdev, "Adding %s:%d\n", name,
 736                                         hsdev->start_collection_index);
 737                         sd->hid_sensor_client_cnt++;
 738                         if (collection_hsdev)
 739                                 collection_hsdev->end_collection_index = i;
 740                         if (collection->type == HID_COLLECTION_APPLICATION &&
 741                             collection->usage == HID_USAGE_SENSOR_COLLECTION)
 742                                 collection_hsdev = hsdev;
 743                 }
 744         }
 745         if (last_hsdev)
 746                 last_hsdev->end_collection_index = i;
 747         if (collection_hsdev)
 748                 collection_hsdev->end_collection_index = i;
 749
 750         ret = mfd_add_hotplug_devices(&hdev->dev,
 751                         sd->hid_sensor_hub_client_devs,
 752                         sd->hid_sensor_client_cnt);
 753         if (ret < 0)
 754                 goto err_stop_hw;
 755
 756         return ret;
 757
 758 err_stop_hw:
 759         hid_hw_stop(hdev);
 760
 761         return ret;
 762 }
 763
 764 static void sensor_hub_remove(struct hid_device *hdev)
 765 {
 766         struct sensor_hub_data *data = hid_get_drvdata(hdev);
 767         unsigned long flags;
 768         int i;
 769
 770         hid_dbg(hdev, " hardware removed\n");
 771         hid_hw_close(hdev);
 772         hid_hw_stop(hdev);
 773         spin_lock_irqsave(&data->lock, flags);
 774         for (i = 0; i < data->hid_sensor_client_cnt; ++i) {
 775                 struct hid_sensor_hub_device *hsdev =
 776                         data->hid_sensor_hub_client_devs[i].platform_data;
 777                 if (hsdev->pending.status)
 778                         complete(&hsdev->pending.ready);
 779         }
 780         spin_unlock_irqrestore(&data->lock, flags);
 781         mfd_remove_devices(&hdev->dev);
 782         hid_set_drvdata(hdev, NULL);
 783         mutex_destroy(&data->mutex);
 784 }
 785
 786 static const struct hid_device_id sensor_hub_devices[] = {
 787         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
 788                         USB_DEVICE_ID_INTEL_HID_SENSOR_0),
 789                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 790         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
 791                         USB_DEVICE_ID_INTEL_HID_SENSOR_0),
 792                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 793         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_1,
 794                         USB_DEVICE_ID_INTEL_HID_SENSOR_1),
 795                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 796         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
 797                         USB_DEVICE_ID_MS_SURFACE_PRO_2),
 798                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 799         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
 800                         USB_DEVICE_ID_MS_TOUCH_COVER_2),
 801                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 802         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
 803                         USB_DEVICE_ID_MS_TYPE_COVER_2),
 804                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 805         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROSOFT,
 806                         0x07bd), /* Microsoft Surface 3 */
 807                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 808         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_MICROCHIP,
 809                         0x0f01), /* MM7150 */
 810                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 811         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
 812                         USB_DEVICE_ID_STM_HID_SENSOR),
 813                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 814         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_STM_0,
 815                         USB_DEVICE_ID_STM_HID_SENSOR_1),
 816                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 817         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_TEXAS_INSTRUMENTS,
 818                         USB_DEVICE_ID_TEXAS_INSTRUMENTS_LENOVO_YOGA),
 819                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 820         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
 821                         USB_DEVICE_ID_ITE_LENOVO_YOGA),
 822                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 823         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
 824                         USB_DEVICE_ID_ITE_LENOVO_YOGA2),
 825                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 826         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_ITE,
 827                         USB_DEVICE_ID_ITE_LENOVO_YOGA900),
 828                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 829         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, USB_VENDOR_ID_INTEL_0,
 830                         0x22D8),
 831                         .driver_data = HID_SENSOR_HUB_ENUM_QUIRK},
 832         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_SENSOR_HUB, HID_ANY_ID,
 833                      HID_ANY_ID) },
 834         { }
 835 };
 836 MODULE_DEVICE_TABLE(hid, sensor_hub_devices);
 837
 838 static struct hid_driver sensor_hub_driver = {
 839         .name = "hid-sensor-hub",
 840         .id_table = sensor_hub_devices,
 841         .probe = sensor_hub_probe,
 842         .remove = sensor_hub_remove,
 843         .raw_event = sensor_hub_raw_event,
 844         .report_fixup = sensor_hub_report_fixup,
 845 #ifdef CONFIG_PM
 846         .suspend = sensor_hub_suspend,
 847         .resume = sensor_hub_resume,
 848         .reset_resume = sensor_hub_reset_resume,
 849 #endif
 850 };
 851 module_hid_driver(sensor_hub_driver);
 852
 853 MODULE_DESCRIPTION("HID Sensor Hub driver");
 854 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
 855 MODULE_LICENSE("GPL");