2 * Copyright (c) 2016 Masaki Ota <masaki.ota@jp.alps.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
10 #include <linux/kernel.h>
11 #include <linux/hid.h>
12 #include <linux/input.h>
13 #include <linux/input/mt.h>
14 #include <linux/module.h>
15 #include <asm/unaligned.h>
18 /* ALPS Device Product ID */
19 #define HID_PRODUCT_ID_T3_BTNLESS 0xD0C0
20 #define HID_PRODUCT_ID_COSMO 0x1202
21 #define HID_PRODUCT_ID_U1_PTP_1 0x1207
22 #define HID_PRODUCT_ID_U1 0x1209
23 #define HID_PRODUCT_ID_U1_PTP_2 0x120A
24 #define HID_PRODUCT_ID_U1_DUAL 0x120B
25 #define HID_PRODUCT_ID_T4_BTNLESS 0x120C
27 #define DEV_SINGLEPOINT 0x01
28 #define DEV_DUALPOINT 0x02
30 #define U1_MOUSE_REPORT_ID 0x01 /* Mouse data ReportID */
31 #define U1_ABSOLUTE_REPORT_ID 0x03 /* Absolute data ReportID */
32 #define U1_FEATURE_REPORT_ID 0x05 /* Feature ReportID */
33 #define U1_SP_ABSOLUTE_REPORT_ID 0x06 /* Feature ReportID */
35 #define U1_FEATURE_REPORT_LEN 0x08 /* Feature Report Length */
36 #define U1_FEATURE_REPORT_LEN_ALL 0x0A
37 #define U1_CMD_REGISTER_READ 0xD1
38 #define U1_CMD_REGISTER_WRITE 0xD2
40 #define U1_DEVTYPE_SP_SUPPORT 0x10 /* SP Support */
41 #define U1_DISABLE_DEV 0x01
42 #define U1_TP_ABS_MODE 0x02
43 #define U1_SP_ABS_MODE 0x80
45 #define ADDRESS_U1_DEV_CTRL_1 0x00800040
46 #define ADDRESS_U1_DEVICE_TYP 0x00800043
47 #define ADDRESS_U1_NUM_SENS_X 0x00800047
48 #define ADDRESS_U1_NUM_SENS_Y 0x00800048
49 #define ADDRESS_U1_PITCH_SENS_X 0x00800049
50 #define ADDRESS_U1_PITCH_SENS_Y 0x0080004A
51 #define ADDRESS_U1_RESO_DWN_ABS 0x0080004E
52 #define ADDRESS_U1_PAD_BTN 0x00800052
53 #define ADDRESS_U1_SP_BTN 0x0080009F
55 #define T4_INPUT_REPORT_LEN sizeof(T4_INPUT_REPORT)
56 #define T4_FEATURE_REPORT_LEN T4_INPUT_REPORT_LEN
57 #define T4_FEATURE_REPORT_ID 7
58 #define T4_CMD_REGISTER_READ 0x08
59 #define T4_CMD_REGISTER_WRITE 0x07
61 #define T4_ADDRESS_BASE 0xC2C0
62 #define PRM_SYS_CONFIG_1 (T4_ADDRESS_BASE + 0x0002)
63 #define T4_PRM_FEED_CONFIG_1 (T4_ADDRESS_BASE + 0x0004)
64 #define T4_PRM_FEED_CONFIG_4 (T4_ADDRESS_BASE + 0x001A)
65 #define T4_PRM_ID_CONFIG_3 (T4_ADDRESS_BASE + 0x00B0)
67 #define T4_FEEDCFG4_ADVANCED_ABS_ENABLE 0x01
68 #define T4_I2C_ABS 0x78
70 #define T4_COUNT_PER_ELECTRODE 256
81 * @input: pointer to the kernel input device
82 * @input2: pointer to the kernel input2 device
83 * @hdev: pointer to the struct hid_device
85 * @dev_type: device type
86 * @max_fingers: total number of fingers
87 * @has_sp: boolean of sp existense
88 * @sp_btn_info: button information
89 * @x_active_len_mm: active area length of X (mm)
90 * @y_active_len_mm: active area length of Y (mm)
91 * @x_max: maximum x coordinate value
92 * @y_max: maximum y coordinate value
93 * @x_min: minimum x coordinate value
94 * @y_min: minimum y coordinate value
95 * @btn_cnt: number of buttons
96 * @sp_btn_cnt: number of stick buttons
99 struct input_dev *input;
100 struct input_dev *input2;
101 struct hid_device *hdev;
117 typedef struct _T4_CONTACT_DATA {
123 } T4_CONTACT_DATA, *PT4_CONTACT_DATA;
125 typedef struct _T4_INPUT_REPORT {
128 T4_CONTACT_DATA Contact[5];
135 } T4_INPUT_REPORT, *PT4_INPUT_REPORT;
137 static u16 t4_calc_check_sum(u8 *buffer, unsigned long offset, unsigned long length)
139 u16 sum1 = 0xFF, sum2 = 0xFF;
142 if (offset + length >= 50)
146 u32 tlen = length > 20 ? 20 : length;
151 sum1 += buffer[offset + i];
154 } while (--tlen > 0);
156 sum1 = (sum1 & 0xFF) + (sum1 >> 8);
157 sum2 = (sum2 & 0xFF) + (sum2 >> 8);
160 sum1 = (sum1 & 0xFF) + (sum1 >> 8);
161 sum2 = (sum2 & 0xFF) + (sum2 >> 8);
163 return(sum2 << 8 | sum1);
166 static int T4_read_write_register(struct hid_device *hdev, u32 address,
167 u8 *read_val, u8 write_val, bool read_flag)
174 input = kzalloc(T4_FEATURE_REPORT_LEN, GFP_KERNEL);
178 input[0] = T4_FEATURE_REPORT_ID;
180 input[1] = T4_CMD_REGISTER_READ;
183 input[1] = T4_CMD_REGISTER_WRITE;
184 input[8] = write_val;
186 put_unaligned_le32(address, input + 2);
190 /*Calculate amd append the checksum*/
191 check_sum = t4_calc_check_sum(input, 1, 8);
192 input[9] = (u8)check_sum;
193 input[10] = (u8)(check_sum >> 8);
196 ret = hid_hw_raw_request(hdev, T4_FEATURE_REPORT_ID, input,
197 T4_FEATURE_REPORT_LEN,
198 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
201 dev_err(&hdev->dev, "failed to read command (%d)\n", ret);
206 readbuf = kzalloc(T4_FEATURE_REPORT_LEN, GFP_KERNEL);
212 ret = hid_hw_raw_request(hdev, T4_FEATURE_REPORT_ID, readbuf,
213 T4_FEATURE_REPORT_LEN,
214 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
216 dev_err(&hdev->dev, "failed read register (%d)\n", ret);
219 if (*(u32 *)&readbuf[6] != address)
220 hid_alert(hdev, "T4_read_write_register address error %x %x\n", *(u32 *)&readbuf[6], address);
221 if (*(u16 *)&readbuf[10] != 1)
222 hid_alert(hdev, "T4_read_write_register size error %x\n", *(u16 *)&readbuf[10]);
223 check_sum = t4_calc_check_sum(readbuf, 6, 7);
224 if (*(u16 *)&readbuf[13] != check_sum)
225 hid_alert(hdev, "T4_read_write_register checksum error %x %x\n", *(u16 *)&readbuf[13], check_sum);
226 *read_val = readbuf[12];
238 static int u1_read_write_register(struct hid_device *hdev, u32 address,
239 u8 *read_val, u8 write_val, bool read_flag)
246 input = kzalloc(U1_FEATURE_REPORT_LEN, GFP_KERNEL);
250 input[0] = U1_FEATURE_REPORT_ID;
252 input[1] = U1_CMD_REGISTER_READ;
255 input[1] = U1_CMD_REGISTER_WRITE;
256 input[6] = write_val;
259 put_unaligned_le32(address, input + 2);
261 /* Calculate the checksum */
262 check_sum = U1_FEATURE_REPORT_LEN_ALL;
263 for (i = 0; i < U1_FEATURE_REPORT_LEN - 1; i++)
264 check_sum += input[i];
266 input[7] = check_sum;
267 ret = hid_hw_raw_request(hdev, U1_FEATURE_REPORT_ID, input,
268 U1_FEATURE_REPORT_LEN,
269 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
272 dev_err(&hdev->dev, "failed to read command (%d)\n", ret);
277 readbuf = kzalloc(U1_FEATURE_REPORT_LEN, GFP_KERNEL);
283 ret = hid_hw_raw_request(hdev, U1_FEATURE_REPORT_ID, readbuf,
284 U1_FEATURE_REPORT_LEN,
285 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
288 dev_err(&hdev->dev, "failed read register (%d)\n", ret);
292 *read_val = readbuf[6];
304 static int T4_raw_event(struct alps_dev *hdata, u8 *data, int size)
306 unsigned int x, y, z;
308 PT4_INPUT_REPORT p_report = (PT4_INPUT_REPORT)data;
312 for (i = 0; i < hdata->max_fingers; i++) {
313 x = p_report->Contact[i].x_hi << 8 | p_report->Contact[i].x_lo;
314 y = p_report->Contact[i].y_hi << 8 | p_report->Contact[i].y_lo;
315 y = hdata->y_max - y + hdata->y_min;
316 z = (p_report->Contact[i].Palm < 0x80 && p_report->Contact[i].Palm > 0) * 62;
319 input_mt_slot(hdata->input, i);
322 input_mt_report_slot_state(hdata->input, MT_TOOL_FINGER, 1);
324 input_mt_report_slot_state(hdata->input, MT_TOOL_FINGER, 0);
328 input_report_abs(hdata->input, ABS_MT_POSITION_X, x);
329 input_report_abs(hdata->input, ABS_MT_POSITION_Y, y);
330 input_report_abs(hdata->input, ABS_MT_PRESSURE, z);
332 input_mt_sync_frame(hdata->input);
334 input_report_key(hdata->input, BTN_LEFT, p_report->Button);
336 input_sync(hdata->input);
340 static int U1_raw_event(struct alps_dev *hdata, u8 *data, int size)
342 unsigned int x, y, z;
349 case U1_MOUSE_REPORT_ID:
351 case U1_FEATURE_REPORT_ID:
353 case U1_ABSOLUTE_REPORT_ID:
354 for (i = 0; i < hdata->max_fingers; i++) {
355 u8 *contact = &data[i * 5];
357 x = get_unaligned_le16(contact + 3);
358 y = get_unaligned_le16(contact + 5);
359 z = contact[7] & 0x7F;
361 input_mt_slot(hdata->input, i);
364 input_mt_report_slot_state(hdata->input,
367 input_report_abs(hdata->input, ABS_MT_POSITION_X, x);
368 input_report_abs(hdata->input, ABS_MT_POSITION_Y, y);
369 input_report_abs(hdata->input, ABS_MT_PRESSURE, z);
371 input_mt_report_slot_state(hdata->input,
376 input_mt_sync_frame(hdata->input);
378 input_report_key(hdata->input, BTN_LEFT,
380 input_report_key(hdata->input, BTN_RIGHT,
381 (data[1] & 0x2) >> 1);
382 input_report_key(hdata->input, BTN_MIDDLE,
383 (data[1] & 0x4) >> 2);
385 input_sync(hdata->input);
389 case U1_SP_ABSOLUTE_REPORT_ID:
390 sp_x = get_unaligned_le16(data + 2);
391 sp_y = get_unaligned_le16(data + 4);
396 input_report_rel(hdata->input2, REL_X, sp_x);
397 input_report_rel(hdata->input2, REL_Y, sp_y);
399 input_report_key(hdata->input2, BTN_LEFT,
401 input_report_key(hdata->input2, BTN_RIGHT,
402 (data[1] & 0x2) >> 1);
403 input_report_key(hdata->input2, BTN_MIDDLE,
404 (data[1] & 0x4) >> 2);
406 input_sync(hdata->input2);
413 static int alps_raw_event(struct hid_device *hdev,
414 struct hid_report *report, u8 *data, int size)
417 struct alps_dev *hdata = hid_get_drvdata(hdev);
419 if (hdev->product == HID_PRODUCT_ID_T4_BTNLESS)
420 ret = T4_raw_event(hdata, data, size);
422 ret = U1_raw_event(hdata, data, size);
427 static int alps_post_reset(struct hid_device *hdev)
430 struct alps_dev *data = hid_get_drvdata(hdev);
432 switch (data->dev_type) {
434 ret = T4_read_write_register(hdev, T4_PRM_FEED_CONFIG_1,
435 NULL, T4_I2C_ABS, false);
436 ret = T4_read_write_register(hdev, T4_PRM_FEED_CONFIG_4,
437 NULL, T4_FEEDCFG4_ADVANCED_ABS_ENABLE, false);
440 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
441 NULL, U1_TP_ABS_MODE | U1_SP_ABS_MODE, false);
449 static int alps_post_resume(struct hid_device *hdev)
451 return alps_post_reset(hdev);
453 #endif /* CONFIG_PM */
455 static int u1_init(struct hid_device *hdev, struct alps_dev *pri_data)
458 u8 tmp, dev_ctrl, sen_line_num_x, sen_line_num_y, pitch_x, pitch_y, resolution;
459 /* Device initialization */
460 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
463 dev_err(&hdev->dev, "failed U1_DEV_CTRL_1 (%d)\n", ret);
467 dev_ctrl &= ~U1_DISABLE_DEV;
468 dev_ctrl |= U1_TP_ABS_MODE;
469 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
470 NULL, dev_ctrl, false);
472 dev_err(&hdev->dev, "failed to change TP mode (%d)\n", ret);
476 ret = u1_read_write_register(hdev, ADDRESS_U1_NUM_SENS_X,
477 &sen_line_num_x, 0, true);
479 dev_err(&hdev->dev, "failed U1_NUM_SENS_X (%d)\n", ret);
483 ret = u1_read_write_register(hdev, ADDRESS_U1_NUM_SENS_Y,
484 &sen_line_num_y, 0, true);
486 dev_err(&hdev->dev, "failed U1_NUM_SENS_Y (%d)\n", ret);
490 ret = u1_read_write_register(hdev, ADDRESS_U1_PITCH_SENS_X,
493 dev_err(&hdev->dev, "failed U1_PITCH_SENS_X (%d)\n", ret);
497 ret = u1_read_write_register(hdev, ADDRESS_U1_PITCH_SENS_Y,
500 dev_err(&hdev->dev, "failed U1_PITCH_SENS_Y (%d)\n", ret);
504 ret = u1_read_write_register(hdev, ADDRESS_U1_RESO_DWN_ABS,
505 &resolution, 0, true);
507 dev_err(&hdev->dev, "failed U1_RESO_DWN_ABS (%d)\n", ret);
510 pri_data->x_active_len_mm =
511 (pitch_x * (sen_line_num_x - 1)) / 10;
512 pri_data->y_active_len_mm =
513 (pitch_y * (sen_line_num_y - 1)) / 10;
516 (resolution << 2) * (sen_line_num_x - 1);
519 (resolution << 2) * (sen_line_num_y - 1);
522 ret = u1_read_write_register(hdev, ADDRESS_U1_PAD_BTN,
525 dev_err(&hdev->dev, "failed U1_PAD_BTN (%d)\n", ret);
528 if ((tmp & 0x0F) == (tmp & 0xF0) >> 4) {
529 pri_data->btn_cnt = (tmp & 0x0F);
532 pri_data->btn_cnt = 1;
535 pri_data->has_sp = 0;
536 /* Check StickPointer device */
537 ret = u1_read_write_register(hdev, ADDRESS_U1_DEVICE_TYP,
540 dev_err(&hdev->dev, "failed U1_DEVICE_TYP (%d)\n", ret);
543 if (tmp & U1_DEVTYPE_SP_SUPPORT) {
544 dev_ctrl |= U1_SP_ABS_MODE;
545 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
546 NULL, dev_ctrl, false);
548 dev_err(&hdev->dev, "failed SP mode (%d)\n", ret);
552 ret = u1_read_write_register(hdev, ADDRESS_U1_SP_BTN,
553 &pri_data->sp_btn_info, 0, true);
555 dev_err(&hdev->dev, "failed U1_SP_BTN (%d)\n", ret);
558 pri_data->has_sp = 1;
560 pri_data->max_fingers = 5;
565 static int T4_init(struct hid_device *hdev, struct alps_dev *pri_data)
568 u8 tmp, sen_line_num_x, sen_line_num_y;
570 ret = T4_read_write_register(hdev, T4_PRM_ID_CONFIG_3, &tmp, 0, true);
572 dev_err(&hdev->dev, "failed T4_PRM_ID_CONFIG_3 (%d)\n", ret);
575 sen_line_num_x = 16 + ((tmp & 0x0F) | (tmp & 0x08 ? 0xF0 : 0));
576 sen_line_num_y = 12 + (((tmp & 0xF0) >> 4) | (tmp & 0x80 ? 0xF0 : 0));
578 pri_data->x_max = sen_line_num_x * T4_COUNT_PER_ELECTRODE;
579 pri_data->x_min = T4_COUNT_PER_ELECTRODE;
580 pri_data->y_max = sen_line_num_y * T4_COUNT_PER_ELECTRODE;
581 pri_data->y_min = T4_COUNT_PER_ELECTRODE;
582 pri_data->x_active_len_mm = 0;
583 pri_data->y_active_len_mm = 0;
584 pri_data->btn_cnt = 1;
586 ret = T4_read_write_register(hdev, PRM_SYS_CONFIG_1, &tmp, 0, true);
588 dev_err(&hdev->dev, "failed PRM_SYS_CONFIG_1 (%d)\n", ret);
592 ret = T4_read_write_register(hdev, PRM_SYS_CONFIG_1, NULL, tmp, false);
594 dev_err(&hdev->dev, "failed PRM_SYS_CONFIG_1 (%d)\n", ret);
598 ret = T4_read_write_register(hdev, T4_PRM_FEED_CONFIG_1, NULL, T4_I2C_ABS, false);
600 dev_err(&hdev->dev, "failed T4_PRM_FEED_CONFIG_1 (%d)\n", ret);
604 ret = T4_read_write_register (hdev, T4_PRM_FEED_CONFIG_4, NULL, T4_FEEDCFG4_ADVANCED_ABS_ENABLE, false);
606 dev_err(&hdev->dev, "failed T4_PRM_FEED_CONFIG_4 (%d)\n", ret);
609 pri_data->max_fingers = 5;
610 pri_data->has_sp = 0;
615 static int alps_input_configured(struct hid_device *hdev, struct hid_input *hi)
617 struct alps_dev *data = hid_get_drvdata(hdev);
618 struct input_dev *input = hi->input, *input2;
624 hid_dbg(hdev, "Opening low level driver\n");
625 ret = hid_hw_open(hdev);
629 /* Allow incoming hid reports */
630 hid_device_io_start(hdev);
631 if (data->dev_type == T4)
632 ret = T4_init(hdev, data);
634 ret = u1_init(hdev, data);
638 __set_bit(EV_ABS, input->evbit);
639 input_set_abs_params(input, ABS_MT_POSITION_X, data->x_min, data->x_max, 0, 0);
640 input_set_abs_params(input, ABS_MT_POSITION_Y, data->y_min, data->y_max, 0, 0);
642 if (data->x_active_len_mm && data->y_active_len_mm) {
643 res_x = (data->x_max - 1) / data->x_active_len_mm;
644 res_y = (data->y_max - 1) / data->y_active_len_mm;
646 input_abs_set_res(input, ABS_MT_POSITION_X, res_x);
647 input_abs_set_res(input, ABS_MT_POSITION_Y, res_y);
650 input_set_abs_params(input, ABS_MT_PRESSURE, 0, 64, 0, 0);
652 input_mt_init_slots(input, data->max_fingers, INPUT_MT_POINTER);
654 __set_bit(EV_KEY, input->evbit);
656 if (data->btn_cnt == 1)
657 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
659 for (i = 0; i < data->btn_cnt; i++)
660 __set_bit(BTN_LEFT + i, input->keybit);
662 /* Stick device initialization */
664 input2 = input_allocate_device();
666 input_free_device(input2);
670 data->input2 = input2;
671 input2->phys = input->phys;
672 input2->name = "DualPoint Stick";
673 input2->id.bustype = BUS_I2C;
674 input2->id.vendor = input->id.vendor;
675 input2->id.product = input->id.product;
676 input2->id.version = input->id.version;
677 input2->dev.parent = input->dev.parent;
679 __set_bit(EV_KEY, input2->evbit);
680 data->sp_btn_cnt = (data->sp_btn_info & 0x0F);
681 for (i = 0; i < data->sp_btn_cnt; i++)
682 __set_bit(BTN_LEFT + i, input2->keybit);
684 __set_bit(EV_REL, input2->evbit);
685 __set_bit(REL_X, input2->relbit);
686 __set_bit(REL_Y, input2->relbit);
687 __set_bit(INPUT_PROP_POINTER, input2->propbit);
688 __set_bit(INPUT_PROP_POINTING_STICK, input2->propbit);
690 if (input_register_device(data->input2)) {
691 input_free_device(input2);
697 hid_device_io_stop(hdev);
702 static int alps_input_mapping(struct hid_device *hdev,
703 struct hid_input *hi, struct hid_field *field,
704 struct hid_usage *usage, unsigned long **bit, int *max)
709 static int alps_probe(struct hid_device *hdev, const struct hid_device_id *id)
711 struct alps_dev *data = NULL;
714 data = devm_kzalloc(&hdev->dev, sizeof(struct alps_dev), GFP_KERNEL);
719 hid_set_drvdata(hdev, data);
721 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
723 ret = hid_parse(hdev);
725 hid_err(hdev, "parse failed\n");
728 switch (hdev->product) {
729 case HID_DEVICE_ID_ALPS_T4_BTNLESS:
732 case HID_DEVICE_ID_ALPS_U1_DUAL:
733 case HID_DEVICE_ID_ALPS_U1:
737 data->dev_type = UNKNOWN;
740 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
742 hid_err(hdev, "hw start failed\n");
749 static void alps_remove(struct hid_device *hdev)
754 static const struct hid_device_id alps_id[] = {
755 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
756 USB_VENDOR_ID_ALPS_JP, HID_DEVICE_ID_ALPS_U1_DUAL) },
757 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
758 USB_VENDOR_ID_ALPS_JP, HID_DEVICE_ID_ALPS_U1) },
759 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
760 USB_VENDOR_ID_ALPS_JP, HID_DEVICE_ID_ALPS_T4_BTNLESS) },
763 MODULE_DEVICE_TABLE(hid, alps_id);
765 static struct hid_driver alps_driver = {
769 .remove = alps_remove,
770 .raw_event = alps_raw_event,
771 .input_mapping = alps_input_mapping,
772 .input_configured = alps_input_configured,
774 .resume = alps_post_resume,
775 .reset_resume = alps_post_reset,
779 module_hid_driver(alps_driver);
781 MODULE_AUTHOR("Masaki Ota <masaki.ota@jp.alps.com>");
782 MODULE_DESCRIPTION("ALPS HID driver");
783 MODULE_LICENSE("GPL");