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
60 * @input: pointer to the kernel input device
61 * @input2: pointer to the kernel input2 device
62 * @hdev: pointer to the struct hid_device
64 * @dev_ctrl: device control parameter
65 * @dev_type: device type
66 * @sen_line_num_x: number of sensor line of X
67 * @sen_line_num_y: number of sensor line of Y
68 * @pitch_x: sensor pitch of X
69 * @pitch_y: sensor pitch of Y
70 * @resolution: resolution
71 * @btn_info: button information
72 * @x_active_len_mm: active area length of X (mm)
73 * @y_active_len_mm: active area length of Y (mm)
74 * @x_max: maximum x coordinate value
75 * @y_max: maximum y coordinate value
76 * @btn_cnt: number of buttons
77 * @sp_btn_cnt: number of stick buttons
80 struct input_dev
*input
;
81 struct input_dev
*input2
;
82 struct hid_device
*hdev
;
101 static int u1_read_write_register(struct hid_device
*hdev
, u32 address
,
102 u8
*read_val
, u8 write_val
, bool read_flag
)
109 input
= kzalloc(U1_FEATURE_REPORT_LEN
, GFP_KERNEL
);
113 input
[0] = U1_FEATURE_REPORT_ID
;
115 input
[1] = U1_CMD_REGISTER_READ
;
118 input
[1] = U1_CMD_REGISTER_WRITE
;
119 input
[6] = write_val
;
122 put_unaligned_le32(address
, input
+ 2);
124 /* Calculate the checksum */
125 check_sum
= U1_FEATURE_REPORT_LEN_ALL
;
126 for (i
= 0; i
< U1_FEATURE_REPORT_LEN
- 1; i
++)
127 check_sum
+= input
[i
];
129 input
[7] = check_sum
;
130 ret
= hid_hw_raw_request(hdev
, U1_FEATURE_REPORT_ID
, input
,
131 U1_FEATURE_REPORT_LEN
,
132 HID_FEATURE_REPORT
, HID_REQ_SET_REPORT
);
135 dev_err(&hdev
->dev
, "failed to read command (%d)\n", ret
);
140 readbuf
= kzalloc(U1_FEATURE_REPORT_LEN
, GFP_KERNEL
);
146 ret
= hid_hw_raw_request(hdev
, U1_FEATURE_REPORT_ID
, readbuf
,
147 U1_FEATURE_REPORT_LEN
,
148 HID_FEATURE_REPORT
, HID_REQ_GET_REPORT
);
151 dev_err(&hdev
->dev
, "failed read register (%d)\n", ret
);
156 *read_val
= readbuf
[6];
168 static int alps_raw_event(struct hid_device
*hdev
,
169 struct hid_report
*report
, u8
*data
, int size
)
171 unsigned int x
, y
, z
;
174 struct u1_dev
*hdata
= hid_get_drvdata(hdev
);
177 case U1_MOUSE_REPORT_ID
:
179 case U1_FEATURE_REPORT_ID
:
181 case U1_ABSOLUTE_REPORT_ID
:
182 for (i
= 0; i
< MAX_TOUCHES
; i
++) {
183 u8
*contact
= &data
[i
* 5];
185 x
= get_unaligned_le16(contact
+ 3);
186 y
= get_unaligned_le16(contact
+ 5);
187 z
= contact
[7] & 0x7F;
189 input_mt_slot(hdata
->input
, i
);
192 input_mt_report_slot_state(hdata
->input
,
194 input_report_abs(hdata
->input
,
195 ABS_MT_POSITION_X
, x
);
196 input_report_abs(hdata
->input
,
197 ABS_MT_POSITION_Y
, y
);
198 input_report_abs(hdata
->input
,
201 input_mt_report_slot_state(hdata
->input
,
206 input_mt_sync_frame(hdata
->input
);
208 input_report_key(hdata
->input
, BTN_LEFT
,
210 input_report_key(hdata
->input
, BTN_RIGHT
,
212 input_report_key(hdata
->input
, BTN_MIDDLE
,
215 input_sync(hdata
->input
);
219 case U1_SP_ABSOLUTE_REPORT_ID
:
220 sp_x
= get_unaligned_le16(data
+2);
221 sp_y
= get_unaligned_le16(data
+4);
226 input_report_rel(hdata
->input2
, REL_X
, sp_x
);
227 input_report_rel(hdata
->input2
, REL_Y
, sp_y
);
229 input_report_key(hdata
->input2
, BTN_LEFT
,
231 input_report_key(hdata
->input2
, BTN_RIGHT
,
233 input_report_key(hdata
->input2
, BTN_MIDDLE
,
236 input_sync(hdata
->input2
);
245 static int alps_post_reset(struct hid_device
*hdev
)
247 return u1_read_write_register(hdev
, ADDRESS_U1_DEV_CTRL_1
,
248 NULL
, U1_TP_ABS_MODE
| U1_SP_ABS_MODE
, false);
251 static int alps_post_resume(struct hid_device
*hdev
)
253 return u1_read_write_register(hdev
, ADDRESS_U1_DEV_CTRL_1
,
254 NULL
, U1_TP_ABS_MODE
| U1_SP_ABS_MODE
, false);
256 #endif /* CONFIG_PM */
258 static int alps_input_configured(struct hid_device
*hdev
, struct hid_input
*hi
)
260 struct u1_dev
*data
= hid_get_drvdata(hdev
);
261 struct input_dev
*input
= hi
->input
, *input2
;
262 struct u1_dev devInfo
;
268 hid_dbg(hdev
, "Opening low level driver\n");
269 ret
= hid_hw_open(hdev
);
273 /* Allow incoming hid reports */
274 hid_device_io_start(hdev
);
276 /* Device initialization */
277 ret
= u1_read_write_register(hdev
, ADDRESS_U1_DEV_CTRL_1
,
278 &devInfo
.dev_ctrl
, 0, true);
280 dev_err(&hdev
->dev
, "failed U1_DEV_CTRL_1 (%d)\n", ret
);
284 devInfo
.dev_ctrl
&= ~U1_DISABLE_DEV
;
285 devInfo
.dev_ctrl
|= U1_TP_ABS_MODE
;
286 ret
= u1_read_write_register(hdev
, ADDRESS_U1_DEV_CTRL_1
,
287 NULL
, devInfo
.dev_ctrl
, false);
289 dev_err(&hdev
->dev
, "failed to change TP mode (%d)\n", ret
);
293 ret
= u1_read_write_register(hdev
, ADDRESS_U1_NUM_SENS_X
,
294 &devInfo
.sen_line_num_x
, 0, true);
296 dev_err(&hdev
->dev
, "failed U1_NUM_SENS_X (%d)\n", ret
);
300 ret
= u1_read_write_register(hdev
, ADDRESS_U1_NUM_SENS_Y
,
301 &devInfo
.sen_line_num_y
, 0, true);
303 dev_err(&hdev
->dev
, "failed U1_NUM_SENS_Y (%d)\n", ret
);
307 ret
= u1_read_write_register(hdev
, ADDRESS_U1_PITCH_SENS_X
,
308 &devInfo
.pitch_x
, 0, true);
310 dev_err(&hdev
->dev
, "failed U1_PITCH_SENS_X (%d)\n", ret
);
314 ret
= u1_read_write_register(hdev
, ADDRESS_U1_PITCH_SENS_Y
,
315 &devInfo
.pitch_y
, 0, true);
317 dev_err(&hdev
->dev
, "failed U1_PITCH_SENS_Y (%d)\n", ret
);
321 ret
= u1_read_write_register(hdev
, ADDRESS_U1_RESO_DWN_ABS
,
322 &devInfo
.resolution
, 0, true);
324 dev_err(&hdev
->dev
, "failed U1_RESO_DWN_ABS (%d)\n", ret
);
328 ret
= u1_read_write_register(hdev
, ADDRESS_U1_PAD_BTN
,
329 &devInfo
.btn_info
, 0, true);
331 dev_err(&hdev
->dev
, "failed U1_PAD_BTN (%d)\n", ret
);
335 /* Check StickPointer device */
336 ret
= u1_read_write_register(hdev
, ADDRESS_U1_DEVICE_TYP
,
337 &devInfo
.dev_type
, 0, true);
339 dev_err(&hdev
->dev
, "failed U1_DEVICE_TYP (%d)\n", ret
);
343 devInfo
.x_active_len_mm
=
344 (devInfo
.pitch_x
* (devInfo
.sen_line_num_x
- 1)) / 10;
345 devInfo
.y_active_len_mm
=
346 (devInfo
.pitch_y
* (devInfo
.sen_line_num_y
- 1)) / 10;
349 (devInfo
.resolution
<< 2) * (devInfo
.sen_line_num_x
- 1);
351 (devInfo
.resolution
<< 2) * (devInfo
.sen_line_num_y
- 1);
353 __set_bit(EV_ABS
, input
->evbit
);
354 input_set_abs_params(input
, ABS_MT_POSITION_X
, 1, devInfo
.x_max
, 0, 0);
355 input_set_abs_params(input
, ABS_MT_POSITION_Y
, 1, devInfo
.y_max
, 0, 0);
357 if (devInfo
.x_active_len_mm
&& devInfo
.y_active_len_mm
) {
358 res_x
= (devInfo
.x_max
- 1) / devInfo
.x_active_len_mm
;
359 res_y
= (devInfo
.y_max
- 1) / devInfo
.y_active_len_mm
;
361 input_abs_set_res(input
, ABS_MT_POSITION_X
, res_x
);
362 input_abs_set_res(input
, ABS_MT_POSITION_Y
, res_y
);
365 input_set_abs_params(input
, ABS_MT_PRESSURE
, 0, 64, 0, 0);
367 input_mt_init_slots(input
, MAX_TOUCHES
, INPUT_MT_POINTER
);
369 __set_bit(EV_KEY
, input
->evbit
);
370 if ((devInfo
.btn_info
& 0x0F) == (devInfo
.btn_info
& 0xF0) >> 4) {
371 devInfo
.btn_cnt
= (devInfo
.btn_info
& 0x0F);
375 __set_bit(INPUT_PROP_BUTTONPAD
, input
->propbit
);
378 for (i
= 0; i
< devInfo
.btn_cnt
; i
++)
379 __set_bit(BTN_LEFT
+ i
, input
->keybit
);
382 /* Stick device initialization */
383 if (devInfo
.dev_type
& U1_DEVTYPE_SP_SUPPORT
) {
385 input2
= input_allocate_device();
391 data
->input2
= input2
;
393 devInfo
.dev_ctrl
|= U1_SP_ABS_MODE
;
394 ret
= u1_read_write_register(hdev
, ADDRESS_U1_DEV_CTRL_1
,
395 NULL
, devInfo
.dev_ctrl
, false);
397 dev_err(&hdev
->dev
, "failed SP mode (%d)\n", ret
);
398 input_free_device(input2
);
402 ret
= u1_read_write_register(hdev
, ADDRESS_U1_SP_BTN
,
403 &devInfo
.sp_btn_info
, 0, true);
405 dev_err(&hdev
->dev
, "failed U1_SP_BTN (%d)\n", ret
);
406 input_free_device(input2
);
410 input2
->phys
= input
->phys
;
411 input2
->name
= "DualPoint Stick";
412 input2
->id
.bustype
= BUS_I2C
;
413 input2
->id
.vendor
= input
->id
.vendor
;
414 input2
->id
.product
= input
->id
.product
;
415 input2
->id
.version
= input
->id
.version
;
416 input2
->dev
.parent
= input
->dev
.parent
;
418 __set_bit(EV_KEY
, input2
->evbit
);
419 devInfo
.sp_btn_cnt
= (devInfo
.sp_btn_info
& 0x0F);
420 for (i
= 0; i
< devInfo
.sp_btn_cnt
; i
++)
421 __set_bit(BTN_LEFT
+ i
, input2
->keybit
);
423 __set_bit(EV_REL
, input2
->evbit
);
424 __set_bit(REL_X
, input2
->relbit
);
425 __set_bit(REL_Y
, input2
->relbit
);
426 __set_bit(INPUT_PROP_POINTER
, input2
->propbit
);
427 __set_bit(INPUT_PROP_POINTING_STICK
, input2
->propbit
);
429 ret
= input_register_device(data
->input2
);
431 input_free_device(input2
);
437 hid_device_io_stop(hdev
);
442 static int alps_input_mapping(struct hid_device
*hdev
,
443 struct hid_input
*hi
, struct hid_field
*field
,
444 struct hid_usage
*usage
, unsigned long **bit
, int *max
)
449 static int alps_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
451 struct u1_dev
*data
= NULL
;
454 data
= devm_kzalloc(&hdev
->dev
, sizeof(struct u1_dev
), GFP_KERNEL
);
459 hid_set_drvdata(hdev
, data
);
461 hdev
->quirks
|= HID_QUIRK_NO_INIT_REPORTS
;
463 ret
= hid_parse(hdev
);
465 hid_err(hdev
, "parse failed\n");
469 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
471 hid_err(hdev
, "hw start failed\n");
478 static void alps_remove(struct hid_device
*hdev
)
483 static const struct hid_device_id alps_id
[] = {
484 { HID_DEVICE(HID_BUS_ANY
, HID_GROUP_ANY
,
485 USB_VENDOR_ID_ALPS_JP
, HID_DEVICE_ID_ALPS_U1_DUAL
) },
488 MODULE_DEVICE_TABLE(hid
, alps_id
);
490 static struct hid_driver alps_driver
= {
494 .remove
= alps_remove
,
495 .raw_event
= alps_raw_event
,
496 .input_mapping
= alps_input_mapping
,
497 .input_configured
= alps_input_configured
,
499 .resume
= alps_post_resume
,
500 .reset_resume
= alps_post_reset
,
504 module_hid_driver(alps_driver
);
506 MODULE_AUTHOR("Masaki Ota <masaki.ota@jp.alps.com>");
507 MODULE_DESCRIPTION("ALPS HID driver");
508 MODULE_LICENSE("GPL");