drivers/hid/hid-alps.c

   1 /*
   2  *  Copyright (c) 2016 Masaki Ota <masaki.ota@jp.alps.com>
   3  *
   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)
   7  * any later version.
   8  */
   9
  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>
  16 #include "hid-ids.h"
  17
  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
  26
  27 #define DEV_SINGLEPOINT                         0x01
  28 #define DEV_DUALPOINT                           0x02
  29
  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 */
  34
  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
  39
  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
  44
  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
  54
  55 #define MAX_TOUCHES     5
  56
  57 /**
  58  * struct u1_data
  59  *
  60  * @input: pointer to the kernel input device
  61  * @input2: pointer to the kernel input2 device
  62  * @hdev: pointer to the struct hid_device
  63  *
  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
  78  */
  79 struct u1_dev {
  80         struct input_dev *input;
  81         struct input_dev *input2;
  82         struct hid_device *hdev;
  83
  84         u8      dev_ctrl;
  85         u8      dev_type;
  86         u8      sen_line_num_x;
  87         u8      sen_line_num_y;
  88         u8      pitch_x;
  89         u8      pitch_y;
  90         u8      resolution;
  91         u8      btn_info;
  92         u8      sp_btn_info;
  93         u32     x_active_len_mm;
  94         u32     y_active_len_mm;
  95         u32     x_max;
  96         u32     y_max;
  97         u32     btn_cnt;
  98         u32     sp_btn_cnt;
  99 };
 100
 101 struct u1_dev *priv;
 102
 103 static int u1_read_write_register(struct hid_device *hdev, u32 address,
 104         u8 *read_val, u8 write_val, bool read_flag)
 105 {
 106         int ret, i;
 107         u8 check_sum;
 108         u8 *input;
 109         u8 *readbuf;
 110
 111         input = kzalloc(sizeof(u8)*U1_FEATURE_REPORT_LEN, GFP_KERNEL);
 112         if (!input)
 113                 return -ENOMEM;
 114
 115         readbuf = kzalloc(sizeof(u8)*U1_FEATURE_REPORT_LEN, GFP_KERNEL);
 116         if (!readbuf) {
 117                 kfree(input);
 118                 return -ENOMEM;
 119         }
 120
 121         input[0] = U1_FEATURE_REPORT_ID;
 122         if (read_flag) {
 123                 input[1] = U1_CMD_REGISTER_READ;
 124                 input[6] = 0x00;
 125         } else {
 126                 input[1] = U1_CMD_REGISTER_WRITE;
 127                 input[6] = write_val;
 128         }
 129
 130         put_unaligned_le32(address, input + 2);
 131
 132         /* Calculate the checksum */
 133         check_sum = U1_FEATURE_REPORT_LEN_ALL;
 134         for (i = 0; i < U1_FEATURE_REPORT_LEN - 1; i++)
 135                 check_sum += input[i];
 136
 137         input[7] = check_sum;
 138         ret = hid_hw_raw_request(hdev, U1_FEATURE_REPORT_ID, input,
 139                         sizeof(input), HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
 140
 141         if (ret < 0) {
 142                 dev_err(&hdev->dev, "failed to read command (%d)\n", ret);
 143                 goto exit;
 144         }
 145
 146         if (read_flag) {
 147                 ret = hid_hw_raw_request(hdev, U1_FEATURE_REPORT_ID, readbuf,
 148                                 sizeof(readbuf), HID_FEATURE_REPORT,
 149                                 HID_REQ_GET_REPORT);
 150
 151                 if (ret < 0) {
 152                         dev_err(&hdev->dev, "failed read register (%d)\n", ret);
 153                         goto exit;
 154                 }
 155
 156                 *read_val = readbuf[6];
 157         }
 158
 159         kfree(input);
 160         kfree(readbuf);
 161         return 0;
 162
 163 exit:
 164         kfree(input);
 165         kfree(readbuf);
 166         return ret;
 167 }
 168
 169 static int alps_raw_event(struct hid_device *hdev,
 170                 struct hid_report *report, u8 *data, int size)
 171 {
 172         int x[MAX_TOUCHES], y[MAX_TOUCHES], z[MAX_TOUCHES];
 173         int i, left, right, middle;
 174         short sp_x, sp_y, sp_z;
 175         struct u1_dev *hdata = hid_get_drvdata(hdev);
 176
 177         switch (data[0]) {
 178         case U1_MOUSE_REPORT_ID:
 179                 break;
 180         case U1_FEATURE_REPORT_ID:
 181                 break;
 182         case U1_ABSOLUTE_REPORT_ID:
 183                 for (i = 0; i < MAX_TOUCHES; i++) {
 184                         x[i] = (data[3+(5*i)] | (data[4+(5*i)] << 8));
 185                         y[i] = (data[5+(5*i)] | (data[6+(5*i)] << 8));
 186                         z[i] = data[7+(5*i)] & 0x7F;
 187                         left = data[1] & 0x1;
 188                         right = (data[1] & 0x2) >> 1;
 189                         middle = (data[1] & 0x4) >> 2;
 190
 191                         input_mt_slot(hdata->input, i);
 192
 193                         if (z[i] != 0) {
 194                                 input_mt_report_slot_state(hdata->input,
 195                                         MT_TOOL_FINGER, 1);
 196                         } else {
 197                                 input_mt_report_slot_state(hdata->input,
 198                                         MT_TOOL_FINGER, 0);
 199                                 break;
 200                         }
 201
 202                         input_event(hdata->input, EV_ABS,
 203                                 ABS_MT_POSITION_X, x[i]);
 204                         input_event(hdata->input, EV_ABS,
 205                                 ABS_MT_POSITION_Y, y[i]);
 206                         input_event(hdata->input, EV_ABS,
 207                                 ABS_MT_PRESSURE, z[i]);
 208                 }
 209
 210                 input_mt_sync_frame(hdata->input);
 211                 input_sync(hdata->input);
 212
 213                 input_event(hdata->input, EV_KEY, BTN_LEFT, left);
 214                 input_event(hdata->input, EV_KEY, BTN_RIGHT, right);
 215                 input_event(hdata->input, EV_KEY, BTN_MIDDLE, middle);
 216
 217                 return 1;
 218
 219         case U1_SP_ABSOLUTE_REPORT_ID:
 220                 sp_x = (data[2] | (data[3] << 8));
 221                 sp_y = (data[4] | (data[5] << 8));
 222                 sp_z = (data[6] | data[7]) & 0x7FFF;
 223                 left = data[1] & 0x1;
 224                 right = (data[1] & 0x2) >> 1;
 225                 middle = (data[1] & 0x4) >> 2;
 226
 227                 sp_x = sp_x / 8;
 228                 sp_y = sp_y / 8;
 229
 230                 input_event(priv->input2, EV_REL, REL_X, sp_x);
 231                 input_event(priv->input2, EV_REL, REL_Y, sp_y);
 232
 233                 input_event(priv->input2, EV_KEY, BTN_LEFT, left);
 234                 input_event(priv->input2, EV_KEY, BTN_RIGHT, right);
 235                 input_event(priv->input2, EV_KEY, BTN_MIDDLE, middle);
 236
 237                 input_sync(priv->input2);
 238
 239                 return 1;
 240         }
 241
 242         return 0;
 243 }
 244
 245 #ifdef CONFIG_PM
 246 static int alps_post_reset(struct hid_device *hdev)
 247 {
 248         return u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
 249                                 NULL, U1_TP_ABS_MODE, false);
 250 }
 251
 252 static int alps_post_resume(struct hid_device *hdev)
 253 {
 254         return u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
 255                                 NULL, U1_TP_ABS_MODE, false);
 256 }
 257 #endif /* CONFIG_PM */
 258
 259 static int alps_input_configured(struct hid_device *hdev, struct hid_input *hi)
 260 {
 261         struct u1_dev *data = hid_get_drvdata(hdev);
 262         struct input_dev *input = hi->input, *input2;
 263         struct u1_dev devInfo;
 264         int ret;
 265         int res_x, res_y, i;
 266
 267         /* Check device product ID */
 268         switch (hdev->product) {
 269         case HID_PRODUCT_ID_U1:
 270         case HID_PRODUCT_ID_U1_DUAL:
 271                 break;
 272         default:
 273                 return 0;
 274         }
 275
 276         data->input = input;
 277
 278         hid_dbg(hdev, "Opening low level driver\n");
 279         ret = hid_hw_open(hdev);
 280         if (ret)
 281                 return ret;
 282
 283         /* Allow incoming hid reports */
 284         hid_device_io_start(hdev);
 285
 286         /* Device initialization */
 287         ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
 288                         &devInfo.dev_ctrl, 0, true);
 289         if (ret < 0) {
 290                 dev_err(&hdev->dev, "failed U1_DEV_CTRL_1 (%d)\n", ret);
 291                 goto exit;
 292         }
 293
 294         devInfo.dev_ctrl &= ~U1_DISABLE_DEV;
 295         devInfo.dev_ctrl |= U1_TP_ABS_MODE;
 296         ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
 297                         NULL, devInfo.dev_ctrl, false);
 298         if (ret < 0) {
 299                 dev_err(&hdev->dev, "failed to change TP mode (%d)\n", ret);
 300                 goto exit;
 301         }
 302
 303         ret = u1_read_write_register(hdev, ADDRESS_U1_NUM_SENS_X,
 304                         &devInfo.sen_line_num_x, 0, true);
 305         if (ret < 0) {
 306                 dev_err(&hdev->dev, "failed U1_NUM_SENS_X (%d)\n", ret);
 307                 goto exit;
 308         }
 309
 310         ret = u1_read_write_register(hdev, ADDRESS_U1_NUM_SENS_Y,
 311                         &devInfo.sen_line_num_y, 0, true);
 312                 if (ret < 0) {
 313                 dev_err(&hdev->dev, "failed U1_NUM_SENS_Y (%d)\n", ret);
 314                 goto exit;
 315         }
 316
 317         ret = u1_read_write_register(hdev, ADDRESS_U1_PITCH_SENS_X,
 318                         &devInfo.pitch_x, 0, true);
 319         if (ret < 0) {
 320                 dev_err(&hdev->dev, "failed U1_PITCH_SENS_X (%d)\n", ret);
 321                 goto exit;
 322         }
 323
 324         ret = u1_read_write_register(hdev, ADDRESS_U1_PITCH_SENS_Y,
 325                         &devInfo.pitch_y, 0, true);
 326         if (ret < 0) {
 327                 dev_err(&hdev->dev, "failed U1_PITCH_SENS_Y (%d)\n", ret);
 328                 goto exit;
 329         }
 330
 331         ret = u1_read_write_register(hdev, ADDRESS_U1_RESO_DWN_ABS,
 332                 &devInfo.resolution, 0, true);
 333         if (ret < 0) {
 334                 dev_err(&hdev->dev, "failed U1_RESO_DWN_ABS (%d)\n", ret);
 335                 goto exit;
 336         }
 337
 338         ret = u1_read_write_register(hdev, ADDRESS_U1_PAD_BTN,
 339                         &devInfo.btn_info, 0, true);
 340         if (ret < 0) {
 341                 dev_err(&hdev->dev, "failed U1_PAD_BTN (%d)\n", ret);
 342                 goto exit;
 343         }
 344
 345         /* Check StickPointer device */
 346         ret = u1_read_write_register(hdev, ADDRESS_U1_DEVICE_TYP,
 347                         &devInfo.dev_type, 0, true);
 348         if (ret < 0) {
 349                 dev_err(&hdev->dev, "failed U1_DEVICE_TYP (%d)\n", ret);
 350                 goto exit;
 351         }
 352
 353         devInfo.x_active_len_mm =
 354                 (devInfo.pitch_x * (devInfo.sen_line_num_x - 1)) / 10;
 355         devInfo.y_active_len_mm =
 356                 (devInfo.pitch_y * (devInfo.sen_line_num_y - 1)) / 10;
 357
 358         devInfo.x_max =
 359                 (devInfo.resolution << 2) * (devInfo.sen_line_num_x - 1);
 360         devInfo.y_max =
 361                 (devInfo.resolution << 2) * (devInfo.sen_line_num_y - 1);
 362
 363         __set_bit(EV_ABS, input->evbit);
 364         input_set_abs_params(input, ABS_MT_POSITION_X, 1, devInfo.x_max, 0, 0);
 365         input_set_abs_params(input, ABS_MT_POSITION_Y, 1, devInfo.y_max, 0, 0);
 366
 367         if (devInfo.x_active_len_mm && devInfo.y_active_len_mm) {
 368                 res_x = (devInfo.x_max - 1) / devInfo.x_active_len_mm;
 369                 res_y = (devInfo.y_max - 1) / devInfo.y_active_len_mm;
 370
 371                 input_abs_set_res(input, ABS_MT_POSITION_X, res_x);
 372                 input_abs_set_res(input, ABS_MT_POSITION_Y, res_y);
 373         }
 374
 375         input_set_abs_params(input, ABS_MT_PRESSURE, 0, 64, 0, 0);
 376
 377         input_mt_init_slots(input, MAX_TOUCHES, INPUT_MT_POINTER);
 378
 379         __set_bit(EV_KEY, input->evbit);
 380         if ((devInfo.btn_info & 0x0F) == (devInfo.btn_info & 0xF0) >> 4) {
 381                 devInfo.btn_cnt = (devInfo.btn_info & 0x0F);
 382         } else {
 383                 /* Button pad */
 384                 devInfo.btn_cnt = 1;
 385                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
 386         }
 387
 388         for (i = 0; i < devInfo.btn_cnt; i++)
 389                 __set_bit(BTN_LEFT + i, input->keybit);
 390
 391
 392         /* Stick device initialization */
 393         if (devInfo.dev_type & U1_DEVTYPE_SP_SUPPORT) {
 394
 395                 priv = kzalloc(sizeof(struct u1_dev), GFP_KERNEL);
 396                 if (!priv) {
 397                         hid_device_io_stop(hdev);
 398                         hid_hw_close(hdev);
 399                         return -ENOMEM;
 400                 }
 401
 402                 input2 = input_allocate_device();
 403                 if (!input2) {
 404                         input_free_device(input2);
 405                         goto exit;
 406                 }
 407
 408                 priv->input2 = input2;
 409
 410                 devInfo.dev_ctrl |= U1_SP_ABS_MODE;
 411                 ret = u1_read_write_register(hdev, ADDRESS_U1_DEV_CTRL_1,
 412                         NULL, devInfo.dev_ctrl, false);
 413                 if (ret < 0) {
 414                         dev_err(&hdev->dev, "failed SP mode (%d)\n", ret);
 415                         input_free_device(input2);
 416                         goto exit;
 417                 }
 418
 419                 ret = u1_read_write_register(hdev, ADDRESS_U1_SP_BTN,
 420                         &devInfo.sp_btn_info, 0, true);
 421                 if (ret < 0) {
 422                         dev_err(&hdev->dev, "failed U1_SP_BTN (%d)\n", ret);
 423                         input_free_device(input2);
 424                         goto exit;
 425                 }
 426
 427                 input2->phys = input->phys;
 428                 input2->name = "DualPoint Stick";
 429                 input2->id.bustype = BUS_I2C;
 430                 input2->id.vendor  = input->id.vendor;
 431                 input2->id.product = input->id.product;
 432                 input2->id.version = input->id.version;
 433                 input2->dev.parent = input->dev.parent;
 434
 435                 __set_bit(EV_KEY, input2->evbit);
 436                 devInfo.sp_btn_cnt = (devInfo.sp_btn_info & 0x0F);
 437                 for (i = 0; i < devInfo.sp_btn_cnt; i++)
 438                         __set_bit(BTN_LEFT + i, input2->keybit);
 439
 440                 __set_bit(EV_REL, input2->evbit);
 441                 __set_bit(REL_X, input2->relbit);
 442                 __set_bit(REL_Y, input2->relbit);
 443                 __set_bit(INPUT_PROP_POINTER, input2->propbit);
 444                 __set_bit(INPUT_PROP_POINTING_STICK, input2->propbit);
 445
 446                 if (input_register_device(priv->input2)) {
 447                         input_free_device(input2);
 448                         goto exit;
 449                 }
 450         }
 451
 452 exit:
 453         hid_device_io_stop(hdev);
 454         hid_hw_close(hdev);
 455         return ret;
 456 }
 457
 458 static int alps_input_mapping(struct hid_device *hdev,
 459                 struct hid_input *hi, struct hid_field *field,
 460                 struct hid_usage *usage, unsigned long **bit, int *max)
 461 {
 462         return -1;
 463 }
 464
 465 static int alps_probe(struct hid_device *hdev, const struct hid_device_id *id)
 466 {
 467         struct u1_dev *data = NULL;
 468         int ret;
 469
 470         data = devm_kzalloc(&hdev->dev, sizeof(struct u1_dev), GFP_KERNEL);
 471         if (!data)
 472                 return -ENOMEM;
 473
 474         data->hdev = hdev;
 475         hid_set_drvdata(hdev, data);
 476
 477         hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
 478
 479         ret = hid_parse(hdev);
 480         if (ret) {
 481                 hid_err(hdev, "parse failed\n");
 482                 return ret;
 483         }
 484
 485         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 486         if (ret) {
 487                 hid_err(hdev, "hw start failed\n");
 488                 return ret;
 489         }
 490
 491         return 0;
 492 }
 493
 494 static void alps_remove(struct hid_device *hdev)
 495 {
 496         hid_hw_stop(hdev);
 497         kfree(priv);
 498 }
 499
 500 static const struct hid_device_id alps_id[] = {
 501         { HID_DEVICE(HID_BUS_ANY, HID_GROUP_ANY,
 502                 USB_VENDOR_ID_ALPS_JP, HID_ANY_ID) },
 503         { }
 504 };
 505 MODULE_DEVICE_TABLE(hid, alps_id);
 506
 507 static struct hid_driver alps_driver = {
 508         .name = "hid-alps",
 509         .id_table               = alps_id,
 510         .probe                  = alps_probe,
 511         .remove                 = alps_remove,
 512         .raw_event              = alps_raw_event,
 513         .input_mapping          = alps_input_mapping,
 514         .input_configured       = alps_input_configured,
 515 #ifdef CONFIG_PM
 516         .resume                 = alps_post_resume,
 517         .reset_resume           = alps_post_reset,
 518 #endif
 519 };
 520
 521 module_hid_driver(alps_driver);
 522
 523 MODULE_AUTHOR("Masaki Ota <masaki.ota@jp.alps.com>");
 524 MODULE_DESCRIPTION("ALPS HID driver");
 525 MODULE_LICENSE("GPL");