Commit | Line | Data |
---|---|---|
534a7b8e NLC |
1 | /* |
2 | * HID driver for Logitech Unifying receivers | |
3 | * | |
4 | * Copyright (c) 2011 Logitech | |
5 | */ | |
6 | ||
7 | /* | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License version 2 as | |
10 | * published by the Free Software Foundation. | |
11 | ||
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program; if not, write to the Free Software | |
20 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 | * | |
22 | */ | |
23 | ||
24 | ||
25 | #include <linux/device.h> | |
26 | #include <linux/hid.h> | |
27 | #include <linux/module.h> | |
28 | #include <linux/usb.h> | |
44d27f7d | 29 | #include <asm/unaligned.h> |
534a7b8e NLC |
30 | #include "usbhid/usbhid.h" |
31 | #include "hid-ids.h" | |
32 | #include "hid-logitech-dj.h" | |
33 | ||
34 | /* Keyboard descriptor (1) */ | |
35 | static const char kbd_descriptor[] = { | |
36 | 0x05, 0x01, /* USAGE_PAGE (generic Desktop) */ | |
37 | 0x09, 0x06, /* USAGE (Keyboard) */ | |
38 | 0xA1, 0x01, /* COLLECTION (Application) */ | |
39 | 0x85, 0x01, /* REPORT_ID (1) */ | |
40 | 0x95, 0x08, /* REPORT_COUNT (8) */ | |
41 | 0x75, 0x01, /* REPORT_SIZE (1) */ | |
42 | 0x15, 0x00, /* LOGICAL_MINIMUM (0) */ | |
43 | 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ | |
44 | 0x05, 0x07, /* USAGE_PAGE (Keyboard) */ | |
45 | 0x19, 0xE0, /* USAGE_MINIMUM (Left Control) */ | |
46 | 0x29, 0xE7, /* USAGE_MAXIMUM (Right GUI) */ | |
47 | 0x81, 0x02, /* INPUT (Data,Var,Abs) */ | |
48 | 0x95, 0x05, /* REPORT COUNT (5) */ | |
49 | 0x05, 0x08, /* USAGE PAGE (LED page) */ | |
50 | 0x19, 0x01, /* USAGE MINIMUM (1) */ | |
51 | 0x29, 0x05, /* USAGE MAXIMUM (5) */ | |
52 | 0x91, 0x02, /* OUTPUT (Data, Variable, Absolute) */ | |
53 | 0x95, 0x01, /* REPORT COUNT (1) */ | |
54 | 0x75, 0x03, /* REPORT SIZE (3) */ | |
55 | 0x91, 0x01, /* OUTPUT (Constant) */ | |
56 | 0x95, 0x06, /* REPORT_COUNT (6) */ | |
57 | 0x75, 0x08, /* REPORT_SIZE (8) */ | |
58 | 0x15, 0x00, /* LOGICAL_MINIMUM (0) */ | |
59 | 0x26, 0xFF, 0x00, /* LOGICAL_MAXIMUM (255) */ | |
60 | 0x05, 0x07, /* USAGE_PAGE (Keyboard) */ | |
61 | 0x19, 0x00, /* USAGE_MINIMUM (no event) */ | |
62 | 0x2A, 0xFF, 0x00, /* USAGE_MAXIMUM (reserved) */ | |
63 | 0x81, 0x00, /* INPUT (Data,Ary,Abs) */ | |
64 | 0xC0 | |
65 | }; | |
66 | ||
67 | /* Mouse descriptor (2) */ | |
68 | static const char mse_descriptor[] = { | |
69 | 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ | |
70 | 0x09, 0x02, /* USAGE (Mouse) */ | |
71 | 0xA1, 0x01, /* COLLECTION (Application) */ | |
72 | 0x85, 0x02, /* REPORT_ID = 2 */ | |
73 | 0x09, 0x01, /* USAGE (pointer) */ | |
74 | 0xA1, 0x00, /* COLLECTION (physical) */ | |
75 | 0x05, 0x09, /* USAGE_PAGE (buttons) */ | |
76 | 0x19, 0x01, /* USAGE_MIN (1) */ | |
77 | 0x29, 0x10, /* USAGE_MAX (16) */ | |
78 | 0x15, 0x00, /* LOGICAL_MIN (0) */ | |
79 | 0x25, 0x01, /* LOGICAL_MAX (1) */ | |
80 | 0x95, 0x10, /* REPORT_COUNT (16) */ | |
81 | 0x75, 0x01, /* REPORT_SIZE (1) */ | |
82 | 0x81, 0x02, /* INPUT (data var abs) */ | |
83 | 0x05, 0x01, /* USAGE_PAGE (generic desktop) */ | |
84 | 0x16, 0x01, 0xF8, /* LOGICAL_MIN (-2047) */ | |
85 | 0x26, 0xFF, 0x07, /* LOGICAL_MAX (2047) */ | |
86 | 0x75, 0x0C, /* REPORT_SIZE (12) */ | |
87 | 0x95, 0x02, /* REPORT_COUNT (2) */ | |
88 | 0x09, 0x30, /* USAGE (X) */ | |
89 | 0x09, 0x31, /* USAGE (Y) */ | |
90 | 0x81, 0x06, /* INPUT */ | |
91 | 0x15, 0x81, /* LOGICAL_MIN (-127) */ | |
92 | 0x25, 0x7F, /* LOGICAL_MAX (127) */ | |
93 | 0x75, 0x08, /* REPORT_SIZE (8) */ | |
94 | 0x95, 0x01, /* REPORT_COUNT (1) */ | |
95 | 0x09, 0x38, /* USAGE (wheel) */ | |
96 | 0x81, 0x06, /* INPUT */ | |
97 | 0x05, 0x0C, /* USAGE_PAGE(consumer) */ | |
98 | 0x0A, 0x38, 0x02, /* USAGE(AC Pan) */ | |
99 | 0x95, 0x01, /* REPORT_COUNT (1) */ | |
100 | 0x81, 0x06, /* INPUT */ | |
101 | 0xC0, /* END_COLLECTION */ | |
102 | 0xC0, /* END_COLLECTION */ | |
103 | }; | |
104 | ||
105 | /* Consumer Control descriptor (3) */ | |
106 | static const char consumer_descriptor[] = { | |
107 | 0x05, 0x0C, /* USAGE_PAGE (Consumer Devices) */ | |
108 | 0x09, 0x01, /* USAGE (Consumer Control) */ | |
109 | 0xA1, 0x01, /* COLLECTION (Application) */ | |
110 | 0x85, 0x03, /* REPORT_ID = 3 */ | |
111 | 0x75, 0x10, /* REPORT_SIZE (16) */ | |
112 | 0x95, 0x02, /* REPORT_COUNT (2) */ | |
113 | 0x15, 0x01, /* LOGICAL_MIN (1) */ | |
114 | 0x26, 0x8C, 0x02, /* LOGICAL_MAX (652) */ | |
115 | 0x19, 0x01, /* USAGE_MIN (1) */ | |
116 | 0x2A, 0x8C, 0x02, /* USAGE_MAX (652) */ | |
117 | 0x81, 0x00, /* INPUT (Data Ary Abs) */ | |
118 | 0xC0, /* END_COLLECTION */ | |
119 | }; /* */ | |
120 | ||
121 | /* System control descriptor (4) */ | |
122 | static const char syscontrol_descriptor[] = { | |
123 | 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ | |
124 | 0x09, 0x80, /* USAGE (System Control) */ | |
125 | 0xA1, 0x01, /* COLLECTION (Application) */ | |
126 | 0x85, 0x04, /* REPORT_ID = 4 */ | |
127 | 0x75, 0x02, /* REPORT_SIZE (2) */ | |
128 | 0x95, 0x01, /* REPORT_COUNT (1) */ | |
129 | 0x15, 0x01, /* LOGICAL_MIN (1) */ | |
130 | 0x25, 0x03, /* LOGICAL_MAX (3) */ | |
131 | 0x09, 0x82, /* USAGE (System Sleep) */ | |
132 | 0x09, 0x81, /* USAGE (System Power Down) */ | |
133 | 0x09, 0x83, /* USAGE (System Wake Up) */ | |
134 | 0x81, 0x60, /* INPUT (Data Ary Abs NPrf Null) */ | |
135 | 0x75, 0x06, /* REPORT_SIZE (6) */ | |
136 | 0x81, 0x03, /* INPUT (Cnst Var Abs) */ | |
137 | 0xC0, /* END_COLLECTION */ | |
138 | }; | |
139 | ||
140 | /* Media descriptor (8) */ | |
141 | static const char media_descriptor[] = { | |
142 | 0x06, 0xbc, 0xff, /* Usage Page 0xffbc */ | |
143 | 0x09, 0x88, /* Usage 0x0088 */ | |
144 | 0xa1, 0x01, /* BeginCollection */ | |
145 | 0x85, 0x08, /* Report ID 8 */ | |
146 | 0x19, 0x01, /* Usage Min 0x0001 */ | |
147 | 0x29, 0xff, /* Usage Max 0x00ff */ | |
148 | 0x15, 0x01, /* Logical Min 1 */ | |
149 | 0x26, 0xff, 0x00, /* Logical Max 255 */ | |
150 | 0x75, 0x08, /* Report Size 8 */ | |
151 | 0x95, 0x01, /* Report Count 1 */ | |
152 | 0x81, 0x00, /* Input */ | |
153 | 0xc0, /* EndCollection */ | |
154 | }; /* */ | |
155 | ||
156 | /* Maximum size of all defined hid reports in bytes (including report id) */ | |
157 | #define MAX_REPORT_SIZE 8 | |
158 | ||
2a039bf5 HR |
159 | /* Make sure all descriptors are present here */ |
160 | #define MAX_RDESC_SIZE \ | |
161 | (sizeof(kbd_descriptor) + \ | |
162 | sizeof(mse_descriptor) + \ | |
163 | sizeof(consumer_descriptor) + \ | |
164 | sizeof(syscontrol_descriptor) + \ | |
165 | sizeof(media_descriptor)) | |
166 | ||
534a7b8e NLC |
167 | /* Number of possible hid report types that can be created by this driver. |
168 | * | |
169 | * Right now, RF report types have the same report types (or report id's) | |
170 | * than the hid report created from those RF reports. In the future | |
171 | * this doesnt have to be true. | |
172 | * | |
173 | * For instance, RF report type 0x01 which has a size of 8 bytes, corresponds | |
174 | * to hid report id 0x01, this is standard keyboard. Same thing applies to mice | |
175 | * reports and consumer control, etc. If a new RF report is created, it doesn't | |
176 | * has to have the same report id as its corresponding hid report, so an | |
177 | * translation may have to take place for future report types. | |
178 | */ | |
179 | #define NUMBER_OF_HID_REPORTS 32 | |
180 | static const u8 hid_reportid_size_map[NUMBER_OF_HID_REPORTS] = { | |
181 | [1] = 8, /* Standard keyboard */ | |
182 | [2] = 8, /* Standard mouse */ | |
183 | [3] = 5, /* Consumer control */ | |
184 | [4] = 2, /* System control */ | |
185 | [8] = 2, /* Media Center */ | |
186 | }; | |
187 | ||
188 | ||
189 | #define LOGITECH_DJ_INTERFACE_NUMBER 0x02 | |
190 | ||
534a7b8e NLC |
191 | static struct hid_ll_driver logi_dj_ll_driver; |
192 | ||
193 | static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf, | |
194 | size_t count, | |
195 | unsigned char report_type); | |
196 | ||
197 | static void logi_dj_recv_destroy_djhid_device(struct dj_receiver_dev *djrcv_dev, | |
198 | struct dj_report *dj_report) | |
199 | { | |
200 | /* Called in delayed work context */ | |
201 | struct dj_device *dj_dev; | |
202 | unsigned long flags; | |
203 | ||
204 | spin_lock_irqsave(&djrcv_dev->lock, flags); | |
205 | dj_dev = djrcv_dev->paired_dj_devices[dj_report->device_index]; | |
206 | djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL; | |
207 | spin_unlock_irqrestore(&djrcv_dev->lock, flags); | |
208 | ||
209 | if (dj_dev != NULL) { | |
210 | hid_destroy_device(dj_dev->hdev); | |
211 | kfree(dj_dev); | |
212 | } else { | |
213 | dev_err(&djrcv_dev->hdev->dev, "%s: can't destroy a NULL device\n", | |
214 | __func__); | |
215 | } | |
216 | } | |
217 | ||
218 | static void logi_dj_recv_add_djhid_device(struct dj_receiver_dev *djrcv_dev, | |
219 | struct dj_report *dj_report) | |
220 | { | |
221 | /* Called in delayed work context */ | |
222 | struct hid_device *djrcv_hdev = djrcv_dev->hdev; | |
223 | struct usb_interface *intf = to_usb_interface(djrcv_hdev->dev.parent); | |
224 | struct usb_device *usbdev = interface_to_usbdev(intf); | |
225 | struct hid_device *dj_hiddev; | |
226 | struct dj_device *dj_dev; | |
227 | ||
228 | /* Device index goes from 1 to 6, we need 3 bytes to store the | |
229 | * semicolon, the index, and a null terminator | |
230 | */ | |
231 | unsigned char tmpstr[3]; | |
232 | ||
233 | if (dj_report->report_params[DEVICE_PAIRED_PARAM_SPFUNCTION] & | |
234 | SPFUNCTION_DEVICE_LIST_EMPTY) { | |
235 | dbg_hid("%s: device list is empty\n", __func__); | |
236 | return; | |
237 | } | |
238 | ||
239 | if ((dj_report->device_index < DJ_DEVICE_INDEX_MIN) || | |
240 | (dj_report->device_index > DJ_DEVICE_INDEX_MAX)) { | |
241 | dev_err(&djrcv_hdev->dev, "%s: invalid device index:%d\n", | |
242 | __func__, dj_report->device_index); | |
243 | return; | |
244 | } | |
245 | ||
246 | dj_hiddev = hid_allocate_device(); | |
247 | if (IS_ERR(dj_hiddev)) { | |
248 | dev_err(&djrcv_hdev->dev, "%s: hid_allocate_device failed\n", | |
249 | __func__); | |
250 | return; | |
251 | } | |
252 | ||
253 | dj_hiddev->ll_driver = &logi_dj_ll_driver; | |
254 | dj_hiddev->hid_output_raw_report = logi_dj_output_hidraw_report; | |
255 | ||
256 | dj_hiddev->dev.parent = &djrcv_hdev->dev; | |
257 | dj_hiddev->bus = BUS_USB; | |
258 | dj_hiddev->vendor = le16_to_cpu(usbdev->descriptor.idVendor); | |
259 | dj_hiddev->product = le16_to_cpu(usbdev->descriptor.idProduct); | |
260 | snprintf(dj_hiddev->name, sizeof(dj_hiddev->name), | |
261 | "Logitech Unifying Device. Wireless PID:%02x%02x", | |
262 | dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_MSB], | |
263 | dj_report->report_params[DEVICE_PAIRED_PARAM_EQUAD_ID_LSB]); | |
264 | ||
265 | usb_make_path(usbdev, dj_hiddev->phys, sizeof(dj_hiddev->phys)); | |
266 | snprintf(tmpstr, sizeof(tmpstr), ":%d", dj_report->device_index); | |
267 | strlcat(dj_hiddev->phys, tmpstr, sizeof(dj_hiddev->phys)); | |
268 | ||
269 | dj_dev = kzalloc(sizeof(struct dj_device), GFP_KERNEL); | |
270 | ||
271 | if (!dj_dev) { | |
272 | dev_err(&djrcv_hdev->dev, "%s: failed allocating dj_device\n", | |
273 | __func__); | |
274 | goto dj_device_allocate_fail; | |
275 | } | |
276 | ||
44d27f7d JN |
277 | dj_dev->reports_supported = get_unaligned_le32( |
278 | dj_report->report_params + DEVICE_PAIRED_RF_REPORT_TYPE); | |
534a7b8e NLC |
279 | dj_dev->hdev = dj_hiddev; |
280 | dj_dev->dj_receiver_dev = djrcv_dev; | |
281 | dj_dev->device_index = dj_report->device_index; | |
282 | dj_hiddev->driver_data = dj_dev; | |
283 | ||
284 | djrcv_dev->paired_dj_devices[dj_report->device_index] = dj_dev; | |
285 | ||
286 | if (hid_add_device(dj_hiddev)) { | |
287 | dev_err(&djrcv_hdev->dev, "%s: failed adding dj_device\n", | |
288 | __func__); | |
289 | goto hid_add_device_fail; | |
290 | } | |
291 | ||
292 | return; | |
293 | ||
294 | hid_add_device_fail: | |
295 | djrcv_dev->paired_dj_devices[dj_report->device_index] = NULL; | |
296 | kfree(dj_dev); | |
297 | dj_device_allocate_fail: | |
298 | hid_destroy_device(dj_hiddev); | |
299 | } | |
300 | ||
301 | static void delayedwork_callback(struct work_struct *work) | |
302 | { | |
303 | struct dj_receiver_dev *djrcv_dev = | |
304 | container_of(work, struct dj_receiver_dev, work); | |
305 | ||
306 | struct dj_report dj_report; | |
307 | unsigned long flags; | |
308 | int count; | |
309 | ||
310 | dbg_hid("%s\n", __func__); | |
311 | ||
312 | spin_lock_irqsave(&djrcv_dev->lock, flags); | |
313 | ||
314 | count = kfifo_out(&djrcv_dev->notif_fifo, &dj_report, | |
315 | sizeof(struct dj_report)); | |
316 | ||
317 | if (count != sizeof(struct dj_report)) { | |
318 | dev_err(&djrcv_dev->hdev->dev, "%s: workitem triggered without " | |
319 | "notifications available\n", __func__); | |
320 | spin_unlock_irqrestore(&djrcv_dev->lock, flags); | |
321 | return; | |
322 | } | |
323 | ||
324 | if (!kfifo_is_empty(&djrcv_dev->notif_fifo)) { | |
325 | if (schedule_work(&djrcv_dev->work) == 0) { | |
326 | dbg_hid("%s: did not schedule the work item, was " | |
327 | "already queued\n", __func__); | |
328 | } | |
329 | } | |
330 | ||
331 | spin_unlock_irqrestore(&djrcv_dev->lock, flags); | |
332 | ||
333 | switch (dj_report.report_type) { | |
334 | case REPORT_TYPE_NOTIF_DEVICE_PAIRED: | |
335 | logi_dj_recv_add_djhid_device(djrcv_dev, &dj_report); | |
336 | break; | |
337 | case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED: | |
338 | logi_dj_recv_destroy_djhid_device(djrcv_dev, &dj_report); | |
339 | break; | |
340 | default: | |
341 | dbg_hid("%s: unexpected report type\n", __func__); | |
342 | } | |
343 | } | |
344 | ||
345 | static void logi_dj_recv_queue_notification(struct dj_receiver_dev *djrcv_dev, | |
346 | struct dj_report *dj_report) | |
347 | { | |
348 | /* We are called from atomic context (tasklet && djrcv->lock held) */ | |
349 | ||
350 | kfifo_in(&djrcv_dev->notif_fifo, dj_report, sizeof(struct dj_report)); | |
351 | ||
352 | if (schedule_work(&djrcv_dev->work) == 0) { | |
353 | dbg_hid("%s: did not schedule the work item, was already " | |
354 | "queued\n", __func__); | |
355 | } | |
356 | } | |
357 | ||
358 | static void logi_dj_recv_forward_null_report(struct dj_receiver_dev *djrcv_dev, | |
359 | struct dj_report *dj_report) | |
360 | { | |
361 | /* We are called from atomic context (tasklet && djrcv->lock held) */ | |
362 | unsigned int i; | |
363 | u8 reportbuffer[MAX_REPORT_SIZE]; | |
364 | struct dj_device *djdev; | |
365 | ||
366 | djdev = djrcv_dev->paired_dj_devices[dj_report->device_index]; | |
367 | ||
368 | if (!djdev) { | |
369 | dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]" | |
370 | " is NULL, index %d\n", dj_report->device_index); | |
371 | return; | |
372 | } | |
373 | ||
374 | memset(reportbuffer, 0, sizeof(reportbuffer)); | |
375 | ||
376 | for (i = 0; i < NUMBER_OF_HID_REPORTS; i++) { | |
377 | if (djdev->reports_supported & (1 << i)) { | |
378 | reportbuffer[0] = i; | |
379 | if (hid_input_report(djdev->hdev, | |
380 | HID_INPUT_REPORT, | |
381 | reportbuffer, | |
382 | hid_reportid_size_map[i], 1)) { | |
383 | dbg_hid("hid_input_report error sending null " | |
384 | "report\n"); | |
385 | } | |
386 | } | |
387 | } | |
388 | } | |
389 | ||
390 | static void logi_dj_recv_forward_report(struct dj_receiver_dev *djrcv_dev, | |
391 | struct dj_report *dj_report) | |
392 | { | |
393 | /* We are called from atomic context (tasklet && djrcv->lock held) */ | |
394 | struct dj_device *dj_device; | |
395 | ||
396 | dj_device = djrcv_dev->paired_dj_devices[dj_report->device_index]; | |
397 | ||
398 | if (dj_device == NULL) { | |
399 | dbg_hid("djrcv_dev->paired_dj_devices[dj_report->device_index]" | |
400 | " is NULL, index %d\n", dj_report->device_index); | |
401 | return; | |
402 | } | |
403 | ||
404 | if ((dj_report->report_type > ARRAY_SIZE(hid_reportid_size_map) - 1) || | |
405 | (hid_reportid_size_map[dj_report->report_type] == 0)) { | |
406 | dbg_hid("invalid report type:%x\n", dj_report->report_type); | |
407 | return; | |
408 | } | |
409 | ||
410 | if (hid_input_report(dj_device->hdev, | |
411 | HID_INPUT_REPORT, &dj_report->report_type, | |
412 | hid_reportid_size_map[dj_report->report_type], 1)) { | |
413 | dbg_hid("hid_input_report error\n"); | |
414 | } | |
415 | } | |
416 | ||
417 | ||
418 | static int logi_dj_recv_send_report(struct dj_receiver_dev *djrcv_dev, | |
419 | struct dj_report *dj_report) | |
420 | { | |
421 | struct hid_device *hdev = djrcv_dev->hdev; | |
422 | int sent_bytes; | |
423 | ||
424 | if (!hdev->hid_output_raw_report) { | |
425 | dev_err(&hdev->dev, "%s:" | |
426 | "hid_output_raw_report is null\n", __func__); | |
427 | return -ENODEV; | |
428 | } | |
429 | ||
430 | sent_bytes = hdev->hid_output_raw_report(hdev, (u8 *) dj_report, | |
431 | sizeof(struct dj_report), | |
432 | HID_OUTPUT_REPORT); | |
433 | ||
434 | return (sent_bytes < 0) ? sent_bytes : 0; | |
435 | } | |
436 | ||
437 | static int logi_dj_recv_query_paired_devices(struct dj_receiver_dev *djrcv_dev) | |
438 | { | |
d8dc3494 MD |
439 | struct dj_report *dj_report; |
440 | int retval; | |
534a7b8e | 441 | |
d8dc3494 MD |
442 | dj_report = kzalloc(sizeof(dj_report), GFP_KERNEL); |
443 | if (!dj_report) | |
444 | return -ENOMEM; | |
445 | dj_report->report_id = REPORT_ID_DJ_SHORT; | |
446 | dj_report->device_index = 0xFF; | |
447 | dj_report->report_type = REPORT_TYPE_CMD_GET_PAIRED_DEVICES; | |
448 | retval = logi_dj_recv_send_report(djrcv_dev, dj_report); | |
449 | kfree(dj_report); | |
450 | return retval; | |
534a7b8e NLC |
451 | } |
452 | ||
453 | static int logi_dj_recv_switch_to_dj_mode(struct dj_receiver_dev *djrcv_dev, | |
454 | unsigned timeout) | |
455 | { | |
d8dc3494 MD |
456 | struct dj_report *dj_report; |
457 | int retval; | |
534a7b8e | 458 | |
d8dc3494 MD |
459 | dj_report = kzalloc(sizeof(dj_report), GFP_KERNEL); |
460 | if (!dj_report) | |
461 | return -ENOMEM; | |
462 | dj_report->report_id = REPORT_ID_DJ_SHORT; | |
463 | dj_report->device_index = 0xFF; | |
464 | dj_report->report_type = REPORT_TYPE_CMD_SWITCH; | |
465 | dj_report->report_params[CMD_SWITCH_PARAM_DEVBITFIELD] = 0x3F; | |
466 | dj_report->report_params[CMD_SWITCH_PARAM_TIMEOUT_SECONDS] = (u8)timeout; | |
467 | retval = logi_dj_recv_send_report(djrcv_dev, dj_report); | |
468 | kfree(dj_report); | |
469 | return retval; | |
534a7b8e NLC |
470 | } |
471 | ||
472 | ||
473 | static int logi_dj_ll_open(struct hid_device *hid) | |
474 | { | |
475 | dbg_hid("%s:%s\n", __func__, hid->phys); | |
476 | return 0; | |
477 | ||
478 | } | |
479 | ||
480 | static void logi_dj_ll_close(struct hid_device *hid) | |
481 | { | |
482 | dbg_hid("%s:%s\n", __func__, hid->phys); | |
483 | } | |
484 | ||
485 | static int logi_dj_output_hidraw_report(struct hid_device *hid, u8 * buf, | |
486 | size_t count, | |
487 | unsigned char report_type) | |
488 | { | |
489 | /* Called by hid raw to send data */ | |
490 | dbg_hid("%s\n", __func__); | |
491 | ||
492 | return 0; | |
493 | } | |
494 | ||
2a039bf5 HR |
495 | static void rdcat(char **rdesc, unsigned int *rsize, const char *data, unsigned int size) |
496 | { | |
497 | memcpy(*rdesc + *rsize, data, size); | |
498 | *rsize += size; | |
499 | } | |
500 | ||
534a7b8e NLC |
501 | static int logi_dj_ll_parse(struct hid_device *hid) |
502 | { | |
503 | struct dj_device *djdev = hid->driver_data; | |
2a039bf5 HR |
504 | unsigned int rsize = 0; |
505 | char *rdesc; | |
534a7b8e NLC |
506 | int retval; |
507 | ||
508 | dbg_hid("%s\n", __func__); | |
509 | ||
510 | djdev->hdev->version = 0x0111; | |
511 | djdev->hdev->country = 0x00; | |
512 | ||
2a039bf5 HR |
513 | rdesc = kmalloc(MAX_RDESC_SIZE, GFP_KERNEL); |
514 | if (!rdesc) | |
515 | return -ENOMEM; | |
516 | ||
534a7b8e NLC |
517 | if (djdev->reports_supported & STD_KEYBOARD) { |
518 | dbg_hid("%s: sending a kbd descriptor, reports_supported: %x\n", | |
519 | __func__, djdev->reports_supported); | |
2a039bf5 | 520 | rdcat(&rdesc, &rsize, kbd_descriptor, sizeof(kbd_descriptor)); |
534a7b8e NLC |
521 | } |
522 | ||
523 | if (djdev->reports_supported & STD_MOUSE) { | |
524 | dbg_hid("%s: sending a mouse descriptor, reports_supported: " | |
525 | "%x\n", __func__, djdev->reports_supported); | |
2a039bf5 | 526 | rdcat(&rdesc, &rsize, mse_descriptor, sizeof(mse_descriptor)); |
534a7b8e NLC |
527 | } |
528 | ||
529 | if (djdev->reports_supported & MULTIMEDIA) { | |
530 | dbg_hid("%s: sending a multimedia report descriptor: %x\n", | |
531 | __func__, djdev->reports_supported); | |
2a039bf5 | 532 | rdcat(&rdesc, &rsize, consumer_descriptor, sizeof(consumer_descriptor)); |
534a7b8e NLC |
533 | } |
534 | ||
535 | if (djdev->reports_supported & POWER_KEYS) { | |
536 | dbg_hid("%s: sending a power keys report descriptor: %x\n", | |
537 | __func__, djdev->reports_supported); | |
2a039bf5 | 538 | rdcat(&rdesc, &rsize, syscontrol_descriptor, sizeof(syscontrol_descriptor)); |
534a7b8e NLC |
539 | } |
540 | ||
541 | if (djdev->reports_supported & MEDIA_CENTER) { | |
542 | dbg_hid("%s: sending a media center report descriptor: %x\n", | |
543 | __func__, djdev->reports_supported); | |
2a039bf5 | 544 | rdcat(&rdesc, &rsize, media_descriptor, sizeof(media_descriptor)); |
534a7b8e NLC |
545 | } |
546 | ||
547 | if (djdev->reports_supported & KBD_LEDS) { | |
548 | dbg_hid("%s: need to send kbd leds report descriptor: %x\n", | |
549 | __func__, djdev->reports_supported); | |
550 | } | |
551 | ||
2a039bf5 HR |
552 | retval = hid_parse_report(hid, rdesc, rsize); |
553 | kfree(rdesc); | |
554 | ||
555 | return retval; | |
534a7b8e NLC |
556 | } |
557 | ||
558 | static int logi_dj_ll_input_event(struct input_dev *dev, unsigned int type, | |
559 | unsigned int code, int value) | |
560 | { | |
561 | /* Sent by the input layer to handle leds and Force Feedback */ | |
562 | struct hid_device *dj_hiddev = input_get_drvdata(dev); | |
563 | struct dj_device *dj_dev = dj_hiddev->driver_data; | |
564 | ||
565 | struct dj_receiver_dev *djrcv_dev = | |
566 | dev_get_drvdata(dj_hiddev->dev.parent); | |
567 | struct hid_device *dj_rcv_hiddev = djrcv_dev->hdev; | |
568 | struct hid_report_enum *output_report_enum; | |
569 | ||
570 | struct hid_field *field; | |
571 | struct hid_report *report; | |
572 | unsigned char data[8]; | |
573 | int offset; | |
574 | ||
575 | dbg_hid("%s: %s, type:%d | code:%d | value:%d\n", | |
576 | __func__, dev->phys, type, code, value); | |
577 | ||
578 | if (type != EV_LED) | |
579 | return -1; | |
580 | ||
581 | offset = hidinput_find_field(dj_hiddev, type, code, &field); | |
582 | ||
583 | if (offset == -1) { | |
584 | dev_warn(&dev->dev, "event field not found\n"); | |
585 | return -1; | |
586 | } | |
587 | hid_set_field(field, offset, value); | |
588 | hid_output_report(field->report, &data[0]); | |
589 | ||
590 | output_report_enum = &dj_rcv_hiddev->report_enum[HID_OUTPUT_REPORT]; | |
591 | report = output_report_enum->report_id_hash[REPORT_ID_DJ_SHORT]; | |
592 | hid_set_field(report->field[0], 0, dj_dev->device_index); | |
593 | hid_set_field(report->field[0], 1, REPORT_TYPE_LEDS); | |
594 | hid_set_field(report->field[0], 2, data[1]); | |
595 | ||
596 | usbhid_submit_report(dj_rcv_hiddev, report, USB_DIR_OUT); | |
597 | ||
598 | return 0; | |
599 | ||
600 | } | |
601 | ||
602 | static int logi_dj_ll_start(struct hid_device *hid) | |
603 | { | |
604 | dbg_hid("%s\n", __func__); | |
605 | return 0; | |
606 | } | |
607 | ||
608 | static void logi_dj_ll_stop(struct hid_device *hid) | |
609 | { | |
610 | dbg_hid("%s\n", __func__); | |
611 | } | |
612 | ||
613 | ||
614 | static struct hid_ll_driver logi_dj_ll_driver = { | |
615 | .parse = logi_dj_ll_parse, | |
616 | .start = logi_dj_ll_start, | |
617 | .stop = logi_dj_ll_stop, | |
618 | .open = logi_dj_ll_open, | |
619 | .close = logi_dj_ll_close, | |
620 | .hidinput_input_event = logi_dj_ll_input_event, | |
621 | }; | |
622 | ||
623 | ||
624 | static int logi_dj_raw_event(struct hid_device *hdev, | |
625 | struct hid_report *report, u8 *data, | |
626 | int size) | |
627 | { | |
628 | struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); | |
629 | struct dj_report *dj_report = (struct dj_report *) data; | |
630 | unsigned long flags; | |
631 | bool report_processed = false; | |
632 | ||
633 | dbg_hid("%s, size:%d\n", __func__, size); | |
634 | ||
635 | /* Here we receive all data coming from iface 2, there are 4 cases: | |
636 | * | |
637 | * 1) Data should continue its normal processing i.e. data does not | |
638 | * come from the DJ collection, in which case we do nothing and | |
639 | * return 0, so hid-core can continue normal processing (will forward | |
640 | * to associated hidraw device) | |
641 | * | |
642 | * 2) Data is from DJ collection, and is intended for this driver i. e. | |
643 | * data contains arrival, departure, etc notifications, in which case | |
644 | * we queue them for delayed processing by the work queue. We return 1 | |
645 | * to hid-core as no further processing is required from it. | |
646 | * | |
647 | * 3) Data is from DJ collection, and informs a connection change, | |
648 | * if the change means rf link loss, then we must send a null report | |
649 | * to the upper layer to discard potentially pressed keys that may be | |
650 | * repeated forever by the input layer. Return 1 to hid-core as no | |
651 | * further processing is required. | |
652 | * | |
653 | * 4) Data is from DJ collection and is an actual input event from | |
654 | * a paired DJ device in which case we forward it to the correct hid | |
655 | * device (via hid_input_report() ) and return 1 so hid-core does not do | |
656 | * anything else with it. | |
657 | */ | |
658 | ||
659 | spin_lock_irqsave(&djrcv_dev->lock, flags); | |
660 | if (dj_report->report_id == REPORT_ID_DJ_SHORT) { | |
661 | switch (dj_report->report_type) { | |
662 | case REPORT_TYPE_NOTIF_DEVICE_PAIRED: | |
663 | case REPORT_TYPE_NOTIF_DEVICE_UNPAIRED: | |
664 | logi_dj_recv_queue_notification(djrcv_dev, dj_report); | |
665 | break; | |
666 | case REPORT_TYPE_NOTIF_CONNECTION_STATUS: | |
667 | if (dj_report->report_params[CONNECTION_STATUS_PARAM_STATUS] == | |
668 | STATUS_LINKLOSS) { | |
669 | logi_dj_recv_forward_null_report(djrcv_dev, dj_report); | |
670 | } | |
671 | break; | |
672 | default: | |
673 | logi_dj_recv_forward_report(djrcv_dev, dj_report); | |
674 | } | |
675 | report_processed = true; | |
676 | } | |
677 | spin_unlock_irqrestore(&djrcv_dev->lock, flags); | |
678 | ||
679 | return report_processed; | |
680 | } | |
681 | ||
682 | static int logi_dj_probe(struct hid_device *hdev, | |
683 | const struct hid_device_id *id) | |
684 | { | |
685 | struct usb_interface *intf = to_usb_interface(hdev->dev.parent); | |
686 | struct dj_receiver_dev *djrcv_dev; | |
687 | int retval; | |
688 | ||
689 | if (is_dj_device((struct dj_device *)hdev->driver_data)) | |
690 | return -ENODEV; | |
691 | ||
692 | dbg_hid("%s called for ifnum %d\n", __func__, | |
693 | intf->cur_altsetting->desc.bInterfaceNumber); | |
694 | ||
695 | /* Ignore interfaces 0 and 1, they will not carry any data, dont create | |
696 | * any hid_device for them */ | |
697 | if (intf->cur_altsetting->desc.bInterfaceNumber != | |
698 | LOGITECH_DJ_INTERFACE_NUMBER) { | |
699 | dbg_hid("%s: ignoring ifnum %d\n", __func__, | |
700 | intf->cur_altsetting->desc.bInterfaceNumber); | |
701 | return -ENODEV; | |
702 | } | |
703 | ||
704 | /* Treat interface 2 */ | |
705 | ||
706 | djrcv_dev = kzalloc(sizeof(struct dj_receiver_dev), GFP_KERNEL); | |
707 | if (!djrcv_dev) { | |
708 | dev_err(&hdev->dev, | |
709 | "%s:failed allocating dj_receiver_dev\n", __func__); | |
710 | return -ENOMEM; | |
711 | } | |
712 | djrcv_dev->hdev = hdev; | |
713 | INIT_WORK(&djrcv_dev->work, delayedwork_callback); | |
714 | spin_lock_init(&djrcv_dev->lock); | |
715 | if (kfifo_alloc(&djrcv_dev->notif_fifo, | |
716 | DJ_MAX_NUMBER_NOTIFICATIONS * sizeof(struct dj_report), | |
717 | GFP_KERNEL)) { | |
718 | dev_err(&hdev->dev, | |
719 | "%s:failed allocating notif_fifo\n", __func__); | |
720 | kfree(djrcv_dev); | |
721 | return -ENOMEM; | |
722 | } | |
723 | hid_set_drvdata(hdev, djrcv_dev); | |
724 | ||
725 | /* Call to usbhid to fetch the HID descriptors of interface 2 and | |
726 | * subsequently call to the hid/hid-core to parse the fetched | |
727 | * descriptors, this will in turn create the hidraw and hiddev nodes | |
728 | * for interface 2 of the receiver */ | |
729 | retval = hid_parse(hdev); | |
730 | if (retval) { | |
731 | dev_err(&hdev->dev, | |
732 | "%s:parse of interface 2 failed\n", __func__); | |
733 | goto hid_parse_fail; | |
734 | } | |
735 | ||
736 | /* Starts the usb device and connects to upper interfaces hiddev and | |
737 | * hidraw */ | |
738 | retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT); | |
739 | if (retval) { | |
740 | dev_err(&hdev->dev, | |
741 | "%s:hid_hw_start returned error\n", __func__); | |
742 | goto hid_hw_start_fail; | |
743 | } | |
744 | ||
745 | retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0); | |
746 | if (retval < 0) { | |
747 | dev_err(&hdev->dev, | |
748 | "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n", | |
749 | __func__, retval); | |
750 | goto switch_to_dj_mode_fail; | |
751 | } | |
752 | ||
753 | /* This is enabling the polling urb on the IN endpoint */ | |
754 | retval = hdev->ll_driver->open(hdev); | |
755 | if (retval < 0) { | |
756 | dev_err(&hdev->dev, "%s:hdev->ll_driver->open returned " | |
757 | "error:%d\n", __func__, retval); | |
758 | goto llopen_failed; | |
759 | } | |
760 | ||
761 | retval = logi_dj_recv_query_paired_devices(djrcv_dev); | |
762 | if (retval < 0) { | |
763 | dev_err(&hdev->dev, "%s:logi_dj_recv_query_paired_devices " | |
764 | "error:%d\n", __func__, retval); | |
765 | goto logi_dj_recv_query_paired_devices_failed; | |
766 | } | |
767 | ||
768 | return retval; | |
769 | ||
770 | logi_dj_recv_query_paired_devices_failed: | |
771 | hdev->ll_driver->close(hdev); | |
772 | ||
773 | llopen_failed: | |
774 | switch_to_dj_mode_fail: | |
775 | hid_hw_stop(hdev); | |
776 | ||
777 | hid_hw_start_fail: | |
778 | hid_parse_fail: | |
779 | kfifo_free(&djrcv_dev->notif_fifo); | |
780 | kfree(djrcv_dev); | |
781 | hid_set_drvdata(hdev, NULL); | |
782 | return retval; | |
783 | ||
784 | } | |
785 | ||
786 | #ifdef CONFIG_PM | |
787 | static int logi_dj_reset_resume(struct hid_device *hdev) | |
788 | { | |
789 | int retval; | |
790 | struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); | |
791 | ||
792 | retval = logi_dj_recv_switch_to_dj_mode(djrcv_dev, 0); | |
793 | if (retval < 0) { | |
794 | dev_err(&hdev->dev, | |
795 | "%s:logi_dj_recv_switch_to_dj_mode returned error:%d\n", | |
796 | __func__, retval); | |
797 | } | |
798 | ||
799 | return 0; | |
800 | } | |
801 | #endif | |
802 | ||
803 | static void logi_dj_remove(struct hid_device *hdev) | |
804 | { | |
805 | struct dj_receiver_dev *djrcv_dev = hid_get_drvdata(hdev); | |
806 | struct dj_device *dj_dev; | |
807 | int i; | |
808 | ||
809 | dbg_hid("%s\n", __func__); | |
810 | ||
811 | cancel_work_sync(&djrcv_dev->work); | |
812 | ||
813 | hdev->ll_driver->close(hdev); | |
814 | hid_hw_stop(hdev); | |
815 | ||
816 | /* I suppose that at this point the only context that can access | |
817 | * the djrecv_data is this thread as the work item is guaranteed to | |
818 | * have finished and no more raw_event callbacks should arrive after | |
819 | * the remove callback was triggered so no locks are put around the | |
820 | * code below */ | |
844580ff | 821 | for (i = 0; i < (DJ_MAX_PAIRED_DEVICES + DJ_DEVICE_INDEX_MIN); i++) { |
534a7b8e NLC |
822 | dj_dev = djrcv_dev->paired_dj_devices[i]; |
823 | if (dj_dev != NULL) { | |
824 | hid_destroy_device(dj_dev->hdev); | |
825 | kfree(dj_dev); | |
826 | djrcv_dev->paired_dj_devices[i] = NULL; | |
827 | } | |
828 | } | |
829 | ||
830 | kfifo_free(&djrcv_dev->notif_fifo); | |
831 | kfree(djrcv_dev); | |
832 | hid_set_drvdata(hdev, NULL); | |
833 | } | |
834 | ||
835 | static int logi_djdevice_probe(struct hid_device *hdev, | |
836 | const struct hid_device_id *id) | |
837 | { | |
838 | int ret; | |
839 | struct dj_device *dj_dev = hdev->driver_data; | |
840 | ||
841 | if (!is_dj_device(dj_dev)) | |
842 | return -ENODEV; | |
843 | ||
844 | ret = hid_parse(hdev); | |
845 | if (!ret) | |
846 | ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT); | |
847 | ||
848 | return ret; | |
849 | } | |
850 | ||
851 | static const struct hid_device_id logi_dj_receivers[] = { | |
852 | {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, | |
853 | USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)}, | |
854 | {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, | |
855 | USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)}, | |
856 | {} | |
857 | }; | |
858 | ||
859 | MODULE_DEVICE_TABLE(hid, logi_dj_receivers); | |
860 | ||
861 | static struct hid_driver logi_djreceiver_driver = { | |
862 | .name = "logitech-djreceiver", | |
863 | .id_table = logi_dj_receivers, | |
864 | .probe = logi_dj_probe, | |
865 | .remove = logi_dj_remove, | |
866 | .raw_event = logi_dj_raw_event, | |
867 | #ifdef CONFIG_PM | |
868 | .reset_resume = logi_dj_reset_resume, | |
869 | #endif | |
870 | }; | |
871 | ||
872 | ||
873 | static const struct hid_device_id logi_dj_devices[] = { | |
874 | {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, | |
875 | USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER)}, | |
876 | {HID_USB_DEVICE(USB_VENDOR_ID_LOGITECH, | |
877 | USB_DEVICE_ID_LOGITECH_UNIFYING_RECEIVER_2)}, | |
878 | {} | |
879 | }; | |
880 | ||
881 | static struct hid_driver logi_djdevice_driver = { | |
882 | .name = "logitech-djdevice", | |
883 | .id_table = logi_dj_devices, | |
884 | .probe = logi_djdevice_probe, | |
885 | }; | |
886 | ||
887 | ||
888 | static int __init logi_dj_init(void) | |
889 | { | |
890 | int retval; | |
891 | ||
892 | dbg_hid("Logitech-DJ:%s\n", __func__); | |
893 | ||
894 | retval = hid_register_driver(&logi_djreceiver_driver); | |
895 | if (retval) | |
896 | return retval; | |
897 | ||
898 | retval = hid_register_driver(&logi_djdevice_driver); | |
899 | if (retval) | |
900 | hid_unregister_driver(&logi_djreceiver_driver); | |
901 | ||
902 | return retval; | |
903 | ||
904 | } | |
905 | ||
906 | static void __exit logi_dj_exit(void) | |
907 | { | |
908 | dbg_hid("Logitech-DJ:%s\n", __func__); | |
909 | ||
910 | hid_unregister_driver(&logi_djdevice_driver); | |
911 | hid_unregister_driver(&logi_djreceiver_driver); | |
912 | ||
913 | } | |
914 | ||
915 | module_init(logi_dj_init); | |
916 | module_exit(logi_dj_exit); | |
917 | MODULE_LICENSE("GPL"); | |
918 | MODULE_AUTHOR("Logitech"); | |
919 | MODULE_AUTHOR("Nestor Lopez Casado"); | |
920 | MODULE_AUTHOR("nlopezcasad@logitech.com"); |