forked from acidanthera/VoodooPS2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VoodooPS2SynapticsTouchPad.cpp
2616 lines (2244 loc) · 99.1 KB
/
VoodooPS2SynapticsTouchPad.cpp
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) 2002 Apple Computer, Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* The contents of this file constitute Original Code as defined in and
* are subject to the Apple Public Source License Version 1.2 (the
* "License"). You may not use this file except in compliance with the
* License. Please obtain a copy of the License at
* http://www.apple.com/publicsource and read it before using this file.
*
* This Original Code and all software distributed under the License are
* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
* License for the specific language governing rights and limitations
* under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
//#define SIMULATE_CLICKPAD
//#define SIMULATE_PASSTHRU
//#define FULL_HW_RESET
//#define SET_STREAM_MODE
//#define UNDOCUMENTED_INIT_SEQUENCE_PRE
#define UNDOCUMENTED_INIT_SEQUENCE_POST
// enable for trackpad debugging
#ifdef DEBUG_MSG
#define DEBUG_VERBOSE
//#define PACKET_DEBUG
#endif
#define kTPDN "TPDN" // Trackpad Disable Notification
#include "LegacyIOService.h"
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Winconsistent-missing-override"
#include <IOKit/IOLib.h>
#include <IOKit/hidsystem/IOHIDParameter.h>
#include <IOKit/IOWorkLoop.h>
#include <IOKit/IOTimerEventSource.h>
#include <IOKit/usb/IOUSBHostFamily.h>
#include <IOKit/usb/IOUSBHostHIDDevice.h>
#include <IOKit/bluetooth/BluetoothAssignedNumbers.h>
#pragma clang diagnostic pop
#include "VoodooPS2Controller.h"
#include "VoodooPS2SynapticsTouchPad.h"
#include "VoodooInputMultitouch/VoodooInputTransducer.h"
#include "VoodooInputMultitouch/VoodooInputMessages.h"
#define kIOFBTransformKey "IOFBTransform"
enum {
// transforms
kIOFBRotateFlags = 0x0000000f,
kIOFBSwapAxes = 0x00000001,
kIOFBInvertX = 0x00000002,
kIOFBInvertY = 0x00000004,
kIOFBRotate0 = 0x00000000,
kIOFBRotate90 = kIOFBSwapAxes | kIOFBInvertX,
kIOFBRotate180 = kIOFBInvertX | kIOFBInvertY,
kIOFBRotate270 = kIOFBSwapAxes | kIOFBInvertY
};
// =============================================================================
// ApplePS2SynapticsTouchPad Class Implementation
//
OSDefineMetaClassAndStructors(ApplePS2SynapticsTouchPad, IOHIPointing);
UInt32 ApplePS2SynapticsTouchPad::deviceType()
{ return NX_EVS_DEVICE_TYPE_MOUSE; };
UInt32 ApplePS2SynapticsTouchPad::interfaceID()
{ return NX_EVS_DEVICE_INTERFACE_BUS_ACE; };
IOItemCount ApplePS2SynapticsTouchPad::buttonCount() { return _buttonCount; };
IOFixed ApplePS2SynapticsTouchPad::resolution() { return _resolution << 16; };
#define abs(x) ((x) < 0 ? -(x) : (x))
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bool ApplePS2SynapticsTouchPad::init(OSDictionary * dict)
{
//
// Initialize this object's minimal state. This is invoked right after this
// object is instantiated.
//
if (!super::init(dict))
return false;
// initialize state...
for (int i = 0; i < SYNAPTICS_MAX_FINGERS; i++)
fingerStates[i].virtualFingerIndex = -1;
// announce version
extern kmod_info_t kmod_info;
DEBUG_LOG("VoodooPS2SynapticsTouchPad: Version %s starting on OS X Darwin %d.%d.\n", kmod_info.version, version_major, version_minor);
setProperty ("Revision", 24, 32);
return true;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void ApplePS2SynapticsTouchPad::injectVersionDependentProperties(OSDictionary *config)
{
// inject properties specific to the version of Darwin that is runnning...
char buf[32];
OSDictionary* dict = NULL;
do
{
// check for "Darwin major.minor"
snprintf(buf, sizeof(buf), "Darwin %d.%d", version_major, version_minor);
if ((dict = OSDynamicCast(OSDictionary, config->getObject(buf))))
break;
// check for "Darwin major.x"
snprintf(buf, sizeof(buf), "Darwin %d.x", version_major);
if ((dict = OSDynamicCast(OSDictionary, config->getObject(buf))))
break;
// check for "Darwin 16+" (this is what is used currently, other formats are for future)
if (version_major >= 16 && (dict = OSDynamicCast(OSDictionary, config->getObject("Darwin 16+"))))
break;
} while (0);
if (dict)
{
// found version specific properties above, inject...
if (OSCollectionIterator* iter = OSCollectionIterator::withCollection(dict))
{
// Note: OSDictionary always contains OSSymbol*
while (const OSSymbol* key = static_cast<const OSSymbol*>(iter->getNextObject()))
{
if (OSObject* value = dict->getObject(key))
setProperty(key, value);
}
iter->release();
}
}
}
ApplePS2SynapticsTouchPad* ApplePS2SynapticsTouchPad::probe(IOService * provider, SInt32 * score)
{
DEBUG_LOG("ApplePS2SynapticsTouchPad::probe entered...\n");
//
// The driver has been instructed to verify the presence of the actual
// hardware we represent. We are guaranteed by the controller that the
// mouse clock is enabled and the mouse itself is disabled (thus it
// won't send any asynchronous mouse data that may mess up the
// responses expected by the commands we send it).
//
if (!super::probe(provider, score))
return 0;
_device = (ApplePS2MouseDevice*)provider;
bool forceSynaptics = false;
// find config specific to Platform Profile
OSDictionary* list = OSDynamicCast(OSDictionary, getProperty(kPlatformProfile));
OSDictionary* config = _device->getController()->makeConfigurationNode(list, "Synaptics TouchPad");
if (config)
{
// if DisableDevice is Yes, then do not load at all...
OSBoolean* disable = OSDynamicCast(OSBoolean, config->getObject(kDisableDevice));
if (disable && disable->isTrue())
{
config->release();
_device = 0;
return 0;
}
if (OSBoolean* force = OSDynamicCast(OSBoolean, config->getObject("ForceSynapticsDetect")))
{
// "ForceSynapticsDetect" can be set to treat a trackpad as Synaptics which does not identify itself properly...
forceSynaptics = force->isTrue();
}
#ifdef DEBUG
// save configuration for later/diagnostics...
setProperty(kMergedConfiguration, config);
#endif
// load settings specific to Platform Profile
setParamPropertiesGated(config);
injectVersionDependentProperties(config);
OSSafeReleaseNULL(config);
}
// for diagnostics...
UInt8 buf3[3];
bool success = getTouchPadData(0x0, buf3);
if (!success)
{
IOLog("VoodooPS2Trackpad: Identify TouchPad command failed\n");
}
else
{
INFO_LOG("VoodooPS2Trackpad: Identify bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
if (0x46 != buf3[1] && 0x47 != buf3[1])
{
IOLog("VoodooPS2Trackpad: Identify TouchPad command returned incorrect byte 2 (of 3): 0x%02x\n", buf3[1]);
}
_touchPadType = buf3[1];
}
if (success)
{
// some synaptics touchpads return 0x46 in byte2 and have a different numbering scheme
// this is all experimental for those touchpads
// most synaptics touchpads return 0x47, and we only support v4.0 or better
// in the case of 0x46, we allow versions as low as v2.0
success = false;
_touchPadVersion = (buf3[2] & 0x0f) << 8 | buf3[0];
if (0x47 == buf3[1])
{
// for diagnostics...
if ( _touchPadVersion < 0x400)
{
IOLog("VoodooPS2Trackpad: TouchPad(0x47) v%d.%d is not supported\n",
(UInt8)(_touchPadVersion >> 8), (UInt8)(_touchPadVersion));
}
// Only support 4.x or later touchpads.
success = _touchPadVersion >= 0x400;
}
if (0x46 == buf3[1])
{
// for diagnostics...
if ( _touchPadVersion < 0x200)
{
IOLog("VoodooPS2Trackpad: TouchPad(0x46) v%d.%d is not supported\n",
(UInt8)(_touchPadVersion >> 8), (UInt8)(_touchPadVersion));
}
// Only support 2.x or later touchpads.
success = _touchPadVersion >= 0x200;
}
if (forceSynaptics)
{
IOLog("VoodooPS2Trackpad: Forcing Synaptics detection due to ForceSynapticsDetect\n");
success = true;
}
}
_device = 0;
DEBUG_LOG("ApplePS2SynapticsTouchPad::probe leaving.\n");
return success ? this : 0;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void ApplePS2SynapticsTouchPad::doHardwareReset()
{
TPS2Request<> request;
int i = 0;
request.commands[i].command = kPS2C_SendMouseCommandAndCompareAck;
request.commands[i++].inOrOut = kDP_SetDefaultsAndDisable; // F5
request.commands[i].command = kPS2C_SendMouseCommandAndCompareAck;
request.commands[i++].inOrOut = kDP_SetDefaultsAndDisable; // F5
request.commands[i].command = kPS2C_WriteCommandPort;
request.commands[i++].inOrOut = kCP_TransmitToMouse;
request.commands[i].command = kPS2C_WriteDataPort;
request.commands[i++].inOrOut = kDP_Reset; // FF
request.commands[i].command = kPS2C_ReadDataPortAndCompare;
request.commands[i++].inOrOut = kSC_Acknowledge;
request.commands[i].command = kPS2C_SleepMS;
request.commands[i++].inOrOut32 = wakedelay*2;
request.commands[i].command = kPS2C_ReadMouseDataPortAndCompare;
request.commands[i++].inOrOut = 0xAA;
request.commands[i].command = kPS2C_ReadMouseDataPortAndCompare;
request.commands[i++].inOrOut = 0x00;
request.commandsCount = i;
DEBUG_LOG("VoodooPS2Trackpad: sending kDP_Reset $FF\n");
assert(request.commandsCount <= countof(request.commands));
_device->submitRequestAndBlock(&request);
if (i != request.commandsCount)
DEBUG_LOG("VoodooPS2Trackpad: sending $FF failed: %d\n", request.commandsCount);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void ApplePS2SynapticsTouchPad::queryCapabilities()
{
// get TouchPad general capabilities
UInt8 buf3[3];
if (!getTouchPadData(0x2, buf3) || !(buf3[0] & 0x80))
buf3[0] = buf3[2] = 0;
int nExtendedQueries = (buf3[0] & 0x70) >> 4;
INFO_LOG("VoodooPS2Trackpad: nExtendedQueries=%d\n", nExtendedQueries);
UInt8 supportsEW = buf3[2] & (1<<5);
INFO_LOG("VoodooPS2Trackpad: supports EW=%d\n", supportsEW != 0);
// deal with pass through capability
if (!skippassthru)
{
UInt8 passthru2 = buf3[2] >> 7;
// see if guest device for pass through is present
UInt8 passthru1 = 0;
if (getTouchPadData(0x1, buf3))
{
// first byte, bit 0 indicates guest present
passthru1 = buf3[0] & 0x01;
}
// trackpad must have both guest present and pass through capability
passthru = passthru1 & passthru2;
#ifdef SIMULATE_PASSTHRU
passthru = true;
#endif
INFO_LOG("VoodooPS2Trackpad: passthru1=%d, passthru2=%d, passthru=%d\n", passthru1, passthru2, passthru);
}
if (forcepassthru)
{
passthru = true;
INFO_LOG("VoodooPS2Trackpad: Forcing Passthru\n");
}
// deal with LED capability
if (0x46 == _touchPadType)
{
ledpresent = true;
INFO_LOG("VoodooPS2Trackpad: ledpresent=%d (forced for type 0x46)\n", ledpresent);
}
else if (nExtendedQueries >= 1 && getTouchPadData(0x9, buf3))
{
ledpresent = (buf3[0] >> 6) & 1;
INFO_LOG("VoodooPS2Trackpad: ledpresent=%d\n", ledpresent);
}
// get resolution data for scaling x -> y or y -> x depending
if (getTouchPadData(0x8, buf3) && (buf3[1] & 0x80) && buf3[0] && buf3[2])
{
xupmm = buf3[0];
yupmm = buf3[2];
}
// now gather some more information about the touchpad
if (getTouchPadData(0x1, buf3))
{
INFO_LOG("VoodooPS2Trackpad: Mode/model($01) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (getTouchPadData(0x2, buf3))
{
INFO_LOG("VoodooPS2Trackpad: Capabilities($02) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (getTouchPadData(0x3, buf3))
{
INFO_LOG("VoodooPS2Trackpad: Model ID($03) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (getTouchPadData(0x6, buf3))
{
INFO_LOG("VoodooPS2Trackpad: SN Prefix($06) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (getTouchPadData(0x7, buf3))
{
INFO_LOG("VoodooPS2Trackpad: SN Suffix($07) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (getTouchPadData(0x8, buf3))
{
INFO_LOG("VoodooPS2Trackpad: Resolutions($08) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (nExtendedQueries >= 1 && getTouchPadData(0x9, buf3))
{
INFO_LOG("VoodooPS2Trackpad: Extended Model($09) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
bool reportsMax = false;
bool reportsMin = false;
bool deluxeLeds = false;
if (nExtendedQueries >= 4 && getTouchPadData(0xc, buf3))
{
setProperty("0xc Query", buf3, 3);
INFO_LOG("VoodooPS2Trackpad: Continued Capabilities($0C) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
clickpadtype = ((buf3[0] & 0x10) >> 4) | ((buf3[1] & 0x01) << 1);
#ifdef SIMULATE_CLICKPAD
clickpadtype = 1;
DEBUG_LOG("VoodooPS2Trackpad: clickpadtype=1 simulation set\n");
#endif
INFO_LOG("VoodooPS2Trackpad: clickpadtype=%d\n", clickpadtype);
_reportsv = (bool)(buf3[1] >> 3) & (1 << 3);
INFO_LOG("VoodooPS2Trackpad: _reportsv=%d\n", _reportsv);
// automatically set extendedwmode if supported
if (supportsEW)
{
_extendedwmodeSupported = true;
INFO_LOG("VoodooPS2Trackpad: Trackpad supports extendedW mode\n");
}
reportsMax = (bool)(buf3[0] & (1 << 1));
reportsMin = (bool)(buf3[1] & (1 << 5));
deluxeLeds = (bool)(buf3[1] & (1 << 1));
}
if (reportsMax && getTouchPadData(0xd, buf3))
{
logical_max_x = (buf3[0] << 5) | ((buf3[1] & 0x0f) << 1);
logical_max_y = (buf3[2] << 5) | ((buf3[1] & 0xf0) >> 3);
INFO_LOG("VoodooPS2Trackpad: Maximum coords($0D) bytes = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
if (deluxeLeds && getTouchPadData(0xe, buf3))
{
INFO_LOG("VoodooPS2Trackpad: Deluxe LED bytes($0E) = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
// 5 mm margins
margin_size_x = 5 * xupmm;
margin_size_y = 5 * yupmm;
if (reportsMin && getTouchPadData(0xf, buf3))
{
logical_min_x = (buf3[0] << 5) | ((buf3[1] & 0x0f) << 1);
logical_min_y = (buf3[2] << 5) | ((buf3[1] & 0xf0) >> 3);
DEBUG_LOG("VoodooPS2Trackpad: Minimum coords bytes($0F) = { 0x%x, 0x%x, 0x%x }\n", buf3[0], buf3[1], buf3[2]);
}
else {
logical_min_x = logical_max_x - 3 * margin_size_x;
logical_min_y = logical_max_y - 3 * margin_size_y;
}
// We should set physical dimensions anyway
logical_min_x += margin_size_x;
logical_min_y += margin_size_y;
logical_max_x -= margin_size_x;
logical_max_y -= margin_size_y;
if (minXOverride != -1)
logical_min_x = minXOverride;
if (minYOverride != -1)
logical_min_y = minYOverride;
if (maxXOverride != -1)
logical_max_x = maxXOverride;
if (maxYOverride != -1)
logical_max_y = maxYOverride;
setProperty(VOODOO_INPUT_LOGICAL_MAX_X_KEY, logical_max_x - logical_min_x, 32);
setProperty(VOODOO_INPUT_LOGICAL_MAX_Y_KEY, logical_max_y - logical_min_y, 32);
// physical dimensions are specified in 0.01 mm units
physical_max_x = (logical_max_x + 1 - (reportsMin ? logical_min_x : 0)) * 100 / xupmm;
physical_max_y = (logical_max_y + 1 - (reportsMin ? logical_min_y : 0)) * 100 / yupmm;
setProperty(VOODOO_INPUT_PHYSICAL_MAX_X_KEY, physical_max_x, 32);
setProperty(VOODOO_INPUT_PHYSICAL_MAX_Y_KEY, physical_max_y, 32);
setProperty(kIOFBTransformKey, 0ull, 32);
setProperty("VoodooInputSupported", kOSBooleanTrue);
registerService();
INFO_LOG("VoodooPS2Trackpad: logical %dx%d-%dx%d physical_max %dx%d upmm %dx%d",
logical_min_x, logical_min_y,
logical_max_x, logical_max_y,
physical_max_x, physical_max_y,
xupmm, yupmm);
}
bool ApplePS2SynapticsTouchPad::handleOpen(IOService *forClient, IOOptionBits options, void *arg) {
if (forClient && forClient->getProperty(VOODOO_INPUT_IDENTIFIER)) {
voodooInputInstance = forClient;
voodooInputInstance->retain();
return true;
}
return super::handleOpen(forClient, options, arg);
}
void ApplePS2SynapticsTouchPad::handleClose(IOService *forClient, IOOptionBits options) {
OSSafeReleaseNULL(voodooInputInstance);
super::handleClose(forClient, options);
}
bool ApplePS2SynapticsTouchPad::start( IOService * provider )
{
//
// The driver has been instructed to start. This is called after a
// successful probe and match.
//
if (!super::start(provider))
return false;
//
// Maintain a pointer to and retain the provider object.
//
_device = (ApplePS2MouseDevice *) provider;
_device->retain();
//
// Announce hardware properties.
//
IOLog("VoodooPS2Trackpad starting: Synaptics TouchPad reports type 0x%02x, version %d.%d\n",
_touchPadType, (UInt8)(_touchPadVersion >> 8), (UInt8)(_touchPadVersion));
char buf[128];
snprintf(buf, sizeof(buf), "type 0x%02x, version %d.%d", _touchPadType, (UInt8)(_touchPadVersion >> 8), (UInt8)(_touchPadVersion));
setProperty("RM,TrackpadInfo", buf);
//
// Advertise the current state of the tapping feature.
//
// Must add this property to let our superclass know that it should handle
// trackpad acceleration settings from user space. Without this, tracking
// speed adjustments from the mouse prefs panel have no effect.
//
setProperty(kIOHIDPointerAccelerationTypeKey, kIOHIDTrackpadAccelerationType);
setProperty(kIOHIDScrollAccelerationTypeKey, kIOHIDTrackpadScrollAccelerationKey);
setProperty(kIOHIDScrollResolutionKey, _scrollresolution << 16, 32);
// added for Sierra precise scrolling (credit usr-sse2)
setProperty("HIDScrollResolutionX", _scrollresolution << 16, 32);
setProperty("HIDScrollResolutionY", _scrollresolution << 16, 32);
//
// Setup workloop with command gate for thread syncronization...
//
IOWorkLoop* pWorkLoop = getWorkLoop();
_cmdGate = IOCommandGate::commandGate(this);
if (!pWorkLoop || !_cmdGate)
{
_device->release();
_device = nullptr;
return false;
}
//
// Lock the controller during initialization
//
_device->lock();
//
// Some machines require a hw reset in order to work correctly -- notably Thinkpads with Trackpoints
//
if (hwresetonstart)
{
doHardwareReset();
}
attachedHIDPointerDevices = OSSet::withCapacity(1);
registerHIDPointerNotifications();
//
// Setup button timer event source
//
if (_buttonCount >= 3)
{
_buttonTimer = IOTimerEventSource::timerEventSource(this, OSMemberFunctionCast(IOTimerEventSource::Action, this, &ApplePS2SynapticsTouchPad::onButtonTimer));
if (!_buttonTimer)
{
_device->unlock();
_device->release();
_device = nullptr;
return false;
}
pWorkLoop->addEventSource(_buttonTimer);
}
pWorkLoop->addEventSource(_cmdGate);
//
// Query the touchpad for the capabilities we need to know.
//
queryCapabilities();
//
// Set the touchpad mode byte, which will also...
// Enable the mouse clock (should already be so) and the mouse IRQ line.
// Enable the touchpad itself.
//
setTouchpadModeByte();
//
// Install our driver's interrupt handler, for asynchronous data delivery.
//
_device->installInterruptAction(this,
OSMemberFunctionCast(PS2InterruptAction,this,&ApplePS2SynapticsTouchPad::interruptOccurred),
OSMemberFunctionCast(PS2PacketAction, this, &ApplePS2SynapticsTouchPad::packetReady));
_interruptHandlerInstalled = true;
// now safe to allow other threads
_device->unlock();
//
// Install our power control handler.
//
_device->installPowerControlAction( this,
OSMemberFunctionCast(PS2PowerControlAction, this, &ApplePS2SynapticsTouchPad::setDevicePowerState) );
_powerControlHandlerInstalled = true;
//
// Request message registration for keyboard to trackpad communication
//
//setProperty(kDeliverNotifications, true);
// get IOACPIPlatformDevice for Device (PS2M)
//REVIEW: should really look at the parent chain for IOACPIPlatformDevice instead.
_provider = (IOACPIPlatformDevice*)IORegistryEntry::fromPath("IOService:/AppleACPIPlatformExpert/PS2M");
if (_provider && kIOReturnSuccess != _provider->validateObject(kTPDN))
{
_provider->release();
_provider = NULL;
}
//
// Update LED -- it could have been disabled then computer was restarted
//
updateTouchpadLED();
return true;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void ApplePS2SynapticsTouchPad::stop( IOService * provider )
{
DEBUG_LOG("%s: stop called\n", getName());
//
// The driver has been instructed to stop. Note that we must break all
// connections to other service objects now (ie. no registered actions,
// no pointers and retains to objects, etc), if any.
//
assert(_device == provider);
unregisterHIDPointerNotifications();
OSSafeReleaseNULL(attachedHIDPointerDevices);
//
// turn off the LED just in case it was on
//
ignoreall = false;
updateTouchpadLED();
//
// Disable the mouse itself, so that it may stop reporting mouse events.
//
setTouchPadEnable(false);
// free up timer for scroll momentum
IOWorkLoop* pWorkLoop = getWorkLoop();
if (pWorkLoop)
{
if (_buttonTimer)
{
pWorkLoop->removeEventSource(_buttonTimer);
_buttonTimer->release();
_buttonTimer = 0;
}
if (_cmdGate)
{
pWorkLoop->removeEventSource(_cmdGate);
_cmdGate->release();
_cmdGate = 0;
}
}
//
// Uninstall the interrupt handler.
//
if (_interruptHandlerInstalled)
{
_device->uninstallInterruptAction();
_interruptHandlerInstalled = false;
}
//
// Uninstall the power control handler.
//
if (_powerControlHandlerInstalled)
{
_device->uninstallPowerControlAction();
_powerControlHandlerInstalled = false;
}
//
// Release the pointer to the provider object.
//
OSSafeReleaseNULL(_device);
//
// Release ACPI provider for PS2M ACPI device
//
OSSafeReleaseNULL(_provider);
super::stop(provider);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PS2InterruptResult ApplePS2SynapticsTouchPad::interruptOccurred(UInt8 data)
{
//
// This will be invoked automatically from our device when asynchronous
// events need to be delivered. Buffer the trackpad data. Do NOT issue
// any BLOCKING commands to our device in this context.
//
UInt8* packet = _ringBuffer.head();
// special case for $AA $00, spontaneous reset (usually due to static electricity)
if (kSC_Reset == _lastdata && 0x00 == data)
{
IOLog("%s: Unexpected reset (%02x %02x) request from PS/2 controller\n", getName(), _lastdata, data);
// spontaneous reset, device has announced with $AA $00, schedule a reset
packet[0] = 0x00;
packet[1] = kSC_Reset;
_ringBuffer.advanceHead(kPacketLength);
_packetByteCount = 0;
return kPS2IR_packetReady;
}
_lastdata = data;
// Ignore all bytes until we see the start of a packet, otherwise the
// packets may get out of sequence and things will get very confusing.
if (0 == _packetByteCount && (data & 0xc8) != 0x80)
{
IOLog("%s: Unexpected byte0 data (%02x) from PS/2 controller\n", getName(), data);
packet[0] = 0x00;
packet[1] = 0; // reason=byte0
_ringBuffer.advanceHead(kPacketLength);
return kPS2IR_packetReady;
}
if (3 == _packetByteCount && (data & 0xc8) != 0xc0)
{
IOLog("%s: Unexpected byte3 data (%02x) from PS/2 controller\n", getName(), data);
packet[0] = 0x00;
packet[1] = 3; // reason=byte3
_ringBuffer.advanceHead(kPacketLength);
_packetByteCount = 0;
return kPS2IR_packetReady;
}
#ifdef PACKET_DEBUG
if (_packetByteCount == 0)
DEBUG_LOG("%s: packet { %02x, ", getName(), data);
else
DEBUG_LOG("%02x%s", data, _packetByteCount == 5 ? " }\n" : ", ");
#endif
//
// Add this byte to the packet buffer. If the packet is complete, that is,
// we have the six bytes, allow main thread to process packets by
// returning kPS2IR_packetReady
//
packet[_packetByteCount++] = data;
if (kPacketLength == _packetByteCount)
{
_ringBuffer.advanceHead(kPacketLength);
_packetByteCount = 0;
return kPS2IR_packetReady;
}
return kPS2IR_packetBuffering;
}
void ApplePS2SynapticsTouchPad::packetReady()
{
// empty the ring buffer, dispatching each packet...
while (_ringBuffer.count() >= kPacketLength)
{
UInt8* packet = _ringBuffer.tail();
if (0x00 != packet[0])
{
// normal packet
if (!ignoreall)
synaptics_parse_hw_state(_ringBuffer.tail());
}
else
{
// a reset packet was buffered... schedule a complete reset
//initTouchPad();
}
_ringBuffer.advanceTail(kPacketLength);
}
}
#define sqr(x) ((x) * (x))
int ApplePS2SynapticsTouchPad::dist(int physicalFinger, int virtualFinger) {
const auto &phy = fingerStates[physicalFinger];
const auto &virt = virtualFingerStates[virtualFinger];
return sqr(phy.x - virt.x_avg.newest()) + sqr(phy.y - virt.y_avg.newest());
}
void ApplePS2SynapticsTouchPad::assignVirtualFinger(int physicalFinger) {
if (physicalFinger < 0 || physicalFinger >= SYNAPTICS_MAX_FINGERS) {
IOLog("VoodooPS2SynapticsTouchPad::assignVirtualFinger ERROR: invalid physical finger %d", physicalFinger);
return;
}
for (int j = 0; j < SYNAPTICS_MAX_FINGERS; j++)
if (!virtualFingerStates[j].touch) {
fingerStates[physicalFinger].virtualFingerIndex = j;
virtualFingerStates[j].touch = true;
virtualFingerStates[j].x_avg.reset();
virtualFingerStates[j].y_avg.reset();
break;
}
}
void ApplePS2SynapticsTouchPad::synaptics_parse_hw_state(const UInt8 buf[])
{
// Check if input is disabled via ApplePS2Keyboard request
if (ignoreall)
return;
int w = (((buf[0] & 0x30) >> 2) |
((buf[0] & 0x04) >> 1) |
((buf[3] & 0x04) >> 2));
int x = buf[4]|((buf[1]&0x0f)<<8)|((buf[3]&0x10)<<8);
int y = buf[5]|((buf[1]&0xf0)<<4)|((buf[3]&0x20)<<7);
DEBUG_LOG("VoodooPS2 w: %d\n", w);
//I'm just reimplement RehabMan old code here, maybe sounds like a hacky solution but hey at least it works!
UInt32 buttonsraw = buf[0] & 0x03; // mask for just R L
UInt32 buttons = buttonsraw;
if (passthru && 3 == w)
passbuttons = buf[1] & 0x7; // mask for just M R L
buttons |= passbuttons;
lastbuttons = buttons;
if (clickpadtype)
{
// ClickPad puts its "button" presses in a different location
// And for single button ClickPad we have to provide a way to simulate right clicks
int clickbuttons = buf[3] & 0x3;
//Let's quickly do some extra logic to see if we are pressing any of the physical buttons for the trackpoint
if (isthinkpad)
{
DEBUG_LOG("IS THINKPAD");
// parse packets for buttons - TrackPoint Buttons may not be passthru
int bp = buf[3] & 0x3; // 1 on clickpad or 2 for the 2 real buttons
int lb = buf[4] & 0x3; // 1 for left real button
int rb = buf[5] & 0x3; // 1 for right real button
if (bp == 2)
{
if( lb == 1 )
{ // left click
clickbuttons = 0x1;
}
else if ( rb == 1 )
{ // right click
clickbuttons = 0x2;
}
else if ( lb == 2 )
{ // middle click
clickbuttons = 0x4;
}
else
{
clickbuttons = 0x0;
}
thinkpadButtonState = clickbuttons;
buttons=clickbuttons;
setClickButtons(clickbuttons);
}
else
{
clickbuttons = bp;
}
}
// always clear _clickbutton state, when ClickPad is not clicked
if (!clickbuttons)
setClickButtons(0);
//Remember the button state on thinkpads.. this is required so we can handle the middle click vs middle scrolling appropriately.
if (isthinkpad)
{
if (thinkpadButtonState)
_clickbuttons = thinkpadButtonState;
}
buttons |= _clickbuttons;
lastbuttons = buttons;
}
// advanced gesture packet (half-resolution packets)
// my port of synaptics_parse_agm from synaptics.c from Linux Kernel
DEBUG_LOG("buttons %d", buttons);
if(w == 2) {
int agmPacketType = (buf[5] & 0x30) >> 4;
switch(agmPacketType) {
case 1:
DEBUG_LOG("synaptics_parse_hw_state: ===========EXTENDED PACKET===========");
fingerStates[1].x = (((buf[4] & 0x0f) << 8) | buf[1]) << 1;
fingerStates[1].y = (((buf[4] & 0xf0) << 4) | buf[2]) << 1;
fingerStates[1].z = ((buf[3] & 0x30) | (buf[5] & 0x0f)) << 1;
fingerStates[1].w = 8 + ((buf[5] & 1) << 2 | (buf[2] & 1) << 1 | (buf[1] & 1));
DEBUG_LOG("synaptics_parse_hw_state: finger 1 pressure %d width %d\n", fingerStates[1].z, fingerStates[1].w);
if (fingerStates[1].x > X_MAX_POSITIVE)
fingerStates[1].x -= 1 << ABS_POS_BITS;
else if (fingerStates[1].x == X_MAX_POSITIVE)
fingerStates[1].x = XMAX;
if (fingerStates[1].y > Y_MAX_POSITIVE)
fingerStates[1].y -= 1 << ABS_POS_BITS;
else if (fingerStates[1].y == Y_MAX_POSITIVE)
fingerStates[1].y = YMAX;
break;
case 2:
DEBUG_LOG("synaptics_parse_hw_state: ===========FINGER COUNT PACKET===========");
agmFingerCount = buf[1] & 0x0f;
DEBUG_LOG("synaptics_parse_hw_state: %d fingers\n", agmFingerCount);
break;
default:
break;
}
}
else if (w == 3 && passthru) {
AbsoluteTime timestamp;
clock_get_uptime(×tamp);
UInt32 buttonsraw = buf[0] & 0x03; // mask for just R L
UInt32 buttons = buttonsraw;
UInt32 passbuttons = buf[1] & 0x7; // mask for just M R L
// if there are buttons set in the last pass through packet, then be sure
// they are set in any trackpad dispatches.
// otherwise, you might see double clicks that aren't there
buttons |= passbuttons;
lastbuttons = buttons;
// New Lenovo clickpads do not have buttons, so LR in packet byte 1 is zero and thus
// passbuttons is 0. Instead we need to check the trackpad buttons in byte 0 and byte 3
// However for clickpads that would miss right clicks, so use the last clickbuttons that
// were saved.
UInt32 combinedButtons = buttons | ((buf[0] & 0x3) | (buf[3] & 0x3)) | _clickbuttons | thinkpadButtonState;
SInt32 dx = ((buf[1] & 0x10) ? 0xffffff00 : 0 ) | buf[4];
SInt32 dy = ((buf[1] & 0x20) ? 0xffffff00 : 0 ) | buf[5];
if (/*mousemiddlescroll && */((buf[1] & 0x4) || thinkpadButtonState == 4)) // only for physical middle button
{
if (dx != 0 || dy != 0)
thinkpadMiddleScrolled = true;
// middle button treats deltas for scrolling
SInt32 scrollx = 0, scrolly = 0;
if (abs(dx) > abs(dy))
scrollx = dx;// * mousescrollmultiplierx;
else
scrolly = dy;// * mousescrollmultipliery;
if (isthinkpad && thinkpadMiddleButtonPressed)
{
scrolly = scrolly * thinkpadNubScrollYMultiplier;
scrollx = scrollx * thinkpadNubScrollXMultiplier;
}
dispatchScrollWheelEvent(scrolly, -scrollx, 0, timestamp);
dx = dy = 0;