From 4b0448493c9c188fbe70fbbf4073509784f740dc Mon Sep 17 00:00:00 2001
From: Serge Bazanski <q3k@q3k.org>
Date: Fri, 28 Jul 2023 23:25:08 +0200
Subject: [PATCH] *: use IDF patch to fix graphical glitching
Turns out there's a bug in ESP-IDF that causes FPU registers to get
correpted on context switches:
https://github.com/espressif/esp-idf/issues/11690
This applies this patch in nix, and reminds others to apply this patch
in the README. With this patch applied, graphical glitches in the
firmware seem gone.
---
README.md | 3 +-
nix/overlay/esp-idf/default.nix | 1 +
...8912c73fa59061d97a2f5fd5acddcc3fa356.patch | 68 +++++++++++++++++++
3 files changed, 71 insertions(+), 1 deletion(-)
create mode 100644 third_party/b03c8912c73fa59061d97a2f5fd5acddcc3fa356.patch
diff --git a/README.md b/README.md
index cc95e49e64..155de82955 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ Please transfer all .py files in python_payload/ for using the demo payload.
## How to install dependencies
-Pay attention to install version 5.1. To be sure follow the generic instructions below.
+Pay attention to install version 5.1 **WITH OUR PATCHES**. To be sure follow the generic instructions below.
### Generic
@@ -30,6 +30,7 @@ $ git clone https://github.com/espressif/esp-idf.git
$ cd esp-idf
$ git checkout v5.1
$ git submodule update --init --recursive
+$ patch -p1 < flow3r/third_party/b03c8912c73fa59061d97a2f5fd5acddcc3fa356.patch
$ cd esp-idf
$ ./install.sh
diff --git a/nix/overlay/esp-idf/default.nix b/nix/overlay/esp-idf/default.nix
index 2ccc3521a2..c7c043f2e6 100644
--- a/nix/overlay/esp-idf/default.nix
+++ b/nix/overlay/esp-idf/default.nix
@@ -174,6 +174,7 @@ stdenv.mkDerivation rec {
patches = [
./rack-off-me-nix-mate.patch
+ ../../../third_party/b03c8912c73fa59061d97a2f5fd5acddcc3fa356.patch
];
installPhase = ''
diff --git a/third_party/b03c8912c73fa59061d97a2f5fd5acddcc3fa356.patch b/third_party/b03c8912c73fa59061d97a2f5fd5acddcc3fa356.patch
new file mode 100644
index 0000000000..2661784cbe
--- /dev/null
+++ b/third_party/b03c8912c73fa59061d97a2f5fd5acddcc3fa356.patch
@@ -0,0 +1,68 @@
+From b03c8912c73fa59061d97a2f5fd5acddcc3fa356 Mon Sep 17 00:00:00 2001
+From: Omar Chebib <omar.chebib@espressif.com>
+Date: Fri, 30 Jun 2023 14:30:17 +0800
+Subject: [PATCH] Xtensa: fix a bug that altered CPU registers in FPU exception
+ handlers
+
+* Fixes https://github.com/espressif/esp-idf/issues/11690
+
+q3k ported this to IDF5 (different file path)
+---
+ components/xtensa/xtensa_vectors.S | 16 +++++++++++++---
+ 1 file changed, 13 insertions(+), 3 deletions(-)
+
+diff --git a/components/freertos/FreeRTOS-Kernel/portable/xtensa/xtensa_vectors.S b/components/freertos/FreeRTOS-Kernel/portable/xtensa/xtensa_vectors.S
+index 40c372abe7e..4843bbae70f 100644
+--- a/components/freertos/FreeRTOS-Kernel/portable/xtensa/xtensa_vectors.S
++++ b/components/freertos/FreeRTOS-Kernel/portable/xtensa/xtensa_vectors.S
+@@ -3,7 +3,7 @@
+ *
+ * SPDX-License-Identifier: MIT
+ *
+- * SPDX-FileContributor: 2016-2022 Espressif Systems (Shanghai) CO LTD
++ * SPDX-FileContributor: 2016-2023 Espressif Systems (Shanghai) CO LTD
+ */
+ /*
+ * Copyright (c) 2015-2019 Cadence Design Systems, Inc.
+@@ -1016,6 +1016,12 @@ _xt_coproc_exc:
+ s32i a2, sp, XT_STK_A2
+ s32i a3, sp, XT_STK_A3
+ s32i a4, sp, XT_STK_A4
++#if portNUM_PROCESSORS > 1
++ /* If multicore, we must save two more interruptee's register to use as
++ * scratch when taking/releasing the _xt_coproc_owner_sa_lock spinlock. */
++ s32i a6, sp, XT_STK_A6
++ s32i a7, sp, XT_STK_A7
++#endif /* portNUM_PROCESSORS > 1 */
+ s32i a15, sp, XT_STK_A15
+
+ /* Call the RTOS coprocessor exception hook */
+@@ -1046,7 +1052,7 @@ _xt_coproc_exc:
+ #if portNUM_PROCESSORS > 1
+ /* If multicore, we must also acquire the _xt_coproc_owner_sa_lock spinlock
+ * to ensure thread safe access of _xt_coproc_owner_sa between cores. */
+- spinlock_take a0 a2 _xt_coproc_owner_sa_lock
++ spinlock_take a6 a7 _xt_coproc_owner_sa_lock
+ #endif /* portNUM_PROCESSORS > 1 */
+
+ /* Get old coprocessor owner thread (save area ptr) and assign new one. */
+@@ -1057,7 +1063,7 @@ _xt_coproc_exc:
+
+ #if portNUM_PROCESSORS > 1
+ /* Release previously taken spinlock */
+- spinlock_release a0 a2 _xt_coproc_owner_sa_lock
++ spinlock_release a6 a7 _xt_coproc_owner_sa_lock
+ #endif /* portNUM_PROCESSORS > 1 */
+
+ /* Only need to context switch if new owner != old owner. */
+@@ -1140,6 +1146,10 @@ _xt_coproc_exc:
+ /* Can omit rsync for wsr.CPENABLE here because _xt_user_exit does it. */
+ .L_xt_coproc_done:
+ l32i a15, sp, XT_STK_A15
++#if portNUM_PROCESSORS > 1
++ l32i a6, sp, XT_STK_A6
++ l32i a7, sp, XT_STK_A7
++#endif /* portNUM_PROCESSORS > 1 */
+ l32i a5, sp, XT_STK_A5
+ l32i a4, sp, XT_STK_A4
+ l32i a3, sp, XT_STK_A3
--
GitLab