]>
Commit | Line | Data |
---|---|---|
4a200c3b BT |
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/delay.h> | |
26 | #include <linux/slab.h> | |
27 | #include <linux/pm.h> | |
28 | #include <linux/device.h> | |
29 | #include <linux/wait.h> | |
30 | #include <linux/err.h> | |
31 | #include <linux/string.h> | |
32 | #include <linux/list.h> | |
33 | #include <linux/jiffies.h> | |
34 | #include <linux/kernel.h> | |
4a200c3b BT |
35 | #include <linux/hid.h> |
36 | ||
37 | #include <linux/i2c/i2c-hid.h> | |
38 | ||
39 | /* flags */ | |
40 | #define I2C_HID_STARTED (1 << 0) | |
41 | #define I2C_HID_RESET_PENDING (1 << 1) | |
42 | #define I2C_HID_READ_PENDING (1 << 2) | |
43 | ||
44 | #define I2C_HID_PWR_ON 0x00 | |
45 | #define I2C_HID_PWR_SLEEP 0x01 | |
46 | ||
47 | /* debug option */ | |
ee8e8806 | 48 | static bool debug; |
4a200c3b BT |
49 | module_param(debug, bool, 0444); |
50 | MODULE_PARM_DESC(debug, "print a lot of debug information"); | |
51 | ||
fa738644 BT |
52 | #define i2c_hid_dbg(ihid, fmt, arg...) \ |
53 | do { \ | |
54 | if (debug) \ | |
55 | dev_printk(KERN_DEBUG, &(ihid)->client->dev, fmt, ##arg); \ | |
56 | } while (0) | |
4a200c3b BT |
57 | |
58 | struct i2c_hid_desc { | |
59 | __le16 wHIDDescLength; | |
60 | __le16 bcdVersion; | |
61 | __le16 wReportDescLength; | |
62 | __le16 wReportDescRegister; | |
63 | __le16 wInputRegister; | |
64 | __le16 wMaxInputLength; | |
65 | __le16 wOutputRegister; | |
66 | __le16 wMaxOutputLength; | |
67 | __le16 wCommandRegister; | |
68 | __le16 wDataRegister; | |
69 | __le16 wVendorID; | |
70 | __le16 wProductID; | |
71 | __le16 wVersionID; | |
27174cff | 72 | __le32 reserved; |
4a200c3b BT |
73 | } __packed; |
74 | ||
75 | struct i2c_hid_cmd { | |
76 | unsigned int registerIndex; | |
77 | __u8 opcode; | |
78 | unsigned int length; | |
79 | bool wait; | |
80 | }; | |
81 | ||
82 | union command { | |
83 | u8 data[0]; | |
84 | struct cmd { | |
85 | __le16 reg; | |
86 | __u8 reportTypeID; | |
87 | __u8 opcode; | |
88 | } __packed c; | |
89 | }; | |
90 | ||
91 | #define I2C_HID_CMD(opcode_) \ | |
92 | .opcode = opcode_, .length = 4, \ | |
93 | .registerIndex = offsetof(struct i2c_hid_desc, wCommandRegister) | |
94 | ||
95 | /* fetch HID descriptor */ | |
96 | static const struct i2c_hid_cmd hid_descr_cmd = { .length = 2 }; | |
97 | /* fetch report descriptors */ | |
98 | static const struct i2c_hid_cmd hid_report_descr_cmd = { | |
99 | .registerIndex = offsetof(struct i2c_hid_desc, | |
100 | wReportDescRegister), | |
101 | .opcode = 0x00, | |
102 | .length = 2 }; | |
103 | /* commands */ | |
104 | static const struct i2c_hid_cmd hid_reset_cmd = { I2C_HID_CMD(0x01), | |
105 | .wait = true }; | |
106 | static const struct i2c_hid_cmd hid_get_report_cmd = { I2C_HID_CMD(0x02) }; | |
107 | static const struct i2c_hid_cmd hid_set_report_cmd = { I2C_HID_CMD(0x03) }; | |
4a200c3b | 108 | static const struct i2c_hid_cmd hid_set_power_cmd = { I2C_HID_CMD(0x08) }; |
6bf6c8bf BT |
109 | |
110 | /* | |
111 | * These definitions are not used here, but are defined by the spec. | |
112 | * Keeping them here for documentation purposes. | |
113 | * | |
114 | * static const struct i2c_hid_cmd hid_get_idle_cmd = { I2C_HID_CMD(0x04) }; | |
115 | * static const struct i2c_hid_cmd hid_set_idle_cmd = { I2C_HID_CMD(0x05) }; | |
116 | * static const struct i2c_hid_cmd hid_get_protocol_cmd = { I2C_HID_CMD(0x06) }; | |
117 | * static const struct i2c_hid_cmd hid_set_protocol_cmd = { I2C_HID_CMD(0x07) }; | |
118 | */ | |
4a200c3b BT |
119 | |
120 | /* The main device structure */ | |
121 | struct i2c_hid { | |
122 | struct i2c_client *client; /* i2c client */ | |
123 | struct hid_device *hid; /* pointer to corresponding HID dev */ | |
124 | union { | |
125 | __u8 hdesc_buffer[sizeof(struct i2c_hid_desc)]; | |
126 | struct i2c_hid_desc hdesc; /* the HID Descriptor */ | |
127 | }; | |
128 | __le16 wHIDDescRegister; /* location of the i2c | |
129 | * register of the HID | |
130 | * descriptor. */ | |
131 | unsigned int bufsize; /* i2c buffer size */ | |
132 | char *inbuf; /* Input buffer */ | |
133 | char *cmdbuf; /* Command buffer */ | |
134 | char *argsbuf; /* Command arguments buffer */ | |
135 | ||
136 | unsigned long flags; /* device flags */ | |
137 | ||
138 | int irq; /* the interrupt line irq */ | |
139 | ||
140 | wait_queue_head_t wait; /* For waiting the interrupt */ | |
141 | }; | |
142 | ||
143 | static int __i2c_hid_command(struct i2c_client *client, | |
144 | const struct i2c_hid_cmd *command, u8 reportID, | |
145 | u8 reportType, u8 *args, int args_len, | |
146 | unsigned char *buf_recv, int data_len) | |
147 | { | |
148 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
149 | union command *cmd = (union command *)ihid->cmdbuf; | |
150 | int ret; | |
151 | struct i2c_msg msg[2]; | |
152 | int msg_num = 1; | |
153 | ||
154 | int length = command->length; | |
155 | bool wait = command->wait; | |
156 | unsigned int registerIndex = command->registerIndex; | |
157 | ||
158 | /* special case for hid_descr_cmd */ | |
159 | if (command == &hid_descr_cmd) { | |
160 | cmd->c.reg = ihid->wHIDDescRegister; | |
161 | } else { | |
162 | cmd->data[0] = ihid->hdesc_buffer[registerIndex]; | |
163 | cmd->data[1] = ihid->hdesc_buffer[registerIndex + 1]; | |
164 | } | |
165 | ||
166 | if (length > 2) { | |
167 | cmd->c.opcode = command->opcode; | |
168 | cmd->c.reportTypeID = reportID | reportType << 4; | |
169 | } | |
170 | ||
171 | memcpy(cmd->data + length, args, args_len); | |
172 | length += args_len; | |
173 | ||
174 | i2c_hid_dbg(ihid, "%s: cmd=%*ph\n", __func__, length, cmd->data); | |
175 | ||
176 | msg[0].addr = client->addr; | |
177 | msg[0].flags = client->flags & I2C_M_TEN; | |
178 | msg[0].len = length; | |
179 | msg[0].buf = cmd->data; | |
180 | if (data_len > 0) { | |
181 | msg[1].addr = client->addr; | |
182 | msg[1].flags = client->flags & I2C_M_TEN; | |
183 | msg[1].flags |= I2C_M_RD; | |
184 | msg[1].len = data_len; | |
185 | msg[1].buf = buf_recv; | |
186 | msg_num = 2; | |
187 | set_bit(I2C_HID_READ_PENDING, &ihid->flags); | |
188 | } | |
189 | ||
190 | if (wait) | |
191 | set_bit(I2C_HID_RESET_PENDING, &ihid->flags); | |
192 | ||
193 | ret = i2c_transfer(client->adapter, msg, msg_num); | |
194 | ||
195 | if (data_len > 0) | |
196 | clear_bit(I2C_HID_READ_PENDING, &ihid->flags); | |
197 | ||
198 | if (ret != msg_num) | |
199 | return ret < 0 ? ret : -EIO; | |
200 | ||
201 | ret = 0; | |
202 | ||
203 | if (wait) { | |
204 | i2c_hid_dbg(ihid, "%s: waiting...\n", __func__); | |
205 | if (!wait_event_timeout(ihid->wait, | |
206 | !test_bit(I2C_HID_RESET_PENDING, &ihid->flags), | |
207 | msecs_to_jiffies(5000))) | |
208 | ret = -ENODATA; | |
209 | i2c_hid_dbg(ihid, "%s: finished.\n", __func__); | |
210 | } | |
211 | ||
212 | return ret; | |
213 | } | |
214 | ||
215 | static int i2c_hid_command(struct i2c_client *client, | |
216 | const struct i2c_hid_cmd *command, | |
217 | unsigned char *buf_recv, int data_len) | |
218 | { | |
219 | return __i2c_hid_command(client, command, 0, 0, NULL, 0, | |
220 | buf_recv, data_len); | |
221 | } | |
222 | ||
223 | static int i2c_hid_get_report(struct i2c_client *client, u8 reportType, | |
224 | u8 reportID, unsigned char *buf_recv, int data_len) | |
225 | { | |
226 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
227 | u8 args[3]; | |
228 | int ret; | |
229 | int args_len = 0; | |
230 | u16 readRegister = le16_to_cpu(ihid->hdesc.wDataRegister); | |
231 | ||
232 | i2c_hid_dbg(ihid, "%s\n", __func__); | |
233 | ||
234 | if (reportID >= 0x0F) { | |
235 | args[args_len++] = reportID; | |
236 | reportID = 0x0F; | |
237 | } | |
238 | ||
239 | args[args_len++] = readRegister & 0xFF; | |
240 | args[args_len++] = readRegister >> 8; | |
241 | ||
242 | ret = __i2c_hid_command(client, &hid_get_report_cmd, reportID, | |
243 | reportType, args, args_len, buf_recv, data_len); | |
244 | if (ret) { | |
245 | dev_err(&client->dev, | |
246 | "failed to retrieve report from device.\n"); | |
317b204a | 247 | return ret; |
4a200c3b BT |
248 | } |
249 | ||
250 | return 0; | |
251 | } | |
252 | ||
253 | static int i2c_hid_set_report(struct i2c_client *client, u8 reportType, | |
254 | u8 reportID, unsigned char *buf, size_t data_len) | |
255 | { | |
256 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
257 | u8 *args = ihid->argsbuf; | |
258 | int ret; | |
259 | u16 dataRegister = le16_to_cpu(ihid->hdesc.wDataRegister); | |
260 | ||
261 | /* hidraw already checked that data_len < HID_MAX_BUFFER_SIZE */ | |
262 | u16 size = 2 /* size */ + | |
263 | (reportID ? 1 : 0) /* reportID */ + | |
264 | data_len /* buf */; | |
265 | int args_len = (reportID >= 0x0F ? 1 : 0) /* optional third byte */ + | |
266 | 2 /* dataRegister */ + | |
267 | size /* args */; | |
268 | int index = 0; | |
269 | ||
270 | i2c_hid_dbg(ihid, "%s\n", __func__); | |
271 | ||
272 | if (reportID >= 0x0F) { | |
273 | args[index++] = reportID; | |
274 | reportID = 0x0F; | |
275 | } | |
276 | ||
277 | args[index++] = dataRegister & 0xFF; | |
278 | args[index++] = dataRegister >> 8; | |
279 | ||
280 | args[index++] = size & 0xFF; | |
281 | args[index++] = size >> 8; | |
282 | ||
283 | if (reportID) | |
284 | args[index++] = reportID; | |
285 | ||
286 | memcpy(&args[index], buf, data_len); | |
287 | ||
288 | ret = __i2c_hid_command(client, &hid_set_report_cmd, reportID, | |
289 | reportType, args, args_len, NULL, 0); | |
290 | if (ret) { | |
291 | dev_err(&client->dev, "failed to set a report to device.\n"); | |
317b204a | 292 | return ret; |
4a200c3b BT |
293 | } |
294 | ||
295 | return data_len; | |
296 | } | |
297 | ||
298 | static int i2c_hid_set_power(struct i2c_client *client, int power_state) | |
299 | { | |
300 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
301 | int ret; | |
302 | ||
303 | i2c_hid_dbg(ihid, "%s\n", __func__); | |
304 | ||
305 | ret = __i2c_hid_command(client, &hid_set_power_cmd, power_state, | |
306 | 0, NULL, 0, NULL, 0); | |
307 | if (ret) | |
308 | dev_err(&client->dev, "failed to change power setting.\n"); | |
309 | ||
310 | return ret; | |
311 | } | |
312 | ||
313 | static int i2c_hid_hwreset(struct i2c_client *client) | |
314 | { | |
315 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
316 | int ret; | |
317 | ||
318 | i2c_hid_dbg(ihid, "%s\n", __func__); | |
319 | ||
320 | ret = i2c_hid_set_power(client, I2C_HID_PWR_ON); | |
321 | if (ret) | |
322 | return ret; | |
323 | ||
324 | i2c_hid_dbg(ihid, "resetting...\n"); | |
325 | ||
326 | ret = i2c_hid_command(client, &hid_reset_cmd, NULL, 0); | |
327 | if (ret) { | |
328 | dev_err(&client->dev, "failed to reset device.\n"); | |
329 | i2c_hid_set_power(client, I2C_HID_PWR_SLEEP); | |
330 | return ret; | |
331 | } | |
332 | ||
333 | return 0; | |
334 | } | |
335 | ||
317b204a | 336 | static void i2c_hid_get_input(struct i2c_hid *ihid) |
4a200c3b BT |
337 | { |
338 | int ret, ret_size; | |
339 | int size = le16_to_cpu(ihid->hdesc.wMaxInputLength); | |
340 | ||
341 | ret = i2c_master_recv(ihid->client, ihid->inbuf, size); | |
342 | if (ret != size) { | |
343 | if (ret < 0) | |
317b204a | 344 | return; |
4a200c3b BT |
345 | |
346 | dev_err(&ihid->client->dev, "%s: got %d data instead of %d\n", | |
347 | __func__, ret, size); | |
317b204a | 348 | return; |
4a200c3b BT |
349 | } |
350 | ||
351 | ret_size = ihid->inbuf[0] | ihid->inbuf[1] << 8; | |
352 | ||
353 | if (!ret_size) { | |
354 | /* host or device initiated RESET completed */ | |
355 | if (test_and_clear_bit(I2C_HID_RESET_PENDING, &ihid->flags)) | |
356 | wake_up(&ihid->wait); | |
317b204a | 357 | return; |
4a200c3b BT |
358 | } |
359 | ||
360 | if (ret_size > size) { | |
361 | dev_err(&ihid->client->dev, "%s: incomplete report (%d/%d)\n", | |
362 | __func__, size, ret_size); | |
317b204a | 363 | return; |
4a200c3b BT |
364 | } |
365 | ||
366 | i2c_hid_dbg(ihid, "input: %*ph\n", ret_size, ihid->inbuf); | |
367 | ||
368 | if (test_bit(I2C_HID_STARTED, &ihid->flags)) | |
369 | hid_input_report(ihid->hid, HID_INPUT_REPORT, ihid->inbuf + 2, | |
370 | ret_size - 2, 1); | |
371 | ||
317b204a | 372 | return; |
4a200c3b BT |
373 | } |
374 | ||
375 | static irqreturn_t i2c_hid_irq(int irq, void *dev_id) | |
376 | { | |
377 | struct i2c_hid *ihid = dev_id; | |
378 | ||
379 | if (test_bit(I2C_HID_READ_PENDING, &ihid->flags)) | |
380 | return IRQ_HANDLED; | |
381 | ||
382 | i2c_hid_get_input(ihid); | |
383 | ||
384 | return IRQ_HANDLED; | |
385 | } | |
386 | ||
387 | static int i2c_hid_get_report_length(struct hid_report *report) | |
388 | { | |
389 | return ((report->size - 1) >> 3) + 1 + | |
390 | report->device->report_enum[report->type].numbered + 2; | |
391 | } | |
392 | ||
393 | static void i2c_hid_init_report(struct hid_report *report, u8 *buffer, | |
394 | size_t bufsize) | |
395 | { | |
396 | struct hid_device *hid = report->device; | |
397 | struct i2c_client *client = hid->driver_data; | |
398 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
399 | unsigned int size, ret_size; | |
400 | ||
401 | size = i2c_hid_get_report_length(report); | |
c737bcf9 | 402 | if (i2c_hid_get_report(client, |
4a200c3b | 403 | report->type == HID_FEATURE_REPORT ? 0x03 : 0x01, |
c737bcf9 BT |
404 | report->id, buffer, size)) |
405 | return; | |
4a200c3b BT |
406 | |
407 | i2c_hid_dbg(ihid, "report (len=%d): %*ph\n", size, size, ihid->inbuf); | |
408 | ||
409 | ret_size = buffer[0] | (buffer[1] << 8); | |
410 | ||
411 | if (ret_size != size) { | |
412 | dev_err(&client->dev, "error in %s size:%d / ret_size:%d\n", | |
413 | __func__, size, ret_size); | |
414 | return; | |
415 | } | |
416 | ||
417 | /* hid->driver_lock is held as we are in probe function, | |
418 | * we just need to setup the input fields, so using | |
419 | * hid_report_raw_event is safe. */ | |
420 | hid_report_raw_event(hid, report->type, buffer + 2, size - 2, 1); | |
421 | } | |
422 | ||
423 | /* | |
424 | * Initialize all reports | |
425 | */ | |
426 | static void i2c_hid_init_reports(struct hid_device *hid) | |
427 | { | |
428 | struct hid_report *report; | |
429 | struct i2c_client *client = hid->driver_data; | |
430 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
431 | u8 *inbuf = kzalloc(ihid->bufsize, GFP_KERNEL); | |
432 | ||
317b204a BT |
433 | if (!inbuf) { |
434 | dev_err(&client->dev, "can not retrieve initial reports\n"); | |
4a200c3b | 435 | return; |
317b204a | 436 | } |
4a200c3b BT |
437 | |
438 | list_for_each_entry(report, | |
439 | &hid->report_enum[HID_INPUT_REPORT].report_list, list) | |
440 | i2c_hid_init_report(report, inbuf, ihid->bufsize); | |
441 | ||
442 | list_for_each_entry(report, | |
443 | &hid->report_enum[HID_FEATURE_REPORT].report_list, list) | |
444 | i2c_hid_init_report(report, inbuf, ihid->bufsize); | |
445 | ||
446 | kfree(inbuf); | |
447 | } | |
448 | ||
449 | /* | |
450 | * Traverse the supplied list of reports and find the longest | |
451 | */ | |
452 | static void i2c_hid_find_max_report(struct hid_device *hid, unsigned int type, | |
453 | unsigned int *max) | |
454 | { | |
455 | struct hid_report *report; | |
456 | unsigned int size; | |
457 | ||
458 | /* We should not rely on wMaxInputLength, as some devices may set it to | |
459 | * a wrong length. */ | |
460 | list_for_each_entry(report, &hid->report_enum[type].report_list, list) { | |
461 | size = i2c_hid_get_report_length(report); | |
462 | if (*max < size) | |
463 | *max = size; | |
464 | } | |
465 | } | |
466 | ||
467 | static int i2c_hid_alloc_buffers(struct i2c_hid *ihid) | |
468 | { | |
469 | /* the worst case is computed from the set_report command with a | |
470 | * reportID > 15 and the maximum report length */ | |
471 | int args_len = sizeof(__u8) + /* optional ReportID byte */ | |
472 | sizeof(__u16) + /* data register */ | |
473 | sizeof(__u16) + /* size of the report */ | |
474 | ihid->bufsize; /* report */ | |
475 | ||
476 | ihid->inbuf = kzalloc(ihid->bufsize, GFP_KERNEL); | |
477 | ||
478 | if (!ihid->inbuf) | |
479 | return -ENOMEM; | |
480 | ||
481 | ihid->argsbuf = kzalloc(args_len, GFP_KERNEL); | |
482 | ||
483 | if (!ihid->argsbuf) { | |
484 | kfree(ihid->inbuf); | |
485 | return -ENOMEM; | |
486 | } | |
487 | ||
488 | ihid->cmdbuf = kzalloc(sizeof(union command) + args_len, GFP_KERNEL); | |
489 | ||
490 | if (!ihid->cmdbuf) { | |
491 | kfree(ihid->inbuf); | |
492 | kfree(ihid->argsbuf); | |
493 | ihid->inbuf = NULL; | |
494 | ihid->argsbuf = NULL; | |
495 | return -ENOMEM; | |
496 | } | |
497 | ||
498 | return 0; | |
499 | } | |
500 | ||
501 | static void i2c_hid_free_buffers(struct i2c_hid *ihid) | |
502 | { | |
503 | kfree(ihid->inbuf); | |
504 | kfree(ihid->argsbuf); | |
505 | kfree(ihid->cmdbuf); | |
506 | ihid->inbuf = NULL; | |
507 | ihid->cmdbuf = NULL; | |
508 | ihid->argsbuf = NULL; | |
509 | } | |
510 | ||
511 | static int i2c_hid_get_raw_report(struct hid_device *hid, | |
512 | unsigned char report_number, __u8 *buf, size_t count, | |
513 | unsigned char report_type) | |
514 | { | |
515 | struct i2c_client *client = hid->driver_data; | |
516 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
517 | int ret; | |
518 | ||
519 | if (report_type == HID_OUTPUT_REPORT) | |
520 | return -EINVAL; | |
521 | ||
522 | if (count > ihid->bufsize) | |
523 | count = ihid->bufsize; | |
524 | ||
525 | ret = i2c_hid_get_report(client, | |
526 | report_type == HID_FEATURE_REPORT ? 0x03 : 0x01, | |
527 | report_number, ihid->inbuf, count); | |
528 | ||
529 | if (ret < 0) | |
530 | return ret; | |
531 | ||
532 | count = ihid->inbuf[0] | (ihid->inbuf[1] << 8); | |
533 | ||
534 | memcpy(buf, ihid->inbuf + 2, count); | |
535 | ||
536 | return count; | |
537 | } | |
538 | ||
539 | static int i2c_hid_output_raw_report(struct hid_device *hid, __u8 *buf, | |
540 | size_t count, unsigned char report_type) | |
541 | { | |
542 | struct i2c_client *client = hid->driver_data; | |
543 | int report_id = buf[0]; | |
544 | ||
545 | if (report_type == HID_INPUT_REPORT) | |
546 | return -EINVAL; | |
547 | ||
548 | return i2c_hid_set_report(client, | |
549 | report_type == HID_FEATURE_REPORT ? 0x03 : 0x02, | |
550 | report_id, buf, count); | |
551 | } | |
552 | ||
553 | static int i2c_hid_parse(struct hid_device *hid) | |
554 | { | |
555 | struct i2c_client *client = hid->driver_data; | |
556 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
557 | struct i2c_hid_desc *hdesc = &ihid->hdesc; | |
558 | unsigned int rsize; | |
559 | char *rdesc; | |
560 | int ret; | |
561 | int tries = 3; | |
562 | ||
563 | i2c_hid_dbg(ihid, "entering %s\n", __func__); | |
564 | ||
565 | rsize = le16_to_cpu(hdesc->wReportDescLength); | |
566 | if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) { | |
567 | dbg_hid("weird size of report descriptor (%u)\n", rsize); | |
568 | return -EINVAL; | |
569 | } | |
570 | ||
571 | do { | |
572 | ret = i2c_hid_hwreset(client); | |
573 | if (ret) | |
574 | msleep(1000); | |
575 | } while (tries-- > 0 && ret); | |
576 | ||
577 | if (ret) | |
578 | return ret; | |
579 | ||
580 | rdesc = kzalloc(rsize, GFP_KERNEL); | |
581 | ||
582 | if (!rdesc) { | |
583 | dbg_hid("couldn't allocate rdesc memory\n"); | |
584 | return -ENOMEM; | |
585 | } | |
586 | ||
587 | i2c_hid_dbg(ihid, "asking HID report descriptor\n"); | |
588 | ||
589 | ret = i2c_hid_command(client, &hid_report_descr_cmd, rdesc, rsize); | |
590 | if (ret) { | |
591 | hid_err(hid, "reading report descriptor failed\n"); | |
592 | kfree(rdesc); | |
593 | return -EIO; | |
594 | } | |
595 | ||
596 | i2c_hid_dbg(ihid, "Report Descriptor: %*ph\n", rsize, rdesc); | |
597 | ||
598 | ret = hid_parse_report(hid, rdesc, rsize); | |
599 | kfree(rdesc); | |
600 | if (ret) { | |
601 | dbg_hid("parsing report descriptor failed\n"); | |
602 | return ret; | |
603 | } | |
604 | ||
605 | return 0; | |
606 | } | |
607 | ||
608 | static int i2c_hid_start(struct hid_device *hid) | |
609 | { | |
610 | struct i2c_client *client = hid->driver_data; | |
611 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
612 | int ret; | |
613 | int old_bufsize = ihid->bufsize; | |
614 | ||
615 | ihid->bufsize = HID_MIN_BUFFER_SIZE; | |
616 | i2c_hid_find_max_report(hid, HID_INPUT_REPORT, &ihid->bufsize); | |
617 | i2c_hid_find_max_report(hid, HID_OUTPUT_REPORT, &ihid->bufsize); | |
618 | i2c_hid_find_max_report(hid, HID_FEATURE_REPORT, &ihid->bufsize); | |
619 | ||
620 | if (ihid->bufsize > old_bufsize || !ihid->inbuf || !ihid->cmdbuf) { | |
621 | i2c_hid_free_buffers(ihid); | |
622 | ||
623 | ret = i2c_hid_alloc_buffers(ihid); | |
624 | ||
625 | if (ret) { | |
626 | ihid->bufsize = old_bufsize; | |
627 | return ret; | |
628 | } | |
629 | } | |
630 | ||
631 | if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS)) | |
632 | i2c_hid_init_reports(hid); | |
633 | ||
634 | return 0; | |
635 | } | |
636 | ||
637 | static void i2c_hid_stop(struct hid_device *hid) | |
638 | { | |
639 | struct i2c_client *client = hid->driver_data; | |
640 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
641 | ||
642 | hid->claimed = 0; | |
643 | ||
644 | i2c_hid_free_buffers(ihid); | |
645 | } | |
646 | ||
647 | static int i2c_hid_open(struct hid_device *hid) | |
648 | { | |
649 | struct i2c_client *client = hid->driver_data; | |
650 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
651 | int ret; | |
652 | ||
653 | if (!hid->open++) { | |
654 | ret = i2c_hid_set_power(client, I2C_HID_PWR_ON); | |
655 | if (ret) { | |
656 | hid->open--; | |
657 | return -EIO; | |
658 | } | |
659 | set_bit(I2C_HID_STARTED, &ihid->flags); | |
660 | } | |
661 | return 0; | |
662 | } | |
663 | ||
664 | static void i2c_hid_close(struct hid_device *hid) | |
665 | { | |
666 | struct i2c_client *client = hid->driver_data; | |
667 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
668 | ||
669 | /* protecting hid->open to make sure we don't restart | |
670 | * data acquistion due to a resumption we no longer | |
671 | * care about | |
672 | */ | |
673 | if (!--hid->open) { | |
674 | clear_bit(I2C_HID_STARTED, &ihid->flags); | |
675 | ||
676 | /* Save some power */ | |
677 | i2c_hid_set_power(client, I2C_HID_PWR_SLEEP); | |
678 | } | |
679 | } | |
680 | ||
681 | static int i2c_hid_power(struct hid_device *hid, int lvl) | |
682 | { | |
683 | struct i2c_client *client = hid->driver_data; | |
684 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
685 | int ret = 0; | |
686 | ||
687 | i2c_hid_dbg(ihid, "%s lvl:%d\n", __func__, lvl); | |
688 | ||
689 | switch (lvl) { | |
690 | case PM_HINT_FULLON: | |
691 | ret = i2c_hid_set_power(client, I2C_HID_PWR_ON); | |
692 | break; | |
693 | case PM_HINT_NORMAL: | |
694 | ret = i2c_hid_set_power(client, I2C_HID_PWR_SLEEP); | |
695 | break; | |
696 | } | |
697 | return ret; | |
698 | } | |
699 | ||
700 | static int i2c_hid_hidinput_input_event(struct input_dev *dev, | |
701 | unsigned int type, unsigned int code, int value) | |
702 | { | |
703 | struct hid_device *hid = input_get_drvdata(dev); | |
704 | struct hid_field *field; | |
705 | int offset; | |
706 | ||
707 | if (type == EV_FF) | |
708 | return input_ff_event(dev, type, code, value); | |
709 | ||
710 | if (type != EV_LED) | |
711 | return -1; | |
712 | ||
713 | offset = hidinput_find_field(hid, type, code, &field); | |
714 | ||
715 | if (offset == -1) { | |
716 | hid_warn(dev, "event field not found\n"); | |
717 | return -1; | |
718 | } | |
719 | ||
317b204a | 720 | return hid_set_field(field, offset, value); |
4a200c3b BT |
721 | } |
722 | ||
723 | static struct hid_ll_driver i2c_hid_ll_driver = { | |
724 | .parse = i2c_hid_parse, | |
725 | .start = i2c_hid_start, | |
726 | .stop = i2c_hid_stop, | |
727 | .open = i2c_hid_open, | |
728 | .close = i2c_hid_close, | |
729 | .power = i2c_hid_power, | |
730 | .hidinput_input_event = i2c_hid_hidinput_input_event, | |
731 | }; | |
732 | ||
733 | static int __devinit i2c_hid_init_irq(struct i2c_client *client) | |
734 | { | |
735 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
736 | int ret; | |
737 | ||
738 | dev_dbg(&client->dev, "Requesting IRQ: %d\n", client->irq); | |
739 | ||
740 | ret = request_threaded_irq(client->irq, NULL, i2c_hid_irq, | |
741 | IRQF_TRIGGER_FALLING | IRQF_ONESHOT, | |
742 | client->name, ihid); | |
743 | if (ret < 0) { | |
9972dcc2 | 744 | dev_warn(&client->dev, |
4a200c3b BT |
745 | "Could not register for %s interrupt, irq = %d," |
746 | " ret = %d\n", | |
9972dcc2 | 747 | client->name, client->irq, ret); |
4a200c3b BT |
748 | |
749 | return ret; | |
750 | } | |
751 | ||
752 | ihid->irq = client->irq; | |
753 | ||
754 | return 0; | |
755 | } | |
756 | ||
757 | static int __devinit i2c_hid_fetch_hid_descriptor(struct i2c_hid *ihid) | |
758 | { | |
759 | struct i2c_client *client = ihid->client; | |
760 | struct i2c_hid_desc *hdesc = &ihid->hdesc; | |
761 | unsigned int dsize; | |
762 | int ret; | |
763 | ||
764 | /* Fetch the length of HID description, retrieve the 4 first bytes: | |
765 | * bytes 0-1 -> length | |
766 | * bytes 2-3 -> bcdVersion (has to be 1.00) */ | |
767 | ret = i2c_hid_command(client, &hid_descr_cmd, ihid->hdesc_buffer, 4); | |
768 | ||
769 | i2c_hid_dbg(ihid, "%s, ihid->hdesc_buffer: %*ph\n", | |
770 | __func__, 4, ihid->hdesc_buffer); | |
771 | ||
772 | if (ret) { | |
9972dcc2 BT |
773 | dev_err(&client->dev, |
774 | "unable to fetch the size of HID descriptor (ret=%d)\n", | |
4a200c3b BT |
775 | ret); |
776 | return -ENODEV; | |
777 | } | |
778 | ||
779 | dsize = le16_to_cpu(hdesc->wHIDDescLength); | |
27174cff BT |
780 | /* |
781 | * the size of the HID descriptor should at least contain | |
782 | * its size and the bcdVersion (4 bytes), and should not be greater | |
783 | * than sizeof(struct i2c_hid_desc) as we directly fill this struct | |
784 | * through i2c_hid_command. | |
785 | */ | |
786 | if (dsize < 4 || dsize > sizeof(struct i2c_hid_desc)) { | |
4a200c3b BT |
787 | dev_err(&client->dev, "weird size of HID descriptor (%u)\n", |
788 | dsize); | |
789 | return -ENODEV; | |
790 | } | |
791 | ||
792 | /* check bcdVersion == 1.0 */ | |
793 | if (le16_to_cpu(hdesc->bcdVersion) != 0x0100) { | |
794 | dev_err(&client->dev, | |
9972dcc2 | 795 | "unexpected HID descriptor bcdVersion (0x%04hx)\n", |
4a200c3b BT |
796 | le16_to_cpu(hdesc->bcdVersion)); |
797 | return -ENODEV; | |
798 | } | |
799 | ||
800 | i2c_hid_dbg(ihid, "Fetching the HID descriptor\n"); | |
801 | ||
802 | ret = i2c_hid_command(client, &hid_descr_cmd, ihid->hdesc_buffer, | |
803 | dsize); | |
804 | if (ret) { | |
805 | dev_err(&client->dev, "hid_descr_cmd Fail\n"); | |
806 | return -ENODEV; | |
807 | } | |
808 | ||
809 | i2c_hid_dbg(ihid, "HID Descriptor: %*ph\n", dsize, ihid->hdesc_buffer); | |
810 | ||
811 | return 0; | |
812 | } | |
813 | ||
814 | static int __devinit i2c_hid_probe(struct i2c_client *client, | |
815 | const struct i2c_device_id *dev_id) | |
816 | { | |
817 | int ret; | |
818 | struct i2c_hid *ihid; | |
819 | struct hid_device *hid; | |
820 | __u16 hidRegister; | |
821 | struct i2c_hid_platform_data *platform_data = client->dev.platform_data; | |
822 | ||
823 | dbg_hid("HID probe called for i2c 0x%02x\n", client->addr); | |
824 | ||
825 | if (!platform_data) { | |
826 | dev_err(&client->dev, "HID register address not provided\n"); | |
827 | return -EINVAL; | |
828 | } | |
829 | ||
830 | if (!client->irq) { | |
831 | dev_err(&client->dev, | |
832 | "HID over i2c has not been provided an Int IRQ\n"); | |
833 | return -EINVAL; | |
834 | } | |
835 | ||
836 | ihid = kzalloc(sizeof(struct i2c_hid), GFP_KERNEL); | |
837 | if (!ihid) | |
838 | return -ENOMEM; | |
839 | ||
840 | i2c_set_clientdata(client, ihid); | |
841 | ||
842 | ihid->client = client; | |
843 | ||
844 | hidRegister = platform_data->hid_descriptor_address; | |
845 | ihid->wHIDDescRegister = cpu_to_le16(hidRegister); | |
846 | ||
847 | init_waitqueue_head(&ihid->wait); | |
848 | ||
849 | /* we need to allocate the command buffer without knowing the maximum | |
850 | * size of the reports. Let's use HID_MIN_BUFFER_SIZE, then we do the | |
851 | * real computation later. */ | |
852 | ihid->bufsize = HID_MIN_BUFFER_SIZE; | |
853 | i2c_hid_alloc_buffers(ihid); | |
854 | ||
855 | ret = i2c_hid_fetch_hid_descriptor(ihid); | |
856 | if (ret < 0) | |
857 | goto err; | |
858 | ||
859 | ret = i2c_hid_init_irq(client); | |
860 | if (ret < 0) | |
861 | goto err; | |
862 | ||
863 | hid = hid_allocate_device(); | |
864 | if (IS_ERR(hid)) { | |
865 | ret = PTR_ERR(hid); | |
866 | goto err; | |
867 | } | |
868 | ||
869 | ihid->hid = hid; | |
870 | ||
871 | hid->driver_data = client; | |
872 | hid->ll_driver = &i2c_hid_ll_driver; | |
873 | hid->hid_get_raw_report = i2c_hid_get_raw_report; | |
874 | hid->hid_output_raw_report = i2c_hid_output_raw_report; | |
875 | hid->dev.parent = &client->dev; | |
876 | hid->bus = BUS_I2C; | |
877 | hid->version = le16_to_cpu(ihid->hdesc.bcdVersion); | |
878 | hid->vendor = le16_to_cpu(ihid->hdesc.wVendorID); | |
879 | hid->product = le16_to_cpu(ihid->hdesc.wProductID); | |
880 | ||
9972dcc2 | 881 | snprintf(hid->name, sizeof(hid->name), "%s %04hX:%04hX", |
4a200c3b BT |
882 | client->name, hid->vendor, hid->product); |
883 | ||
884 | ret = hid_add_device(hid); | |
885 | if (ret) { | |
886 | if (ret != -ENODEV) | |
887 | hid_err(client, "can't add hid device: %d\n", ret); | |
888 | goto err_mem_free; | |
889 | } | |
890 | ||
891 | return 0; | |
892 | ||
893 | err_mem_free: | |
894 | hid_destroy_device(hid); | |
895 | ||
896 | err: | |
897 | if (ihid->irq) | |
898 | free_irq(ihid->irq, ihid); | |
899 | ||
3c626024 | 900 | i2c_hid_free_buffers(ihid); |
4a200c3b BT |
901 | kfree(ihid); |
902 | return ret; | |
903 | } | |
904 | ||
905 | static int __devexit i2c_hid_remove(struct i2c_client *client) | |
906 | { | |
907 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
908 | struct hid_device *hid; | |
909 | ||
4a200c3b BT |
910 | hid = ihid->hid; |
911 | hid_destroy_device(hid); | |
912 | ||
913 | free_irq(client->irq, ihid); | |
914 | ||
134ebfd8 BT |
915 | if (ihid->bufsize) |
916 | i2c_hid_free_buffers(ihid); | |
917 | ||
4a200c3b BT |
918 | kfree(ihid); |
919 | ||
920 | return 0; | |
921 | } | |
922 | ||
923 | #ifdef CONFIG_PM_SLEEP | |
924 | static int i2c_hid_suspend(struct device *dev) | |
925 | { | |
926 | struct i2c_client *client = to_i2c_client(dev); | |
927 | struct i2c_hid *ihid = i2c_get_clientdata(client); | |
928 | ||
929 | if (device_may_wakeup(&client->dev)) | |
930 | enable_irq_wake(ihid->irq); | |
931 | ||
932 | /* Save some power */ | |
933 | i2c_hid_set_power(client, I2C_HID_PWR_SLEEP); | |
934 | ||
935 | return 0; | |
936 | } | |
937 | ||
938 | static int i2c_hid_resume(struct device *dev) | |
939 | { | |
940 | int ret; | |
941 | struct i2c_client *client = to_i2c_client(dev); | |
942 | ||
943 | ret = i2c_hid_hwreset(client); | |
944 | if (ret) | |
945 | return ret; | |
946 | ||
947 | if (device_may_wakeup(&client->dev)) | |
948 | disable_irq_wake(client->irq); | |
949 | ||
950 | return 0; | |
951 | } | |
952 | #endif | |
953 | ||
954 | static SIMPLE_DEV_PM_OPS(i2c_hid_pm, i2c_hid_suspend, i2c_hid_resume); | |
955 | ||
956 | static const struct i2c_device_id i2c_hid_id_table[] = { | |
24ebb37e | 957 | { "hid", 0 }, |
4a200c3b BT |
958 | { }, |
959 | }; | |
960 | MODULE_DEVICE_TABLE(i2c, i2c_hid_id_table); | |
961 | ||
962 | ||
963 | static struct i2c_driver i2c_hid_driver = { | |
964 | .driver = { | |
965 | .name = "i2c_hid", | |
966 | .owner = THIS_MODULE, | |
967 | .pm = &i2c_hid_pm, | |
968 | }, | |
969 | ||
970 | .probe = i2c_hid_probe, | |
971 | .remove = __devexit_p(i2c_hid_remove), | |
972 | ||
973 | .id_table = i2c_hid_id_table, | |
974 | }; | |
975 | ||
976 | module_i2c_driver(i2c_hid_driver); | |
977 | ||
978 | MODULE_DESCRIPTION("HID over I2C core driver"); | |
979 | MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>"); | |
980 | MODULE_LICENSE("GPL"); |