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(struct 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)
68 #define T4_FEEDCFG4_ADVANCED_ABS_ENABLE 0x01
69 #define T4_I2C_ABS 0x78
71 #define T4_COUNT_PER_ELECTRODE 256
82 * @input: pointer to the kernel input device
83 * @input2: pointer to the kernel input2 device
84 * @hdev: pointer to the struct hid_device
86 * @dev_type: device type
87 * @max_fingers: total number of fingers
88 * @has_sp: boolean of sp existense
89 * @sp_btn_info: button information
90 * @x_active_len_mm: active area length of X (mm)
91 * @y_active_len_mm: active area length of Y (mm)
92 * @x_max: maximum x coordinate value
93 * @y_max: maximum y coordinate value
94 * @x_min: minimum x coordinate value
95 * @y_min: minimum y coordinate value
96 * @btn_cnt: number of buttons
97 * @sp_btn_cnt: number of stick buttons
100 struct input_dev *input;
101 struct input_dev *input2;
102 struct hid_device *hdev;
104 enum dev_num dev_type;
118 struct t4_contact_data {
126 struct t4_input_report {
129 struct t4_contact_data contact[5];
138 static u16 t4_calc_check_sum(u8 *buffer,
139 unsigned long offset, unsigned long length)
141 u16 sum1 = 0xFF, sum2 = 0xFF;
144 if (offset + length >= 50)
148 u32 tlen = length > 20 ? 20 : length;
153 sum1 += buffer[offset + i];
156 } while (--tlen > 0);
158 sum1 = (sum1 & 0xFF) + (sum1 >> 8);
159 sum2 = (sum2 & 0xFF) + (sum2 >> 8);
162 sum1 = (sum1 & 0xFF) + (sum1 >> 8);
163 sum2 = (sum2 & 0xFF) + (sum2 >> 8);
165 return(sum2 << 8 | sum1);
168 static int t4_read_write_register(struct hid_device *hdev, u32 address,
169 u8 *read_val, u8 write_val, bool read_flag)
176 input = kzalloc(T4_FEATURE_REPORT_LEN, GFP_KERNEL);
180 input[0] = T4_FEATURE_REPORT_ID;
182 input[1] = T4_CMD_REGISTER_READ;
185 input[1] = T4_CMD_REGISTER_WRITE;
186 input[8] = write_val;
188 put_unaligned_le32(address, input + 2);
192 /* Calculate the checksum */
193 check_sum = t4_calc_check_sum(input, 1, 8);
194 input[9] = (u8)check_sum;
195 input[10] = (u8)(check_sum >> 8);
198 ret = hid_hw_raw_request(hdev, T4_FEATURE_REPORT_ID, input,
199 T4_FEATURE_REPORT_LEN,
200 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
203 dev_err(&hdev->dev, "failed to read command (%d)\n", ret);
208 readbuf = kzalloc(T4_FEATURE_REPORT_LEN, GFP_KERNEL);
214 ret = hid_hw_raw_request(hdev, T4_FEATURE_REPORT_ID, readbuf,
215 T4_FEATURE_REPORT_LEN,
216 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
218 dev_err(&hdev->dev, "failed read register (%d)\n", ret);
224 if (*(u32 *)&readbuf[6] != address) {
225 dev_err(&hdev->dev, "read register address error (%x,%x)\n",
226 *(u32 *)&readbuf[6], address);
230 if (*(u16 *)&readbuf[10] != 1) {
231 dev_err(&hdev->dev, "read register size error (%x)\n",
232 *(u16 *)&readbuf[10]);
236 check_sum = t4_calc_check_sum(readbuf, 6, 7);
237 if (*(u16 *)&readbuf[13] != check_sum) {
238 dev_err(&hdev->dev, "read register checksum error (%x,%x)\n",
239 *(u16 *)&readbuf[13], check_sum);
243 *read_val = readbuf[12];
255 static int u1_read_write_register(struct hid_device *hdev, u32 address,
256 u8 *read_val, u8 write_val, bool read_flag)
263 input = kzalloc(U1_FEATURE_REPORT_LEN, GFP_KERNEL);
267 input[0] = U1_FEATURE_REPORT_ID;
269 input[1] = U1_CMD_REGISTER_READ;
272 input[1] = U1_CMD_REGISTER_WRITE;
273 input[6] = write_val;
276 put_unaligned_le32(address, input + 2);
278 /* Calculate the checksum */
279 check_sum = U1_FEATURE_REPORT_LEN_ALL;
280 for (i = 0; i < U1_FEATURE_REPORT_LEN - 1; i++)
281 check_sum += input[i];
283 input[7] = check_sum;
284 ret = hid_hw_raw_request(hdev, U1_FEATURE_REPORT_ID, input,
285 U1_FEATURE_REPORT_LEN,
286 HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
289 dev_err(&hdev->dev, "failed to read command (%d)\n", ret);
294 readbuf = kzalloc(U1_FEATURE_REPORT_LEN, GFP_KERNEL);
300 ret = hid_hw_raw_request(hdev, U1_FEATURE_REPORT_ID, readbuf,
301 U1_FEATURE_REPORT_LEN,
302 HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
305 dev_err(&hdev->dev, "failed read register (%d)\n", ret);
310 *read_val = readbuf[6];
322 static int t4_raw_event(struct alps_dev *hdata, u8 *data, int size)
324 unsigned int x, y, z;
326 struct t4_input_report *p_report = (struct t4_input_report *)data;
330 for (i = 0; i < hdata->max_fingers; i++) {
331 x = p_report->contact[i].x_hi << 8 | p_report->contact[i].x_lo;
332 y = p_report->contact[i].y_hi << 8 | p_report->contact[i].y_lo;
333 y = hdata->y_max - y + hdata->y_min;
334 z = (p_report->contact[i].palm < 0x80 &&
335 p_report->contact[i].palm > 0) * 62;
341 input_mt_slot(hdata->input, i);
343 input_mt_report_slot_state(hdata->input,
344 MT_TOOL_FINGER, z != 0);
349 input_report_abs(hdata->input, ABS_MT_POSITION_X, x);
350 input_report_abs(hdata->input, ABS_MT_POSITION_Y, y);
351 input_report_abs(hdata->input, ABS_MT_PRESSURE, z);
353 input_mt_sync_frame(hdata->input);
355 input_report_key(hdata->input, BTN_LEFT, p_report->button);
357 input_sync(hdata->input);
361 static int u1_raw_event(struct alps_dev *hdata, u8 *data, int size)
363 unsigned int x, y, z;
370 case U1_MOUSE_REPORT_ID:
372 case U1_FEATURE_REPORT_ID:
374 case U1_ABSOLUTE_REPORT_ID:
375 for (i = 0; i < hdata->max_fingers; i++) {
376 u8 *contact = &data[i * 5];
378 x = get_unaligned_le16(contact + 3);
379 y = get_unaligned_le16(contact + 5);
380 z = contact[7] & 0x7F;
382 input_mt_slot(hdata->input, i);
385 input_mt_report_slot_state(hdata->input,
387 input_report_abs(hdata->input,
388 ABS_MT_POSITION_X, x);
389 input_report_abs(hdata->input,
390 ABS_MT_POSITION_Y, y);
391 input_report_abs(hdata->input,
394 input_mt_report_slot_state(hdata->input,
399 input_mt_sync_frame(hdata->input);
401 input_report_key(hdata->input, BTN_LEFT,
403 input_report_key(hdata->input, BTN_RIGHT,
405 input_report_key(hdata->input, BTN_MIDDLE,
408 input_sync(hdata->input);
412 case U1_SP_ABSOLUTE_REPORT_ID:
413 sp_x = get_unaligned_le16(data+2);
414 sp_y = get_unaligned_le16(data+4);
419 input_report_rel(hdata->input2, REL_X, sp_x);
420 input_report_rel(hdata->input2, REL_Y, sp_y);
422 input_report_key(hdata->input2, BTN_LEFT,
424 input_report_key(hdata->input2, BTN_RIGHT,
426 input_report_key(hdata->input2, BTN_MIDDLE,
429 input_sync(hdata->input2);
437 static int alps_raw_event(struct hid_device *hdev,
438 struct hid_report *report, u8 *data, int size)
441 struct alps_dev *hdata = hid_get_drvdata(hdev);
443 switch (hdev->product) {
444 case HID_PRODUCT_ID_T4_BTNLESS:
445 ret = t4_raw_event(hdata, data, size);
448 ret = u1_raw_event(hdata, data, size);
454 static int __maybe_unused alps_post_reset(struct hid_device *hdev)
457 struct alps_dev *data = hid_get_drvdata(hdev);
459 switch (data->dev_type) {
461 ret = t4_read_write_register(hdev, T4_PRM_FEED_CONFIG_1,
462 NULL, T4_I2C_ABS, false);
464 dev_err(&hdev->dev, "failed T4_PRM_FEED_CONFIG_1 (%d)\n",
469 ret = t4_read_write_register(hdev, T4_PRM_FEED_CONFIG_4,
470 NULL, T4_FEEDCFG4_ADVANCED_ABS_ENABLE, false);
472 dev_err(&hdev->dev, "failed T4_PRM_FEED_CONFIG_4 (%d)\n",
478 ret = u1_read_write_register(hdev,
479 ADDRESS_U1_DEV_CTRL_1, NULL,
480 U1_TP_ABS_MODE | U1_SP_ABS_MODE, false);
482 dev_err(&hdev->dev, "failed to change TP mode (%d)\n",
495 static int __maybe_unused alps_post_resume(struct hid_device *hdev)
497 return alps_post_reset(hdev);
500 static int u1_init(struct hid_device *hdev, struct alps_dev *pri_data)
503 u8 tmp, dev_ctrl, sen_line_num_x, sen_line_num_y;
504 u8 pitch_x, pitch_y, resolution;
506 /* Device initialization */
507 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
510 dev_err(&hdev->dev, "failed U1_DEV_CTRL_1 (%d)\n", ret);
514 dev_ctrl &= ~U1_DISABLE_DEV;
515 dev_ctrl |= U1_TP_ABS_MODE;
516 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
517 NULL, dev_ctrl, false);
519 dev_err(&hdev->dev, "failed to change TP mode (%d)\n", ret);
523 ret = u1_read_write_register(hdev, ADDRESS_U1_NUM_SENS_X,
524 &sen_line_num_x, 0, true);
526 dev_err(&hdev->dev, "failed U1_NUM_SENS_X (%d)\n", ret);
530 ret = u1_read_write_register(hdev, ADDRESS_U1_NUM_SENS_Y,
531 &sen_line_num_y, 0, true);
533 dev_err(&hdev->dev, "failed U1_NUM_SENS_Y (%d)\n", ret);
537 ret = u1_read_write_register(hdev, ADDRESS_U1_PITCH_SENS_X,
540 dev_err(&hdev->dev, "failed U1_PITCH_SENS_X (%d)\n", ret);
544 ret = u1_read_write_register(hdev, ADDRESS_U1_PITCH_SENS_Y,
547 dev_err(&hdev->dev, "failed U1_PITCH_SENS_Y (%d)\n", ret);
551 ret = u1_read_write_register(hdev, ADDRESS_U1_RESO_DWN_ABS,
552 &resolution, 0, true);
554 dev_err(&hdev->dev, "failed U1_RESO_DWN_ABS (%d)\n", ret);
557 pri_data->x_active_len_mm =
558 (pitch_x * (sen_line_num_x - 1)) / 10;
559 pri_data->y_active_len_mm =
560 (pitch_y * (sen_line_num_y - 1)) / 10;
563 (resolution << 2) * (sen_line_num_x - 1);
566 (resolution << 2) * (sen_line_num_y - 1);
569 ret = u1_read_write_register(hdev, ADDRESS_U1_PAD_BTN,
572 dev_err(&hdev->dev, "failed U1_PAD_BTN (%d)\n", ret);
575 if ((tmp & 0x0F) == (tmp & 0xF0) >> 4) {
576 pri_data->btn_cnt = (tmp & 0x0F);
579 pri_data->btn_cnt = 1;
582 pri_data->has_sp = 0;
583 /* Check StickPointer device */
584 ret = u1_read_write_register(hdev, ADDRESS_U1_DEVICE_TYP,
587 dev_err(&hdev->dev, "failed U1_DEVICE_TYP (%d)\n", ret);
590 if (tmp & U1_DEVTYPE_SP_SUPPORT) {
591 dev_ctrl |= U1_SP_ABS_MODE;
592 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
593 NULL, dev_ctrl, false);
595 dev_err(&hdev->dev, "failed SP mode (%d)\n", ret);
599 ret = u1_read_write_register(hdev, ADDRESS_U1_SP_BTN,
600 &pri_data->sp_btn_info, 0, true);
602 dev_err(&hdev->dev, "failed U1_SP_BTN (%d)\n", ret);
605 pri_data->has_sp = 1;
607 pri_data->max_fingers = 5;
612 static int T4_init(struct hid_device *hdev, struct alps_dev *pri_data)
615 u8 tmp, sen_line_num_x, sen_line_num_y;
617 ret = t4_read_write_register(hdev, T4_PRM_ID_CONFIG_3, &tmp, 0, true);
619 dev_err(&hdev->dev, "failed T4_PRM_ID_CONFIG_3 (%d)\n", ret);
622 sen_line_num_x = 16 + ((tmp & 0x0F) | (tmp & 0x08 ? 0xF0 : 0));
623 sen_line_num_y = 12 + (((tmp & 0xF0) >> 4) | (tmp & 0x80 ? 0xF0 : 0));
625 pri_data->x_max = sen_line_num_x * T4_COUNT_PER_ELECTRODE;
626 pri_data->x_min = T4_COUNT_PER_ELECTRODE;
627 pri_data->y_max = sen_line_num_y * T4_COUNT_PER_ELECTRODE;
628 pri_data->y_min = T4_COUNT_PER_ELECTRODE;
629 pri_data->x_active_len_mm = pri_data->y_active_len_mm = 0;
630 pri_data->btn_cnt = 1;
632 ret = t4_read_write_register(hdev, PRM_SYS_CONFIG_1, &tmp, 0, true);
634 dev_err(&hdev->dev, "failed PRM_SYS_CONFIG_1 (%d)\n", ret);
638 ret = t4_read_write_register(hdev, PRM_SYS_CONFIG_1, NULL, tmp, false);
640 dev_err(&hdev->dev, "failed PRM_SYS_CONFIG_1 (%d)\n", ret);
644 ret = t4_read_write_register(hdev, T4_PRM_FEED_CONFIG_1,
645 NULL, T4_I2C_ABS, false);
647 dev_err(&hdev->dev, "failed T4_PRM_FEED_CONFIG_1 (%d)\n", ret);
651 ret = t4_read_write_register(hdev, T4_PRM_FEED_CONFIG_4, NULL,
652 T4_FEEDCFG4_ADVANCED_ABS_ENABLE, false);
654 dev_err(&hdev->dev, "failed T4_PRM_FEED_CONFIG_4 (%d)\n", ret);
657 pri_data->max_fingers = 5;
658 pri_data->has_sp = 0;
663 static int alps_sp_open(struct input_dev *dev)
665 struct hid_device *hid = input_get_drvdata(dev);
667 return hid_hw_open(hid);
670 static void alps_sp_close(struct input_dev *dev)
672 struct hid_device *hid = input_get_drvdata(dev);
677 static int alps_input_configured(struct hid_device *hdev, struct hid_input *hi)
679 struct alps_dev *data = hid_get_drvdata(hdev);
680 struct input_dev *input = hi->input, *input2;
686 hid_dbg(hdev, "Opening low level driver\n");
687 ret = hid_hw_open(hdev);
691 /* Allow incoming hid reports */
692 hid_device_io_start(hdev);
693 switch (data->dev_type) {
695 ret = T4_init(hdev, data);
698 ret = u1_init(hdev, data);
707 __set_bit(EV_ABS, input->evbit);
708 input_set_abs_params(input, ABS_MT_POSITION_X,
709 data->x_min, data->x_max, 0, 0);
710 input_set_abs_params(input, ABS_MT_POSITION_Y,
711 data->y_min, data->y_max, 0, 0);
713 if (data->x_active_len_mm && data->y_active_len_mm) {
714 res_x = (data->x_max - 1) / data->x_active_len_mm;
715 res_y = (data->y_max - 1) / data->y_active_len_mm;
717 input_abs_set_res(input, ABS_MT_POSITION_X, res_x);
718 input_abs_set_res(input, ABS_MT_POSITION_Y, res_y);
721 input_set_abs_params(input, ABS_MT_PRESSURE, 0, 64, 0, 0);
723 input_mt_init_slots(input, data->max_fingers, INPUT_MT_POINTER);
725 __set_bit(EV_KEY, input->evbit);
727 if (data->btn_cnt == 1)
728 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
730 for (i = 0; i < data->btn_cnt; i++)
731 __set_bit(BTN_LEFT + i, input->keybit);
733 /* Stick device initialization */
735 input2 = input_allocate_device();
737 input_free_device(input2);
741 data->input2 = input2;
742 input2->phys = input->phys;
743 input2->name = "DualPoint Stick";
744 input2->id.bustype = BUS_I2C;
745 input2->id.vendor = input->id.vendor;
746 input2->id.product = input->id.product;
747 input2->id.version = input->id.version;
748 input2->dev.parent = input->dev.parent;
750 input_set_drvdata(input2, hdev);
751 input2->open = alps_sp_open;
752 input2->close = alps_sp_close;
754 __set_bit(EV_KEY, input2->evbit);
755 data->sp_btn_cnt = (data->sp_btn_info & 0x0F);
756 for (i = 0; i < data->sp_btn_cnt; i++)
757 __set_bit(BTN_LEFT + i, input2->keybit);
759 __set_bit(EV_REL, input2->evbit);
760 __set_bit(REL_X, input2->relbit);
761 __set_bit(REL_Y, input2->relbit);
762 __set_bit(INPUT_PROP_POINTER, input2->propbit);
763 __set_bit(INPUT_PROP_POINTING_STICK, input2->propbit);
765 if (input_register_device(data->input2)) {
766 input_free_device(input2);
772 hid_device_io_stop(hdev);
777 static int alps_input_mapping(struct hid_device *hdev,
778 struct hid_input *hi, struct hid_field *field,
779 struct hid_usage *usage, unsigned long **bit, int *max)
784 static int alps_probe(struct hid_device *hdev, const struct hid_device_id *id)
786 struct alps_dev *data = NULL;
788 data = devm_kzalloc(&hdev->dev, sizeof(struct alps_dev), GFP_KERNEL);
793 hid_set_drvdata(hdev, data);
795 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
797 ret = hid_parse(hdev);
799 hid_err(hdev, "parse failed\n");
803 switch (hdev->product) {
804 case HID_DEVICE_ID_ALPS_T4_BTNLESS:
807 case HID_DEVICE_ID_ALPS_U1_DUAL:
808 case HID_DEVICE_ID_ALPS_U1:
812 data->dev_type = UNKNOWN;
815 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
817 hid_err(hdev, "hw start failed\n");
824 static void alps_remove(struct hid_device *hdev)
829 static const struct hid_device_id alps_id[] = {
830 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
831 USB_VENDOR_ID_ALPS_JP, HID_DEVICE_ID_ALPS_U1_DUAL) },
832 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
833 USB_VENDOR_ID_ALPS_JP, HID_DEVICE_ID_ALPS_U1) },
834 { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
835 USB_VENDOR_ID_ALPS_JP, HID_DEVICE_ID_ALPS_T4_BTNLESS) },
838 MODULE_DEVICE_TABLE(hid, alps_id);
840 static struct hid_driver alps_driver = {
844 .remove = alps_remove,
845 .raw_event = alps_raw_event,
846 .input_mapping = alps_input_mapping,
847 .input_configured = alps_input_configured,
849 .resume = alps_post_resume,
850 .reset_resume = alps_post_reset,
854 module_hid_driver(alps_driver);
857 MODULE_DESCRIPTION("ALPS HID driver");
858 MODULE_LICENSE("GPL");