2 * HID over I2C protocol implementation
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
8 * This code is partly based on "USB HID support for Linux":
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
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/delay.h>
26 #include <linux/slab.h>
28 #include <linux/pm_runtime.h>
29 #include <linux/device.h>
30 #include <linux/wait.h>
31 #include <linux/err.h>
32 #include <linux/string.h>
33 #include <linux/list.h>
34 #include <linux/jiffies.h>
35 #include <linux/kernel.h>
36 #include <linux/hid.h>
37 #include <linux/mutex.h>
38 #include <linux/acpi.h>
41 #include <linux/i2c/i2c-hid.h>
44 #define I2C_HID_STARTED (1 << 0)
45 #define I2C_HID_RESET_PENDING (1 << 1)
46 #define I2C_HID_READ_PENDING (1 << 2)
48 #define I2C_HID_PWR_ON 0x00
49 #define I2C_HID_PWR_SLEEP 0x01
53 module_param(debug, bool, 0444);
54 MODULE_PARM_DESC(debug, "print a lot of debug information");
56 #define i2c_hid_dbg(ihid, fmt, arg...) \
59 dev_printk(KERN_DEBUG, &(ihid)->client->dev, fmt, ##arg); \
63 __le16 wHIDDescLength;
65 __le16 wReportDescLength;
66 __le16 wReportDescRegister;
67 __le16 wInputRegister;
68 __le16 wMaxInputLength;
69 __le16 wOutputRegister;
70 __le16 wMaxOutputLength;
71 __le16 wCommandRegister;
80 unsigned int registerIndex;
95 #define I2C_HID_CMD(opcode_) \
96 .opcode = opcode_, .length = 4, \
97 .registerIndex = offsetof(struct i2c_hid_desc, wCommandRegister)
99 /* fetch HID descriptor */
100 static const struct i2c_hid_cmd hid_descr_cmd = { .length = 2 };
101 /* fetch report descriptors */
102 static const struct i2c_hid_cmd hid_report_descr_cmd = {
103 .registerIndex = offsetof(struct i2c_hid_desc,
104 wReportDescRegister),
108 static const struct i2c_hid_cmd hid_reset_cmd = { I2C_HID_CMD(0x01),
110 static const struct i2c_hid_cmd hid_get_report_cmd = { I2C_HID_CMD(0x02) };
111 static const struct i2c_hid_cmd hid_set_report_cmd = { I2C_HID_CMD(0x03) };
112 static const struct i2c_hid_cmd hid_set_power_cmd = { I2C_HID_CMD(0x08) };
113 static const struct i2c_hid_cmd hid_no_cmd = { .length = 0 };
116 * These definitions are not used here, but are defined by the spec.
117 * Keeping them here for documentation purposes.
119 * static const struct i2c_hid_cmd hid_get_idle_cmd = { I2C_HID_CMD(0x04) };
120 * static const struct i2c_hid_cmd hid_set_idle_cmd = { I2C_HID_CMD(0x05) };
121 * static const struct i2c_hid_cmd hid_get_protocol_cmd = { I2C_HID_CMD(0x06) };
122 * static const struct i2c_hid_cmd hid_set_protocol_cmd = { I2C_HID_CMD(0x07) };
125 static DEFINE_MUTEX(i2c_hid_open_mut);
127 /* The main device structure */
129 struct i2c_client *client; /* i2c client */
130 struct hid_device *hid; /* pointer to corresponding HID dev */
132 __u8 hdesc_buffer[sizeof(struct i2c_hid_desc)];
133 struct i2c_hid_desc hdesc; /* the HID Descriptor */
135 __le16 wHIDDescRegister; /* location of the i2c
136 * register of the HID
138 unsigned int bufsize; /* i2c buffer size */
139 char *inbuf; /* Input buffer */
140 char *rawbuf; /* Raw Input buffer */
141 char *cmdbuf; /* Command buffer */
142 char *argsbuf; /* Command arguments buffer */
144 unsigned long flags; /* device flags */
146 wait_queue_head_t wait; /* For waiting the interrupt */
148 struct i2c_hid_platform_data pdata;
151 static int __i2c_hid_command(struct i2c_client *client,
152 const struct i2c_hid_cmd *command, u8 reportID,
153 u8 reportType, u8 *args, int args_len,
154 unsigned char *buf_recv, int data_len)
156 struct i2c_hid *ihid = i2c_get_clientdata(client);
157 union command *cmd = (union command *)ihid->cmdbuf;
159 struct i2c_msg msg[2];
162 int length = command->length;
163 bool wait = command->wait;
164 unsigned int registerIndex = command->registerIndex;
166 /* special case for hid_descr_cmd */
167 if (command == &hid_descr_cmd) {
168 cmd->c.reg = ihid->wHIDDescRegister;
170 cmd->data[0] = ihid->hdesc_buffer[registerIndex];
171 cmd->data[1] = ihid->hdesc_buffer[registerIndex + 1];
175 cmd->c.opcode = command->opcode;
176 cmd->c.reportTypeID = reportID | reportType << 4;
179 memcpy(cmd->data + length, args, args_len);
182 i2c_hid_dbg(ihid, "%s: cmd=%*ph\n", __func__, length, cmd->data);
184 msg[0].addr = client->addr;
185 msg[0].flags = client->flags & I2C_M_TEN;
187 msg[0].buf = cmd->data;
189 msg[1].addr = client->addr;
190 msg[1].flags = client->flags & I2C_M_TEN;
191 msg[1].flags |= I2C_M_RD;
192 msg[1].len = data_len;
193 msg[1].buf = buf_recv;
195 set_bit(I2C_HID_READ_PENDING, &ihid->flags);
199 set_bit(I2C_HID_RESET_PENDING, &ihid->flags);
201 ret = i2c_transfer(client->adapter, msg, msg_num);
204 clear_bit(I2C_HID_READ_PENDING, &ihid->flags);
207 return ret < 0 ? ret : -EIO;
212 i2c_hid_dbg(ihid, "%s: waiting...\n", __func__);
213 if (!wait_event_timeout(ihid->wait,
214 !test_bit(I2C_HID_RESET_PENDING, &ihid->flags),
215 msecs_to_jiffies(5000)))
217 i2c_hid_dbg(ihid, "%s: finished.\n", __func__);
223 static int i2c_hid_command(struct i2c_client *client,
224 const struct i2c_hid_cmd *command,
225 unsigned char *buf_recv, int data_len)
227 return __i2c_hid_command(client, command, 0, 0, NULL, 0,
231 static int i2c_hid_get_report(struct i2c_client *client, u8 reportType,
232 u8 reportID, unsigned char *buf_recv, int data_len)
234 struct i2c_hid *ihid = i2c_get_clientdata(client);
238 u16 readRegister = le16_to_cpu(ihid->hdesc.wDataRegister);
240 i2c_hid_dbg(ihid, "%s\n", __func__);
242 if (reportID >= 0x0F) {
243 args[args_len++] = reportID;
247 args[args_len++] = readRegister & 0xFF;
248 args[args_len++] = readRegister >> 8;
250 ret = __i2c_hid_command(client, &hid_get_report_cmd, reportID,
251 reportType, args, args_len, buf_recv, data_len);
253 dev_err(&client->dev,
254 "failed to retrieve report from device.\n");
262 * i2c_hid_set_or_send_report: forward an incoming report to the device
263 * @client: the i2c_client of the device
264 * @reportType: 0x03 for HID_FEATURE_REPORT ; 0x02 for HID_OUTPUT_REPORT
265 * @reportID: the report ID
266 * @buf: the actual data to transfer, without the report ID
268 * @use_data: true: use SET_REPORT HID command, false: send plain OUTPUT report
270 static int i2c_hid_set_or_send_report(struct i2c_client *client, u8 reportType,
271 u8 reportID, unsigned char *buf, size_t data_len, bool use_data)
273 struct i2c_hid *ihid = i2c_get_clientdata(client);
274 u8 *args = ihid->argsbuf;
275 const struct i2c_hid_cmd *hidcmd;
277 u16 dataRegister = le16_to_cpu(ihid->hdesc.wDataRegister);
278 u16 outputRegister = le16_to_cpu(ihid->hdesc.wOutputRegister);
279 u16 maxOutputLength = le16_to_cpu(ihid->hdesc.wMaxOutputLength);
281 /* hid_hw_* already checked that data_len < HID_MAX_BUFFER_SIZE */
282 u16 size = 2 /* size */ +
283 (reportID ? 1 : 0) /* reportID */ +
285 int args_len = (reportID >= 0x0F ? 1 : 0) /* optional third byte */ +
286 2 /* dataRegister */ +
290 i2c_hid_dbg(ihid, "%s\n", __func__);
292 if (!use_data && maxOutputLength == 0)
295 if (reportID >= 0x0F) {
296 args[index++] = reportID;
301 * use the data register for feature reports or if the device does not
302 * support the output register
305 args[index++] = dataRegister & 0xFF;
306 args[index++] = dataRegister >> 8;
307 hidcmd = &hid_set_report_cmd;
309 args[index++] = outputRegister & 0xFF;
310 args[index++] = outputRegister >> 8;
311 hidcmd = &hid_no_cmd;
314 args[index++] = size & 0xFF;
315 args[index++] = size >> 8;
318 args[index++] = reportID;
320 memcpy(&args[index], buf, data_len);
322 ret = __i2c_hid_command(client, hidcmd, reportID,
323 reportType, args, args_len, NULL, 0);
325 dev_err(&client->dev, "failed to set a report to device.\n");
332 static int i2c_hid_set_power(struct i2c_client *client, int power_state)
334 struct i2c_hid *ihid = i2c_get_clientdata(client);
337 i2c_hid_dbg(ihid, "%s\n", __func__);
339 ret = __i2c_hid_command(client, &hid_set_power_cmd, power_state,
340 0, NULL, 0, NULL, 0);
342 dev_err(&client->dev, "failed to change power setting.\n");
347 static int i2c_hid_hwreset(struct i2c_client *client)
349 struct i2c_hid *ihid = i2c_get_clientdata(client);
352 i2c_hid_dbg(ihid, "%s\n", __func__);
354 ret = i2c_hid_set_power(client, I2C_HID_PWR_ON);
358 i2c_hid_dbg(ihid, "resetting...\n");
360 ret = i2c_hid_command(client, &hid_reset_cmd, NULL, 0);
362 dev_err(&client->dev, "failed to reset device.\n");
363 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
370 static void i2c_hid_get_input(struct i2c_hid *ihid)
373 int size = ihid->bufsize;
375 ret = i2c_master_recv(ihid->client, ihid->inbuf, size);
380 dev_err(&ihid->client->dev, "%s: got %d data instead of %d\n",
381 __func__, ret, size);
385 ret_size = ihid->inbuf[0] | ihid->inbuf[1] << 8;
388 /* host or device initiated RESET completed */
389 if (test_and_clear_bit(I2C_HID_RESET_PENDING, &ihid->flags))
390 wake_up(&ihid->wait);
394 if (ret_size > size) {
395 dev_err(&ihid->client->dev, "%s: incomplete report (%d/%d)\n",
396 __func__, size, ret_size);
400 i2c_hid_dbg(ihid, "input: %*ph\n", ret_size, ihid->inbuf);
402 if (test_bit(I2C_HID_STARTED, &ihid->flags))
403 hid_input_report(ihid->hid, HID_INPUT_REPORT, ihid->inbuf + 2,
409 static irqreturn_t i2c_hid_irq(int irq, void *dev_id)
411 struct i2c_hid *ihid = dev_id;
413 if (test_bit(I2C_HID_READ_PENDING, &ihid->flags))
416 i2c_hid_get_input(ihid);
421 static int i2c_hid_get_report_length(struct hid_report *report)
423 return ((report->size - 1) >> 3) + 1 +
424 report->device->report_enum[report->type].numbered + 2;
427 static void i2c_hid_init_report(struct hid_report *report, u8 *buffer,
430 struct hid_device *hid = report->device;
431 struct i2c_client *client = hid->driver_data;
432 struct i2c_hid *ihid = i2c_get_clientdata(client);
433 unsigned int size, ret_size;
435 size = i2c_hid_get_report_length(report);
436 if (i2c_hid_get_report(client,
437 report->type == HID_FEATURE_REPORT ? 0x03 : 0x01,
438 report->id, buffer, size))
441 i2c_hid_dbg(ihid, "report (len=%d): %*ph\n", size, size, buffer);
443 ret_size = buffer[0] | (buffer[1] << 8);
445 if (ret_size != size) {
446 dev_err(&client->dev, "error in %s size:%d / ret_size:%d\n",
447 __func__, size, ret_size);
451 /* hid->driver_lock is held as we are in probe function,
452 * we just need to setup the input fields, so using
453 * hid_report_raw_event is safe. */
454 hid_report_raw_event(hid, report->type, buffer + 2, size - 2, 1);
458 * Initialize all reports
460 static void i2c_hid_init_reports(struct hid_device *hid)
462 struct hid_report *report;
463 struct i2c_client *client = hid->driver_data;
464 struct i2c_hid *ihid = i2c_get_clientdata(client);
465 u8 *inbuf = kzalloc(ihid->bufsize, GFP_KERNEL);
468 dev_err(&client->dev, "can not retrieve initial reports\n");
473 * The device must be powered on while we fetch initial reports
476 pm_runtime_get_sync(&client->dev);
478 list_for_each_entry(report,
479 &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
480 i2c_hid_init_report(report, inbuf, ihid->bufsize);
482 pm_runtime_put(&client->dev);
488 * Traverse the supplied list of reports and find the longest
490 static void i2c_hid_find_max_report(struct hid_device *hid, unsigned int type,
493 struct hid_report *report;
496 /* We should not rely on wMaxInputLength, as some devices may set it to
498 list_for_each_entry(report, &hid->report_enum[type].report_list, list) {
499 size = i2c_hid_get_report_length(report);
505 static void i2c_hid_free_buffers(struct i2c_hid *ihid)
509 kfree(ihid->argsbuf);
514 ihid->argsbuf = NULL;
518 static int i2c_hid_alloc_buffers(struct i2c_hid *ihid, size_t report_size)
520 /* the worst case is computed from the set_report command with a
521 * reportID > 15 and the maximum report length */
522 int args_len = sizeof(__u8) + /* optional ReportID byte */
523 sizeof(__u16) + /* data register */
524 sizeof(__u16) + /* size of the report */
525 report_size; /* report */
527 ihid->inbuf = kzalloc(report_size, GFP_KERNEL);
528 ihid->rawbuf = kzalloc(report_size, GFP_KERNEL);
529 ihid->argsbuf = kzalloc(args_len, GFP_KERNEL);
530 ihid->cmdbuf = kzalloc(sizeof(union command) + args_len, GFP_KERNEL);
532 if (!ihid->inbuf || !ihid->rawbuf || !ihid->argsbuf || !ihid->cmdbuf) {
533 i2c_hid_free_buffers(ihid);
537 ihid->bufsize = report_size;
542 static int i2c_hid_get_raw_report(struct hid_device *hid,
543 unsigned char report_number, __u8 *buf, size_t count,
544 unsigned char report_type)
546 struct i2c_client *client = hid->driver_data;
547 struct i2c_hid *ihid = i2c_get_clientdata(client);
548 size_t ret_count, ask_count;
551 if (report_type == HID_OUTPUT_REPORT)
554 /* +2 bytes to include the size of the reply in the query buffer */
555 ask_count = min(count + 2, (size_t)ihid->bufsize);
557 ret = i2c_hid_get_report(client,
558 report_type == HID_FEATURE_REPORT ? 0x03 : 0x01,
559 report_number, ihid->rawbuf, ask_count);
564 ret_count = ihid->rawbuf[0] | (ihid->rawbuf[1] << 8);
569 ret_count = min(ret_count, ask_count);
571 /* The query buffer contains the size, dropping it in the reply */
572 count = min(count, ret_count - 2);
573 memcpy(buf, ihid->rawbuf + 2, count);
578 static int i2c_hid_output_raw_report(struct hid_device *hid, __u8 *buf,
579 size_t count, unsigned char report_type, bool use_data)
581 struct i2c_client *client = hid->driver_data;
582 int report_id = buf[0];
585 if (report_type == HID_INPUT_REPORT)
593 ret = i2c_hid_set_or_send_report(client,
594 report_type == HID_FEATURE_REPORT ? 0x03 : 0x02,
595 report_id, buf, count, use_data);
597 if (report_id && ret >= 0)
598 ret++; /* add report_id to the number of transfered bytes */
603 static int i2c_hid_output_report(struct hid_device *hid, __u8 *buf,
606 return i2c_hid_output_raw_report(hid, buf, count, HID_OUTPUT_REPORT,
610 static int i2c_hid_raw_request(struct hid_device *hid, unsigned char reportnum,
611 __u8 *buf, size_t len, unsigned char rtype,
615 case HID_REQ_GET_REPORT:
616 return i2c_hid_get_raw_report(hid, reportnum, buf, len, rtype);
617 case HID_REQ_SET_REPORT:
618 if (buf[0] != reportnum)
620 return i2c_hid_output_raw_report(hid, buf, len, rtype, true);
626 static int i2c_hid_parse(struct hid_device *hid)
628 struct i2c_client *client = hid->driver_data;
629 struct i2c_hid *ihid = i2c_get_clientdata(client);
630 struct i2c_hid_desc *hdesc = &ihid->hdesc;
636 i2c_hid_dbg(ihid, "entering %s\n", __func__);
638 rsize = le16_to_cpu(hdesc->wReportDescLength);
639 if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) {
640 dbg_hid("weird size of report descriptor (%u)\n", rsize);
645 ret = i2c_hid_hwreset(client);
648 } while (tries-- > 0 && ret);
653 rdesc = kzalloc(rsize, GFP_KERNEL);
656 dbg_hid("couldn't allocate rdesc memory\n");
660 i2c_hid_dbg(ihid, "asking HID report descriptor\n");
662 ret = i2c_hid_command(client, &hid_report_descr_cmd, rdesc, rsize);
664 hid_err(hid, "reading report descriptor failed\n");
669 i2c_hid_dbg(ihid, "Report Descriptor: %*ph\n", rsize, rdesc);
671 ret = hid_parse_report(hid, rdesc, rsize);
674 dbg_hid("parsing report descriptor failed\n");
681 static int i2c_hid_start(struct hid_device *hid)
683 struct i2c_client *client = hid->driver_data;
684 struct i2c_hid *ihid = i2c_get_clientdata(client);
686 unsigned int bufsize = HID_MIN_BUFFER_SIZE;
688 i2c_hid_find_max_report(hid, HID_INPUT_REPORT, &bufsize);
689 i2c_hid_find_max_report(hid, HID_OUTPUT_REPORT, &bufsize);
690 i2c_hid_find_max_report(hid, HID_FEATURE_REPORT, &bufsize);
692 if (bufsize > ihid->bufsize) {
693 i2c_hid_free_buffers(ihid);
695 ret = i2c_hid_alloc_buffers(ihid, bufsize);
701 if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
702 i2c_hid_init_reports(hid);
707 static void i2c_hid_stop(struct hid_device *hid)
712 static int i2c_hid_open(struct hid_device *hid)
714 struct i2c_client *client = hid->driver_data;
715 struct i2c_hid *ihid = i2c_get_clientdata(client);
718 mutex_lock(&i2c_hid_open_mut);
720 ret = pm_runtime_get_sync(&client->dev);
725 set_bit(I2C_HID_STARTED, &ihid->flags);
728 mutex_unlock(&i2c_hid_open_mut);
729 return ret < 0 ? ret : 0;
732 static void i2c_hid_close(struct hid_device *hid)
734 struct i2c_client *client = hid->driver_data;
735 struct i2c_hid *ihid = i2c_get_clientdata(client);
737 /* protecting hid->open to make sure we don't restart
738 * data acquistion due to a resumption we no longer
741 mutex_lock(&i2c_hid_open_mut);
743 clear_bit(I2C_HID_STARTED, &ihid->flags);
745 /* Save some power */
746 pm_runtime_put(&client->dev);
748 mutex_unlock(&i2c_hid_open_mut);
751 static int i2c_hid_power(struct hid_device *hid, int lvl)
753 struct i2c_client *client = hid->driver_data;
754 struct i2c_hid *ihid = i2c_get_clientdata(client);
756 i2c_hid_dbg(ihid, "%s lvl:%d\n", __func__, lvl);
760 pm_runtime_get_sync(&client->dev);
763 pm_runtime_put(&client->dev);
769 static struct hid_ll_driver i2c_hid_ll_driver = {
770 .parse = i2c_hid_parse,
771 .start = i2c_hid_start,
772 .stop = i2c_hid_stop,
773 .open = i2c_hid_open,
774 .close = i2c_hid_close,
775 .power = i2c_hid_power,
776 .output_report = i2c_hid_output_report,
777 .raw_request = i2c_hid_raw_request,
780 static int i2c_hid_init_irq(struct i2c_client *client)
782 struct i2c_hid *ihid = i2c_get_clientdata(client);
785 dev_dbg(&client->dev, "Requesting IRQ: %d\n", client->irq);
787 ret = request_threaded_irq(client->irq, NULL, i2c_hid_irq,
788 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
791 dev_warn(&client->dev,
792 "Could not register for %s interrupt, irq = %d,"
794 client->name, client->irq, ret);
802 static int i2c_hid_fetch_hid_descriptor(struct i2c_hid *ihid)
804 struct i2c_client *client = ihid->client;
805 struct i2c_hid_desc *hdesc = &ihid->hdesc;
809 /* i2c hid fetch using a fixed descriptor size (30 bytes) */
810 i2c_hid_dbg(ihid, "Fetching the HID descriptor\n");
811 ret = i2c_hid_command(client, &hid_descr_cmd, ihid->hdesc_buffer,
812 sizeof(struct i2c_hid_desc));
814 dev_err(&client->dev, "hid_descr_cmd failed\n");
818 /* Validate the length of HID descriptor, the 4 first bytes:
819 * bytes 0-1 -> length
820 * bytes 2-3 -> bcdVersion (has to be 1.00) */
821 /* check bcdVersion == 1.0 */
822 if (le16_to_cpu(hdesc->bcdVersion) != 0x0100) {
823 dev_err(&client->dev,
824 "unexpected HID descriptor bcdVersion (0x%04hx)\n",
825 le16_to_cpu(hdesc->bcdVersion));
829 /* Descriptor length should be 30 bytes as per the specification */
830 dsize = le16_to_cpu(hdesc->wHIDDescLength);
831 if (dsize != sizeof(struct i2c_hid_desc)) {
832 dev_err(&client->dev, "weird size of HID descriptor (%u)\n",
836 i2c_hid_dbg(ihid, "HID Descriptor: %*ph\n", dsize, ihid->hdesc_buffer);
841 static int i2c_hid_acpi_pdata(struct i2c_client *client,
842 struct i2c_hid_platform_data *pdata)
844 static u8 i2c_hid_guid[] = {
845 0xF7, 0xF6, 0xDF, 0x3C, 0x67, 0x42, 0x55, 0x45,
846 0xAD, 0x05, 0xB3, 0x0A, 0x3D, 0x89, 0x38, 0xDE,
848 union acpi_object *obj;
849 struct acpi_device *adev;
852 handle = ACPI_HANDLE(&client->dev);
853 if (!handle || acpi_bus_get_device(handle, &adev))
856 obj = acpi_evaluate_dsm_typed(handle, i2c_hid_guid, 1, 1, NULL,
859 dev_err(&client->dev, "device _DSM execution failed\n");
863 pdata->hid_descriptor_address = obj->integer.value;
869 static const struct acpi_device_id i2c_hid_acpi_match[] = {
874 MODULE_DEVICE_TABLE(acpi, i2c_hid_acpi_match);
876 static inline int i2c_hid_acpi_pdata(struct i2c_client *client,
877 struct i2c_hid_platform_data *pdata)
884 static int i2c_hid_of_probe(struct i2c_client *client,
885 struct i2c_hid_platform_data *pdata)
887 struct device *dev = &client->dev;
891 ret = of_property_read_u32(dev->of_node, "hid-descr-addr", &val);
893 dev_err(&client->dev, "HID register address not provided\n");
897 dev_err(&client->dev, "Bad HID register address: 0x%08x\n",
901 pdata->hid_descriptor_address = val;
906 static const struct of_device_id i2c_hid_of_match[] = {
907 { .compatible = "hid-over-i2c" },
910 MODULE_DEVICE_TABLE(of, i2c_hid_of_match);
912 static inline int i2c_hid_of_probe(struct i2c_client *client,
913 struct i2c_hid_platform_data *pdata)
919 static int i2c_hid_probe(struct i2c_client *client,
920 const struct i2c_device_id *dev_id)
923 struct i2c_hid *ihid;
924 struct hid_device *hid;
926 struct i2c_hid_platform_data *platform_data = client->dev.platform_data;
928 dbg_hid("HID probe called for i2c 0x%02x\n", client->addr);
931 dev_err(&client->dev,
932 "HID over i2c has not been provided an Int IRQ\n");
936 ihid = kzalloc(sizeof(struct i2c_hid), GFP_KERNEL);
940 if (client->dev.of_node) {
941 ret = i2c_hid_of_probe(client, &ihid->pdata);
944 } else if (!platform_data) {
945 ret = i2c_hid_acpi_pdata(client, &ihid->pdata);
947 dev_err(&client->dev,
948 "HID register address not provided\n");
952 ihid->pdata = *platform_data;
955 i2c_set_clientdata(client, ihid);
957 ihid->client = client;
959 hidRegister = ihid->pdata.hid_descriptor_address;
960 ihid->wHIDDescRegister = cpu_to_le16(hidRegister);
962 init_waitqueue_head(&ihid->wait);
964 /* we need to allocate the command buffer without knowing the maximum
965 * size of the reports. Let's use HID_MIN_BUFFER_SIZE, then we do the
966 * real computation later. */
967 ret = i2c_hid_alloc_buffers(ihid, HID_MIN_BUFFER_SIZE);
971 pm_runtime_get_noresume(&client->dev);
972 pm_runtime_set_active(&client->dev);
973 pm_runtime_enable(&client->dev);
975 ret = i2c_hid_fetch_hid_descriptor(ihid);
979 ret = i2c_hid_init_irq(client);
983 hid = hid_allocate_device();
991 hid->driver_data = client;
992 hid->ll_driver = &i2c_hid_ll_driver;
993 hid->dev.parent = &client->dev;
994 ACPI_COMPANION_SET(&hid->dev, ACPI_COMPANION(&client->dev));
996 hid->version = le16_to_cpu(ihid->hdesc.bcdVersion);
997 hid->vendor = le16_to_cpu(ihid->hdesc.wVendorID);
998 hid->product = le16_to_cpu(ihid->hdesc.wProductID);
1000 snprintf(hid->name, sizeof(hid->name), "%s %04hX:%04hX",
1001 client->name, hid->vendor, hid->product);
1003 ret = hid_add_device(hid);
1006 hid_err(client, "can't add hid device: %d\n", ret);
1010 pm_runtime_put(&client->dev);
1014 hid_destroy_device(hid);
1017 free_irq(client->irq, ihid);
1020 pm_runtime_put_noidle(&client->dev);
1021 pm_runtime_disable(&client->dev);
1024 i2c_hid_free_buffers(ihid);
1029 static int i2c_hid_remove(struct i2c_client *client)
1031 struct i2c_hid *ihid = i2c_get_clientdata(client);
1032 struct hid_device *hid;
1034 pm_runtime_get_sync(&client->dev);
1035 pm_runtime_disable(&client->dev);
1036 pm_runtime_set_suspended(&client->dev);
1037 pm_runtime_put_noidle(&client->dev);
1040 hid_destroy_device(hid);
1042 free_irq(client->irq, ihid);
1045 i2c_hid_free_buffers(ihid);
1052 #ifdef CONFIG_PM_SLEEP
1053 static int i2c_hid_suspend(struct device *dev)
1055 struct i2c_client *client = to_i2c_client(dev);
1056 struct i2c_hid *ihid = i2c_get_clientdata(client);
1057 struct hid_device *hid = ihid->hid;
1060 disable_irq(client->irq);
1061 if (device_may_wakeup(&client->dev))
1062 enable_irq_wake(client->irq);
1064 if (hid->driver && hid->driver->suspend)
1065 ret = hid->driver->suspend(hid, PMSG_SUSPEND);
1067 /* Save some power */
1068 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1073 static int i2c_hid_resume(struct device *dev)
1076 struct i2c_client *client = to_i2c_client(dev);
1077 struct i2c_hid *ihid = i2c_get_clientdata(client);
1078 struct hid_device *hid = ihid->hid;
1080 enable_irq(client->irq);
1081 ret = i2c_hid_hwreset(client);
1085 if (device_may_wakeup(&client->dev))
1086 disable_irq_wake(client->irq);
1088 if (hid->driver && hid->driver->reset_resume) {
1089 ret = hid->driver->reset_resume(hid);
1098 static int i2c_hid_runtime_suspend(struct device *dev)
1100 struct i2c_client *client = to_i2c_client(dev);
1102 i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
1103 disable_irq(client->irq);
1107 static int i2c_hid_runtime_resume(struct device *dev)
1109 struct i2c_client *client = to_i2c_client(dev);
1111 enable_irq(client->irq);
1112 i2c_hid_set_power(client, I2C_HID_PWR_ON);
1117 static const struct dev_pm_ops i2c_hid_pm = {
1118 SET_SYSTEM_SLEEP_PM_OPS(i2c_hid_suspend, i2c_hid_resume)
1119 SET_RUNTIME_PM_OPS(i2c_hid_runtime_suspend, i2c_hid_runtime_resume,
1123 static const struct i2c_device_id i2c_hid_id_table[] = {
1127 MODULE_DEVICE_TABLE(i2c, i2c_hid_id_table);
1130 static struct i2c_driver i2c_hid_driver = {
1133 .owner = THIS_MODULE,
1135 .acpi_match_table = ACPI_PTR(i2c_hid_acpi_match),
1136 .of_match_table = of_match_ptr(i2c_hid_of_match),
1139 .probe = i2c_hid_probe,
1140 .remove = i2c_hid_remove,
1142 .id_table = i2c_hid_id_table,
1145 module_i2c_driver(i2c_hid_driver);
1147 MODULE_DESCRIPTION("HID over I2C core driver");
1148 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
1149 MODULE_LICENSE("GPL");