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