2 * HIDPP protocol for Logitech Unifying receivers
4 * Copyright (c) 2011 Logitech (c)
5 * Copyright (c) 2012-2013 Google (c)
6 * Copyright (c) 2013-2014 Red Hat Inc.
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; version 2 of the License.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/device.h>
18 #include <linux/hid.h>
19 #include <linux/module.h>
20 #include <linux/slab.h>
21 #include <linux/sched.h>
22 #include <linux/kfifo.h>
23 #include <linux/input/mt.h>
24 #include <asm/unaligned.h>
27 MODULE_LICENSE("GPL");
28 MODULE_AUTHOR("Benjamin Tissoires <benjamin.tissoires@gmail.com>");
29 MODULE_AUTHOR("Nestor Lopez Casado <nlopezcasad@logitech.com>");
31 #define REPORT_ID_HIDPP_SHORT 0x10
32 #define REPORT_ID_HIDPP_LONG 0x11
34 #define HIDPP_REPORT_SHORT_LENGTH 7
35 #define HIDPP_REPORT_LONG_LENGTH 20
37 #define HIDPP_QUIRK_CLASS_WTP BIT(0)
39 /* bits 1..20 are reserved for classes */
40 #define HIDPP_QUIRK_DELAYED_INIT BIT(21)
41 #define HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS BIT(22)
42 #define HIDPP_QUIRK_MULTI_INPUT BIT(23)
45 * There are two hidpp protocols in use, the first version hidpp10 is known
46 * as register access protocol or RAP, the second version hidpp20 is known as
47 * feature access protocol or FAP
49 * Most older devices (including the Unifying usb receiver) use the RAP protocol
50 * where as most newer devices use the FAP protocol. Both protocols are
51 * compatible with the underlying transport, which could be usb, Unifiying, or
52 * bluetooth. The message lengths are defined by the hid vendor specific report
53 * descriptor for the HIDPP_SHORT report type (total message lenth 7 bytes) and
54 * the HIDPP_LONG report type (total message length 20 bytes)
56 * The RAP protocol uses both report types, whereas the FAP only uses HIDPP_LONG
57 * messages. The Unifying receiver itself responds to RAP messages (device index
58 * is 0xFF for the receiver), and all messages (short or long) with a device
59 * index between 1 and 6 are passed untouched to the corresponding paired
62 * The paired device can be RAP or FAP, it will receive the message untouched
63 * from the Unifiying receiver.
68 u8 funcindex_clientid;
69 u8 params[HIDPP_REPORT_LONG_LENGTH - 4U];
75 u8 params[HIDPP_REPORT_LONG_LENGTH - 4U];
84 u8 rawbytes[sizeof(struct fap)];
89 struct hid_device *hid_dev;
90 struct mutex send_mutex;
91 void *send_receive_buf;
92 wait_queue_head_t wait;
93 bool answer_available;
99 struct work_struct work;
100 struct kfifo delayed_work_fifo;
102 struct input_dev *delayed_input;
104 unsigned long quirks;
108 #define HIDPP_ERROR 0x8f
109 #define HIDPP_ERROR_SUCCESS 0x00
110 #define HIDPP_ERROR_INVALID_SUBID 0x01
111 #define HIDPP_ERROR_INVALID_ADRESS 0x02
112 #define HIDPP_ERROR_INVALID_VALUE 0x03
113 #define HIDPP_ERROR_CONNECT_FAIL 0x04
114 #define HIDPP_ERROR_TOO_MANY_DEVICES 0x05
115 #define HIDPP_ERROR_ALREADY_EXISTS 0x06
116 #define HIDPP_ERROR_BUSY 0x07
117 #define HIDPP_ERROR_UNKNOWN_DEVICE 0x08
118 #define HIDPP_ERROR_RESOURCE_ERROR 0x09
119 #define HIDPP_ERROR_REQUEST_UNAVAILABLE 0x0a
120 #define HIDPP_ERROR_INVALID_PARAM_VALUE 0x0b
121 #define HIDPP_ERROR_WRONG_PIN_CODE 0x0c
123 static void hidpp_connect_event(struct hidpp_device *hidpp_dev);
125 static int __hidpp_send_report(struct hid_device *hdev,
126 struct hidpp_report *hidpp_report)
128 int fields_count, ret;
130 switch (hidpp_report->report_id) {
131 case REPORT_ID_HIDPP_SHORT:
132 fields_count = HIDPP_REPORT_SHORT_LENGTH;
134 case REPORT_ID_HIDPP_LONG:
135 fields_count = HIDPP_REPORT_LONG_LENGTH;
142 * set the device_index as the receiver, it will be overwritten by
143 * hid_hw_request if needed
145 hidpp_report->device_index = 0xff;
147 ret = hid_hw_raw_request(hdev, hidpp_report->report_id,
148 (u8 *)hidpp_report, fields_count, HID_OUTPUT_REPORT,
151 return ret == fields_count ? 0 : -1;
155 * hidpp_send_message_sync() returns 0 in case of success, and something else
156 * in case of a failure.
157 * - If ' something else' is positive, that means that an error has been raised
158 * by the protocol itself.
159 * - If ' something else' is negative, that means that we had a classic error
160 * (-ENOMEM, -EPIPE, etc...)
162 static int hidpp_send_message_sync(struct hidpp_device *hidpp,
163 struct hidpp_report *message,
164 struct hidpp_report *response)
168 mutex_lock(&hidpp->send_mutex);
170 hidpp->send_receive_buf = response;
171 hidpp->answer_available = false;
174 * So that we can later validate the answer when it arrives
177 *response = *message;
179 ret = __hidpp_send_report(hidpp->hid_dev, message);
182 dbg_hid("__hidpp_send_report returned err: %d\n", ret);
183 memset(response, 0, sizeof(struct hidpp_report));
187 if (!wait_event_timeout(hidpp->wait, hidpp->answer_available,
189 dbg_hid("%s:timeout waiting for response\n", __func__);
190 memset(response, 0, sizeof(struct hidpp_report));
194 if (response->report_id == REPORT_ID_HIDPP_SHORT &&
195 response->fap.feature_index == HIDPP_ERROR) {
196 ret = response->fap.params[1];
197 dbg_hid("__hidpp_send_report got hidpp error %02X\n", ret);
202 mutex_unlock(&hidpp->send_mutex);
207 static int hidpp_send_fap_command_sync(struct hidpp_device *hidpp,
208 u8 feat_index, u8 funcindex_clientid, u8 *params, int param_count,
209 struct hidpp_report *response)
211 struct hidpp_report *message;
214 if (param_count > sizeof(message->fap.params))
217 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
220 message->report_id = REPORT_ID_HIDPP_LONG;
221 message->fap.feature_index = feat_index;
222 message->fap.funcindex_clientid = funcindex_clientid;
223 memcpy(&message->fap.params, params, param_count);
225 ret = hidpp_send_message_sync(hidpp, message, response);
230 static int hidpp_send_rap_command_sync(struct hidpp_device *hidpp_dev,
231 u8 report_id, u8 sub_id, u8 reg_address, u8 *params, int param_count,
232 struct hidpp_report *response)
234 struct hidpp_report *message;
237 if ((report_id != REPORT_ID_HIDPP_SHORT) &&
238 (report_id != REPORT_ID_HIDPP_LONG))
241 if (param_count > sizeof(message->rap.params))
244 message = kzalloc(sizeof(struct hidpp_report), GFP_KERNEL);
247 message->report_id = report_id;
248 message->rap.sub_id = sub_id;
249 message->rap.reg_address = reg_address;
250 memcpy(&message->rap.params, params, param_count);
252 ret = hidpp_send_message_sync(hidpp_dev, message, response);
257 static void delayed_work_cb(struct work_struct *work)
259 struct hidpp_device *hidpp = container_of(work, struct hidpp_device,
261 hidpp_connect_event(hidpp);
264 static inline bool hidpp_match_answer(struct hidpp_report *question,
265 struct hidpp_report *answer)
267 return (answer->fap.feature_index == question->fap.feature_index) &&
268 (answer->fap.funcindex_clientid == question->fap.funcindex_clientid);
271 static inline bool hidpp_match_error(struct hidpp_report *question,
272 struct hidpp_report *answer)
274 return (answer->fap.feature_index == HIDPP_ERROR) &&
275 (answer->fap.funcindex_clientid == question->fap.feature_index) &&
276 (answer->fap.params[0] == question->fap.funcindex_clientid);
279 static inline bool hidpp_report_is_connect_event(struct hidpp_report *report)
281 return (report->report_id == REPORT_ID_HIDPP_SHORT) &&
282 (report->rap.sub_id == 0x41);
285 /* -------------------------------------------------------------------------- */
286 /* HIDP++ 1.0 commands */
287 /* -------------------------------------------------------------------------- */
289 #define HIDPP_SET_REGISTER 0x80
290 #define HIDPP_GET_REGISTER 0x81
291 #define HIDPP_SET_LONG_REGISTER 0x82
292 #define HIDPP_GET_LONG_REGISTER 0x83
294 #define HIDPP_REG_PAIRING_INFORMATION 0xB5
295 #define DEVICE_NAME 0x40
297 static char *hidpp_get_unifying_name(struct hidpp_device *hidpp_dev)
299 struct hidpp_report response;
301 /* hid-logitech-dj is in charge of setting the right device index */
302 u8 params[1] = { DEVICE_NAME };
306 ret = hidpp_send_rap_command_sync(hidpp_dev,
307 REPORT_ID_HIDPP_SHORT,
308 HIDPP_GET_LONG_REGISTER,
309 HIDPP_REG_PAIRING_INFORMATION,
310 params, 1, &response);
314 len = response.rap.params[1];
316 if (2 + len > sizeof(response.rap.params))
319 name = kzalloc(len + 1, GFP_KERNEL);
323 memcpy(name, &response.rap.params[2], len);
327 /* -------------------------------------------------------------------------- */
329 /* -------------------------------------------------------------------------- */
331 #define HIDPP_PAGE_ROOT 0x0000
332 #define HIDPP_PAGE_ROOT_IDX 0x00
334 #define CMD_ROOT_GET_FEATURE 0x01
335 #define CMD_ROOT_GET_PROTOCOL_VERSION 0x11
337 static int hidpp_root_get_feature(struct hidpp_device *hidpp, u16 feature,
338 u8 *feature_index, u8 *feature_type)
340 struct hidpp_report response;
342 u8 params[2] = { feature >> 8, feature & 0x00FF };
344 ret = hidpp_send_fap_command_sync(hidpp,
346 CMD_ROOT_GET_FEATURE,
347 params, 2, &response);
351 *feature_index = response.fap.params[0];
352 *feature_type = response.fap.params[1];
357 static int hidpp_root_get_protocol_version(struct hidpp_device *hidpp)
359 struct hidpp_report response;
362 ret = hidpp_send_fap_command_sync(hidpp,
364 CMD_ROOT_GET_PROTOCOL_VERSION,
367 if (ret == HIDPP_ERROR_INVALID_SUBID) {
368 hidpp->protocol_major = 1;
369 hidpp->protocol_minor = 0;
373 /* the device might not be connected */
374 if (ret == HIDPP_ERROR_RESOURCE_ERROR)
378 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
385 hidpp->protocol_major = response.fap.params[0];
386 hidpp->protocol_minor = response.fap.params[1];
391 static bool hidpp_is_connected(struct hidpp_device *hidpp)
395 ret = hidpp_root_get_protocol_version(hidpp);
397 hid_dbg(hidpp->hid_dev, "HID++ %u.%u device connected.\n",
398 hidpp->protocol_major, hidpp->protocol_minor);
402 /* -------------------------------------------------------------------------- */
403 /* 0x0005: GetDeviceNameType */
404 /* -------------------------------------------------------------------------- */
406 #define HIDPP_PAGE_GET_DEVICE_NAME_TYPE 0x0005
408 #define CMD_GET_DEVICE_NAME_TYPE_GET_COUNT 0x01
409 #define CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME 0x11
410 #define CMD_GET_DEVICE_NAME_TYPE_GET_TYPE 0x21
412 static int hidpp_devicenametype_get_count(struct hidpp_device *hidpp,
413 u8 feature_index, u8 *nameLength)
415 struct hidpp_report response;
418 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
419 CMD_GET_DEVICE_NAME_TYPE_GET_COUNT, NULL, 0, &response);
422 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
429 *nameLength = response.fap.params[0];
434 static int hidpp_devicenametype_get_device_name(struct hidpp_device *hidpp,
435 u8 feature_index, u8 char_index, char *device_name, int len_buf)
437 struct hidpp_report response;
441 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
442 CMD_GET_DEVICE_NAME_TYPE_GET_DEVICE_NAME, &char_index, 1,
446 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
453 if (response.report_id == REPORT_ID_HIDPP_LONG)
454 count = HIDPP_REPORT_LONG_LENGTH - 4;
456 count = HIDPP_REPORT_SHORT_LENGTH - 4;
461 for (i = 0; i < count; i++)
462 device_name[i] = response.fap.params[i];
467 static char *hidpp_get_device_name(struct hidpp_device *hidpp)
476 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_GET_DEVICE_NAME_TYPE,
477 &feature_index, &feature_type);
481 ret = hidpp_devicenametype_get_count(hidpp, feature_index,
486 name = kzalloc(__name_length + 1, GFP_KERNEL);
490 while (index < __name_length) {
491 ret = hidpp_devicenametype_get_device_name(hidpp,
492 feature_index, index, name + index,
493 __name_length - index);
504 /* -------------------------------------------------------------------------- */
505 /* 0x6100: TouchPadRawXY */
506 /* -------------------------------------------------------------------------- */
508 #define HIDPP_PAGE_TOUCHPAD_RAW_XY 0x6100
510 #define CMD_TOUCHPAD_GET_RAW_INFO 0x01
511 #define CMD_TOUCHPAD_SET_RAW_REPORT_STATE 0x21
513 #define EVENT_TOUCHPAD_RAW_XY 0x00
515 #define TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT 0x01
516 #define TOUCHPAD_RAW_XY_ORIGIN_UPPER_LEFT 0x03
518 struct hidpp_touchpad_raw_info {
529 struct hidpp_touchpad_raw_xy_finger {
539 struct hidpp_touchpad_raw_xy {
541 struct hidpp_touchpad_raw_xy_finger fingers[2];
548 static int hidpp_touchpad_get_raw_info(struct hidpp_device *hidpp,
549 u8 feature_index, struct hidpp_touchpad_raw_info *raw_info)
551 struct hidpp_report response;
553 u8 *params = (u8 *)response.fap.params;
555 ret = hidpp_send_fap_command_sync(hidpp, feature_index,
556 CMD_TOUCHPAD_GET_RAW_INFO, NULL, 0, &response);
559 hid_err(hidpp->hid_dev, "%s: received protocol error 0x%02x\n",
566 raw_info->x_size = get_unaligned_be16(¶ms[0]);
567 raw_info->y_size = get_unaligned_be16(¶ms[2]);
568 raw_info->z_range = params[4];
569 raw_info->area_range = params[5];
570 raw_info->maxcontacts = params[7];
571 raw_info->origin = params[8];
572 /* res is given in unit per inch */
573 raw_info->res = get_unaligned_be16(¶ms[13]) * 2 / 51;
578 static int hidpp_touchpad_set_raw_report_state(struct hidpp_device *hidpp_dev,
579 u8 feature_index, bool send_raw_reports,
580 bool sensor_enhanced_settings)
582 struct hidpp_report response;
587 * bit 1 - 16bit Z, no area
588 * bit 2 - enhanced sensitivity
589 * bit 3 - width, height (4 bits each) instead of area
590 * bit 4 - send raw + gestures (degrades smoothness)
591 * remaining bits - reserved
593 u8 params = send_raw_reports | (sensor_enhanced_settings << 2);
595 return hidpp_send_fap_command_sync(hidpp_dev, feature_index,
596 CMD_TOUCHPAD_SET_RAW_REPORT_STATE, ¶ms, 1, &response);
599 static void hidpp_touchpad_touch_event(u8 *data,
600 struct hidpp_touchpad_raw_xy_finger *finger)
602 u8 x_m = data[0] << 2;
603 u8 y_m = data[2] << 2;
605 finger->x = x_m << 6 | data[1];
606 finger->y = y_m << 6 | data[3];
608 finger->contact_type = data[0] >> 6;
609 finger->contact_status = data[2] >> 6;
612 finger->area = data[5];
613 finger->finger_id = data[6] >> 4;
616 static void hidpp_touchpad_raw_xy_event(struct hidpp_device *hidpp_dev,
617 u8 *data, struct hidpp_touchpad_raw_xy *raw_xy)
619 memset(raw_xy, 0, sizeof(struct hidpp_touchpad_raw_xy));
620 raw_xy->end_of_frame = data[8] & 0x01;
621 raw_xy->spurious_flag = (data[8] >> 1) & 0x01;
622 raw_xy->finger_count = data[15] & 0x0f;
623 raw_xy->button = (data[8] >> 2) & 0x01;
625 if (raw_xy->finger_count) {
626 hidpp_touchpad_touch_event(&data[2], &raw_xy->fingers[0]);
627 hidpp_touchpad_touch_event(&data[9], &raw_xy->fingers[1]);
631 /* ************************************************************************** */
635 /* ************************************************************************** */
637 /* -------------------------------------------------------------------------- */
638 /* Touchpad HID++ devices */
639 /* -------------------------------------------------------------------------- */
641 #define WTP_MANUAL_RESOLUTION 39
644 struct input_dev *input;
648 u8 button_feature_index;
651 unsigned int resolution;
654 static int wtp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
655 struct hid_field *field, struct hid_usage *usage,
656 unsigned long **bit, int *max)
658 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
660 if ((hidpp->quirks & HIDPP_QUIRK_MULTI_INPUT) &&
661 (field->application == HID_GD_KEYBOARD))
667 static void wtp_populate_input(struct hidpp_device *hidpp,
668 struct input_dev *input_dev, bool origin_is_hid_core)
670 struct wtp_data *wd = hidpp->private_data;
672 if ((hidpp->quirks & HIDPP_QUIRK_MULTI_INPUT) && origin_is_hid_core)
673 /* this is the generic hid-input call */
676 __set_bit(EV_ABS, input_dev->evbit);
677 __set_bit(EV_KEY, input_dev->evbit);
678 __clear_bit(EV_REL, input_dev->evbit);
679 __clear_bit(EV_LED, input_dev->evbit);
681 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 0, wd->x_size, 0, 0);
682 input_abs_set_res(input_dev, ABS_MT_POSITION_X, wd->resolution);
683 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 0, wd->y_size, 0, 0);
684 input_abs_set_res(input_dev, ABS_MT_POSITION_Y, wd->resolution);
686 /* Max pressure is not given by the devices, pick one */
687 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 0, 50, 0, 0);
689 input_set_capability(input_dev, EV_KEY, BTN_LEFT);
691 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS)
692 input_set_capability(input_dev, EV_KEY, BTN_RIGHT);
694 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
696 input_mt_init_slots(input_dev, wd->maxcontacts, INPUT_MT_POINTER |
697 INPUT_MT_DROP_UNUSED);
699 wd->input = input_dev;
702 static void wtp_touch_event(struct wtp_data *wd,
703 struct hidpp_touchpad_raw_xy_finger *touch_report)
707 if (!touch_report->finger_id || touch_report->contact_type)
711 slot = input_mt_get_slot_by_key(wd->input, touch_report->finger_id);
713 input_mt_slot(wd->input, slot);
714 input_mt_report_slot_state(wd->input, MT_TOOL_FINGER,
715 touch_report->contact_status);
716 if (touch_report->contact_status) {
717 input_event(wd->input, EV_ABS, ABS_MT_POSITION_X,
719 input_event(wd->input, EV_ABS, ABS_MT_POSITION_Y,
720 wd->flip_y ? wd->y_size - touch_report->y :
722 input_event(wd->input, EV_ABS, ABS_MT_PRESSURE,
727 static void wtp_send_raw_xy_event(struct hidpp_device *hidpp,
728 struct hidpp_touchpad_raw_xy *raw)
730 struct wtp_data *wd = hidpp->private_data;
733 for (i = 0; i < 2; i++)
734 wtp_touch_event(wd, &(raw->fingers[i]));
736 if (raw->end_of_frame &&
737 !(hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS))
738 input_event(wd->input, EV_KEY, BTN_LEFT, raw->button);
740 if (raw->end_of_frame || raw->finger_count <= 2) {
741 input_mt_sync_frame(wd->input);
742 input_sync(wd->input);
746 static int wtp_mouse_raw_xy_event(struct hidpp_device *hidpp, u8 *data)
748 struct wtp_data *wd = hidpp->private_data;
749 u8 c1_area = ((data[7] & 0xf) * (data[7] & 0xf) +
750 (data[7] >> 4) * (data[7] >> 4)) / 2;
751 u8 c2_area = ((data[13] & 0xf) * (data[13] & 0xf) +
752 (data[13] >> 4) * (data[13] >> 4)) / 2;
753 struct hidpp_touchpad_raw_xy raw = {
754 .timestamp = data[1],
758 .contact_status = !!data[7],
759 .x = get_unaligned_le16(&data[3]),
760 .y = get_unaligned_le16(&data[5]),
763 .finger_id = data[2],
766 .contact_status = !!data[13],
767 .x = get_unaligned_le16(&data[9]),
768 .y = get_unaligned_le16(&data[11]),
771 .finger_id = data[8],
774 .finger_count = wd->maxcontacts,
776 .end_of_frame = (data[0] >> 7) == 0,
777 .button = data[0] & 0x01,
780 wtp_send_raw_xy_event(hidpp, &raw);
785 static int wtp_raw_event(struct hid_device *hdev, u8 *data, int size)
787 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
788 struct wtp_data *wd = hidpp->private_data;
789 struct hidpp_report *report = (struct hidpp_report *)data;
790 struct hidpp_touchpad_raw_xy raw;
792 if (!wd || !wd->input)
798 hid_err(hdev, "Received HID report of bad size (%d)",
802 if (hidpp->quirks & HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS) {
803 input_event(wd->input, EV_KEY, BTN_LEFT,
805 input_event(wd->input, EV_KEY, BTN_RIGHT,
807 input_sync(wd->input);
812 return wtp_mouse_raw_xy_event(hidpp, &data[7]);
814 case REPORT_ID_HIDPP_LONG:
815 /* size is already checked in hidpp_raw_event. */
816 if ((report->fap.feature_index != wd->mt_feature_index) ||
817 (report->fap.funcindex_clientid != EVENT_TOUCHPAD_RAW_XY))
819 hidpp_touchpad_raw_xy_event(hidpp, data + 4, &raw);
821 wtp_send_raw_xy_event(hidpp, &raw);
828 static int wtp_get_config(struct hidpp_device *hidpp)
830 struct wtp_data *wd = hidpp->private_data;
831 struct hidpp_touchpad_raw_info raw_info = {0};
835 ret = hidpp_root_get_feature(hidpp, HIDPP_PAGE_TOUCHPAD_RAW_XY,
836 &wd->mt_feature_index, &feature_type);
838 /* means that the device is not powered up */
841 ret = hidpp_touchpad_get_raw_info(hidpp, wd->mt_feature_index,
846 wd->x_size = raw_info.x_size;
847 wd->y_size = raw_info.y_size;
848 wd->maxcontacts = raw_info.maxcontacts;
849 wd->flip_y = raw_info.origin == TOUCHPAD_RAW_XY_ORIGIN_LOWER_LEFT;
850 wd->resolution = raw_info.res;
852 wd->resolution = WTP_MANUAL_RESOLUTION;
857 static int wtp_allocate(struct hid_device *hdev, const struct hid_device_id *id)
859 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
862 wd = devm_kzalloc(&hdev->dev, sizeof(struct wtp_data),
867 hidpp->private_data = wd;
872 static void wtp_connect(struct hid_device *hdev, bool connected)
874 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
875 struct wtp_data *wd = hidpp->private_data;
882 ret = wtp_get_config(hidpp);
884 hid_err(hdev, "Can not get wtp config: %d\n", ret);
889 hidpp_touchpad_set_raw_report_state(hidpp, wd->mt_feature_index,
893 /* -------------------------------------------------------------------------- */
894 /* Generic HID++ devices */
895 /* -------------------------------------------------------------------------- */
897 static int hidpp_input_mapping(struct hid_device *hdev, struct hid_input *hi,
898 struct hid_field *field, struct hid_usage *usage,
899 unsigned long **bit, int *max)
901 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
903 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
904 return wtp_input_mapping(hdev, hi, field, usage, bit, max);
909 static void hidpp_populate_input(struct hidpp_device *hidpp,
910 struct input_dev *input, bool origin_is_hid_core)
912 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
913 wtp_populate_input(hidpp, input, origin_is_hid_core);
916 static void hidpp_input_configured(struct hid_device *hdev,
917 struct hid_input *hidinput)
919 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
920 struct input_dev *input = hidinput->input;
922 hidpp_populate_input(hidpp, input, true);
925 static int hidpp_raw_hidpp_event(struct hidpp_device *hidpp, u8 *data,
928 struct hidpp_report *question = hidpp->send_receive_buf;
929 struct hidpp_report *answer = hidpp->send_receive_buf;
930 struct hidpp_report *report = (struct hidpp_report *)data;
933 * If the mutex is locked then we have a pending answer from a
934 * previoulsly sent command
936 if (unlikely(mutex_is_locked(&hidpp->send_mutex))) {
938 * Check for a correct hidpp20 answer or the corresponding
941 if (hidpp_match_answer(question, report) ||
942 hidpp_match_error(question, report)) {
944 hidpp->answer_available = true;
945 wake_up(&hidpp->wait);
947 * This was an answer to a command that this driver sent
948 * We return 1 to hid-core to avoid forwarding the
949 * command upstream as it has been treated by the driver
956 if (unlikely(hidpp_report_is_connect_event(report))) {
957 atomic_set(&hidpp->connected,
958 !(report->rap.params[0] & (1 << 6)));
959 if ((hidpp->quirks & HIDPP_QUIRK_DELAYED_INIT) &&
960 (schedule_work(&hidpp->work) == 0))
961 dbg_hid("%s: connect event already queued\n", __func__);
965 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
966 return wtp_raw_event(hidpp->hid_dev, data, size);
971 static int hidpp_raw_event(struct hid_device *hdev, struct hid_report *report,
974 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
977 case REPORT_ID_HIDPP_LONG:
978 if (size != HIDPP_REPORT_LONG_LENGTH) {
979 hid_err(hdev, "received hid++ report of bad size (%d)",
983 return hidpp_raw_hidpp_event(hidpp, data, size);
984 case REPORT_ID_HIDPP_SHORT:
985 if (size != HIDPP_REPORT_SHORT_LENGTH) {
986 hid_err(hdev, "received hid++ report of bad size (%d)",
990 return hidpp_raw_hidpp_event(hidpp, data, size);
993 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
994 return wtp_raw_event(hdev, data, size);
999 static void hidpp_overwrite_name(struct hid_device *hdev, bool use_unifying)
1001 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1006 * the device is connected through an Unifying receiver, and
1007 * might not be already connected.
1008 * Ask the receiver for its name.
1010 name = hidpp_get_unifying_name(hidpp);
1012 name = hidpp_get_device_name(hidpp);
1015 hid_err(hdev, "unable to retrieve the name of the device");
1017 snprintf(hdev->name, sizeof(hdev->name), "%s", name);
1022 static int hidpp_input_open(struct input_dev *dev)
1024 struct hid_device *hid = input_get_drvdata(dev);
1026 return hid_hw_open(hid);
1029 static void hidpp_input_close(struct input_dev *dev)
1031 struct hid_device *hid = input_get_drvdata(dev);
1036 static struct input_dev *hidpp_allocate_input(struct hid_device *hdev)
1038 struct input_dev *input_dev = devm_input_allocate_device(&hdev->dev);
1043 input_set_drvdata(input_dev, hdev);
1044 input_dev->open = hidpp_input_open;
1045 input_dev->close = hidpp_input_close;
1047 input_dev->name = hdev->name;
1048 input_dev->phys = hdev->phys;
1049 input_dev->uniq = hdev->uniq;
1050 input_dev->id.bustype = hdev->bus;
1051 input_dev->id.vendor = hdev->vendor;
1052 input_dev->id.product = hdev->product;
1053 input_dev->id.version = hdev->version;
1054 input_dev->dev.parent = &hdev->dev;
1059 static void hidpp_connect_event(struct hidpp_device *hidpp)
1061 struct hid_device *hdev = hidpp->hid_dev;
1063 bool connected = atomic_read(&hidpp->connected);
1064 struct input_dev *input;
1065 char *name, *devm_name;
1067 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)
1068 wtp_connect(hdev, connected);
1070 if (!connected || hidpp->delayed_input)
1073 if (!hidpp->protocol_major) {
1074 ret = !hidpp_is_connected(hidpp);
1076 hid_err(hdev, "Can not get the protocol version.\n");
1081 /* the device is already connected, we can ask for its name and
1083 hid_info(hdev, "HID++ %u.%u device connected.\n",
1084 hidpp->protocol_major, hidpp->protocol_minor);
1086 input = hidpp_allocate_input(hdev);
1088 hid_err(hdev, "cannot allocate new input device: %d\n", ret);
1092 name = hidpp_get_device_name(hidpp);
1094 hid_err(hdev, "unable to retrieve the name of the device");
1096 devm_name = devm_kasprintf(&hdev->dev, GFP_KERNEL, "%s", name);
1098 input->name = devm_name;
1102 hidpp_populate_input(hidpp, input, false);
1104 ret = input_register_device(input);
1106 input_free_device(input);
1108 hidpp->delayed_input = input;
1111 static int hidpp_probe(struct hid_device *hdev, const struct hid_device_id *id)
1113 struct hidpp_device *hidpp;
1116 unsigned int connect_mask = HID_CONNECT_DEFAULT;
1118 hidpp = devm_kzalloc(&hdev->dev, sizeof(struct hidpp_device),
1123 hidpp->hid_dev = hdev;
1124 hid_set_drvdata(hdev, hidpp);
1126 hidpp->quirks = id->driver_data;
1128 if (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP) {
1129 ret = wtp_allocate(hdev, id);
1131 goto wtp_allocate_fail;
1134 INIT_WORK(&hidpp->work, delayed_work_cb);
1135 mutex_init(&hidpp->send_mutex);
1136 init_waitqueue_head(&hidpp->wait);
1138 ret = hid_parse(hdev);
1140 hid_err(hdev, "%s:parse failed\n", __func__);
1141 goto hid_parse_fail;
1144 /* Allow incoming packets */
1145 hid_device_io_start(hdev);
1147 connected = hidpp_is_connected(hidpp);
1148 if (id->group != HID_GROUP_LOGITECH_DJ_DEVICE) {
1150 hid_err(hdev, "Device not connected");
1151 hid_device_io_stop(hdev);
1152 goto hid_parse_fail;
1155 hid_info(hdev, "HID++ %u.%u device connected.\n",
1156 hidpp->protocol_major, hidpp->protocol_minor);
1159 hidpp_overwrite_name(hdev, id->group == HID_GROUP_LOGITECH_DJ_DEVICE);
1160 atomic_set(&hidpp->connected, connected);
1162 if (connected && (hidpp->quirks & HIDPP_QUIRK_CLASS_WTP)) {
1163 ret = wtp_get_config(hidpp);
1165 goto hid_parse_fail;
1168 /* Block incoming packets */
1169 hid_device_io_stop(hdev);
1171 if (hidpp->quirks & HIDPP_QUIRK_DELAYED_INIT)
1172 connect_mask &= ~HID_CONNECT_HIDINPUT;
1174 /* Re-enable hidinput for multi-input devices */
1175 if (hidpp->quirks & HIDPP_QUIRK_MULTI_INPUT)
1176 connect_mask |= HID_CONNECT_HIDINPUT;
1178 ret = hid_hw_start(hdev, connect_mask);
1180 hid_err(hdev, "%s:hid_hw_start returned error\n", __func__);
1181 goto hid_hw_start_fail;
1184 if (hidpp->quirks & HIDPP_QUIRK_DELAYED_INIT) {
1185 /* Allow incoming packets */
1186 hid_device_io_start(hdev);
1188 hidpp_connect_event(hidpp);
1195 cancel_work_sync(&hidpp->work);
1196 mutex_destroy(&hidpp->send_mutex);
1198 hid_set_drvdata(hdev, NULL);
1202 static void hidpp_remove(struct hid_device *hdev)
1204 struct hidpp_device *hidpp = hid_get_drvdata(hdev);
1206 cancel_work_sync(&hidpp->work);
1207 mutex_destroy(&hidpp->send_mutex);
1211 static const struct hid_device_id hidpp_devices[] = {
1212 { /* wireless touchpad */
1213 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
1214 USB_VENDOR_ID_LOGITECH, 0x4011),
1215 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT |
1216 HIDPP_QUIRK_WTP_PHYSICAL_BUTTONS },
1217 { /* wireless touchpad T650 */
1218 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
1219 USB_VENDOR_ID_LOGITECH, 0x4101),
1220 .driver_data = HIDPP_QUIRK_CLASS_WTP | HIDPP_QUIRK_DELAYED_INIT },
1221 { /* wireless touchpad T651 */
1222 HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
1223 USB_DEVICE_ID_LOGITECH_T651),
1224 .driver_data = HIDPP_QUIRK_CLASS_WTP },
1225 { /* Keyboard TK820 */
1226 HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
1227 USB_VENDOR_ID_LOGITECH, 0x4102),
1228 .driver_data = HIDPP_QUIRK_DELAYED_INIT | HIDPP_QUIRK_MULTI_INPUT |
1229 HIDPP_QUIRK_CLASS_WTP },
1231 { HID_DEVICE(BUS_USB, HID_GROUP_LOGITECH_DJ_DEVICE,
1232 USB_VENDOR_ID_LOGITECH, HID_ANY_ID)},
1236 MODULE_DEVICE_TABLE(hid, hidpp_devices);
1238 static struct hid_driver hidpp_driver = {
1239 .name = "logitech-hidpp-device",
1240 .id_table = hidpp_devices,
1241 .probe = hidpp_probe,
1242 .remove = hidpp_remove,
1243 .raw_event = hidpp_raw_event,
1244 .input_configured = hidpp_input_configured,
1245 .input_mapping = hidpp_input_mapping,
1248 module_hid_driver(hidpp_driver);