forked from microsoft/WSL2-Linux-Kernel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrmi_f11.c
1363 lines (1165 loc) · 40.1 KB
/
rmi_f11.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2011-2015 Synaptics Incorporated
* Copyright (c) 2011 Unixphere
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as published by
* the Free Software Foundation.
*/
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/input.h>
#include <linux/input/mt.h>
#include <linux/rmi.h>
#include <linux/slab.h>
#include <linux/of.h>
#include "rmi_driver.h"
#include "rmi_2d_sensor.h"
#define F11_MAX_NUM_OF_FINGERS 10
#define F11_MAX_NUM_OF_TOUCH_SHAPES 16
#define FINGER_STATE_MASK 0x03
#define F11_CTRL_SENSOR_MAX_X_POS_OFFSET 6
#define F11_CTRL_SENSOR_MAX_Y_POS_OFFSET 8
#define DEFAULT_XY_MAX 9999
#define DEFAULT_MAX_ABS_MT_PRESSURE 255
#define DEFAULT_MAX_ABS_MT_TOUCH 15
#define DEFAULT_MAX_ABS_MT_ORIENTATION 1
#define DEFAULT_MIN_ABS_MT_TRACKING_ID 1
#define DEFAULT_MAX_ABS_MT_TRACKING_ID 10
/** A note about RMI4 F11 register structure.
*
* The properties for
* a given sensor are described by its query registers. The number of query
* registers and the layout of their contents are described by the F11 device
* queries as well as the sensor query information.
*
* Similarly, each sensor has control registers that govern its behavior. The
* size and layout of the control registers for a given sensor can be determined
* by parsing that sensors query registers.
*
* And in a likewise fashion, each sensor has data registers where it reports
* its touch data and other interesting stuff. The size and layout of a
* sensors data registers must be determined by parsing its query registers.
*
* The short story is that we need to read and parse a lot of query
* registers in order to determine the attributes of a sensor. Then
* we need to use that data to compute the size of the control and data
* registers for sensor.
*
* The end result is that we have a number of structs that aren't used to
* directly generate the input events, but their size, location and contents
* are critical to determining where the data we are interested in lives.
*
* At this time, the driver does not yet comprehend all possible F11
* configuration options, but it should be sufficient to cover 99% of RMI4 F11
* devices currently in the field.
*/
/* maximum ABS_MT_POSITION displacement (in mm) */
#define DMAX 10
/**
* @rezero - writing this to the F11 command register will cause the sensor to
* calibrate to the current capacitive state.
*/
#define RMI_F11_REZERO 0x01
#define RMI_F11_HAS_QUERY9 (1 << 3)
#define RMI_F11_HAS_QUERY11 (1 << 4)
#define RMI_F11_HAS_QUERY12 (1 << 5)
#define RMI_F11_HAS_QUERY27 (1 << 6)
#define RMI_F11_HAS_QUERY28 (1 << 7)
/** Defs for Query 1 */
#define RMI_F11_NR_FINGERS_MASK 0x07
#define RMI_F11_HAS_REL (1 << 3)
#define RMI_F11_HAS_ABS (1 << 4)
#define RMI_F11_HAS_GESTURES (1 << 5)
#define RMI_F11_HAS_SENSITIVITY_ADJ (1 << 6)
#define RMI_F11_CONFIGURABLE (1 << 7)
/** Defs for Query 2, 3, and 4. */
#define RMI_F11_NR_ELECTRODES_MASK 0x7F
/** Defs for Query 5 */
#define RMI_F11_ABS_DATA_SIZE_MASK 0x03
#define RMI_F11_HAS_ANCHORED_FINGER (1 << 2)
#define RMI_F11_HAS_ADJ_HYST (1 << 3)
#define RMI_F11_HAS_DRIBBLE (1 << 4)
#define RMI_F11_HAS_BENDING_CORRECTION (1 << 5)
#define RMI_F11_HAS_LARGE_OBJECT_SUPPRESSION (1 << 6)
#define RMI_F11_HAS_JITTER_FILTER (1 << 7)
/** Defs for Query 7 */
#define RMI_F11_HAS_SINGLE_TAP (1 << 0)
#define RMI_F11_HAS_TAP_AND_HOLD (1 << 1)
#define RMI_F11_HAS_DOUBLE_TAP (1 << 2)
#define RMI_F11_HAS_EARLY_TAP (1 << 3)
#define RMI_F11_HAS_FLICK (1 << 4)
#define RMI_F11_HAS_PRESS (1 << 5)
#define RMI_F11_HAS_PINCH (1 << 6)
#define RMI_F11_HAS_CHIRAL (1 << 7)
/** Defs for Query 8 */
#define RMI_F11_HAS_PALM_DET (1 << 0)
#define RMI_F11_HAS_ROTATE (1 << 1)
#define RMI_F11_HAS_TOUCH_SHAPES (1 << 2)
#define RMI_F11_HAS_SCROLL_ZONES (1 << 3)
#define RMI_F11_HAS_INDIVIDUAL_SCROLL_ZONES (1 << 4)
#define RMI_F11_HAS_MF_SCROLL (1 << 5)
#define RMI_F11_HAS_MF_EDGE_MOTION (1 << 6)
#define RMI_F11_HAS_MF_SCROLL_INERTIA (1 << 7)
/** Defs for Query 9. */
#define RMI_F11_HAS_PEN (1 << 0)
#define RMI_F11_HAS_PROXIMITY (1 << 1)
#define RMI_F11_HAS_PALM_DET_SENSITIVITY (1 << 2)
#define RMI_F11_HAS_SUPPRESS_ON_PALM_DETECT (1 << 3)
#define RMI_F11_HAS_TWO_PEN_THRESHOLDS (1 << 4)
#define RMI_F11_HAS_CONTACT_GEOMETRY (1 << 5)
#define RMI_F11_HAS_PEN_HOVER_DISCRIMINATION (1 << 6)
#define RMI_F11_HAS_PEN_FILTERS (1 << 7)
/** Defs for Query 10. */
#define RMI_F11_NR_TOUCH_SHAPES_MASK 0x1F
/** Defs for Query 11 */
#define RMI_F11_HAS_Z_TUNING (1 << 0)
#define RMI_F11_HAS_ALGORITHM_SELECTION (1 << 1)
#define RMI_F11_HAS_W_TUNING (1 << 2)
#define RMI_F11_HAS_PITCH_INFO (1 << 3)
#define RMI_F11_HAS_FINGER_SIZE (1 << 4)
#define RMI_F11_HAS_SEGMENTATION_AGGRESSIVENESS (1 << 5)
#define RMI_F11_HAS_XY_CLIP (1 << 6)
#define RMI_F11_HAS_DRUMMING_FILTER (1 << 7)
/** Defs for Query 12. */
#define RMI_F11_HAS_GAPLESS_FINGER (1 << 0)
#define RMI_F11_HAS_GAPLESS_FINGER_TUNING (1 << 1)
#define RMI_F11_HAS_8BIT_W (1 << 2)
#define RMI_F11_HAS_ADJUSTABLE_MAPPING (1 << 3)
#define RMI_F11_HAS_INFO2 (1 << 4)
#define RMI_F11_HAS_PHYSICAL_PROPS (1 << 5)
#define RMI_F11_HAS_FINGER_LIMIT (1 << 6)
#define RMI_F11_HAS_LINEAR_COEFF (1 << 7)
/** Defs for Query 13. */
#define RMI_F11_JITTER_WINDOW_MASK 0x1F
#define RMI_F11_JITTER_FILTER_MASK 0x60
#define RMI_F11_JITTER_FILTER_SHIFT 5
/** Defs for Query 14. */
#define RMI_F11_LIGHT_CONTROL_MASK 0x03
#define RMI_F11_IS_CLEAR (1 << 2)
#define RMI_F11_CLICKPAD_PROPS_MASK 0x18
#define RMI_F11_CLICKPAD_PROPS_SHIFT 3
#define RMI_F11_MOUSE_BUTTONS_MASK 0x60
#define RMI_F11_MOUSE_BUTTONS_SHIFT 5
#define RMI_F11_HAS_ADVANCED_GESTURES (1 << 7)
#define RMI_F11_QUERY_SIZE 4
#define RMI_F11_QUERY_GESTURE_SIZE 2
#define F11_LIGHT_CTL_NONE 0x00
#define F11_LUXPAD 0x01
#define F11_DUAL_MODE 0x02
#define F11_NOT_CLICKPAD 0x00
#define F11_HINGED_CLICKPAD 0x01
#define F11_UNIFORM_CLICKPAD 0x02
/**
* Query registers 1 through 4 are always present.
*
* @nr_fingers - describes the maximum number of fingers the 2-D sensor
* supports.
* @has_rel - the sensor supports relative motion reporting.
* @has_abs - the sensor supports absolute poition reporting.
* @has_gestures - the sensor supports gesture reporting.
* @has_sensitivity_adjust - the sensor supports a global sensitivity
* adjustment.
* @configurable - the sensor supports various configuration options.
* @num_of_x_electrodes - the maximum number of electrodes the 2-D sensor
* supports on the X axis.
* @num_of_y_electrodes - the maximum number of electrodes the 2-D sensor
* supports on the Y axis.
* @max_electrodes - the total number of X and Y electrodes that may be
* configured.
*
* Query 5 is present if the has_abs bit is set.
*
* @abs_data_size - describes the format of data reported by the absolute
* data source. Only one format (the kind used here) is supported at this
* time.
* @has_anchored_finger - then the sensor supports the high-precision second
* finger tracking provided by the manual tracking and motion sensitivity
* options.
* @has_adjust_hyst - the difference between the finger release threshold and
* the touch threshold.
* @has_dribble - the sensor supports the generation of dribble interrupts,
* which may be enabled or disabled with the dribble control bit.
* @has_bending_correction - Bending related data registers 28 and 36, and
* control register 52..57 are present.
* @has_large_object_suppression - control register 58 and data register 28
* exist.
* @has_jitter_filter - query 13 and control 73..76 exist.
*
* Gesture information queries 7 and 8 are present if has_gestures bit is set.
*
* @has_single_tap - a basic single-tap gesture is supported.
* @has_tap_n_hold - tap-and-hold gesture is supported.
* @has_double_tap - double-tap gesture is supported.
* @has_early_tap - early tap is supported and reported as soon as the finger
* lifts for any tap event that could be interpreted as either a single tap
* or as the first tap of a double-tap or tap-and-hold gesture.
* @has_flick - flick detection is supported.
* @has_press - press gesture reporting is supported.
* @has_pinch - pinch gesture detection is supported.
* @has_palm_det - the 2-D sensor notifies the host whenever a large conductive
* object such as a palm or a cheek touches the 2-D sensor.
* @has_rotate - rotation gesture detection is supported.
* @has_touch_shapes - TouchShapes are supported. A TouchShape is a fixed
* rectangular area on the sensor that behaves like a capacitive button.
* @has_scroll_zones - scrolling areas near the sensor edges are supported.
* @has_individual_scroll_zones - if 1, then 4 scroll zones are supported;
* if 0, then only two are supported.
* @has_mf_scroll - the multifinger_scrolling bit will be set when
* more than one finger is involved in a scrolling action.
*
* Convenience for checking bytes in the gesture info registers. This is done
* often enough that we put it here to declutter the conditionals
*
* @query7_nonzero - true if none of the query 7 bits are set
* @query8_nonzero - true if none of the query 8 bits are set
*
* Query 9 is present if the has_query9 is set.
*
* @has_pen - detection of a stylus is supported and registers F11_2D_Ctrl20
* and F11_2D_Ctrl21 exist.
* @has_proximity - detection of fingers near the sensor is supported and
* registers F11_2D_Ctrl22 through F11_2D_Ctrl26 exist.
* @has_palm_det_sensitivity - the sensor supports the palm detect sensitivity
* feature and register F11_2D_Ctrl27 exists.
* @has_two_pen_thresholds - is has_pen is also set, then F11_2D_Ctrl35 exists.
* @has_contact_geometry - the sensor supports the use of contact geometry to
* map absolute X and Y target positions and registers F11_2D_Data18
* through F11_2D_Data27 exist.
*
* Touch shape info (query 10) is present if has_touch_shapes is set.
*
* @nr_touch_shapes - the total number of touch shapes supported.
*
* Query 11 is present if the has_query11 bit is set in query 0.
*
* @has_z_tuning - if set, the sensor supports Z tuning and registers
* F11_2D_Ctrl29 through F11_2D_Ctrl33 exist.
* @has_algorithm_selection - controls choice of noise suppression algorithm
* @has_w_tuning - the sensor supports Wx and Wy scaling and registers
* F11_2D_Ctrl36 through F11_2D_Ctrl39 exist.
* @has_pitch_info - the X and Y pitches of the sensor electrodes can be
* configured and registers F11_2D_Ctrl40 and F11_2D_Ctrl41 exist.
* @has_finger_size - the default finger width settings for the
* sensor can be configured and registers F11_2D_Ctrl42 through F11_2D_Ctrl44
* exist.
* @has_segmentation_aggressiveness - the sensor’s ability to distinguish
* multiple objects close together can be configured and register F11_2D_Ctrl45
* exists.
* @has_XY_clip - the inactive outside borders of the sensor can be
* configured and registers F11_2D_Ctrl46 through F11_2D_Ctrl49 exist.
* @has_drumming_filter - the sensor can be configured to distinguish
* between a fast flick and a quick drumming movement and registers
* F11_2D_Ctrl50 and F11_2D_Ctrl51 exist.
*
* Query 12 is present if hasQuery12 bit is set.
*
* @has_gapless_finger - control registers relating to gapless finger are
* present.
* @has_gapless_finger_tuning - additional control and data registers relating
* to gapless finger are present.
* @has_8bit_w - larger W value reporting is supported.
* @has_adjustable_mapping - TBD
* @has_info2 - the general info query14 is present
* @has_physical_props - additional queries describing the physical properties
* of the sensor are present.
* @has_finger_limit - indicates that F11 Ctrl 80 exists.
* @has_linear_coeff - indicates that F11 Ctrl 81 exists.
*
* Query 13 is present if Query 5's has_jitter_filter bit is set.
* @jitter_window_size - used by Design Studio 4.
* @jitter_filter_type - used by Design Studio 4.
*
* Query 14 is present if query 12's has_general_info2 flag is set.
*
* @light_control - Indicates what light/led control features are present, if
* any.
* @is_clear - if set, this is a clear sensor (indicating direct pointing
* application), otherwise it's opaque (indicating indirect pointing).
* @clickpad_props - specifies if this is a clickpad, and if so what sort of
* mechanism it uses
* @mouse_buttons - specifies the number of mouse buttons present (if any).
* @has_advanced_gestures - advanced driver gestures are supported.
*/
struct f11_2d_sensor_queries {
/* query1 */
u8 nr_fingers;
bool has_rel;
bool has_abs;
bool has_gestures;
bool has_sensitivity_adjust;
bool configurable;
/* query2 */
u8 nr_x_electrodes;
/* query3 */
u8 nr_y_electrodes;
/* query4 */
u8 max_electrodes;
/* query5 */
u8 abs_data_size;
bool has_anchored_finger;
bool has_adj_hyst;
bool has_dribble;
bool has_bending_correction;
bool has_large_object_suppression;
bool has_jitter_filter;
u8 f11_2d_query6;
/* query 7 */
bool has_single_tap;
bool has_tap_n_hold;
bool has_double_tap;
bool has_early_tap;
bool has_flick;
bool has_press;
bool has_pinch;
bool has_chiral;
bool query7_nonzero;
/* query 8 */
bool has_palm_det;
bool has_rotate;
bool has_touch_shapes;
bool has_scroll_zones;
bool has_individual_scroll_zones;
bool has_mf_scroll;
bool has_mf_edge_motion;
bool has_mf_scroll_inertia;
bool query8_nonzero;
/* Query 9 */
bool has_pen;
bool has_proximity;
bool has_palm_det_sensitivity;
bool has_suppress_on_palm_detect;
bool has_two_pen_thresholds;
bool has_contact_geometry;
bool has_pen_hover_discrimination;
bool has_pen_filters;
/* Query 10 */
u8 nr_touch_shapes;
/* Query 11. */
bool has_z_tuning;
bool has_algorithm_selection;
bool has_w_tuning;
bool has_pitch_info;
bool has_finger_size;
bool has_segmentation_aggressiveness;
bool has_XY_clip;
bool has_drumming_filter;
/* Query 12 */
bool has_gapless_finger;
bool has_gapless_finger_tuning;
bool has_8bit_w;
bool has_adjustable_mapping;
bool has_info2;
bool has_physical_props;
bool has_finger_limit;
bool has_linear_coeff_2;
/* Query 13 */
u8 jitter_window_size;
u8 jitter_filter_type;
/* Query 14 */
u8 light_control;
bool is_clear;
u8 clickpad_props;
u8 mouse_buttons;
bool has_advanced_gestures;
/* Query 15 - 18 */
u16 x_sensor_size_mm;
u16 y_sensor_size_mm;
};
/* Defs for Ctrl0. */
#define RMI_F11_REPORT_MODE_MASK 0x07
#define RMI_F11_ABS_POS_FILT (1 << 3)
#define RMI_F11_REL_POS_FILT (1 << 4)
#define RMI_F11_REL_BALLISTICS (1 << 5)
#define RMI_F11_DRIBBLE (1 << 6)
#define RMI_F11_REPORT_BEYOND_CLIP (1 << 7)
/* Defs for Ctrl1. */
#define RMI_F11_PALM_DETECT_THRESH_MASK 0x0F
#define RMI_F11_MOTION_SENSITIVITY_MASK 0x30
#define RMI_F11_MANUAL_TRACKING (1 << 6)
#define RMI_F11_MANUAL_TRACKED_FINGER (1 << 7)
#define RMI_F11_DELTA_X_THRESHOLD 2
#define RMI_F11_DELTA_Y_THRESHOLD 3
#define RMI_F11_CTRL_REG_COUNT 12
struct f11_2d_ctrl {
u8 ctrl0_11[RMI_F11_CTRL_REG_COUNT];
u16 ctrl0_11_address;
};
#define RMI_F11_ABS_BYTES 5
#define RMI_F11_REL_BYTES 2
/* Defs for Data 8 */
#define RMI_F11_SINGLE_TAP (1 << 0)
#define RMI_F11_TAP_AND_HOLD (1 << 1)
#define RMI_F11_DOUBLE_TAP (1 << 2)
#define RMI_F11_EARLY_TAP (1 << 3)
#define RMI_F11_FLICK (1 << 4)
#define RMI_F11_PRESS (1 << 5)
#define RMI_F11_PINCH (1 << 6)
/* Defs for Data 9 */
#define RMI_F11_PALM_DETECT (1 << 0)
#define RMI_F11_ROTATE (1 << 1)
#define RMI_F11_SHAPE (1 << 2)
#define RMI_F11_SCROLLZONE (1 << 3)
#define RMI_F11_GESTURE_FINGER_COUNT_MASK 0x70
/** Handy pointers into our data buffer.
*
* @f_state - start of finger state registers.
* @abs_pos - start of absolute position registers (if present).
* @rel_pos - start of relative data registers (if present).
* @gest_1 - gesture flags (if present).
* @gest_2 - gesture flags & finger count (if present).
* @pinch - pinch motion register (if present).
* @flick - flick distance X & Y, flick time (if present).
* @rotate - rotate motion and finger separation.
* @multi_scroll - chiral deltas for X and Y (if present).
* @scroll_zones - scroll deltas for 4 regions (if present).
*/
struct f11_2d_data {
u8 *f_state;
u8 *abs_pos;
s8 *rel_pos;
u8 *gest_1;
u8 *gest_2;
s8 *pinch;
u8 *flick;
u8 *rotate;
u8 *shapes;
s8 *multi_scroll;
s8 *scroll_zones;
};
/** Data pertaining to F11 in general. For per-sensor data, see struct
* f11_2d_sensor.
*
* @dev_query - F11 device specific query registers.
* @dev_controls - F11 device specific control registers.
* @dev_controls_mutex - lock for the control registers.
* @rezero_wait_ms - if nonzero, upon resume we will wait this many
* milliseconds before rezeroing the sensor(s). This is useful in systems with
* poor electrical behavior on resume, where the initial calibration of the
* sensor(s) coming out of sleep state may be bogus.
* @sensors - per sensor data structures.
*/
struct f11_data {
bool has_query9;
bool has_query11;
bool has_query12;
bool has_query27;
bool has_query28;
bool has_acm;
struct f11_2d_ctrl dev_controls;
struct mutex dev_controls_mutex;
u16 rezero_wait_ms;
struct rmi_2d_sensor sensor;
struct f11_2d_sensor_queries sens_query;
struct f11_2d_data data;
struct rmi_2d_sensor_platform_data sensor_pdata;
unsigned long *abs_mask;
unsigned long *rel_mask;
unsigned long *result_bits;
};
enum f11_finger_state {
F11_NO_FINGER = 0x00,
F11_PRESENT = 0x01,
F11_INACCURATE = 0x02,
F11_RESERVED = 0x03
};
static void rmi_f11_rel_pos_report(struct f11_data *f11, u8 n_finger)
{
struct rmi_2d_sensor *sensor = &f11->sensor;
struct f11_2d_data *data = &f11->data;
s8 x, y;
x = data->rel_pos[n_finger * RMI_F11_REL_BYTES];
y = data->rel_pos[n_finger * RMI_F11_REL_BYTES + 1];
rmi_2d_sensor_rel_report(sensor, x, y);
}
static void rmi_f11_abs_pos_process(struct f11_data *f11,
struct rmi_2d_sensor *sensor,
struct rmi_2d_sensor_abs_object *obj,
enum f11_finger_state finger_state,
u8 n_finger)
{
struct f11_2d_data *data = &f11->data;
u8 *pos_data = &data->abs_pos[n_finger * RMI_F11_ABS_BYTES];
int tool_type = MT_TOOL_FINGER;
switch (finger_state) {
case F11_PRESENT:
obj->type = RMI_2D_OBJECT_FINGER;
break;
default:
obj->type = RMI_2D_OBJECT_NONE;
}
obj->mt_tool = tool_type;
obj->x = (pos_data[0] << 4) | (pos_data[2] & 0x0F);
obj->y = (pos_data[1] << 4) | (pos_data[2] >> 4);
obj->z = pos_data[4];
obj->wx = pos_data[3] & 0x0f;
obj->wy = pos_data[3] >> 4;
rmi_2d_sensor_abs_process(sensor, obj, n_finger);
}
static inline u8 rmi_f11_parse_finger_state(const u8 *f_state, u8 n_finger)
{
return (f_state[n_finger / 4] >> (2 * (n_finger % 4))) &
FINGER_STATE_MASK;
}
static void rmi_f11_finger_handler(struct f11_data *f11,
struct rmi_2d_sensor *sensor,
unsigned long *irq_bits, int num_irq_regs,
int size)
{
const u8 *f_state = f11->data.f_state;
u8 finger_state;
u8 i;
int abs_fingers;
int rel_fingers;
int abs_size = sensor->nbr_fingers * RMI_F11_ABS_BYTES;
int abs_bits = bitmap_and(f11->result_bits, irq_bits, f11->abs_mask,
num_irq_regs * 8);
int rel_bits = bitmap_and(f11->result_bits, irq_bits, f11->rel_mask,
num_irq_regs * 8);
if (abs_bits) {
if (abs_size > size)
abs_fingers = size / RMI_F11_ABS_BYTES;
else
abs_fingers = sensor->nbr_fingers;
for (i = 0; i < abs_fingers; i++) {
/* Possible of having 4 fingers per f_state register */
finger_state = rmi_f11_parse_finger_state(f_state, i);
if (finger_state == F11_RESERVED) {
pr_err("Invalid finger state[%d]: 0x%02x", i,
finger_state);
continue;
}
rmi_f11_abs_pos_process(f11, sensor, &sensor->objs[i],
finger_state, i);
}
}
if (rel_bits) {
if ((abs_size + sensor->nbr_fingers * RMI_F11_REL_BYTES) > size)
rel_fingers = (size - abs_size) / RMI_F11_REL_BYTES;
else
rel_fingers = sensor->nbr_fingers;
for (i = 0; i < rel_fingers; i++)
rmi_f11_rel_pos_report(f11, i);
}
if (abs_bits) {
/*
* the absolute part is made in 2 parts to allow the kernel
* tracking to take place.
*/
if (sensor->kernel_tracking)
input_mt_assign_slots(sensor->input,
sensor->tracking_slots,
sensor->tracking_pos,
sensor->nbr_fingers,
sensor->dmax);
for (i = 0; i < abs_fingers; i++) {
finger_state = rmi_f11_parse_finger_state(f_state, i);
if (finger_state == F11_RESERVED)
/* no need to send twice the error */
continue;
rmi_2d_sensor_abs_report(sensor, &sensor->objs[i], i);
}
input_mt_sync_frame(sensor->input);
}
}
static int f11_2d_construct_data(struct f11_data *f11)
{
struct rmi_2d_sensor *sensor = &f11->sensor;
struct f11_2d_sensor_queries *query = &f11->sens_query;
struct f11_2d_data *data = &f11->data;
int i;
sensor->nbr_fingers = (query->nr_fingers == 5 ? 10 :
query->nr_fingers + 1);
sensor->pkt_size = DIV_ROUND_UP(sensor->nbr_fingers, 4);
if (query->has_abs) {
sensor->pkt_size += (sensor->nbr_fingers * 5);
sensor->attn_size = sensor->pkt_size;
}
if (query->has_rel)
sensor->pkt_size += (sensor->nbr_fingers * 2);
/* Check if F11_2D_Query7 is non-zero */
if (query->query7_nonzero)
sensor->pkt_size += sizeof(u8);
/* Check if F11_2D_Query7 or F11_2D_Query8 is non-zero */
if (query->query7_nonzero || query->query8_nonzero)
sensor->pkt_size += sizeof(u8);
if (query->has_pinch || query->has_flick || query->has_rotate) {
sensor->pkt_size += 3;
if (!query->has_flick)
sensor->pkt_size--;
if (!query->has_rotate)
sensor->pkt_size--;
}
if (query->has_touch_shapes)
sensor->pkt_size +=
DIV_ROUND_UP(query->nr_touch_shapes + 1, 8);
sensor->data_pkt = devm_kzalloc(&sensor->fn->dev, sensor->pkt_size,
GFP_KERNEL);
if (!sensor->data_pkt)
return -ENOMEM;
data->f_state = sensor->data_pkt;
i = DIV_ROUND_UP(sensor->nbr_fingers, 4);
if (query->has_abs) {
data->abs_pos = &sensor->data_pkt[i];
i += (sensor->nbr_fingers * RMI_F11_ABS_BYTES);
}
if (query->has_rel) {
data->rel_pos = &sensor->data_pkt[i];
i += (sensor->nbr_fingers * RMI_F11_REL_BYTES);
}
if (query->query7_nonzero) {
data->gest_1 = &sensor->data_pkt[i];
i++;
}
if (query->query7_nonzero || query->query8_nonzero) {
data->gest_2 = &sensor->data_pkt[i];
i++;
}
if (query->has_pinch) {
data->pinch = &sensor->data_pkt[i];
i++;
}
if (query->has_flick) {
if (query->has_pinch) {
data->flick = data->pinch;
i += 2;
} else {
data->flick = &sensor->data_pkt[i];
i += 3;
}
}
if (query->has_rotate) {
if (query->has_flick) {
data->rotate = data->flick + 1;
} else {
data->rotate = &sensor->data_pkt[i];
i += 2;
}
}
if (query->has_touch_shapes)
data->shapes = &sensor->data_pkt[i];
return 0;
}
static int f11_read_control_regs(struct rmi_function *fn,
struct f11_2d_ctrl *ctrl, u16 ctrl_base_addr) {
struct rmi_device *rmi_dev = fn->rmi_dev;
int error = 0;
ctrl->ctrl0_11_address = ctrl_base_addr;
error = rmi_read_block(rmi_dev, ctrl_base_addr, ctrl->ctrl0_11,
RMI_F11_CTRL_REG_COUNT);
if (error < 0) {
dev_err(&fn->dev, "Failed to read ctrl0, code: %d.\n", error);
return error;
}
return 0;
}
static int f11_write_control_regs(struct rmi_function *fn,
struct f11_2d_sensor_queries *query,
struct f11_2d_ctrl *ctrl,
u16 ctrl_base_addr)
{
struct rmi_device *rmi_dev = fn->rmi_dev;
int error;
error = rmi_write_block(rmi_dev, ctrl_base_addr, ctrl->ctrl0_11,
RMI_F11_CTRL_REG_COUNT);
if (error < 0)
return error;
return 0;
}
static int rmi_f11_get_query_parameters(struct rmi_device *rmi_dev,
struct f11_data *f11,
struct f11_2d_sensor_queries *sensor_query,
u16 query_base_addr)
{
int query_size;
int rc;
u8 query_buf[RMI_F11_QUERY_SIZE];
bool has_query36 = false;
rc = rmi_read_block(rmi_dev, query_base_addr, query_buf,
RMI_F11_QUERY_SIZE);
if (rc < 0)
return rc;
sensor_query->nr_fingers = query_buf[0] & RMI_F11_NR_FINGERS_MASK;
sensor_query->has_rel = !!(query_buf[0] & RMI_F11_HAS_REL);
sensor_query->has_abs = !!(query_buf[0] & RMI_F11_HAS_ABS);
sensor_query->has_gestures = !!(query_buf[0] & RMI_F11_HAS_GESTURES);
sensor_query->has_sensitivity_adjust =
!!(query_buf[0] & RMI_F11_HAS_SENSITIVITY_ADJ);
sensor_query->configurable = !!(query_buf[0] & RMI_F11_CONFIGURABLE);
sensor_query->nr_x_electrodes =
query_buf[1] & RMI_F11_NR_ELECTRODES_MASK;
sensor_query->nr_y_electrodes =
query_buf[2] & RMI_F11_NR_ELECTRODES_MASK;
sensor_query->max_electrodes =
query_buf[3] & RMI_F11_NR_ELECTRODES_MASK;
query_size = RMI_F11_QUERY_SIZE;
if (sensor_query->has_abs) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->abs_data_size =
query_buf[0] & RMI_F11_ABS_DATA_SIZE_MASK;
sensor_query->has_anchored_finger =
!!(query_buf[0] & RMI_F11_HAS_ANCHORED_FINGER);
sensor_query->has_adj_hyst =
!!(query_buf[0] & RMI_F11_HAS_ADJ_HYST);
sensor_query->has_dribble =
!!(query_buf[0] & RMI_F11_HAS_DRIBBLE);
sensor_query->has_bending_correction =
!!(query_buf[0] & RMI_F11_HAS_BENDING_CORRECTION);
sensor_query->has_large_object_suppression =
!!(query_buf[0] & RMI_F11_HAS_LARGE_OBJECT_SUPPRESSION);
sensor_query->has_jitter_filter =
!!(query_buf[0] & RMI_F11_HAS_JITTER_FILTER);
query_size++;
}
if (sensor_query->has_rel) {
rc = rmi_read(rmi_dev, query_base_addr + query_size,
&sensor_query->f11_2d_query6);
if (rc < 0)
return rc;
query_size++;
}
if (sensor_query->has_gestures) {
rc = rmi_read_block(rmi_dev, query_base_addr + query_size,
query_buf, RMI_F11_QUERY_GESTURE_SIZE);
if (rc < 0)
return rc;
sensor_query->has_single_tap =
!!(query_buf[0] & RMI_F11_HAS_SINGLE_TAP);
sensor_query->has_tap_n_hold =
!!(query_buf[0] & RMI_F11_HAS_TAP_AND_HOLD);
sensor_query->has_double_tap =
!!(query_buf[0] & RMI_F11_HAS_DOUBLE_TAP);
sensor_query->has_early_tap =
!!(query_buf[0] & RMI_F11_HAS_EARLY_TAP);
sensor_query->has_flick =
!!(query_buf[0] & RMI_F11_HAS_FLICK);
sensor_query->has_press =
!!(query_buf[0] & RMI_F11_HAS_PRESS);
sensor_query->has_pinch =
!!(query_buf[0] & RMI_F11_HAS_PINCH);
sensor_query->has_chiral =
!!(query_buf[0] & RMI_F11_HAS_CHIRAL);
/* query 8 */
sensor_query->has_palm_det =
!!(query_buf[1] & RMI_F11_HAS_PALM_DET);
sensor_query->has_rotate =
!!(query_buf[1] & RMI_F11_HAS_ROTATE);
sensor_query->has_touch_shapes =
!!(query_buf[1] & RMI_F11_HAS_TOUCH_SHAPES);
sensor_query->has_scroll_zones =
!!(query_buf[1] & RMI_F11_HAS_SCROLL_ZONES);
sensor_query->has_individual_scroll_zones =
!!(query_buf[1] & RMI_F11_HAS_INDIVIDUAL_SCROLL_ZONES);
sensor_query->has_mf_scroll =
!!(query_buf[1] & RMI_F11_HAS_MF_SCROLL);
sensor_query->has_mf_edge_motion =
!!(query_buf[1] & RMI_F11_HAS_MF_EDGE_MOTION);
sensor_query->has_mf_scroll_inertia =
!!(query_buf[1] & RMI_F11_HAS_MF_SCROLL_INERTIA);
sensor_query->query7_nonzero = !!(query_buf[0]);
sensor_query->query8_nonzero = !!(query_buf[1]);
query_size += 2;
}
if (f11->has_query9) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->has_pen =
!!(query_buf[0] & RMI_F11_HAS_PEN);
sensor_query->has_proximity =
!!(query_buf[0] & RMI_F11_HAS_PROXIMITY);
sensor_query->has_palm_det_sensitivity =
!!(query_buf[0] & RMI_F11_HAS_PALM_DET_SENSITIVITY);
sensor_query->has_suppress_on_palm_detect =
!!(query_buf[0] & RMI_F11_HAS_SUPPRESS_ON_PALM_DETECT);
sensor_query->has_two_pen_thresholds =
!!(query_buf[0] & RMI_F11_HAS_TWO_PEN_THRESHOLDS);
sensor_query->has_contact_geometry =
!!(query_buf[0] & RMI_F11_HAS_CONTACT_GEOMETRY);
sensor_query->has_pen_hover_discrimination =
!!(query_buf[0] & RMI_F11_HAS_PEN_HOVER_DISCRIMINATION);
sensor_query->has_pen_filters =
!!(query_buf[0] & RMI_F11_HAS_PEN_FILTERS);
query_size++;
}
if (sensor_query->has_touch_shapes) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->nr_touch_shapes = query_buf[0] &
RMI_F11_NR_TOUCH_SHAPES_MASK;
query_size++;
}
if (f11->has_query11) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->has_z_tuning =
!!(query_buf[0] & RMI_F11_HAS_Z_TUNING);
sensor_query->has_algorithm_selection =
!!(query_buf[0] & RMI_F11_HAS_ALGORITHM_SELECTION);
sensor_query->has_w_tuning =
!!(query_buf[0] & RMI_F11_HAS_W_TUNING);
sensor_query->has_pitch_info =
!!(query_buf[0] & RMI_F11_HAS_PITCH_INFO);
sensor_query->has_finger_size =
!!(query_buf[0] & RMI_F11_HAS_FINGER_SIZE);
sensor_query->has_segmentation_aggressiveness =
!!(query_buf[0] &
RMI_F11_HAS_SEGMENTATION_AGGRESSIVENESS);
sensor_query->has_XY_clip =
!!(query_buf[0] & RMI_F11_HAS_XY_CLIP);
sensor_query->has_drumming_filter =
!!(query_buf[0] & RMI_F11_HAS_DRUMMING_FILTER);
query_size++;
}
if (f11->has_query12) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->has_gapless_finger =
!!(query_buf[0] & RMI_F11_HAS_GAPLESS_FINGER);
sensor_query->has_gapless_finger_tuning =
!!(query_buf[0] & RMI_F11_HAS_GAPLESS_FINGER_TUNING);
sensor_query->has_8bit_w =
!!(query_buf[0] & RMI_F11_HAS_8BIT_W);
sensor_query->has_adjustable_mapping =
!!(query_buf[0] & RMI_F11_HAS_ADJUSTABLE_MAPPING);
sensor_query->has_info2 =
!!(query_buf[0] & RMI_F11_HAS_INFO2);
sensor_query->has_physical_props =
!!(query_buf[0] & RMI_F11_HAS_PHYSICAL_PROPS);
sensor_query->has_finger_limit =
!!(query_buf[0] & RMI_F11_HAS_FINGER_LIMIT);
sensor_query->has_linear_coeff_2 =
!!(query_buf[0] & RMI_F11_HAS_LINEAR_COEFF);
query_size++;
}
if (sensor_query->has_jitter_filter) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->jitter_window_size = query_buf[0] &
RMI_F11_JITTER_WINDOW_MASK;
sensor_query->jitter_filter_type = (query_buf[0] &
RMI_F11_JITTER_FILTER_MASK) >>
RMI_F11_JITTER_FILTER_SHIFT;
query_size++;
}
if (sensor_query->has_info2) {
rc = rmi_read(rmi_dev, query_base_addr + query_size, query_buf);
if (rc < 0)
return rc;
sensor_query->light_control =
query_buf[0] & RMI_F11_LIGHT_CONTROL_MASK;
sensor_query->is_clear =
!!(query_buf[0] & RMI_F11_IS_CLEAR);
sensor_query->clickpad_props =
(query_buf[0] & RMI_F11_CLICKPAD_PROPS_MASK) >>
RMI_F11_CLICKPAD_PROPS_SHIFT;
sensor_query->mouse_buttons =
(query_buf[0] & RMI_F11_MOUSE_BUTTONS_MASK) >>
RMI_F11_MOUSE_BUTTONS_SHIFT;
sensor_query->has_advanced_gestures =
!!(query_buf[0] & RMI_F11_HAS_ADVANCED_GESTURES);