2 * HID over I2C protocol implementation
5 * Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France
6 * Copyright (c) 2012 Red Hat, Inc
8 * This code is partly based on "USB HID support for Linux":
10 * Copyright (c) 1999 Andreas Gal
13 * Copyright (c) 2007-2008 Oliver Neukum
14 * Copyright (c) 2006-2010 Jiri Kosina
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
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>
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>
41 #include <linux/regulator/consumer.h>
43 #include <linux/platform_data/i2c-hid.h>
45 #include "../hid-ids.h"
48 /* quirks to control the device */
49 #define I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV BIT(0)
50 #define I2C_HID_QUIRK_NO_IRQ_AFTER_RESET BIT(1)
51 #define I2C_HID_QUIRK_NO_RUNTIME_PM BIT(2)
52 #define I2C_HID_QUIRK_DELAY_AFTER_SLEEP BIT(3)
55 #define I2C_HID_STARTED 0
56 #define I2C_HID_RESET_PENDING 1
57 #define I2C_HID_READ_PENDING 2
59 #define I2C_HID_PWR_ON 0x00
60 #define I2C_HID_PWR_SLEEP 0x01
64 module_param(debug, bool, 0444);
65 MODULE_PARM_DESC(debug, "print a lot of debug information");
67 #define i2c_hid_dbg(ihid, fmt, arg...) \
70 dev_printk(KERN_DEBUG, &(ihid)->client->dev, fmt, ##arg); \
74 __le16 wHIDDescLength;
76 __le16 wReportDescLength;
77 __le16 wReportDescRegister;
78 __le16 wInputRegister;
79 __le16 wMaxInputLength;
80 __le16 wOutputRegister;
81 __le16 wMaxOutputLength;
82 __le16 wCommandRegister;
91 unsigned int registerIndex;
106 #define I2C_HID_CMD(opcode_) \
107 .opcode = opcode_, .length = 4, \
108 .registerIndex = offsetof(struct i2c_hid_desc, wCommandRegister)
110 /* fetch HID descriptor */
111 static const struct i2c_hid_cmd hid_descr_cmd = { .length = 2 };
112 /* fetch report descriptors */
113 static const struct i2c_hid_cmd hid_report_descr_cmd = {
114 .registerIndex = offsetof(struct i2c_hid_desc,
115 wReportDescRegister),
119 static const struct i2c_hid_cmd hid_reset_cmd = { I2C_HID_CMD(0x01),
121 static const struct i2c_hid_cmd hid_get_report_cmd = { I2C_HID_CMD(0x02) };
122 static const struct i2c_hid_cmd hid_set_report_cmd = { I2C_HID_CMD(0x03) };
123 static const struct i2c_hid_cmd hid_set_power_cmd = { I2C_HID_CMD(0x08) };
124 static const struct i2c_hid_cmd hid_no_cmd = { .length = 0 };
127 * These definitions are not used here, but are defined by the spec.
128 * Keeping them here for documentation purposes.
130 * static const struct i2c_hid_cmd hid_get_idle_cmd = { I2C_HID_CMD(0x04) };
131 * static const struct i2c_hid_cmd hid_set_idle_cmd = { I2C_HID_CMD(0x05) };
132 * static const struct i2c_hid_cmd hid_get_protocol_cmd = { I2C_HID_CMD(0x06) };
133 * static const struct i2c_hid_cmd hid_set_protocol_cmd = { I2C_HID_CMD(0x07) };
136 /* The main device structure */
138 struct i2c_client *client; /* i2c client */
139 struct hid_device *hid; /* pointer to corresponding HID dev */
141 __u8 hdesc_buffer[sizeof(struct i2c_hid_desc)];
142 struct i2c_hid_desc hdesc; /* the HID Descriptor */
144 __le16 wHIDDescRegister; /* location of the i2c
145 * register of the HID
147 unsigned int bufsize; /* i2c buffer size */
148 u8 *inbuf; /* Input buffer */
149 u8 *rawbuf; /* Raw Input buffer */
150 u8 *cmdbuf; /* Command buffer */
151 u8 *argsbuf; /* Command arguments buffer */
153 unsigned long flags; /* device flags */
154 unsigned long quirks; /* Various quirks */
156 wait_queue_head_t wait; /* For waiting the interrupt */
158 struct i2c_hid_platform_data pdata;
160 bool irq_wake_enabled;
161 struct mutex reset_lock;
163 unsigned long sleep_delay;
166 static const struct i2c_hid_quirks {
170 } i2c_hid_quirks[] = {
171 { USB_VENDOR_ID_WEIDA, USB_DEVICE_ID_WEIDA_8752,
172 I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV },
173 { USB_VENDOR_ID_WEIDA, USB_DEVICE_ID_WEIDA_8755,
174 I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV },
175 { I2C_VENDOR_ID_HANTICK, I2C_PRODUCT_ID_HANTICK_5288,
176 I2C_HID_QUIRK_NO_IRQ_AFTER_RESET |
177 I2C_HID_QUIRK_NO_RUNTIME_PM },
178 { I2C_VENDOR_ID_RAYDIUM, I2C_PRODUCT_ID_RAYDIUM_4B33,
179 I2C_HID_QUIRK_DELAY_AFTER_SLEEP },
180 { USB_VENDOR_ID_LG, I2C_DEVICE_ID_LG_8001,
181 I2C_HID_QUIRK_NO_RUNTIME_PM },
186 * i2c_hid_lookup_quirk: return any quirks associated with a I2C HID device
187 * @idVendor: the 16-bit vendor ID
188 * @idProduct: the 16-bit product ID
190 * Returns: a u32 quirks value.
192 static u32 i2c_hid_lookup_quirk(const u16 idVendor, const u16 idProduct)
197 for (n = 0; i2c_hid_quirks[n].idVendor; n++)
198 if (i2c_hid_quirks[n].idVendor == idVendor &&
199 (i2c_hid_quirks[n].idProduct == (__u16)HID_ANY_ID ||
200 i2c_hid_quirks[n].idProduct == idProduct))
201 quirks = i2c_hid_quirks[n].quirks;
206 static int __i2c_hid_command(struct i2c_client *client,
207 const struct i2c_hid_cmd *command, u8 reportID,
208 u8 reportType, u8 *args, int args_len,
209 unsigned char *buf_recv, int data_len)
211 struct i2c_hid *ihid = i2c_get_clientdata(client);
212 union command *cmd = (union command *)ihid->cmdbuf;
214 struct i2c_msg msg[2];
217 int length = command->length;
218 bool wait = command->wait;
219 unsigned int registerIndex = command->registerIndex;
221 /* special case for hid_descr_cmd */
222 if (command == &hid_descr_cmd) {
223 cmd->c.reg = ihid->wHIDDescRegister;
225 cmd->data[0] = ihid->hdesc_buffer[registerIndex];
226 cmd->data[1] = ihid->hdesc_buffer[registerIndex + 1];
230 cmd->c.opcode = command->opcode;
231 cmd->c.reportTypeID = reportID | reportType << 4;
234 memcpy(cmd->data + length, args, args_len);
237 i2c_hid_dbg(ihid, "%s: cmd=%*ph\n", __func__, length, cmd->data);
239 msg[0].addr = client->addr;
240 msg[0].flags = client->flags & I2C_M_TEN;
242 msg[0].buf = cmd->data;
244 msg[1].addr = client->addr;
245 msg[1].flags = client->flags & I2C_M_TEN;
246 msg[1].flags |= I2C_M_RD;
247 msg[1].len = data_len;
248 msg[1].buf = buf_recv;
250 set_bit(I2C_HID_READ_PENDING, &ihid->flags);
254 set_bit(I2C_HID_RESET_PENDING, &ihid->flags);
256 ret = i2c_transfer(client->adapter, msg, msg_num);
259 clear_bit(I2C_HID_READ_PENDING, &ihid->flags);
262 return ret < 0 ? ret : -EIO;
266 if (wait && (ihid->quirks & I2C_HID_QUIRK_NO_IRQ_AFTER_RESET)) {
269 i2c_hid_dbg(ihid, "%s: waiting...\n", __func__);
270 if (!wait_event_timeout(ihid->wait,
271 !test_bit(I2C_HID_RESET_PENDING, &ihid->flags),
272 msecs_to_jiffies(5000)))
274 i2c_hid_dbg(ihid, "%s: finished.\n", __func__);
280 static int i2c_hid_command(struct i2c_client *client,
281 const struct i2c_hid_cmd *command,
282 unsigned char *buf_recv, int data_len)
284 return __i2c_hid_command(client, command, 0, 0, NULL, 0,
288 static int i2c_hid_get_report(struct i2c_client *client, u8 reportType,
289 u8 reportID, unsigned char *buf_recv, int data_len)
291 struct i2c_hid *ihid = i2c_get_clientdata(client);
295 u16 readRegister = le16_to_cpu(ihid->hdesc.wDataRegister);
297 i2c_hid_dbg(ihid, "%s\n", __func__);
299 if (reportID >= 0x0F) {
300 args[args_len++] = reportID;
304 args[args_len++] = readRegister & 0xFF;
305 args[args_len++] = readRegister >> 8;
307 ret = __i2c_hid_command(client, &hid_get_report_cmd, reportID,
308 reportType, args, args_len, buf_recv, data_len);
310 dev_err(&client->dev,
311 "failed to retrieve report from device.\n");
319 * i2c_hid_set_or_send_report: forward an incoming report to the device
320 * @client: the i2c_client of the device
321 * @reportType: 0x03 for HID_FEATURE_REPORT ; 0x02 for HID_OUTPUT_REPORT
322 * @reportID: the report ID
323 * @buf: the actual data to transfer, without the report ID
325 * @use_data: true: use SET_REPORT HID command, false: send plain OUTPUT report
327 static int i2c_hid_set_or_send_report(struct i2c_client *client, u8 reportType,
328 u8 reportID, unsigned char *buf, size_t data_len, bool use_data)
330 struct i2c_hid *ihid = i2c_get_clientdata(client);
331 u8 *args = ihid->argsbuf;
332 const struct i2c_hid_cmd *hidcmd;
334 u16 dataRegister = le16_to_cpu(ihid->hdesc.wDataRegister);
335 u16 outputRegister = le16_to_cpu(ihid->hdesc.wOutputRegister);
336 u16 maxOutputLength = le16_to_cpu(ihid->hdesc.wMaxOutputLength);
341 i2c_hid_dbg(ihid, "%s\n", __func__);
343 if (data_len > ihid->bufsize)
346 size = 2 /* size */ +
347 (reportID ? 1 : 0) /* reportID */ +
349 args_len = (reportID >= 0x0F ? 1 : 0) /* optional third byte */ +
350 2 /* dataRegister */ +
353 if (!use_data && maxOutputLength == 0)
356 if (reportID >= 0x0F) {
357 args[index++] = reportID;
362 * use the data register for feature reports or if the device does not
363 * support the output register
366 args[index++] = dataRegister & 0xFF;
367 args[index++] = dataRegister >> 8;
368 hidcmd = &hid_set_report_cmd;
370 args[index++] = outputRegister & 0xFF;
371 args[index++] = outputRegister >> 8;
372 hidcmd = &hid_no_cmd;
375 args[index++] = size & 0xFF;
376 args[index++] = size >> 8;
379 args[index++] = reportID;
381 memcpy(&args[index], buf, data_len);
383 ret = __i2c_hid_command(client, hidcmd, reportID,
384 reportType, args, args_len, NULL, 0);
386 dev_err(&client->dev, "failed to set a report to device.\n");
393 static int i2c_hid_set_power(struct i2c_client *client, int power_state)
395 struct i2c_hid *ihid = i2c_get_clientdata(client);
397 unsigned long now, delay;
399 i2c_hid_dbg(ihid, "%s\n", __func__);
402 * Some devices require to send a command to wakeup before power on.
403 * The call will get a return value (EREMOTEIO) but device will be
404 * triggered and activated. After that, it goes like a normal device.
406 if (power_state == I2C_HID_PWR_ON &&
407 ihid->quirks & I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV) {
408 ret = i2c_hid_command(client, &hid_set_power_cmd, NULL, 0);
410 /* Device was already activated */
415 if (ihid->quirks & I2C_HID_QUIRK_DELAY_AFTER_SLEEP &&
416 power_state == I2C_HID_PWR_ON) {
418 if (time_after(ihid->sleep_delay, now)) {
419 delay = jiffies_to_usecs(ihid->sleep_delay - now);
420 usleep_range(delay, delay + 1);
424 ret = __i2c_hid_command(client, &hid_set_power_cmd, power_state,
425 0, NULL, 0, NULL, 0);
427 if (ihid->quirks & I2C_HID_QUIRK_DELAY_AFTER_SLEEP &&
428 power_state == I2C_HID_PWR_SLEEP)
429 ihid->sleep_delay = jiffies + msecs_to_jiffies(20);
432 dev_err(&client->dev, "failed to change power setting.\n");
438 static int i2c_hid_hwreset(struct i2c_client *client)
440 struct i2c_hid *ihid = i2c_get_clientdata(client);
443 i2c_hid_dbg(ihid, "%s\n", __func__);
446 * This prevents sending feature reports while the device is
447 * being reset. Otherwise we may lose the reset complete
450 mutex_lock(&ihid->reset_lock);
452 ret = i2c_hid_set_power(client, I2C_HID_PWR_ON);
457 * The HID over I2C specification states that if a DEVICE needs time
458 * after the PWR_ON request, it should utilise CLOCK stretching.
459 * However, it has been observered that the Windows driver provides a
460 * 1ms sleep between the PWR_ON and RESET requests and that some devices
463 usleep_range(1000, 5000);
465 i2c_hid_dbg(ihid, "resetting...\n");
467 ret = i2c_hid_command(client, &hid_reset_cmd, NULL, 0);
469 dev_err(&client->dev, "failed to reset device.\n");
470 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
474 mutex_unlock(&ihid->reset_lock);
478 static void i2c_hid_get_input(struct i2c_hid *ihid)
482 int size = le16_to_cpu(ihid->hdesc.wMaxInputLength);
484 if (size > ihid->bufsize)
485 size = ihid->bufsize;
487 ret = i2c_master_recv(ihid->client, ihid->inbuf, size);
492 dev_err(&ihid->client->dev, "%s: got %d data instead of %d\n",
493 __func__, ret, size);
497 ret_size = ihid->inbuf[0] | ihid->inbuf[1] << 8;
500 /* host or device initiated RESET completed */
501 if (test_and_clear_bit(I2C_HID_RESET_PENDING, &ihid->flags))
502 wake_up(&ihid->wait);
506 if ((ret_size > size) || (ret_size < 2)) {
507 dev_err(&ihid->client->dev, "%s: incomplete report (%d/%d)\n",
508 __func__, size, ret_size);
512 i2c_hid_dbg(ihid, "input: %*ph\n", ret_size, ihid->inbuf);
514 if (test_bit(I2C_HID_STARTED, &ihid->flags))
515 hid_input_report(ihid->hid, HID_INPUT_REPORT, ihid->inbuf + 2,
521 static irqreturn_t i2c_hid_irq(int irq, void *dev_id)
523 struct i2c_hid *ihid = dev_id;
525 if (test_bit(I2C_HID_READ_PENDING, &ihid->flags))
528 i2c_hid_get_input(ihid);
533 static int i2c_hid_get_report_length(struct hid_report *report)
535 return ((report->size - 1) >> 3) + 1 +
536 report->device->report_enum[report->type].numbered + 2;
540 * Traverse the supplied list of reports and find the longest
542 static void i2c_hid_find_max_report(struct hid_device *hid, unsigned int type,
545 struct hid_report *report;
548 /* We should not rely on wMaxInputLength, as some devices may set it to
550 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
551 size = i2c_hid_get_report_length(report);
557 static void i2c_hid_free_buffers(struct i2c_hid *ihid)
561 kfree(ihid->argsbuf);
566 ihid->argsbuf = NULL;
570 static int i2c_hid_alloc_buffers(struct i2c_hid *ihid, size_t report_size)
572 /* the worst case is computed from the set_report command with a
573 * reportID > 15 and the maximum report length */
574 int args_len = sizeof(__u8) + /* ReportID */
575 sizeof(__u8) + /* optional ReportID byte */
576 sizeof(__u16) + /* data register */
577 sizeof(__u16) + /* size of the report */
578 report_size; /* report */
580 ihid->inbuf = kzalloc(report_size, GFP_KERNEL);
581 ihid->rawbuf = kzalloc(report_size, GFP_KERNEL);
582 ihid->argsbuf = kzalloc(args_len, GFP_KERNEL);
583 ihid->cmdbuf = kzalloc(sizeof(union command) + args_len, GFP_KERNEL);
585 if (!ihid->inbuf || !ihid->rawbuf || !ihid->argsbuf || !ihid->cmdbuf) {
586 i2c_hid_free_buffers(ihid);
590 ihid->bufsize = report_size;
595 static int i2c_hid_get_raw_report(struct hid_device *hid,
596 unsigned char report_number, __u8 *buf, size_t count,
597 unsigned char report_type)
599 struct i2c_client *client = hid->driver_data;
600 struct i2c_hid *ihid = i2c_get_clientdata(client);
601 size_t ret_count, ask_count;
604 if (report_type == HID_OUTPUT_REPORT)
607 /* +2 bytes to include the size of the reply in the query buffer */
608 ask_count = min(count + 2, (size_t)ihid->bufsize);
610 ret = i2c_hid_get_report(client,
611 report_type == HID_FEATURE_REPORT ? 0x03 : 0x01,
612 report_number, ihid->rawbuf, ask_count);
617 ret_count = ihid->rawbuf[0] | (ihid->rawbuf[1] << 8);
622 ret_count = min(ret_count, ask_count);
624 /* The query buffer contains the size, dropping it in the reply */
625 count = min(count, ret_count - 2);
626 memcpy(buf, ihid->rawbuf + 2, count);
631 static int i2c_hid_output_raw_report(struct hid_device *hid, __u8 *buf,
632 size_t count, unsigned char report_type, bool use_data)
634 struct i2c_client *client = hid->driver_data;
635 struct i2c_hid *ihid = i2c_get_clientdata(client);
636 int report_id = buf[0];
639 if (report_type == HID_INPUT_REPORT)
642 mutex_lock(&ihid->reset_lock);
649 ret = i2c_hid_set_or_send_report(client,
650 report_type == HID_FEATURE_REPORT ? 0x03 : 0x02,
651 report_id, buf, count, use_data);
653 if (report_id && ret >= 0)
654 ret++; /* add report_id to the number of transfered bytes */
656 mutex_unlock(&ihid->reset_lock);
661 static int i2c_hid_output_report(struct hid_device *hid, __u8 *buf,
664 return i2c_hid_output_raw_report(hid, buf, count, HID_OUTPUT_REPORT,
668 static int i2c_hid_raw_request(struct hid_device *hid, unsigned char reportnum,
669 __u8 *buf, size_t len, unsigned char rtype,
673 case HID_REQ_GET_REPORT:
674 return i2c_hid_get_raw_report(hid, reportnum, buf, len, rtype);
675 case HID_REQ_SET_REPORT:
676 if (buf[0] != reportnum)
678 return i2c_hid_output_raw_report(hid, buf, len, rtype, true);
684 static int i2c_hid_parse(struct hid_device *hid)
686 struct i2c_client *client = hid->driver_data;
687 struct i2c_hid *ihid = i2c_get_clientdata(client);
688 struct i2c_hid_desc *hdesc = &ihid->hdesc;
695 i2c_hid_dbg(ihid, "entering %s\n", __func__);
697 rsize = le16_to_cpu(hdesc->wReportDescLength);
698 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
699 dbg_hid("weird size of report descriptor (%u)\n", rsize);
704 ret = i2c_hid_hwreset(client);
707 } while (tries-- > 0 && ret);
712 use_override = i2c_hid_get_dmi_hid_report_desc_override(client->name,
716 rdesc = use_override;
717 i2c_hid_dbg(ihid, "Using a HID report descriptor override\n");
719 rdesc = kzalloc(rsize, GFP_KERNEL);
722 dbg_hid("couldn't allocate rdesc memory\n");
726 i2c_hid_dbg(ihid, "asking HID report descriptor\n");
728 ret = i2c_hid_command(client, &hid_report_descr_cmd,
731 hid_err(hid, "reading report descriptor failed\n");
737 i2c_hid_dbg(ihid, "Report Descriptor: %*ph\n", rsize, rdesc);
739 ret = hid_parse_report(hid, rdesc, rsize);
744 dbg_hid("parsing report descriptor failed\n");
751 static int i2c_hid_start(struct hid_device *hid)
753 struct i2c_client *client = hid->driver_data;
754 struct i2c_hid *ihid = i2c_get_clientdata(client);
756 unsigned int bufsize = HID_MIN_BUFFER_SIZE;
758 i2c_hid_find_max_report(hid, HID_INPUT_REPORT, &bufsize);
759 i2c_hid_find_max_report(hid, HID_OUTPUT_REPORT, &bufsize);
760 i2c_hid_find_max_report(hid, HID_FEATURE_REPORT, &bufsize);
762 if (bufsize > ihid->bufsize) {
763 disable_irq(client->irq);
764 i2c_hid_free_buffers(ihid);
766 ret = i2c_hid_alloc_buffers(ihid, bufsize);
767 enable_irq(client->irq);
776 static void i2c_hid_stop(struct hid_device *hid)
781 static int i2c_hid_open(struct hid_device *hid)
783 struct i2c_client *client = hid->driver_data;
784 struct i2c_hid *ihid = i2c_get_clientdata(client);
787 ret = pm_runtime_get_sync(&client->dev);
791 set_bit(I2C_HID_STARTED, &ihid->flags);
795 static void i2c_hid_close(struct hid_device *hid)
797 struct i2c_client *client = hid->driver_data;
798 struct i2c_hid *ihid = i2c_get_clientdata(client);
800 clear_bit(I2C_HID_STARTED, &ihid->flags);
802 /* Save some power */
803 pm_runtime_put(&client->dev);
806 static int i2c_hid_power(struct hid_device *hid, int lvl)
808 struct i2c_client *client = hid->driver_data;
809 struct i2c_hid *ihid = i2c_get_clientdata(client);
811 i2c_hid_dbg(ihid, "%s lvl:%d\n", __func__, lvl);
815 pm_runtime_get_sync(&client->dev);
818 pm_runtime_put(&client->dev);
824 struct hid_ll_driver i2c_hid_ll_driver = {
825 .parse = i2c_hid_parse,
826 .start = i2c_hid_start,
827 .stop = i2c_hid_stop,
828 .open = i2c_hid_open,
829 .close = i2c_hid_close,
830 .power = i2c_hid_power,
831 .output_report = i2c_hid_output_report,
832 .raw_request = i2c_hid_raw_request,
834 EXPORT_SYMBOL_GPL(i2c_hid_ll_driver);
836 static int i2c_hid_init_irq(struct i2c_client *client)
838 struct i2c_hid *ihid = i2c_get_clientdata(client);
839 unsigned long irqflags = 0;
842 dev_dbg(&client->dev, "Requesting IRQ: %d\n", client->irq);
844 if (!irq_get_trigger_type(client->irq))
845 irqflags = IRQF_TRIGGER_LOW;
847 ret = request_threaded_irq(client->irq, NULL, i2c_hid_irq,
848 irqflags | IRQF_ONESHOT, client->name, ihid);
850 dev_warn(&client->dev,
851 "Could not register for %s interrupt, irq = %d,"
853 client->name, client->irq, ret);
861 static int i2c_hid_fetch_hid_descriptor(struct i2c_hid *ihid)
863 struct i2c_client *client = ihid->client;
864 struct i2c_hid_desc *hdesc = &ihid->hdesc;
868 /* i2c hid fetch using a fixed descriptor size (30 bytes) */
869 if (i2c_hid_get_dmi_i2c_hid_desc_override(client->name)) {
870 i2c_hid_dbg(ihid, "Using a HID descriptor override\n");
872 *i2c_hid_get_dmi_i2c_hid_desc_override(client->name);
874 i2c_hid_dbg(ihid, "Fetching the HID descriptor\n");
875 ret = i2c_hid_command(client, &hid_descr_cmd,
877 sizeof(struct i2c_hid_desc));
879 dev_err(&client->dev, "hid_descr_cmd failed\n");
884 /* Validate the length of HID descriptor, the 4 first bytes:
885 * bytes 0-1 -> length
886 * bytes 2-3 -> bcdVersion (has to be 1.00) */
887 /* check bcdVersion == 1.0 */
888 if (le16_to_cpu(hdesc->bcdVersion) != 0x0100) {
889 dev_err(&client->dev,
890 "unexpected HID descriptor bcdVersion (0x%04hx)\n",
891 le16_to_cpu(hdesc->bcdVersion));
895 /* Descriptor length should be 30 bytes as per the specification */
896 dsize = le16_to_cpu(hdesc->wHIDDescLength);
897 if (dsize != sizeof(struct i2c_hid_desc)) {
898 dev_err(&client->dev, "weird size of HID descriptor (%u)\n",
902 i2c_hid_dbg(ihid, "HID Descriptor: %*ph\n", dsize, ihid->hdesc_buffer);
907 static const struct acpi_device_id i2c_hid_acpi_blacklist[] = {
909 * The CHPN0001 ACPI device, which is used to describe the Chipone
910 * ICN8505 controller, has a _CID of PNP0C50 but is not HID compatible.
916 static int i2c_hid_acpi_pdata(struct i2c_client *client,
917 struct i2c_hid_platform_data *pdata)
919 static guid_t i2c_hid_guid =
920 GUID_INIT(0x3CDFF6F7, 0x4267, 0x4555,
921 0xAD, 0x05, 0xB3, 0x0A, 0x3D, 0x89, 0x38, 0xDE);
922 union acpi_object *obj;
923 struct acpi_device *adev;
926 handle = ACPI_HANDLE(&client->dev);
927 if (!handle || acpi_bus_get_device(handle, &adev)) {
928 dev_err(&client->dev, "Error could not get ACPI device\n");
932 if (acpi_match_device_ids(adev, i2c_hid_acpi_blacklist) == 0)
935 obj = acpi_evaluate_dsm_typed(handle, &i2c_hid_guid, 1, 1, NULL,
938 dev_err(&client->dev, "Error _DSM call to get HID descriptor address failed\n");
942 pdata->hid_descriptor_address = obj->integer.value;
948 static void i2c_hid_acpi_fix_up_power(struct device *dev)
950 struct acpi_device *adev;
952 adev = ACPI_COMPANION(dev);
954 acpi_device_fix_up_power(adev);
957 static const struct acpi_device_id i2c_hid_acpi_match[] = {
962 MODULE_DEVICE_TABLE(acpi, i2c_hid_acpi_match);
964 static inline int i2c_hid_acpi_pdata(struct i2c_client *client,
965 struct i2c_hid_platform_data *pdata)
970 static inline void i2c_hid_acpi_fix_up_power(struct device *dev) {}
974 static int i2c_hid_of_probe(struct i2c_client *client,
975 struct i2c_hid_platform_data *pdata)
977 struct device *dev = &client->dev;
981 ret = of_property_read_u32(dev->of_node, "hid-descr-addr", &val);
983 dev_err(&client->dev, "HID register address not provided\n");
987 dev_err(&client->dev, "Bad HID register address: 0x%08x\n",
991 pdata->hid_descriptor_address = val;
996 static const struct of_device_id i2c_hid_of_match[] = {
997 { .compatible = "hid-over-i2c" },
1000 MODULE_DEVICE_TABLE(of, i2c_hid_of_match);
1002 static inline int i2c_hid_of_probe(struct i2c_client *client,
1003 struct i2c_hid_platform_data *pdata)
1009 static void i2c_hid_fwnode_probe(struct i2c_client *client,
1010 struct i2c_hid_platform_data *pdata)
1014 if (!device_property_read_u32(&client->dev, "post-power-on-delay-ms",
1016 pdata->post_power_delay_ms = val;
1019 static int i2c_hid_probe(struct i2c_client *client,
1020 const struct i2c_device_id *dev_id)
1023 struct i2c_hid *ihid;
1024 struct hid_device *hid;
1026 struct i2c_hid_platform_data *platform_data = client->dev.platform_data;
1028 dbg_hid("HID probe called for i2c 0x%02x\n", client->addr);
1031 dev_err(&client->dev,
1032 "HID over i2c has not been provided an Int IRQ\n");
1036 if (client->irq < 0) {
1037 if (client->irq != -EPROBE_DEFER)
1038 dev_err(&client->dev,
1039 "HID over i2c doesn't have a valid IRQ\n");
1043 ihid = devm_kzalloc(&client->dev, sizeof(*ihid), GFP_KERNEL);
1047 if (client->dev.of_node) {
1048 ret = i2c_hid_of_probe(client, &ihid->pdata);
1051 } else if (!platform_data) {
1052 ret = i2c_hid_acpi_pdata(client, &ihid->pdata);
1056 ihid->pdata = *platform_data;
1059 /* Parse platform agnostic common properties from ACPI / device tree */
1060 i2c_hid_fwnode_probe(client, &ihid->pdata);
1062 ihid->pdata.supplies[0].supply = "vdd";
1063 ihid->pdata.supplies[1].supply = "vddl";
1065 ret = devm_regulator_bulk_get(&client->dev,
1066 ARRAY_SIZE(ihid->pdata.supplies),
1067 ihid->pdata.supplies);
1071 ret = regulator_bulk_enable(ARRAY_SIZE(ihid->pdata.supplies),
1072 ihid->pdata.supplies);
1076 if (ihid->pdata.post_power_delay_ms)
1077 msleep(ihid->pdata.post_power_delay_ms);
1079 i2c_set_clientdata(client, ihid);
1081 ihid->client = client;
1083 hidRegister = ihid->pdata.hid_descriptor_address;
1084 ihid->wHIDDescRegister = cpu_to_le16(hidRegister);
1086 init_waitqueue_head(&ihid->wait);
1087 mutex_init(&ihid->reset_lock);
1089 /* we need to allocate the command buffer without knowing the maximum
1090 * size of the reports. Let's use HID_MIN_BUFFER_SIZE, then we do the
1091 * real computation later. */
1092 ret = i2c_hid_alloc_buffers(ihid, HID_MIN_BUFFER_SIZE);
1096 i2c_hid_acpi_fix_up_power(&client->dev);
1098 pm_runtime_get_noresume(&client->dev);
1099 pm_runtime_set_active(&client->dev);
1100 pm_runtime_enable(&client->dev);
1101 device_enable_async_suspend(&client->dev);
1103 /* Make sure there is something at this address */
1104 ret = i2c_smbus_read_byte(client);
1106 dev_dbg(&client->dev, "nothing at this address: %d\n", ret);
1111 ret = i2c_hid_fetch_hid_descriptor(ihid);
1115 ret = i2c_hid_init_irq(client);
1119 hid = hid_allocate_device();
1127 hid->driver_data = client;
1128 hid->ll_driver = &i2c_hid_ll_driver;
1129 hid->dev.parent = &client->dev;
1131 hid->version = le16_to_cpu(ihid->hdesc.bcdVersion);
1132 hid->vendor = le16_to_cpu(ihid->hdesc.wVendorID);
1133 hid->product = le16_to_cpu(ihid->hdesc.wProductID);
1135 snprintf(hid->name, sizeof(hid->name), "%s %04hX:%04hX",
1136 client->name, hid->vendor, hid->product);
1137 strlcpy(hid->phys, dev_name(&client->dev), sizeof(hid->phys));
1139 ihid->quirks = i2c_hid_lookup_quirk(hid->vendor, hid->product);
1141 ret = hid_add_device(hid);
1144 hid_err(client, "can't add hid device: %d\n", ret);
1148 if (!(ihid->quirks & I2C_HID_QUIRK_NO_RUNTIME_PM))
1149 pm_runtime_put(&client->dev);
1154 hid_destroy_device(hid);
1157 free_irq(client->irq, ihid);
1160 pm_runtime_put_noidle(&client->dev);
1161 pm_runtime_disable(&client->dev);
1164 regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
1165 ihid->pdata.supplies);
1166 i2c_hid_free_buffers(ihid);
1170 static int i2c_hid_remove(struct i2c_client *client)
1172 struct i2c_hid *ihid = i2c_get_clientdata(client);
1173 struct hid_device *hid;
1175 if (!(ihid->quirks & I2C_HID_QUIRK_NO_RUNTIME_PM))
1176 pm_runtime_get_sync(&client->dev);
1177 pm_runtime_disable(&client->dev);
1178 pm_runtime_set_suspended(&client->dev);
1179 pm_runtime_put_noidle(&client->dev);
1182 hid_destroy_device(hid);
1184 free_irq(client->irq, ihid);
1187 i2c_hid_free_buffers(ihid);
1189 regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
1190 ihid->pdata.supplies);
1195 static void i2c_hid_shutdown(struct i2c_client *client)
1197 struct i2c_hid *ihid = i2c_get_clientdata(client);
1199 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1200 free_irq(client->irq, ihid);
1203 #ifdef CONFIG_PM_SLEEP
1204 static int i2c_hid_suspend(struct device *dev)
1206 struct i2c_client *client = to_i2c_client(dev);
1207 struct i2c_hid *ihid = i2c_get_clientdata(client);
1208 struct hid_device *hid = ihid->hid;
1212 if (hid->driver && hid->driver->suspend) {
1214 * Wake up the device so that IO issues in
1215 * HID driver's suspend code can succeed.
1217 ret = pm_runtime_resume(dev);
1221 ret = hid->driver->suspend(hid, PMSG_SUSPEND);
1226 if (!pm_runtime_suspended(dev)) {
1227 /* Save some power */
1228 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1230 disable_irq(client->irq);
1233 if (device_may_wakeup(&client->dev)) {
1234 wake_status = enable_irq_wake(client->irq);
1236 ihid->irq_wake_enabled = true;
1238 hid_warn(hid, "Failed to enable irq wake: %d\n",
1241 regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
1242 ihid->pdata.supplies);
1248 static int i2c_hid_resume(struct device *dev)
1251 struct i2c_client *client = to_i2c_client(dev);
1252 struct i2c_hid *ihid = i2c_get_clientdata(client);
1253 struct hid_device *hid = ihid->hid;
1256 if (!device_may_wakeup(&client->dev)) {
1257 ret = regulator_bulk_enable(ARRAY_SIZE(ihid->pdata.supplies),
1258 ihid->pdata.supplies);
1260 hid_warn(hid, "Failed to enable supplies: %d\n", ret);
1262 if (ihid->pdata.post_power_delay_ms)
1263 msleep(ihid->pdata.post_power_delay_ms);
1264 } else if (ihid->irq_wake_enabled) {
1265 wake_status = disable_irq_wake(client->irq);
1267 ihid->irq_wake_enabled = false;
1269 hid_warn(hid, "Failed to disable irq wake: %d\n",
1273 /* We'll resume to full power */
1274 pm_runtime_disable(dev);
1275 pm_runtime_set_active(dev);
1276 pm_runtime_enable(dev);
1278 enable_irq(client->irq);
1280 /* Instead of resetting device, simply powers the device on. This
1281 * solves "incomplete reports" on Raydium devices 2386:3118 and
1282 * 2386:4B33 and fixes various SIS touchscreens no longer sending
1283 * data after a suspend/resume.
1285 ret = i2c_hid_set_power(client, I2C_HID_PWR_ON);
1289 if (hid->driver && hid->driver->reset_resume) {
1290 ret = hid->driver->reset_resume(hid);
1299 static int i2c_hid_runtime_suspend(struct device *dev)
1301 struct i2c_client *client = to_i2c_client(dev);
1303 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1304 disable_irq(client->irq);
1308 static int i2c_hid_runtime_resume(struct device *dev)
1310 struct i2c_client *client = to_i2c_client(dev);
1312 enable_irq(client->irq);
1313 i2c_hid_set_power(client, I2C_HID_PWR_ON);
1318 static const struct dev_pm_ops i2c_hid_pm = {
1319 SET_SYSTEM_SLEEP_PM_OPS(i2c_hid_suspend, i2c_hid_resume)
1320 SET_RUNTIME_PM_OPS(i2c_hid_runtime_suspend, i2c_hid_runtime_resume,
1324 static const struct i2c_device_id i2c_hid_id_table[] = {
1326 { "hid-over-i2c", 0 },
1329 MODULE_DEVICE_TABLE(i2c, i2c_hid_id_table);
1332 static struct i2c_driver i2c_hid_driver = {
1336 .acpi_match_table = ACPI_PTR(i2c_hid_acpi_match),
1337 .of_match_table = of_match_ptr(i2c_hid_of_match),
1340 .probe = i2c_hid_probe,
1341 .remove = i2c_hid_remove,
1342 .shutdown = i2c_hid_shutdown,
1343 .id_table = i2c_hid_id_table,
1346 module_i2c_driver(i2c_hid_driver);
1348 MODULE_DESCRIPTION("HID over I2C core driver");
1350 MODULE_LICENSE("GPL");