From 69c29bcf19f629df30a345bc5117c552c3b7f3ed Mon Sep 17 00:00:00 2001
From: vit9696 <vit9696@users.noreply.github.com>
Date: Thu, 22 Apr 2021 15:57:20 +0300
Subject: [PATCH] Added `DisableDeepSleep` to workaround ACPI S3 wakes on some
 Synaptics touchpads

closes acidanthera/bugtracker#1610
---
 Changelog.md                                    |  9 ++++++---
 Docs/ACPI/SSDT-DisableDeepSleep.dsl             | 17 +++++++++++++++++
 VoodooPS2Controller.xcodeproj/project.pbxproj   |  4 +++-
 .../xcschemes/VoodooPS2Controller.xcscheme      |  2 +-
 .../xcschemes/VoodooPS2Keyboard.xcscheme        |  2 +-
 .../xcschemes/VoodooPS2Mouse.xcscheme           |  2 +-
 .../xcschemes/VoodooPS2Trackpad.xcscheme        |  2 +-
 .../VoodooPS2SynapticsTouchPad.cpp              | 16 +++++++++++-----
 VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.h  | 10 ++++++----
 9 files changed, 47 insertions(+), 17 deletions(-)
 create mode 100644 Docs/ACPI/SSDT-DisableDeepSleep.dsl

diff --git a/Changelog.md b/Changelog.md
index cc4ab256..35290a92 100644
--- a/Changelog.md
+++ b/Changelog.md
@@ -1,12 +1,15 @@
 VoodooPS2 Changelog
 ============================
-#### 2.2.2
+#### v2.2.3
+- Added `DisableDeepSleep` to workaround ACPI S3 wakes on some Synaptics touchpads
+
+#### v2.2.2
 - Added NumLockSupport & NumLockOnAtBoot
 
-#### 2.2.1
+#### v2.2.1
 - Fix issue with registering of services matched by property name "RM,deliverNotifications". It solves issue with broadcasting timestamp for the last pressed key and handling of QuietTimeAfterTyping [see bug #1415](https://github.com/acidanthera/bugtracker/issues/1415) 
 
-#### 2.2.0
+#### v2.2.0
 - Added VoodooRmi compatibility to allow external touchpad resets
 
 #### v2.1.9
diff --git a/Docs/ACPI/SSDT-DisableDeepSleep.dsl b/Docs/ACPI/SSDT-DisableDeepSleep.dsl
new file mode 100644
index 00000000..f61dbe63
--- /dev/null
+++ b/Docs/ACPI/SSDT-DisableDeepSleep.dsl
@@ -0,0 +1,17 @@
+// For computers with Synaptics touchpad that wake immediately after
+// going to sleep deeper touchpad sleep can be disabled.
+//
+// This will cause the touchpad to consume more power in ACPI S3.
+DefinitionBlock("", "SSDT", 2, "ACDT", "ps2", 0)
+{
+    External (_SB_.PCI0.LPCB.PS2K, DeviceObj)
+
+    Name(_SB.PCI0.LPCB.PS2K.RMCF, Package()
+    {
+        "Synaptics TouchPad", Package()
+        {
+            "DisableDeepSleep", ">y",
+        }
+    })
+}
+//EOF
diff --git a/VoodooPS2Controller.xcodeproj/project.pbxproj b/VoodooPS2Controller.xcodeproj/project.pbxproj
index e274926e..66cc5112 100644
--- a/VoodooPS2Controller.xcodeproj/project.pbxproj
+++ b/VoodooPS2Controller.xcodeproj/project.pbxproj
@@ -122,6 +122,7 @@
 		CE8DA1C4251839B2008C44E8 /* libkmod.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = libkmod.a; path = MacKernelSDK/Library/x86_64/libkmod.a; sourceTree = "<group>"; };
 		CEA35504257C6E3500E17556 /* SSDT-Swap-CommandOption.dsl */ = {isa = PBXFileReference; lastKnownFileType = text; path = "SSDT-Swap-CommandOption.dsl"; sourceTree = "<group>"; };
 		CEAFF570259F8AE700693DEC /* SSDT-DisableElanWakeDelay.dsl */ = {isa = PBXFileReference; lastKnownFileType = text; path = "SSDT-DisableElanWakeDelay.dsl"; sourceTree = "<group>"; };
+		CEF251412631A92B00A20C9A /* SSDT-DisableDeepSleep.dsl */ = {isa = PBXFileReference; lastKnownFileType = text; path = "SSDT-DisableDeepSleep.dsl"; sourceTree = "<group>"; };
 		ED1C95C51F9B88EF00CAFCA3 /* SSDT-PrtSc-Remap.dsl */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = "SSDT-PrtSc-Remap.dsl"; sourceTree = "<group>"; };
 		ED48777A207D94BC00D6B1E8 /* SSDT-AlternateSwipes.dsl */ = {isa = PBXFileReference; lastKnownFileType = text; path = "SSDT-AlternateSwipes.dsl"; sourceTree = "<group>"; };
 		ED5759741D44FBA50069DF9F /* SSDT-KEY-DELL-WN09.dsl */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = "SSDT-KEY-DELL-WN09.dsl"; sourceTree = "<group>"; };
