HID: intel-ish-hid: using list_head for ipc write queue
[muen/linux.git] / drivers / hid / i2c-hid / i2c-hid.c
1 /*
2  * HID over I2C protocol implementation
3  *
4  * Copyright (c) 2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
5  * Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France
6  * Copyright (c) 2012 Red Hat, Inc
7  *
8  * This code is partly based on "USB HID support for Linux":
9  *
10  *  Copyright (c) 1999 Andreas Gal
11  *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
12  *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
13  *  Copyright (c) 2007-2008 Oliver Neukum
14  *  Copyright (c) 2006-2010 Jiri Kosina
15  *
16  * This file is subject to the terms and conditions of the GNU General Public
17  * License.  See the file COPYING in the main directory of this archive for
18  * more details.
19  */
20
21 #include <linux/module.h>
22 #include <linux/i2c.h>
23 #include <linux/interrupt.h>
24 #include <linux/input.h>
25 #include <linux/irq.h>
26 #include <linux/delay.h>
27 #include <linux/slab.h>
28 #include <linux/pm.h>
29 #include <linux/pm_runtime.h>
30 #include <linux/device.h>
31 #include <linux/wait.h>
32 #include <linux/err.h>
33 #include <linux/string.h>
34 #include <linux/list.h>
35 #include <linux/jiffies.h>
36 #include <linux/kernel.h>
37 #include <linux/hid.h>
38 #include <linux/mutex.h>
39 #include <linux/acpi.h>
40 #include <linux/of.h>
41 #include <linux/regulator/consumer.h>
42
43 #include <linux/platform_data/i2c-hid.h>
44
45 #include "../hid-ids.h"
46
47 /* quirks to control the device */
48 #define I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV        BIT(0)
49 #define I2C_HID_QUIRK_NO_IRQ_AFTER_RESET        BIT(1)
50 #define I2C_HID_QUIRK_RESEND_REPORT_DESCR       BIT(2)
51
52 /* flags */
53 #define I2C_HID_STARTED         0
54 #define I2C_HID_RESET_PENDING   1
55 #define I2C_HID_READ_PENDING    2
56
57 #define I2C_HID_PWR_ON          0x00
58 #define I2C_HID_PWR_SLEEP       0x01
59
60 /* debug option */
61 static bool debug;
62 module_param(debug, bool, 0444);
63 MODULE_PARM_DESC(debug, "print a lot of debug information");
64
65 #define i2c_hid_dbg(ihid, fmt, arg...)                                    \
66 do {                                                                      \
67         if (debug)                                                        \
68                 dev_printk(KERN_DEBUG, &(ihid)->client->dev, fmt, ##arg); \
69 } while (0)
70
71 struct i2c_hid_desc {
72         __le16 wHIDDescLength;
73         __le16 bcdVersion;
74         __le16 wReportDescLength;
75         __le16 wReportDescRegister;
76         __le16 wInputRegister;
77         __le16 wMaxInputLength;
78         __le16 wOutputRegister;
79         __le16 wMaxOutputLength;
80         __le16 wCommandRegister;
81         __le16 wDataRegister;
82         __le16 wVendorID;
83         __le16 wProductID;
84         __le16 wVersionID;
85         __le32 reserved;
86 } __packed;
87
88 struct i2c_hid_cmd {
89         unsigned int registerIndex;
90         __u8 opcode;
91         unsigned int length;
92         bool wait;
93 };
94
95 union command {
96         u8 data[0];
97         struct cmd {
98                 __le16 reg;
99                 __u8 reportTypeID;
100                 __u8 opcode;
101         } __packed c;
102 };
103
104 #define I2C_HID_CMD(opcode_) \
105         .opcode = opcode_, .length = 4, \
106         .registerIndex = offsetof(struct i2c_hid_desc, wCommandRegister)
107
108 /* fetch HID descriptor */
109 static const struct i2c_hid_cmd hid_descr_cmd = { .length = 2 };
110 /* fetch report descriptors */
111 static const struct i2c_hid_cmd hid_report_descr_cmd = {
112                 .registerIndex = offsetof(struct i2c_hid_desc,
113                         wReportDescRegister),
114                 .opcode = 0x00,
115                 .length = 2 };
116 /* commands */
117 static const struct i2c_hid_cmd hid_reset_cmd =         { I2C_HID_CMD(0x01),
118                                                           .wait = true };
119 static const struct i2c_hid_cmd hid_get_report_cmd =    { I2C_HID_CMD(0x02) };
120 static const struct i2c_hid_cmd hid_set_report_cmd =    { I2C_HID_CMD(0x03) };
121 static const struct i2c_hid_cmd hid_set_power_cmd =     { I2C_HID_CMD(0x08) };
122 static const struct i2c_hid_cmd hid_no_cmd =            { .length = 0 };
123
124 /*
125  * These definitions are not used here, but are defined by the spec.
126  * Keeping them here for documentation purposes.
127  *
128  * static const struct i2c_hid_cmd hid_get_idle_cmd = { I2C_HID_CMD(0x04) };
129  * static const struct i2c_hid_cmd hid_set_idle_cmd = { I2C_HID_CMD(0x05) };
130  * static const struct i2c_hid_cmd hid_get_protocol_cmd = { I2C_HID_CMD(0x06) };
131  * static const struct i2c_hid_cmd hid_set_protocol_cmd = { I2C_HID_CMD(0x07) };
132  */
133
134 /* The main device structure */
135 struct i2c_hid {
136         struct i2c_client       *client;        /* i2c client */
137         struct hid_device       *hid;   /* pointer to corresponding HID dev */
138         union {
139                 __u8 hdesc_buffer[sizeof(struct i2c_hid_desc)];
140                 struct i2c_hid_desc hdesc;      /* the HID Descriptor */
141         };
142         __le16                  wHIDDescRegister; /* location of the i2c
143                                                    * register of the HID
144                                                    * descriptor. */
145         unsigned int            bufsize;        /* i2c buffer size */
146         u8                      *inbuf;         /* Input buffer */
147         u8                      *rawbuf;        /* Raw Input buffer */
148         u8                      *cmdbuf;        /* Command buffer */
149         u8                      *argsbuf;       /* Command arguments buffer */
150
151         unsigned long           flags;          /* device flags */
152         unsigned long           quirks;         /* Various quirks */
153
154         wait_queue_head_t       wait;           /* For waiting the interrupt */
155
156         struct i2c_hid_platform_data pdata;
157
158         bool                    irq_wake_enabled;
159         struct mutex            reset_lock;
160 };
161
162 static const struct i2c_hid_quirks {
163         __u16 idVendor;
164         __u16 idProduct;
165         __u32 quirks;
166 } i2c_hid_quirks[] = {
167         { USB_VENDOR_ID_WEIDA, USB_DEVICE_ID_WEIDA_8752,
168                 I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV },
169         { USB_VENDOR_ID_WEIDA, USB_DEVICE_ID_WEIDA_8755,
170                 I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV },
171         { I2C_VENDOR_ID_HANTICK, I2C_PRODUCT_ID_HANTICK_5288,
172                 I2C_HID_QUIRK_NO_IRQ_AFTER_RESET },
173         { USB_VENDOR_ID_SIS_TOUCH, USB_DEVICE_ID_SIS10FB_TOUCH,
174                 I2C_HID_QUIRK_RESEND_REPORT_DESCR },
175         { 0, 0 }
176 };
177
178 /*
179  * i2c_hid_lookup_quirk: return any quirks associated with a I2C HID device
180  * @idVendor: the 16-bit vendor ID
181  * @idProduct: the 16-bit product ID
182  *
183  * Returns: a u32 quirks value.
184  */
185 static u32 i2c_hid_lookup_quirk(const u16 idVendor, const u16 idProduct)
186 {
187         u32 quirks = 0;
188         int n;
189
190         for (n = 0; i2c_hid_quirks[n].idVendor; n++)
191                 if (i2c_hid_quirks[n].idVendor == idVendor &&
192                     (i2c_hid_quirks[n].idProduct == (__u16)HID_ANY_ID ||
193                      i2c_hid_quirks[n].idProduct == idProduct))
194                         quirks = i2c_hid_quirks[n].quirks;
195
196         return quirks;
197 }
198
199 static int __i2c_hid_command(struct i2c_client *client,
200                 const struct i2c_hid_cmd *command, u8 reportID,
201                 u8 reportType, u8 *args, int args_len,
202                 unsigned char *buf_recv, int data_len)
203 {
204         struct i2c_hid *ihid = i2c_get_clientdata(client);
205         union command *cmd = (union command *)ihid->cmdbuf;
206         int ret;
207         struct i2c_msg msg[2];
208         int msg_num = 1;
209
210         int length = command->length;
211         bool wait = command->wait;
212         unsigned int registerIndex = command->registerIndex;
213
214         /* special case for hid_descr_cmd */
215         if (command == &hid_descr_cmd) {
216                 cmd->c.reg = ihid->wHIDDescRegister;
217         } else {
218                 cmd->data[0] = ihid->hdesc_buffer[registerIndex];
219                 cmd->data[1] = ihid->hdesc_buffer[registerIndex + 1];
220         }
221
222         if (length > 2) {
223                 cmd->c.opcode = command->opcode;
224                 cmd->c.reportTypeID = reportID | reportType << 4;
225         }
226
227         memcpy(cmd->data + length, args, args_len);
228         length += args_len;
229
230         i2c_hid_dbg(ihid, "%s: cmd=%*ph\n", __func__, length, cmd->data);
231
232         msg[0].addr = client->addr;
233         msg[0].flags = client->flags & I2C_M_TEN;
234         msg[0].len = length;
235         msg[0].buf = cmd->data;
236         if (data_len > 0) {
237                 msg[1].addr = client->addr;
238                 msg[1].flags = client->flags & I2C_M_TEN;
239                 msg[1].flags |= I2C_M_RD;
240                 msg[1].len = data_len;
241                 msg[1].buf = buf_recv;
242                 msg_num = 2;
243                 set_bit(I2C_HID_READ_PENDING, &ihid->flags);
244         }
245
246         if (wait)
247                 set_bit(I2C_HID_RESET_PENDING, &ihid->flags);
248
249         ret = i2c_transfer(client->adapter, msg, msg_num);
250
251         if (data_len > 0)
252                 clear_bit(I2C_HID_READ_PENDING, &ihid->flags);
253
254         if (ret != msg_num)
255                 return ret < 0 ? ret : -EIO;
256
257         ret = 0;
258
259         if (wait && (ihid->quirks & I2C_HID_QUIRK_NO_IRQ_AFTER_RESET)) {
260                 msleep(100);
261         } else if (wait) {
262                 i2c_hid_dbg(ihid, "%s: waiting...\n", __func__);
263                 if (!wait_event_timeout(ihid->wait,
264                                 !test_bit(I2C_HID_RESET_PENDING, &ihid->flags),
265                                 msecs_to_jiffies(5000)))
266                         ret = -ENODATA;
267                 i2c_hid_dbg(ihid, "%s: finished.\n", __func__);
268         }
269
270         return ret;
271 }
272
273 static int i2c_hid_command(struct i2c_client *client,
274                 const struct i2c_hid_cmd *command,
275                 unsigned char *buf_recv, int data_len)
276 {
277         return __i2c_hid_command(client, command, 0, 0, NULL, 0,
278                                 buf_recv, data_len);
279 }
280
281 static int i2c_hid_get_report(struct i2c_client *client, u8 reportType,
282                 u8 reportID, unsigned char *buf_recv, int data_len)
283 {
284         struct i2c_hid *ihid = i2c_get_clientdata(client);
285         u8 args[3];
286         int ret;
287         int args_len = 0;
288         u16 readRegister = le16_to_cpu(ihid->hdesc.wDataRegister);
289
290         i2c_hid_dbg(ihid, "%s\n", __func__);
291
292         if (reportID >= 0x0F) {
293                 args[args_len++] = reportID;
294                 reportID = 0x0F;
295         }
296
297         args[args_len++] = readRegister & 0xFF;
298         args[args_len++] = readRegister >> 8;
299
300         ret = __i2c_hid_command(client, &hid_get_report_cmd, reportID,
301                 reportType, args, args_len, buf_recv, data_len);
302         if (ret) {
303                 dev_err(&client->dev,
304                         "failed to retrieve report from device.\n");
305                 return ret;
306         }
307
308         return 0;
309 }
310
311 /**
312  * i2c_hid_set_or_send_report: forward an incoming report to the device
313  * @client: the i2c_client of the device
314  * @reportType: 0x03 for HID_FEATURE_REPORT ; 0x02 for HID_OUTPUT_REPORT
315  * @reportID: the report ID
316  * @buf: the actual data to transfer, without the report ID
317  * @len: size of buf
318  * @use_data: true: use SET_REPORT HID command, false: send plain OUTPUT report
319  */
320 static int i2c_hid_set_or_send_report(struct i2c_client *client, u8 reportType,
321                 u8 reportID, unsigned char *buf, size_t data_len, bool use_data)
322 {
323         struct i2c_hid *ihid = i2c_get_clientdata(client);
324         u8 *args = ihid->argsbuf;
325         const struct i2c_hid_cmd *hidcmd;
326         int ret;
327         u16 dataRegister = le16_to_cpu(ihid->hdesc.wDataRegister);
328         u16 outputRegister = le16_to_cpu(ihid->hdesc.wOutputRegister);
329         u16 maxOutputLength = le16_to_cpu(ihid->hdesc.wMaxOutputLength);
330         u16 size;
331         int args_len;
332         int index = 0;
333
334         i2c_hid_dbg(ihid, "%s\n", __func__);
335
336         if (data_len > ihid->bufsize)
337                 return -EINVAL;
338
339         size =          2                       /* size */ +
340                         (reportID ? 1 : 0)      /* reportID */ +
341                         data_len                /* buf */;
342         args_len =      (reportID >= 0x0F ? 1 : 0) /* optional third byte */ +
343                         2                       /* dataRegister */ +
344                         size                    /* args */;
345
346         if (!use_data && maxOutputLength == 0)
347                 return -ENOSYS;
348
349         if (reportID >= 0x0F) {
350                 args[index++] = reportID;
351                 reportID = 0x0F;
352         }
353
354         /*
355          * use the data register for feature reports or if the device does not
356          * support the output register
357          */
358         if (use_data) {
359                 args[index++] = dataRegister & 0xFF;
360                 args[index++] = dataRegister >> 8;
361                 hidcmd = &hid_set_report_cmd;
362         } else {
363                 args[index++] = outputRegister & 0xFF;
364                 args[index++] = outputRegister >> 8;
365                 hidcmd = &hid_no_cmd;
366         }
367
368         args[index++] = size & 0xFF;
369         args[index++] = size >> 8;
370
371         if (reportID)
372                 args[index++] = reportID;
373
374         memcpy(&args[index], buf, data_len);
375
376         ret = __i2c_hid_command(client, hidcmd, reportID,
377                 reportType, args, args_len, NULL, 0);
378         if (ret) {
379                 dev_err(&client->dev, "failed to set a report to device.\n");
380                 return ret;
381         }
382
383         return data_len;
384 }
385
386 static int i2c_hid_set_power(struct i2c_client *client, int power_state)
387 {
388         struct i2c_hid *ihid = i2c_get_clientdata(client);
389         int ret;
390
391         i2c_hid_dbg(ihid, "%s\n", __func__);
392
393         /*
394          * Some devices require to send a command to wakeup before power on.
395          * The call will get a return value (EREMOTEIO) but device will be
396          * triggered and activated. After that, it goes like a normal device.
397          */
398         if (power_state == I2C_HID_PWR_ON &&
399             ihid->quirks & I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV) {
400                 ret = i2c_hid_command(client, &hid_set_power_cmd, NULL, 0);
401
402                 /* Device was already activated */
403                 if (!ret)
404                         goto set_pwr_exit;
405         }
406
407         ret = __i2c_hid_command(client, &hid_set_power_cmd, power_state,
408                 0, NULL, 0, NULL, 0);
409
410         if (ret)
411                 dev_err(&client->dev, "failed to change power setting.\n");
412
413 set_pwr_exit:
414         return ret;
415 }
416
417 static int i2c_hid_hwreset(struct i2c_client *client)
418 {
419         struct i2c_hid *ihid = i2c_get_clientdata(client);
420         int ret;
421
422         i2c_hid_dbg(ihid, "%s\n", __func__);
423
424         /*
425          * This prevents sending feature reports while the device is
426          * being reset. Otherwise we may lose the reset complete
427          * interrupt.
428          */
429         mutex_lock(&ihid->reset_lock);
430
431         ret = i2c_hid_set_power(client, I2C_HID_PWR_ON);
432         if (ret)
433                 goto out_unlock;
434
435         /*
436          * The HID over I2C specification states that if a DEVICE needs time
437          * after the PWR_ON request, it should utilise CLOCK stretching.
438          * However, it has been observered that the Windows driver provides a
439          * 1ms sleep between the PWR_ON and RESET requests and that some devices
440          * rely on this.
441          */
442         usleep_range(1000, 5000);
443
444         i2c_hid_dbg(ihid, "resetting...\n");
445
446         ret = i2c_hid_command(client, &hid_reset_cmd, NULL, 0);
447         if (ret) {
448                 dev_err(&client->dev, "failed to reset device.\n");
449                 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
450         }
451
452 out_unlock:
453         mutex_unlock(&ihid->reset_lock);
454         return ret;
455 }
456
457 static void i2c_hid_get_input(struct i2c_hid *ihid)
458 {
459         int ret;
460         u32 ret_size;
461         int size = le16_to_cpu(ihid->hdesc.wMaxInputLength);
462
463         if (size > ihid->bufsize)
464                 size = ihid->bufsize;
465
466         ret = i2c_master_recv(ihid->client, ihid->inbuf, size);
467         if (ret != size) {
468                 if (ret < 0)
469                         return;
470
471                 dev_err(&ihid->client->dev, "%s: got %d data instead of %d\n",
472                         __func__, ret, size);
473                 return;
474         }
475
476         ret_size = ihid->inbuf[0] | ihid->inbuf[1] << 8;
477
478         if (!ret_size) {
479                 /* host or device initiated RESET completed */
480                 if (test_and_clear_bit(I2C_HID_RESET_PENDING, &ihid->flags))
481                         wake_up(&ihid->wait);
482                 return;
483         }
484
485         if ((ret_size > size) || (ret_size < 2)) {
486                 dev_err(&ihid->client->dev, "%s: incomplete report (%d/%d)\n",
487                         __func__, size, ret_size);
488                 return;
489         }
490
491         i2c_hid_dbg(ihid, "input: %*ph\n", ret_size, ihid->inbuf);
492
493         if (test_bit(I2C_HID_STARTED, &ihid->flags))
494                 hid_input_report(ihid->hid, HID_INPUT_REPORT, ihid->inbuf + 2,
495                                 ret_size - 2, 1);
496
497         return;
498 }
499
500 static irqreturn_t i2c_hid_irq(int irq, void *dev_id)
501 {
502         struct i2c_hid *ihid = dev_id;
503
504         if (test_bit(I2C_HID_READ_PENDING, &ihid->flags))
505                 return IRQ_HANDLED;
506
507         i2c_hid_get_input(ihid);
508
509         return IRQ_HANDLED;
510 }
511
512 static int i2c_hid_get_report_length(struct hid_report *report)
513 {
514         return ((report->size - 1) >> 3) + 1 +
515                 report->device->report_enum[report->type].numbered + 2;
516 }
517
518 /*
519  * Traverse the supplied list of reports and find the longest
520  */
521 static void i2c_hid_find_max_report(struct hid_device *hid, unsigned int type,
522                 unsigned int *max)
523 {
524         struct hid_report *report;
525         unsigned int size;
526
527         /* We should not rely on wMaxInputLength, as some devices may set it to
528          * a wrong length. */
529         list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
530                 size = i2c_hid_get_report_length(report);
531                 if (*max < size)
532                         *max = size;
533         }
534 }
535
536 static void i2c_hid_free_buffers(struct i2c_hid *ihid)
537 {
538         kfree(ihid->inbuf);
539         kfree(ihid->rawbuf);
540         kfree(ihid->argsbuf);
541         kfree(ihid->cmdbuf);
542         ihid->inbuf = NULL;
543         ihid->rawbuf = NULL;
544         ihid->cmdbuf = NULL;
545         ihid->argsbuf = NULL;
546         ihid->bufsize = 0;
547 }
548
549 static int i2c_hid_alloc_buffers(struct i2c_hid *ihid, size_t report_size)
550 {
551         /* the worst case is computed from the set_report command with a
552          * reportID > 15 and the maximum report length */
553         int args_len = sizeof(__u8) + /* ReportID */
554                        sizeof(__u8) + /* optional ReportID byte */
555                        sizeof(__u16) + /* data register */
556                        sizeof(__u16) + /* size of the report */
557                        report_size; /* report */
558
559         ihid->inbuf = kzalloc(report_size, GFP_KERNEL);
560         ihid->rawbuf = kzalloc(report_size, GFP_KERNEL);
561         ihid->argsbuf = kzalloc(args_len, GFP_KERNEL);
562         ihid->cmdbuf = kzalloc(sizeof(union command) + args_len, GFP_KERNEL);
563
564         if (!ihid->inbuf || !ihid->rawbuf || !ihid->argsbuf || !ihid->cmdbuf) {
565                 i2c_hid_free_buffers(ihid);
566                 return -ENOMEM;
567         }
568
569         ihid->bufsize = report_size;
570
571         return 0;
572 }
573
574 static int i2c_hid_get_raw_report(struct hid_device *hid,
575                 unsigned char report_number, __u8 *buf, size_t count,
576                 unsigned char report_type)
577 {
578         struct i2c_client *client = hid->driver_data;
579         struct i2c_hid *ihid = i2c_get_clientdata(client);
580         size_t ret_count, ask_count;
581         int ret;
582
583         if (report_type == HID_OUTPUT_REPORT)
584                 return -EINVAL;
585
586         /* +2 bytes to include the size of the reply in the query buffer */
587         ask_count = min(count + 2, (size_t)ihid->bufsize);
588
589         ret = i2c_hid_get_report(client,
590                         report_type == HID_FEATURE_REPORT ? 0x03 : 0x01,
591                         report_number, ihid->rawbuf, ask_count);
592
593         if (ret < 0)
594                 return ret;
595
596         ret_count = ihid->rawbuf[0] | (ihid->rawbuf[1] << 8);
597
598         if (ret_count <= 2)
599                 return 0;
600
601         ret_count = min(ret_count, ask_count);
602
603         /* The query buffer contains the size, dropping it in the reply */
604         count = min(count, ret_count - 2);
605         memcpy(buf, ihid->rawbuf + 2, count);
606
607         return count;
608 }
609
610 static int i2c_hid_output_raw_report(struct hid_device *hid, __u8 *buf,
611                 size_t count, unsigned char report_type, bool use_data)
612 {
613         struct i2c_client *client = hid->driver_data;
614         struct i2c_hid *ihid = i2c_get_clientdata(client);
615         int report_id = buf[0];
616         int ret;
617
618         if (report_type == HID_INPUT_REPORT)
619                 return -EINVAL;
620
621         mutex_lock(&ihid->reset_lock);
622
623         if (report_id) {
624                 buf++;
625                 count--;
626         }
627
628         ret = i2c_hid_set_or_send_report(client,
629                                 report_type == HID_FEATURE_REPORT ? 0x03 : 0x02,
630                                 report_id, buf, count, use_data);
631
632         if (report_id && ret >= 0)
633                 ret++; /* add report_id to the number of transfered bytes */
634
635         mutex_unlock(&ihid->reset_lock);
636
637         return ret;
638 }
639
640 static int i2c_hid_output_report(struct hid_device *hid, __u8 *buf,
641                 size_t count)
642 {
643         return i2c_hid_output_raw_report(hid, buf, count, HID_OUTPUT_REPORT,
644                         false);
645 }
646
647 static int i2c_hid_raw_request(struct hid_device *hid, unsigned char reportnum,
648                                __u8 *buf, size_t len, unsigned char rtype,
649                                int reqtype)
650 {
651         switch (reqtype) {
652         case HID_REQ_GET_REPORT:
653                 return i2c_hid_get_raw_report(hid, reportnum, buf, len, rtype);
654         case HID_REQ_SET_REPORT:
655                 if (buf[0] != reportnum)
656                         return -EINVAL;
657                 return i2c_hid_output_raw_report(hid, buf, len, rtype, true);
658         default:
659                 return -EIO;
660         }
661 }
662
663 static int i2c_hid_parse(struct hid_device *hid)
664 {
665         struct i2c_client *client = hid->driver_data;
666         struct i2c_hid *ihid = i2c_get_clientdata(client);
667         struct i2c_hid_desc *hdesc = &ihid->hdesc;
668         unsigned int rsize;
669         char *rdesc;
670         int ret;
671         int tries = 3;
672
673         i2c_hid_dbg(ihid, "entering %s\n", __func__);
674
675         rsize = le16_to_cpu(hdesc->wReportDescLength);
676         if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
677                 dbg_hid("weird size of report descriptor (%u)\n", rsize);
678                 return -EINVAL;
679         }
680
681         do {
682                 ret = i2c_hid_hwreset(client);
683                 if (ret)
684                         msleep(1000);
685         } while (tries-- > 0 && ret);
686
687         if (ret)
688                 return ret;
689
690         rdesc = kzalloc(rsize, GFP_KERNEL);
691
692         if (!rdesc) {
693                 dbg_hid("couldn't allocate rdesc memory\n");
694                 return -ENOMEM;
695         }
696
697         i2c_hid_dbg(ihid, "asking HID report descriptor\n");
698
699         ret = i2c_hid_command(client, &hid_report_descr_cmd, rdesc, rsize);
700         if (ret) {
701                 hid_err(hid, "reading report descriptor failed\n");
702                 kfree(rdesc);
703                 return -EIO;
704         }
705
706         i2c_hid_dbg(ihid, "Report Descriptor: %*ph\n", rsize, rdesc);
707
708         ret = hid_parse_report(hid, rdesc, rsize);
709         kfree(rdesc);
710         if (ret) {
711                 dbg_hid("parsing report descriptor failed\n");
712                 return ret;
713         }
714
715         return 0;
716 }
717
718 static int i2c_hid_start(struct hid_device *hid)
719 {
720         struct i2c_client *client = hid->driver_data;
721         struct i2c_hid *ihid = i2c_get_clientdata(client);
722         int ret;
723         unsigned int bufsize = HID_MIN_BUFFER_SIZE;
724
725         i2c_hid_find_max_report(hid, HID_INPUT_REPORT, &bufsize);
726         i2c_hid_find_max_report(hid, HID_OUTPUT_REPORT, &bufsize);
727         i2c_hid_find_max_report(hid, HID_FEATURE_REPORT, &bufsize);
728
729         if (bufsize > ihid->bufsize) {
730                 disable_irq(client->irq);
731                 i2c_hid_free_buffers(ihid);
732
733                 ret = i2c_hid_alloc_buffers(ihid, bufsize);
734                 enable_irq(client->irq);
735
736                 if (ret)
737                         return ret;
738         }
739
740         return 0;
741 }
742
743 static void i2c_hid_stop(struct hid_device *hid)
744 {
745         hid->claimed = 0;
746 }
747
748 static int i2c_hid_open(struct hid_device *hid)
749 {
750         struct i2c_client *client = hid->driver_data;
751         struct i2c_hid *ihid = i2c_get_clientdata(client);
752         int ret = 0;
753
754         ret = pm_runtime_get_sync(&client->dev);
755         if (ret < 0)
756                 return ret;
757
758         set_bit(I2C_HID_STARTED, &ihid->flags);
759         return 0;
760 }
761
762 static void i2c_hid_close(struct hid_device *hid)
763 {
764         struct i2c_client *client = hid->driver_data;
765         struct i2c_hid *ihid = i2c_get_clientdata(client);
766
767         clear_bit(I2C_HID_STARTED, &ihid->flags);
768
769         /* Save some power */
770         pm_runtime_put(&client->dev);
771 }
772
773 static int i2c_hid_power(struct hid_device *hid, int lvl)
774 {
775         struct i2c_client *client = hid->driver_data;
776         struct i2c_hid *ihid = i2c_get_clientdata(client);
777
778         i2c_hid_dbg(ihid, "%s lvl:%d\n", __func__, lvl);
779
780         switch (lvl) {
781         case PM_HINT_FULLON:
782                 pm_runtime_get_sync(&client->dev);
783                 break;
784         case PM_HINT_NORMAL:
785                 pm_runtime_put(&client->dev);
786                 break;
787         }
788         return 0;
789 }
790
791 struct hid_ll_driver i2c_hid_ll_driver = {
792         .parse = i2c_hid_parse,
793         .start = i2c_hid_start,
794         .stop = i2c_hid_stop,
795         .open = i2c_hid_open,
796         .close = i2c_hid_close,
797         .power = i2c_hid_power,
798         .output_report = i2c_hid_output_report,
799         .raw_request = i2c_hid_raw_request,
800 };
801 EXPORT_SYMBOL_GPL(i2c_hid_ll_driver);
802
803 static int i2c_hid_init_irq(struct i2c_client *client)
804 {
805         struct i2c_hid *ihid = i2c_get_clientdata(client);
806         unsigned long irqflags = 0;
807         int ret;
808
809         dev_dbg(&client->dev, "Requesting IRQ: %d\n", client->irq);
810
811         if (!irq_get_trigger_type(client->irq))
812                 irqflags = IRQF_TRIGGER_LOW;
813
814         ret = request_threaded_irq(client->irq, NULL, i2c_hid_irq,
815                                    irqflags | IRQF_ONESHOT, client->name, ihid);
816         if (ret < 0) {
817                 dev_warn(&client->dev,
818                         "Could not register for %s interrupt, irq = %d,"
819                         " ret = %d\n",
820                         client->name, client->irq, ret);
821
822                 return ret;
823         }
824
825         return 0;
826 }
827
828 static int i2c_hid_fetch_hid_descriptor(struct i2c_hid *ihid)
829 {
830         struct i2c_client *client = ihid->client;
831         struct i2c_hid_desc *hdesc = &ihid->hdesc;
832         unsigned int dsize;
833         int ret;
834
835         /* i2c hid fetch using a fixed descriptor size (30 bytes) */
836         i2c_hid_dbg(ihid, "Fetching the HID descriptor\n");
837         ret = i2c_hid_command(client, &hid_descr_cmd, ihid->hdesc_buffer,
838                                 sizeof(struct i2c_hid_desc));
839         if (ret) {
840                 dev_err(&client->dev, "hid_descr_cmd failed\n");
841                 return -ENODEV;
842         }
843
844         /* Validate the length of HID descriptor, the 4 first bytes:
845          * bytes 0-1 -> length
846          * bytes 2-3 -> bcdVersion (has to be 1.00) */
847         /* check bcdVersion == 1.0 */
848         if (le16_to_cpu(hdesc->bcdVersion) != 0x0100) {
849                 dev_err(&client->dev,
850                         "unexpected HID descriptor bcdVersion (0x%04hx)\n",
851                         le16_to_cpu(hdesc->bcdVersion));
852                 return -ENODEV;
853         }
854
855         /* Descriptor length should be 30 bytes as per the specification */
856         dsize = le16_to_cpu(hdesc->wHIDDescLength);
857         if (dsize != sizeof(struct i2c_hid_desc)) {
858                 dev_err(&client->dev, "weird size of HID descriptor (%u)\n",
859                         dsize);
860                 return -ENODEV;
861         }
862         i2c_hid_dbg(ihid, "HID Descriptor: %*ph\n", dsize, ihid->hdesc_buffer);
863         return 0;
864 }
865
866 #ifdef CONFIG_ACPI
867 static const struct acpi_device_id i2c_hid_acpi_blacklist[] = {
868         /*
869          * The CHPN0001 ACPI device, which is used to describe the Chipone
870          * ICN8505 controller, has a _CID of PNP0C50 but is not HID compatible.
871          */
872         {"CHPN0001", 0 },
873         { },
874 };
875
876 static int i2c_hid_acpi_pdata(struct i2c_client *client,
877                 struct i2c_hid_platform_data *pdata)
878 {
879         static guid_t i2c_hid_guid =
880                 GUID_INIT(0x3CDFF6F7, 0x4267, 0x4555,
881                           0xAD, 0x05, 0xB3, 0x0A, 0x3D, 0x89, 0x38, 0xDE);
882         union acpi_object *obj;
883         struct acpi_device *adev;
884         acpi_handle handle;
885
886         handle = ACPI_HANDLE(&client->dev);
887         if (!handle || acpi_bus_get_device(handle, &adev)) {
888                 dev_err(&client->dev, "Error could not get ACPI device\n");
889                 return -ENODEV;
890         }
891
892         if (acpi_match_device_ids(adev, i2c_hid_acpi_blacklist) == 0)
893                 return -ENODEV;
894
895         obj = acpi_evaluate_dsm_typed(handle, &i2c_hid_guid, 1, 1, NULL,
896                                       ACPI_TYPE_INTEGER);
897         if (!obj) {
898                 dev_err(&client->dev, "Error _DSM call to get HID descriptor address failed\n");
899                 return -ENODEV;
900         }
901
902         pdata->hid_descriptor_address = obj->integer.value;
903         ACPI_FREE(obj);
904
905         return 0;
906 }
907
908 static void i2c_hid_acpi_fix_up_power(struct device *dev)
909 {
910         struct acpi_device *adev;
911
912         adev = ACPI_COMPANION(dev);
913         if (adev)
914                 acpi_device_fix_up_power(adev);
915 }
916
917 static const struct acpi_device_id i2c_hid_acpi_match[] = {
918         {"ACPI0C50", 0 },
919         {"PNP0C50", 0 },
920         { },
921 };
922 MODULE_DEVICE_TABLE(acpi, i2c_hid_acpi_match);
923 #else
924 static inline int i2c_hid_acpi_pdata(struct i2c_client *client,
925                 struct i2c_hid_platform_data *pdata)
926 {
927         return -ENODEV;
928 }
929
930 static inline void i2c_hid_acpi_fix_up_power(struct device *dev) {}
931 #endif
932
933 #ifdef CONFIG_OF
934 static int i2c_hid_of_probe(struct i2c_client *client,
935                 struct i2c_hid_platform_data *pdata)
936 {
937         struct device *dev = &client->dev;
938         u32 val;
939         int ret;
940
941         ret = of_property_read_u32(dev->of_node, "hid-descr-addr", &val);
942         if (ret) {
943                 dev_err(&client->dev, "HID register address not provided\n");
944                 return -ENODEV;
945         }
946         if (val >> 16) {
947                 dev_err(&client->dev, "Bad HID register address: 0x%08x\n",
948                         val);
949                 return -EINVAL;
950         }
951         pdata->hid_descriptor_address = val;
952
953         return 0;
954 }
955
956 static const struct of_device_id i2c_hid_of_match[] = {
957         { .compatible = "hid-over-i2c" },
958         {},
959 };
960 MODULE_DEVICE_TABLE(of, i2c_hid_of_match);
961 #else
962 static inline int i2c_hid_of_probe(struct i2c_client *client,
963                 struct i2c_hid_platform_data *pdata)
964 {
965         return -ENODEV;
966 }
967 #endif
968
969 static void i2c_hid_fwnode_probe(struct i2c_client *client,
970                                  struct i2c_hid_platform_data *pdata)
971 {
972         u32 val;
973
974         if (!device_property_read_u32(&client->dev, "post-power-on-delay-ms",
975                                       &val))
976                 pdata->post_power_delay_ms = val;
977 }
978
979 static int i2c_hid_probe(struct i2c_client *client,
980                          const struct i2c_device_id *dev_id)
981 {
982         int ret;
983         struct i2c_hid *ihid;
984         struct hid_device *hid;
985         __u16 hidRegister;
986         struct i2c_hid_platform_data *platform_data = client->dev.platform_data;
987
988         dbg_hid("HID probe called for i2c 0x%02x\n", client->addr);
989
990         if (!client->irq) {
991                 dev_err(&client->dev,
992                         "HID over i2c has not been provided an Int IRQ\n");
993                 return -EINVAL;
994         }
995
996         if (client->irq < 0) {
997                 if (client->irq != -EPROBE_DEFER)
998                         dev_err(&client->dev,
999                                 "HID over i2c doesn't have a valid IRQ\n");
1000                 return client->irq;
1001         }
1002
1003         ihid = devm_kzalloc(&client->dev, sizeof(*ihid), GFP_KERNEL);
1004         if (!ihid)
1005                 return -ENOMEM;
1006
1007         if (client->dev.of_node) {
1008                 ret = i2c_hid_of_probe(client, &ihid->pdata);
1009                 if (ret)
1010                         return ret;
1011         } else if (!platform_data) {
1012                 ret = i2c_hid_acpi_pdata(client, &ihid->pdata);
1013                 if (ret)
1014                         return ret;
1015         } else {
1016                 ihid->pdata = *platform_data;
1017         }
1018
1019         /* Parse platform agnostic common properties from ACPI / device tree */
1020         i2c_hid_fwnode_probe(client, &ihid->pdata);
1021
1022         ihid->pdata.supplies[0].supply = "vdd";
1023         ihid->pdata.supplies[1].supply = "vddl";
1024
1025         ret = devm_regulator_bulk_get(&client->dev,
1026                                       ARRAY_SIZE(ihid->pdata.supplies),
1027                                       ihid->pdata.supplies);
1028         if (ret)
1029                 return ret;
1030
1031         ret = regulator_bulk_enable(ARRAY_SIZE(ihid->pdata.supplies),
1032                                     ihid->pdata.supplies);
1033         if (ret < 0)
1034                 return ret;
1035
1036         if (ihid->pdata.post_power_delay_ms)
1037                 msleep(ihid->pdata.post_power_delay_ms);
1038
1039         i2c_set_clientdata(client, ihid);
1040
1041         ihid->client = client;
1042
1043         hidRegister = ihid->pdata.hid_descriptor_address;
1044         ihid->wHIDDescRegister = cpu_to_le16(hidRegister);
1045
1046         init_waitqueue_head(&ihid->wait);
1047         mutex_init(&ihid->reset_lock);
1048
1049         /* we need to allocate the command buffer without knowing the maximum
1050          * size of the reports. Let's use HID_MIN_BUFFER_SIZE, then we do the
1051          * real computation later. */
1052         ret = i2c_hid_alloc_buffers(ihid, HID_MIN_BUFFER_SIZE);
1053         if (ret < 0)
1054                 goto err_regulator;
1055
1056         i2c_hid_acpi_fix_up_power(&client->dev);
1057
1058         pm_runtime_get_noresume(&client->dev);
1059         pm_runtime_set_active(&client->dev);
1060         pm_runtime_enable(&client->dev);
1061         device_enable_async_suspend(&client->dev);
1062
1063         /* Make sure there is something at this address */
1064         ret = i2c_smbus_read_byte(client);
1065         if (ret < 0) {
1066                 dev_dbg(&client->dev, "nothing at this address: %d\n", ret);
1067                 ret = -ENXIO;
1068                 goto err_pm;
1069         }
1070
1071         ret = i2c_hid_fetch_hid_descriptor(ihid);
1072         if (ret < 0)
1073                 goto err_pm;
1074
1075         ret = i2c_hid_init_irq(client);
1076         if (ret < 0)
1077                 goto err_pm;
1078
1079         hid = hid_allocate_device();
1080         if (IS_ERR(hid)) {
1081                 ret = PTR_ERR(hid);
1082                 goto err_irq;
1083         }
1084
1085         ihid->hid = hid;
1086
1087         hid->driver_data = client;
1088         hid->ll_driver = &i2c_hid_ll_driver;
1089         hid->dev.parent = &client->dev;
1090         hid->bus = BUS_I2C;
1091         hid->version = le16_to_cpu(ihid->hdesc.bcdVersion);
1092         hid->vendor = le16_to_cpu(ihid->hdesc.wVendorID);
1093         hid->product = le16_to_cpu(ihid->hdesc.wProductID);
1094
1095         snprintf(hid->name, sizeof(hid->name), "%s %04hX:%04hX",
1096                  client->name, hid->vendor, hid->product);
1097         strlcpy(hid->phys, dev_name(&client->dev), sizeof(hid->phys));
1098
1099         ihid->quirks = i2c_hid_lookup_quirk(hid->vendor, hid->product);
1100
1101         ret = hid_add_device(hid);
1102         if (ret) {
1103                 if (ret != -ENODEV)
1104                         hid_err(client, "can't add hid device: %d\n", ret);
1105                 goto err_mem_free;
1106         }
1107
1108         pm_runtime_put(&client->dev);
1109         return 0;
1110
1111 err_mem_free:
1112         hid_destroy_device(hid);
1113
1114 err_irq:
1115         free_irq(client->irq, ihid);
1116
1117 err_pm:
1118         pm_runtime_put_noidle(&client->dev);
1119         pm_runtime_disable(&client->dev);
1120
1121 err_regulator:
1122         regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
1123                                ihid->pdata.supplies);
1124         i2c_hid_free_buffers(ihid);
1125         return ret;
1126 }
1127
1128 static int i2c_hid_remove(struct i2c_client *client)
1129 {
1130         struct i2c_hid *ihid = i2c_get_clientdata(client);
1131         struct hid_device *hid;
1132
1133         pm_runtime_get_sync(&client->dev);
1134         pm_runtime_disable(&client->dev);
1135         pm_runtime_set_suspended(&client->dev);
1136         pm_runtime_put_noidle(&client->dev);
1137
1138         hid = ihid->hid;
1139         hid_destroy_device(hid);
1140
1141         free_irq(client->irq, ihid);
1142
1143         if (ihid->bufsize)
1144                 i2c_hid_free_buffers(ihid);
1145
1146         regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
1147                                ihid->pdata.supplies);
1148
1149         return 0;
1150 }
1151
1152 static void i2c_hid_shutdown(struct i2c_client *client)
1153 {
1154         struct i2c_hid *ihid = i2c_get_clientdata(client);
1155
1156         i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1157         free_irq(client->irq, ihid);
1158 }
1159
1160 #ifdef CONFIG_PM_SLEEP
1161 static int i2c_hid_suspend(struct device *dev)
1162 {
1163         struct i2c_client *client = to_i2c_client(dev);
1164         struct i2c_hid *ihid = i2c_get_clientdata(client);
1165         struct hid_device *hid = ihid->hid;
1166         int ret;
1167         int wake_status;
1168
1169         if (hid->driver && hid->driver->suspend) {
1170                 /*
1171                  * Wake up the device so that IO issues in
1172                  * HID driver's suspend code can succeed.
1173                  */
1174                 ret = pm_runtime_resume(dev);
1175                 if (ret < 0)
1176                         return ret;
1177
1178                 ret = hid->driver->suspend(hid, PMSG_SUSPEND);
1179                 if (ret < 0)
1180                         return ret;
1181         }
1182
1183         if (!pm_runtime_suspended(dev)) {
1184                 /* Save some power */
1185                 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1186
1187                 disable_irq(client->irq);
1188         }
1189
1190         if (device_may_wakeup(&client->dev)) {
1191                 wake_status = enable_irq_wake(client->irq);
1192                 if (!wake_status)
1193                         ihid->irq_wake_enabled = true;
1194                 else
1195                         hid_warn(hid, "Failed to enable irq wake: %d\n",
1196                                 wake_status);
1197         } else {
1198                 regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
1199                                        ihid->pdata.supplies);
1200         }
1201
1202         return 0;
1203 }
1204
1205 static int i2c_hid_resume(struct device *dev)
1206 {
1207         int ret;
1208         struct i2c_client *client = to_i2c_client(dev);
1209         struct i2c_hid *ihid = i2c_get_clientdata(client);
1210         struct hid_device *hid = ihid->hid;
1211         int wake_status;
1212
1213         if (!device_may_wakeup(&client->dev)) {
1214                 ret = regulator_bulk_enable(ARRAY_SIZE(ihid->pdata.supplies),
1215                                             ihid->pdata.supplies);
1216                 if (ret)
1217                         hid_warn(hid, "Failed to enable supplies: %d\n", ret);
1218
1219                 if (ihid->pdata.post_power_delay_ms)
1220                         msleep(ihid->pdata.post_power_delay_ms);
1221         } else if (ihid->irq_wake_enabled) {
1222                 wake_status = disable_irq_wake(client->irq);
1223                 if (!wake_status)
1224                         ihid->irq_wake_enabled = false;
1225                 else
1226                         hid_warn(hid, "Failed to disable irq wake: %d\n",
1227                                 wake_status);
1228         }
1229
1230         /* We'll resume to full power */
1231         pm_runtime_disable(dev);
1232         pm_runtime_set_active(dev);
1233         pm_runtime_enable(dev);
1234
1235         enable_irq(client->irq);
1236
1237         /* Instead of resetting device, simply powers the device on. This
1238          * solves "incomplete reports" on Raydium devices 2386:3118 and
1239          * 2386:4B33
1240          */
1241         ret = i2c_hid_set_power(client, I2C_HID_PWR_ON);
1242         if (ret)
1243                 return ret;
1244
1245         /* Some devices need to re-send report descr cmd
1246          * after resume, after this it will be back normal.
1247          * otherwise it issues too many incomplete reports.
1248          */
1249         if (ihid->quirks & I2C_HID_QUIRK_RESEND_REPORT_DESCR) {
1250                 ret = i2c_hid_command(client, &hid_report_descr_cmd, NULL, 0);
1251                 if (ret)
1252                         return ret;
1253         }
1254
1255         if (hid->driver && hid->driver->reset_resume) {
1256                 ret = hid->driver->reset_resume(hid);
1257                 return ret;
1258         }
1259
1260         return 0;
1261 }
1262 #endif
1263
1264 #ifdef CONFIG_PM
1265 static int i2c_hid_runtime_suspend(struct device *dev)
1266 {
1267         struct i2c_client *client = to_i2c_client(dev);
1268
1269         i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1270         disable_irq(client->irq);
1271         return 0;
1272 }
1273
1274 static int i2c_hid_runtime_resume(struct device *dev)
1275 {
1276         struct i2c_client *client = to_i2c_client(dev);
1277
1278         enable_irq(client->irq);
1279         i2c_hid_set_power(client, I2C_HID_PWR_ON);
1280         return 0;
1281 }
1282 #endif
1283
1284 static const struct dev_pm_ops i2c_hid_pm = {
1285         SET_SYSTEM_SLEEP_PM_OPS(i2c_hid_suspend, i2c_hid_resume)
1286         SET_RUNTIME_PM_OPS(i2c_hid_runtime_suspend, i2c_hid_runtime_resume,
1287                            NULL)
1288 };
1289
1290 static const struct i2c_device_id i2c_hid_id_table[] = {
1291         { "hid", 0 },
1292         { "hid-over-i2c", 0 },
1293         { },
1294 };
1295 MODULE_DEVICE_TABLE(i2c, i2c_hid_id_table);
1296
1297
1298 static struct i2c_driver i2c_hid_driver = {
1299         .driver = {
1300                 .name   = "i2c_hid",
1301                 .pm     = &i2c_hid_pm,
1302                 .acpi_match_table = ACPI_PTR(i2c_hid_acpi_match),
1303                 .of_match_table = of_match_ptr(i2c_hid_of_match),
1304         },
1305
1306         .probe          = i2c_hid_probe,
1307         .remove         = i2c_hid_remove,
1308         .shutdown       = i2c_hid_shutdown,
1309         .id_table       = i2c_hid_id_table,
1310 };
1311
1312 module_i2c_driver(i2c_hid_driver);
1313
1314 MODULE_DESCRIPTION("HID over I2C core driver");
1315 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
1316 MODULE_LICENSE("GPL");