1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (c) 2012-2016 Synaptics Incorporated 4 */ 5 #include <linux/input.h> 6 #include <linux/input/mt.h> 7 #include <linux/rmi.h> 8 #include <linux/sizes.h> 9 #include <linux/unaligned.h> 10 #include "rmi_driver.h" 11 #include "rmi_2d_sensor.h" 12 13 enum rmi_f12_object_type { 14 RMI_F12_OBJECT_NONE = 0x00, 15 RMI_F12_OBJECT_FINGER = 0x01, 16 RMI_F12_OBJECT_STYLUS = 0x02, 17 RMI_F12_OBJECT_PALM = 0x03, 18 RMI_F12_OBJECT_UNCLASSIFIED = 0x04, 19 RMI_F12_OBJECT_GLOVED_FINGER = 0x06, 20 RMI_F12_OBJECT_NARROW_OBJECT = 0x07, 21 RMI_F12_OBJECT_HAND_EDGE = 0x08, 22 RMI_F12_OBJECT_COVER = 0x0A, 23 RMI_F12_OBJECT_STYLUS_2 = 0x0B, 24 RMI_F12_OBJECT_ERASER = 0x0C, 25 RMI_F12_OBJECT_SMALL_OBJECT = 0x0D, 26 }; 27 28 #define F12_DATA1_BYTES_PER_OBJ 8 29 #define RMI_F12_QUERY_RESOLUTION 29 30 31 struct f12_data { 32 struct rmi_2d_sensor sensor; 33 struct rmi_2d_sensor_platform_data sensor_pdata; 34 bool has_dribble; 35 36 u16 data_addr; 37 38 struct rmi_register_descriptor query_reg_desc; 39 struct rmi_register_descriptor control_reg_desc; 40 struct rmi_register_descriptor data_reg_desc; 41 42 /* F12 Data1 describes sensed objects */ 43 const struct rmi_register_desc_item *data1; 44 u16 data1_offset; 45 46 /* F12 Data5 describes finger ACM */ 47 const struct rmi_register_desc_item *data5; 48 u16 data5_offset; 49 50 /* F12 Data5 describes Pen */ 51 const struct rmi_register_desc_item *data6; 52 u16 data6_offset; 53 54 /* F12 Data9 reports relative data */ 55 const struct rmi_register_desc_item *data9; 56 u16 data9_offset; 57 58 const struct rmi_register_desc_item *data15; 59 u16 data15_offset; 60 61 unsigned long irq_mask[]; 62 }; 63 64 static int rmi_f12_read_register_descs(struct rmi_function *fn, 65 struct f12_data *f12, u16 query_addr) 66 { 67 struct { 68 struct rmi_register_descriptor *desc; 69 const char *name; 70 } descriptors[] = { 71 { &f12->query_reg_desc, "Query" }, 72 { &f12->control_reg_desc, "Control" }, 73 { &f12->data_reg_desc, "Data" }, 74 }; 75 struct rmi_device *rmi_dev = fn->rmi_dev; 76 int error; 77 int i; 78 79 for (i = 0; i < ARRAY_SIZE(descriptors); i++) { 80 error = rmi_read_register_desc(rmi_dev, query_addr, 81 descriptors[i].desc); 82 if (error) { 83 dev_err(&fn->dev, 84 "Failed to read the %s Register Descriptor: %d\n", 85 descriptors[i].name, error); 86 return error; 87 } 88 query_addr += 3; 89 } 90 91 return 0; 92 } 93 94 static int rmi_f12_read_sensor_tuning(struct f12_data *f12) 95 { 96 const struct rmi_register_desc_item *item; 97 struct rmi_2d_sensor *sensor = &f12->sensor; 98 struct rmi_function *fn = sensor->fn; 99 struct rmi_device *rmi_dev = fn->rmi_dev; 100 int ret; 101 int offset; 102 u8 buf[15]; 103 int pitch_x = 0; 104 int pitch_y = 0; 105 int rx_receivers = 0; 106 int tx_receivers = 0; 107 u16 query_dpm_addr = 0; 108 int dpm_resolution = 0; 109 110 item = rmi_get_register_desc_item(&f12->control_reg_desc, 8); 111 if (!item) { 112 dev_err(&fn->dev, 113 "F12 does not have the sensor tuning control register\n"); 114 return -ENODEV; 115 } 116 117 offset = rmi_register_desc_calc_reg_offset(&f12->control_reg_desc, 8); 118 119 if (item->reg_size > sizeof(buf)) { 120 dev_err(&fn->dev, 121 "F12 control8 should be no bigger than %zd bytes, not: %u\n", 122 sizeof(buf), item->reg_size); 123 return -ENODEV; 124 } 125 126 ret = rmi_read_block(rmi_dev, fn->fd.control_base_addr + offset, 127 buf, item->reg_size); 128 if (ret) 129 return ret; 130 131 offset = 0; 132 if (rmi_register_desc_has_subpacket(item, 0)) { 133 sensor->max_x = get_unaligned_le16(&buf[offset]); 134 sensor->max_y = get_unaligned_le16(&buf[offset + 2]); 135 offset += 4; 136 } 137 138 rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: max_x: %d max_y: %d\n", __func__, 139 sensor->max_x, sensor->max_y); 140 141 if (rmi_register_desc_has_subpacket(item, 1)) { 142 pitch_x = get_unaligned_le16(&buf[offset]); 143 pitch_y = get_unaligned_le16(&buf[offset + 2]); 144 offset += 4; 145 } 146 147 if (rmi_register_desc_has_subpacket(item, 2)) { 148 /* Units 1/128 sensor pitch */ 149 rmi_dbg(RMI_DEBUG_FN, &fn->dev, 150 "%s: Inactive Border xlo:%d xhi:%d ylo:%d yhi:%d\n", 151 __func__, 152 buf[offset], buf[offset + 1], 153 buf[offset + 2], buf[offset + 3]); 154 155 offset += 4; 156 } 157 158 /* 159 * Use the Query DPM feature when the resolution query register 160 * exists. 161 */ 162 if (rmi_get_register_desc_item(&f12->query_reg_desc, 163 RMI_F12_QUERY_RESOLUTION)) { 164 offset = rmi_register_desc_calc_reg_offset(&f12->query_reg_desc, 165 RMI_F12_QUERY_RESOLUTION); 166 query_dpm_addr = fn->fd.query_base_addr + offset; 167 ret = rmi_read(fn->rmi_dev, query_dpm_addr, buf); 168 if (ret) { 169 dev_err(&fn->dev, "Failed to read DPM value: %d\n", ret); 170 return ret; 171 } 172 dpm_resolution = buf[0]; 173 174 sensor->x_mm = sensor->max_x / dpm_resolution; 175 sensor->y_mm = sensor->max_y / dpm_resolution; 176 } else { 177 if (rmi_register_desc_has_subpacket(item, 3)) { 178 rx_receivers = buf[offset]; 179 tx_receivers = buf[offset + 1]; 180 offset += 2; 181 } 182 183 /* Skip over sensor flags */ 184 if (rmi_register_desc_has_subpacket(item, 4)) 185 offset += 1; 186 187 sensor->x_mm = (pitch_x * rx_receivers) >> 12; 188 sensor->y_mm = (pitch_y * tx_receivers) >> 12; 189 } 190 191 rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: x_mm: %d y_mm: %d\n", __func__, 192 sensor->x_mm, sensor->y_mm); 193 194 return 0; 195 } 196 197 static void rmi_f12_process_objects(struct f12_data *f12, u8 *data1, u32 size) 198 { 199 struct rmi_2d_sensor *sensor = &f12->sensor; 200 u32 objects = min(f12->data1->num_subpackets, size / F12_DATA1_BYTES_PER_OBJ); 201 int i; 202 203 for (i = 0; i < objects; i++) { 204 struct rmi_2d_sensor_abs_object *obj = &sensor->objs[i]; 205 206 obj->type = RMI_2D_OBJECT_NONE; 207 obj->mt_tool = MT_TOOL_FINGER; 208 209 switch (data1[0]) { 210 case RMI_F12_OBJECT_FINGER: 211 obj->type = RMI_2D_OBJECT_FINGER; 212 break; 213 case RMI_F12_OBJECT_STYLUS: 214 obj->type = RMI_2D_OBJECT_STYLUS; 215 obj->mt_tool = MT_TOOL_PEN; 216 break; 217 case RMI_F12_OBJECT_PALM: 218 obj->type = RMI_2D_OBJECT_PALM; 219 obj->mt_tool = MT_TOOL_PALM; 220 break; 221 case RMI_F12_OBJECT_UNCLASSIFIED: 222 obj->type = RMI_2D_OBJECT_UNCLASSIFIED; 223 break; 224 } 225 226 obj->x = get_unaligned_le16(&data1[1]); 227 obj->y = get_unaligned_le16(&data1[3]); 228 obj->z = data1[5]; 229 obj->wx = data1[6]; 230 obj->wy = data1[7]; 231 232 rmi_2d_sensor_abs_process(sensor, obj, i); 233 234 data1 += F12_DATA1_BYTES_PER_OBJ; 235 } 236 237 if (sensor->kernel_tracking) 238 input_mt_assign_slots(sensor->input, 239 sensor->tracking_slots, 240 sensor->tracking_pos, 241 sensor->nbr_fingers, 242 sensor->dmax); 243 244 for (i = 0; i < objects; i++) 245 rmi_2d_sensor_abs_report(sensor, &sensor->objs[i], i); 246 } 247 248 static irqreturn_t rmi_f12_attention(int irq, void *ctx) 249 { 250 struct rmi_function *fn = ctx; 251 struct rmi_device *rmi_dev = fn->rmi_dev; 252 struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev); 253 struct f12_data *f12 = dev_get_drvdata(&fn->dev); 254 struct rmi_2d_sensor *sensor = &f12->sensor; 255 u32 valid_bytes = sensor->pkt_size; 256 int retval; 257 258 if (drvdata->attn_data.data) { 259 valid_bytes = min_t(u32, sensor->attn_size, drvdata->attn_data.size); 260 memcpy(sensor->data_pkt, drvdata->attn_data.data, valid_bytes); 261 drvdata->attn_data.data += valid_bytes; 262 drvdata->attn_data.size -= valid_bytes; 263 } else { 264 retval = rmi_read_block(rmi_dev, f12->data_addr, 265 sensor->data_pkt, sensor->pkt_size); 266 if (retval < 0) { 267 dev_err(&fn->dev, "Failed to read object data. Code: %d.\n", 268 retval); 269 return IRQ_RETVAL(retval); 270 } 271 } 272 273 if (f12->data1) 274 rmi_f12_process_objects(f12, &sensor->data_pkt[f12->data1_offset], 275 valid_bytes); 276 277 input_mt_sync_frame(sensor->input); 278 279 return IRQ_HANDLED; 280 } 281 282 static int rmi_f12_update_dribble(struct rmi_function *fn, struct f12_data *f12) 283 { 284 const struct rmi_register_desc_item *item; 285 struct rmi_device *rmi_dev = fn->rmi_dev; 286 u8 subpacket_offset = 0; 287 u16 control_offset; 288 u32 control_size; 289 int error; 290 u8 buf[3]; 291 292 item = rmi_get_register_desc_item(&f12->control_reg_desc, 20); 293 if (!item) 294 return 0; 295 296 control_offset = rmi_register_desc_calc_reg_offset(&f12->control_reg_desc, 20); 297 298 /* 299 * The byte containing the EnableDribble bit will be 300 * in either byte 0 or byte 2 of control 20. Depending 301 * on the existence of subpacket 0. If control 20 is 302 * larger then 3 bytes, just read the first 3. 303 */ 304 control_size = min(item->reg_size, 3U); 305 306 error = rmi_read_block(rmi_dev, fn->fd.control_base_addr + control_offset, 307 buf, control_size); 308 if (error) 309 return error; 310 311 if (rmi_register_desc_has_subpacket(item, 0)) 312 subpacket_offset += 1; 313 314 switch (f12->sensor.dribble) { 315 case RMI_REG_STATE_OFF: 316 buf[subpacket_offset] &= ~BIT(2); 317 break; 318 case RMI_REG_STATE_ON: 319 buf[subpacket_offset] |= BIT(2); 320 break; 321 case RMI_REG_STATE_DEFAULT: 322 default: 323 break; 324 } 325 326 error = rmi_write_block(rmi_dev, fn->fd.control_base_addr + control_offset, 327 buf, control_size); 328 if (error) 329 return error; 330 331 return 0; 332 } 333 334 static int rmi_f12_write_control_regs(struct rmi_function *fn) 335 { 336 struct f12_data *f12 = dev_get_drvdata(&fn->dev); 337 338 if (f12->has_dribble && f12->sensor.dribble != RMI_REG_STATE_DEFAULT) 339 return rmi_f12_update_dribble(fn, f12); 340 341 return 0; 342 } 343 344 static int rmi_f12_config(struct rmi_function *fn) 345 { 346 struct rmi_driver *drv = fn->rmi_dev->driver; 347 struct f12_data *f12 = dev_get_drvdata(&fn->dev); 348 struct rmi_driver_data *drvdata = dev_get_drvdata(&fn->rmi_dev->dev); 349 int irq_mask_size = BITS_TO_LONGS(drvdata->irq_count); 350 unsigned long *abs_mask = f12->irq_mask; 351 unsigned long *rel_mask = f12->irq_mask + irq_mask_size; 352 struct rmi_2d_sensor *sensor; 353 int ret; 354 355 sensor = &f12->sensor; 356 357 if (!sensor->report_abs) 358 drv->clear_irq_bits(fn->rmi_dev, abs_mask); 359 else 360 drv->set_irq_bits(fn->rmi_dev, abs_mask); 361 362 drv->clear_irq_bits(fn->rmi_dev, rel_mask); 363 364 ret = rmi_f12_write_control_regs(fn); 365 if (ret) 366 dev_warn(&fn->dev, 367 "Failed to write F12 control registers: %d\n", ret); 368 369 return 0; 370 } 371 372 static int rmi_f12_probe(struct rmi_function *fn) 373 { 374 struct f12_data *f12; 375 int ret; 376 struct rmi_device *rmi_dev = fn->rmi_dev; 377 char buf; 378 u16 query_addr = fn->fd.query_base_addr; 379 const struct rmi_register_desc_item *item; 380 struct rmi_2d_sensor *sensor; 381 struct rmi_device_platform_data *pdata = rmi_get_platform_data(rmi_dev); 382 struct rmi_driver_data *drvdata = dev_get_drvdata(&rmi_dev->dev); 383 size_t data_offset = 0; 384 size_t pkt_size; 385 int irq_mask_size; 386 int i; 387 388 rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s\n", __func__); 389 390 irq_mask_size = BITS_TO_LONGS(drvdata->irq_count); 391 392 ret = rmi_read(fn->rmi_dev, query_addr, &buf); 393 if (ret < 0) { 394 dev_err(&fn->dev, "Failed to read general info register: %d\n", 395 ret); 396 return -ENODEV; 397 } 398 ++query_addr; 399 400 if (!(buf & BIT(0))) { 401 dev_err(&fn->dev, 402 "Behavior of F12 without register descriptors is undefined.\n"); 403 return -ENODEV; 404 } 405 406 f12 = devm_kzalloc(&fn->dev, struct_size(f12, irq_mask, irq_mask_size * 2), 407 GFP_KERNEL); 408 if (!f12) 409 return -ENOMEM; 410 411 set_bit(fn->irq_pos, f12->irq_mask); 412 set_bit(fn->irq_pos + 1, f12->irq_mask + irq_mask_size); 413 414 f12->has_dribble = !!(buf & BIT(3)); 415 416 if (fn->dev.of_node) { 417 ret = rmi_2d_sensor_of_probe(&fn->dev, &f12->sensor_pdata); 418 if (ret) 419 return ret; 420 } else { 421 f12->sensor_pdata = pdata->sensor_pdata; 422 } 423 424 ret = rmi_f12_read_register_descs(fn, f12, query_addr); 425 if (ret) 426 return ret; 427 428 sensor = &f12->sensor; 429 sensor->fn = fn; 430 f12->data_addr = fn->fd.data_base_addr; 431 pkt_size = rmi_register_desc_calc_size(&f12->data_reg_desc); 432 if (pkt_size > SZ_1M) { 433 dev_err(&fn->dev, "Invalid data packet size: %zu\n", pkt_size); 434 return -EINVAL; 435 } 436 sensor->pkt_size = pkt_size; 437 438 sensor->axis_align = f12->sensor_pdata.axis_align; 439 440 sensor->x_mm = f12->sensor_pdata.x_mm; 441 sensor->y_mm = f12->sensor_pdata.y_mm; 442 sensor->dribble = f12->sensor_pdata.dribble; 443 444 if (sensor->sensor_type == rmi_sensor_default) 445 sensor->sensor_type = f12->sensor_pdata.sensor_type; 446 447 rmi_dbg(RMI_DEBUG_FN, &fn->dev, "%s: data packet size: %u\n", __func__, 448 sensor->pkt_size); 449 sensor->data_pkt = devm_kmalloc(&fn->dev, sensor->pkt_size, GFP_KERNEL); 450 if (!sensor->data_pkt) 451 return -ENOMEM; 452 453 dev_set_drvdata(&fn->dev, f12); 454 455 ret = rmi_f12_read_sensor_tuning(f12); 456 if (ret) 457 return ret; 458 459 /* 460 * Identify available data registers and calculate their offsets within 461 * the attention report. For HID devices, only Data1 and Data5 are 462 * included in the report; other registers may be described but are 463 * not transmitted in the attention packet and thus skipped here. 464 */ 465 for (i = 0; i < 16; i++) { 466 item = rmi_get_register_desc_item(&f12->data_reg_desc, i); 467 if (!item) 468 continue; 469 470 /* HID attention reports only contain Data1 and Data5 */ 471 if (drvdata->attn_data.data && i != 1 && i != 5) 472 continue; 473 474 if (data_offset > U16_MAX) { 475 dev_err(&fn->dev, "Invalid offset for data%d: %zu\n", 476 i, data_offset); 477 return -EINVAL; 478 } 479 480 switch (i) { 481 case 1: 482 f12->data1 = item; 483 f12->data1_offset = data_offset; 484 485 if (item->num_subpackets > 255) { 486 dev_err(&fn->dev, 487 "Too many fingers declared: %d\n", 488 item->num_subpackets); 489 return -EINVAL; 490 } 491 492 sensor->nbr_fingers = item->num_subpackets; 493 sensor->report_abs = 1; 494 sensor->attn_size += item->reg_size; 495 break; 496 497 case 5: 498 f12->data5 = item; 499 f12->data5_offset = data_offset; 500 sensor->attn_size += item->reg_size; 501 break; 502 503 case 6: 504 f12->data6 = item; 505 f12->data6_offset = data_offset; 506 break; 507 508 case 9: 509 f12->data9 = item; 510 f12->data9_offset = data_offset; 511 if (!sensor->report_abs) 512 sensor->report_rel = 1; 513 break; 514 515 case 15: 516 f12->data15 = item; 517 f12->data15_offset = data_offset; 518 break; 519 } 520 521 data_offset += item->reg_size; 522 } 523 524 /* allocate the in-kernel tracking buffers */ 525 sensor->tracking_pos = devm_kcalloc(&fn->dev, sensor->nbr_fingers, 526 sizeof(*sensor->tracking_pos), 527 GFP_KERNEL); 528 if (!sensor->tracking_pos) 529 return -ENOMEM; 530 531 sensor->tracking_slots = devm_kcalloc(&fn->dev, sensor->nbr_fingers, 532 sizeof(*sensor->tracking_slots), 533 GFP_KERNEL); 534 if (!sensor->tracking_slots) 535 return -ENOMEM; 536 537 sensor->objs = devm_kcalloc(&fn->dev, sensor->nbr_fingers, 538 sizeof(*sensor->objs), GFP_KERNEL); 539 if (!sensor->objs) 540 return -ENOMEM; 541 542 ret = rmi_2d_sensor_configure_input(fn, sensor); 543 if (ret) 544 return ret; 545 546 return 0; 547 } 548 549 struct rmi_function_handler rmi_f12_handler = { 550 .driver = { 551 .name = "rmi4_f12", 552 }, 553 .func = 0x12, 554 .probe = rmi_f12_probe, 555 .config = rmi_f12_config, 556 .attention = rmi_f12_attention, 557 }; 558