@@ -319,6 +320,7 @@
 				73119AB825E1961D0017311C /* SSDT-NumLockSupport.dsl */,
 				CE7F451122E8A8C4003F7971 /* SSDT-MouseAsTrackpad.dsl */,
 				ED48777A207D94BC00D6B1E8 /* SSDT-AlternateSwipes.dsl */,
+				CEF251412631A92B00A20C9A /* SSDT-DisableDeepSleep.dsl */,
 				CEAFF570259F8AE700693DEC /* SSDT-DisableElanWakeDelay.dsl */,
 				ED6BB589209E4EE8007AC3A4 /* SSDT-DisableTrackpadProbe.dsl */,
 				EDD970FD1FD0B826004CCFFD /* SSDT-HP-FixLidSleep.dsl */,
@@ -492,7 +494,7 @@
 		84167808161B55B2002C60E6 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1220;
+				LastUpgradeCheck = 1240;
 				ORGANIZATIONNAME = Acidanthera;
 			};
 			buildConfigurationList = 8416780B161B55B2002C60E6 /* Build configuration list for PBXProject "VoodooPS2Controller" */;
diff --git a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Controller.xcscheme b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Controller.xcscheme
index bf3d8d13..860a7f87 100644
--- a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Controller.xcscheme
+++ b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Controller.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1220"
+   LastUpgradeVersion = "1240"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Keyboard.xcscheme b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Keyboard.xcscheme
index 63d32c7b..f2e760ee 100644
--- a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Keyboard.xcscheme
+++ b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Keyboard.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1220"
+   LastUpgradeVersion = "1240"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Mouse.xcscheme b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Mouse.xcscheme
index 50f9d067..5472d94a 100644
--- a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Mouse.xcscheme
+++ b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Mouse.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1220"
+   LastUpgradeVersion = "1240"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Trackpad.xcscheme b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Trackpad.xcscheme
index d689572c..a701ee49 100644
--- a/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Trackpad.xcscheme
+++ b/VoodooPS2Controller.xcodeproj/xcshareddata/xcschemes/VoodooPS2Trackpad.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1220"
+   LastUpgradeVersion = "1240"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.cpp b/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.cpp
index a4133cc9..064e065c 100644
--- a/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.cpp
+++ b/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.cpp
@@ -2216,6 +2216,7 @@ void ApplePS2SynapticsTouchPad::setParamPropertiesGated(OSDictionary * config)
  	};
     const struct {const char* name; bool* var;} lowbitvars[]={
         {"USBMouseStopsTrackpad",           &usb_mouse_stops_trackpad},
+        {"DisableDeepSleep",                &disableDeepSleep}
     };
     const struct {const char* name; uint64_t* var; } int64vars[]={
         {"QuietTimeAfterTyping",            &maxaftertyping},
@@ -2346,8 +2347,11 @@ void ApplePS2SynapticsTouchPad::setDevicePowerState( UInt32 whatToDo )
             //
 
             setTouchPadEnable( false ); // Disable stream mode
-            _touchPadModeByte |= 1 << 3;
-            setModeByte(_touchPadModeByte); // Enable sleep
+
+            if (!disableDeepSleep) {
+                _touchPadModeByte |= 1 << 3;
+                setModeByte(_touchPadModeByte); // Enable sleep
+            }
             break;
 
         case kPS2C_EnableDevice:
@@ -2356,9 +2360,11 @@ void ApplePS2SynapticsTouchPad::setDevicePowerState( UInt32 whatToDo )
             // completed its power-on self-test and calibration.
             //
 
-            IOSleep(wakedelay);
-            _touchPadModeByte &= ~(1 << 3); // Wake from sleep
-            setModeByte(_touchPadModeByte);
+            if (!disableDeepSleep) {
+                IOSleep(wakedelay);
+                _touchPadModeByte &= ~(1 << 3); // Wake from sleep
+                setModeByte(_touchPadModeByte);
+            }
             IOSleep(wakedelay);
             
             // Reset and enable the touchpad.
diff --git a/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.h b/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.h
index 0e156f2e..00fc296d 100644
--- a/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.h
+++ b/VoodooPS2Trackpad/VoodooPS2SynapticsTouchPad.h
@@ -238,14 +238,16 @@ class EXPORT ApplePS2SynapticsTouchPad : public IOHIPointing
     uint32_t physical_max_x {0};
     uint32_t physical_max_y {0};
 
-	synaptics_hw_state fingerStates[SYNAPTICS_MAX_FINGERS] {};
+    synaptics_hw_state fingerStates[SYNAPTICS_MAX_FINGERS] {};
     virtual_finger_state virtualFingerStates[SYNAPTICS_MAX_FINGERS] {};
-	bool freeFingerTypes[kMT2FingerTypeCount];
+    bool freeFingerTypes[kMT2FingerTypeCount];
 
-	static_assert(SYNAPTICS_MAX_FINGERS <= kMT2FingerTypeLittleFinger, "Too many fingers for one hand");
+    bool disableDeepSleep {false};
+
+    static_assert(SYNAPTICS_MAX_FINGERS <= kMT2FingerTypeLittleFinger, "Too many fingers for one hand");
 
     void assignVirtualFinger(int physicalFinger);
-	void assignFingerType(virtual_finger_state &vf);
+    void assignFingerType(virtual_finger_state &vf);
     int lastFingerCount;
     int lastSentFingerCount;
     bool hadLiftFinger;