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