From 20b5615305639c9e33907a755cee1c22cc5aa664 Mon Sep 17 00:00:00 2001
From: ellensp <530024+ellensp@users.noreply.github.com>
Date: Sat, 26 Mar 2022 16:44:22 +1300
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Configurable=20FREEZE=20pin=20state?=
 =?UTF-8?q?=20(#23944)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Scott Lahteine <thinkyhead@users.noreply.github.com>
---
 Marlin/Configuration_adv.h         |  1 +
 Marlin/src/MarlinCore.cpp          | 10 +++++++---
 Marlin/src/inc/Conditionals_post.h | 14 +++-----------
 Marlin/src/inc/SanityCheck.h       |  4 ++--
 Marlin/src/module/stepper.cpp      |  4 ++--
 Marlin/src/module/stepper.h        |  2 +-
 Marlin/src/pins/pinsDebug_list.h   |  2 +-
 7 files changed, 17 insertions(+), 20 deletions(-)

diff --git a/Marlin/Configuration_adv.h b/Marlin/Configuration_adv.h
index 86eef1a02657..195a0e8d163d 100644
--- a/Marlin/Configuration_adv.h
+++ b/Marlin/Configuration_adv.h
@@ -4116,6 +4116,7 @@
 //#define FREEZE_FEATURE
 #if ENABLED(FREEZE_FEATURE)
   //#define FREEZE_PIN 41   // Override the default (KILL) pin here
+  #define FREEZE_STATE LOW  // State of pin indicating freeze
 #endif
 
 /**
diff --git a/Marlin/src/MarlinCore.cpp b/Marlin/src/MarlinCore.cpp
index 4117d3f382a1..b1684d8928ef 100644
--- a/Marlin/src/MarlinCore.cpp
+++ b/Marlin/src/MarlinCore.cpp
@@ -476,7 +476,7 @@ inline void manage_inactivity(const bool no_stepper_sleep=false) {
   #endif
 
   #if HAS_FREEZE_PIN
-    Stepper::frozen = !READ(FREEZE_PIN);
+    Stepper::frozen = READ(FREEZE_PIN) ^ DISABLED(INVERT_FREEZE_PIN);
   #endif
 
   #if HAS_HOME
@@ -1166,9 +1166,13 @@ void setup() {
     #endif
   #endif
 
-  #if HAS_FREEZE_PIN
+  #if ENABLED(FREEZE_FEATURE)
     SETUP_LOG("FREEZE_PIN");
-    SET_INPUT_PULLUP(FREEZE_PIN);
+    #if FREEZE_STATE
+      SET_INPUT_PULLDOWN(FREEZE_PIN);
+    #else
+      SET_INPUT_PULLUP(FREEZE_PIN);
+    #endif
   #endif
 
   #if HAS_SUICIDE
diff --git a/Marlin/src/inc/Conditionals_post.h b/Marlin/src/inc/Conditionals_post.h
index dd175ac2cc41..85ccb8088ec2 100644
--- a/Marlin/src/inc/Conditionals_post.h
+++ b/Marlin/src/inc/Conditionals_post.h
@@ -2824,17 +2824,9 @@
 #endif
 
 // User Interface
-#if ENABLED(FREEZE_FEATURE)
-  #if !PIN_EXISTS(FREEZE) && PIN_EXISTS(KILL)
-    #define FREEZE_PIN KILL_PIN
-  #endif
-  #if PIN_EXISTS(FREEZE)
-    #define HAS_FREEZE_PIN 1
-  #endif
-#else
-  #undef FREEZE_PIN
-#endif
-#if PIN_EXISTS(KILL) && TERN1(FREEZE_FEATURE, KILL_PIN != FREEZE_PIN)
+#if ENABLED(FREEZE_FEATURE) && !PIN_EXISTS(FREEZE) && PIN_EXISTS(KILL)
+  #define FREEZE_PIN KILL_PIN
+#elif PIN_EXISTS(KILL) && TERN1(FREEZE_FEATURE, KILL_PIN != FREEZE_PIN)
   #define HAS_KILL 1
 #endif
 #if PIN_EXISTS(HOME)
diff --git a/Marlin/src/inc/SanityCheck.h b/Marlin/src/inc/SanityCheck.h
index 552a6270934e..405c9fd7ca5d 100644
--- a/Marlin/src/inc/SanityCheck.h
+++ b/Marlin/src/inc/SanityCheck.h
@@ -1035,8 +1035,8 @@ static_assert(Y_MAX_LENGTH >= Y_BED_SIZE, "Movement bounds (Y_MIN_POS, Y_MAX_POS
 /**
  * Instant Freeze
  */
-#if ENABLED(FREEZE_FEATURE) && !PIN_EXISTS(FREEZE)
-  #error "FREEZE_FEATURE requires a FREEZE_PIN to be defined."
+#if ENABLED(FREEZE_FEATURE) && !(PIN_EXISTS(FREEZE) && defined(FREEZE_STATE))
+  #error "FREEZE_FEATURE requires both FREEZE_PIN and FREEZE_STATE."
 #endif
 
 /**
diff --git a/Marlin/src/module/stepper.cpp b/Marlin/src/module/stepper.cpp
index f83104fe9c47..af64d9f8bf1d 100644
--- a/Marlin/src/module/stepper.cpp
+++ b/Marlin/src/module/stepper.cpp
@@ -189,7 +189,7 @@ bool Stepper::abort_current_block;
 uint32_t Stepper::acceleration_time, Stepper::deceleration_time;
 uint8_t Stepper::steps_per_isr;
 
-#if HAS_FREEZE_PIN
+#if ENABLED(FREEZE_FEATURE)
   bool Stepper::frozen; // = false
 #endif
 
@@ -1643,7 +1643,7 @@ void Stepper::pulse_phase_isr() {
   if (!current_block) return;
 
   // Skipping step processing causes motion to freeze
-  if (TERN0(HAS_FREEZE_PIN, frozen)) return;
+  if (TERN0(FREEZE_FEATURE, frozen)) return;
 
   // Count of pending loops and events for this iteration
   const uint32_t pending_events = step_event_count - step_events_completed;
diff --git a/Marlin/src/module/stepper.h b/Marlin/src/module/stepper.h
index 99aa714ca095..4c9fbb9556b9 100644
--- a/Marlin/src/module/stepper.h
+++ b/Marlin/src/module/stepper.h
@@ -336,7 +336,7 @@ class Stepper {
       static constexpr uint8_t last_moved_extruder = 0;
     #endif
 
-    #if HAS_FREEZE_PIN
+    #if ENABLED(FREEZE_FEATURE)
       static bool frozen;                   // Set this flag to instantly freeze motion
     #endif
 
diff --git a/Marlin/src/pins/pinsDebug_list.h b/Marlin/src/pins/pinsDebug_list.h
index 2328a826ef7e..d7e84b996605 100644
--- a/Marlin/src/pins/pinsDebug_list.h
+++ b/Marlin/src/pins/pinsDebug_list.h
@@ -823,7 +823,7 @@
 #if HAS_KILL
   REPORT_NAME_DIGITAL(__LINE__, KILL_PIN)
 #endif
-#if HAS_FREEZE_PIN
+#if PIN_EXISTS(FREEZE)
   REPORT_NAME_DIGITAL(__LINE__, FREEZE_PIN)
 #endif
 #if PIN_EXISTS(LCD_BACKLIGHT)