Lots of web workflow, C3 and title bar fixes

tannewt · tannewt · commit d6344812e8ca · 2022-07-28T16:06:56.000-07:00
* Fixes #6221 - C3 hang on `import wifi`. Enabling the WiFi PHY was disabling USB. Now boards that use it set CONFIG_ESP_PHY_ENABLE_USB explicitly. * Fixes #6655 - Allows pasting into the web serial page. Fixes reading more than 0xf bytes at a time. * Fixes #6653 - Fixes web socket encoding of payloads >125 bytes. Can happen when printing a long string. * Fixes C3 responsiveness when waiting for key to enter REPL. (It now correctly stops sleeping.) * Disables title bar updates when in raw REPL. Related to #6548. * Adds version to title bar.
diff --git a/main.c b/main.c
@@ -57,6 +57,7 @@
 #include "supervisor/shared/stack.h"
 #include "supervisor/shared/status_leds.h"
 #include "supervisor/shared/tick.h"
+#include "supervisor/shared/title_bar.h"
 #include "supervisor/shared/traceback.h"
 #include "supervisor/shared/translate/translate.h"
 #include "supervisor/shared/workflow.h"
@@ -822,7 +823,9 @@ STATIC int run_repl(bool first_run) {
     status_led_deinit();
     #endif
     if (pyexec_mode_kind == PYEXEC_MODE_RAW_REPL) {
+        supervisor_title_bar_suspend();
         exit_code = pyexec_raw_repl();
+        supervisor_title_bar_resume();
     } else {
         exit_code = pyexec_friendly_repl();
     }
@@ -914,6 +917,7 @@ int __attribute__((used)) main(void) {
     run_boot_py(safe_mode);
 
     supervisor_workflow_start();
+    supervisor_title_bar_start();
 
     // Boot script is finished, so now go into REPL or run code.py.
     int exit_code = PYEXEC_FORCED_EXIT;
diff --git a/ports/espressif/boards/adafruit_qtpy_esp32c3/sdkconfig b/ports/espressif/boards/adafruit_qtpy_esp32c3/sdkconfig
@@ -30,6 +30,14 @@ CONFIG_PARTITION_TABLE_FILENAME="esp-idf-config/partitions-4MB-no-uf2.csv"
 #
 # Component config
 #
+#
+
+#
+# PHY
+#
+CONFIG_ESP_PHY_ENABLE_USB=y
+# end of PHY
+
 #
 # ESP System Settings
 #
diff --git a/ports/espressif/boards/beetle-esp32-c3/sdkconfig b/ports/espressif/boards/beetle-esp32-c3/sdkconfig
@@ -1,3 +1,9 @@
+#
+# PHY
+#
+CONFIG_ESP_PHY_ENABLE_USB=y
+# end of PHY
+
 #
 # LWIP
 #
diff --git a/ports/espressif/boards/lolin_c3_mini/sdkconfig b/ports/espressif/boards/lolin_c3_mini/sdkconfig
@@ -1,3 +1,9 @@
+#
+# PHY
+#
+CONFIG_ESP_PHY_ENABLE_USB=y
+# end of PHY
+
 #
 # LWIP
 #
diff --git a/ports/espressif/common-hal/wifi/__init__.c b/ports/espressif/common-hal/wifi/__init__.c
@@ -44,6 +44,7 @@ wifi_radio_obj_t common_hal_wifi_radio_obj;
 #include "components/log/include/esp_log.h"
 
 #include "supervisor/port.h"
+#include "supervisor/shared/title_bar.h"
 #include "supervisor/workflow.h"
 
 #include "esp_ipc.h"
@@ -55,7 +56,7 @@ wifi_radio_obj_t common_hal_wifi_radio_obj;
 static const char *TAG = "CP wifi";
 
 STATIC void schedule_background_on_cp_core(void *arg) {
-    supervisor_workflow_request_background();
+    supervisor_title_bar_request_update(false);
 
     // CircuitPython's VM is run in a separate FreeRTOS task from wifi callbacks. So, we have to
     // notify the main task every time in case it's waiting for us.
diff --git a/ports/espressif/esp-idf b/ports/espressif/esp-idf
@@ -1 +1 @@
-Subproject commit 0180c0cb80f052919badc15df164e8edde6344ad
+Subproject commit ddb7ddbcb613a582e0a91eda8b1d2510dd0a2d83
diff --git a/ports/espressif/supervisor/port.c b/ports/espressif/supervisor/port.c
@@ -30,7 +30,6 @@
 #include "supervisor/board.h"
 #include "supervisor/port.h"
 #include "py/runtime.h"
-#include "supervisor/esp_port.h"
 
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
@@ -390,6 +389,14 @@ void port_wake_main_task() {
     xTaskNotifyGive(circuitpython_task);
 }
 
+void port_wake_main_task_from_isr() {
+    BaseType_t xHigherPriorityTaskWoken = pdFALSE;
+    vTaskNotifyGiveFromISR(circuitpython_task, &xHigherPriorityTaskWoken);
+    if (xHigherPriorityTaskWoken == pdTRUE) {
+        portYIELD_FROM_ISR();
+    }
+}
+
 void sleep_timer_cb(void *arg) {
     port_wake_main_task();
 }
diff --git a/ports/espressif/supervisor/usb_serial_jtag.c b/ports/espressif/supervisor/usb_serial_jtag.c
@@ -28,19 +28,23 @@
 #include "py/ringbuf.h"
 #include "py/runtime.h"
 #include "py/mphal.h"
-#include "usb_serial_jtag.h"
+#include "supervisor/port.h"
+#include "supervisor/usb_serial_jtag.h"
 
 #include "hal/usb_serial_jtag_ll.h"
 #include "esp_intr_alloc.h"
 #include "soc/periph_defs.h"
 
-#include "supervisor/esp_port.h"
 
 #define USB_SERIAL_JTAG_BUF_SIZE (64)
 
 STATIC ringbuf_t ringbuf;
 STATIC uint8_t buf[128];
-STATIC bool connected;
+STATIC volatile bool connected;
+
+#if CIRCUITPY_ESP_USB_SERIAL_JTAG && !CONFIG_ESP_PHY_ENABLE_USB
+#error "CONFIG_ESP_PHY_ENABLE_USB must be enabled in sdkconfig"
+#endif
 
 static void usb_serial_jtag_isr_handler(void *arg) {
     uint32_t flags = usb_serial_jtag_ll_get_intsts_mask();
@@ -49,6 +53,11 @@ static void usb_serial_jtag_isr_handler(void *arg) {
         usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_INTR_SOF);
     }
 
+    if (flags & USB_SERIAL_JTAG_INTR_TOKEN_REC_IN_EP1) {
+        usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_INTR_TOKEN_REC_IN_EP1);
+        connected = true;
+    }
+
     if (flags & USB_SERIAL_JTAG_INTR_SERIAL_OUT_RECV_PKT) {
         usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_INTR_SERIAL_OUT_RECV_PKT);
         size_t req_len = ringbuf_num_empty(&ringbuf);
@@ -64,25 +73,19 @@ static void usb_serial_jtag_isr_handler(void *arg) {
                 ringbuf_put(&ringbuf, rx_buf[i]);
             }
         }
-        vTaskNotifyGiveFromISR(circuitpython_task, NULL);
+        port_wake_main_task_from_isr();
     }
 }
 
 void usb_serial_jtag_init(void) {
     ringbuf_init(&ringbuf, buf, sizeof(buf));
-    usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_INTR_SOF | USB_SERIAL_JTAG_INTR_SERIAL_OUT_RECV_PKT);
-    usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_SOF | USB_SERIAL_JTAG_INTR_SERIAL_OUT_RECV_PKT);
+    usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_INTR_SOF | USB_SERIAL_JTAG_INTR_SERIAL_OUT_RECV_PKT | USB_SERIAL_JTAG_INTR_TOKEN_REC_IN_EP1);
+    usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_SOF | USB_SERIAL_JTAG_INTR_SERIAL_OUT_RECV_PKT | USB_SERIAL_JTAG_INTR_TOKEN_REC_IN_EP1);
     ESP_ERROR_CHECK(esp_intr_alloc(ETS_USB_SERIAL_JTAG_INTR_SOURCE, ESP_INTR_FLAG_LEVEL1,
         usb_serial_jtag_isr_handler, NULL, NULL));
 }
 
 bool usb_serial_jtag_connected(void) {
-    // Make connected sticky. Otherwise we'll be disconnected every time the SOF
-    // index is 0. (It's only ~15 bits so it wraps around frequently.)
-    if (connected) {
-        return true;
-    }
-    connected = USB_SERIAL_JTAG.fram_num.sof_frame_index > 0;
     return connected;
 }
 
diff --git a/supervisor/port.h b/supervisor/port.h
@@ -99,8 +99,14 @@ void port_background_task(void);
 void port_start_background_task(void);
 void port_finish_background_task(void);
 
-// Some ports need special handling to wake the main task from an interrupt
-// context or other task.  The port must implement the necessary code in this
-// function.  A default weak implementation is provided that does nothing.
+// Some ports need special handling to wake the main task from another task. The
+// port must implement the necessary code in this function.  A default weak
+// implementation is provided that does nothing.
 void port_wake_main_task(void);
+
+// Some ports need special handling to wake the main task from an interrupt
+// context.  The port must implement the necessary code in this function.  A
+// default weak implementation is provided that does nothing.
+void port_wake_main_task_from_isr(void);
+
 #endif  // MICROPY_INCLUDED_SUPERVISOR_PORT_H
diff --git a/supervisor/shared/port.c b/supervisor/shared/port.c
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2019 Lucian Copeland for Adafruit Industries
+ * Copyright (c) 2022 Scott Shawcroft for Adafruit Industries
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -24,12 +24,10 @@
  * THE SOFTWARE.
  */
 
-#ifndef MICROPY_INCLUDED_ESPRESSIF_SUPERVISOR_PORT_H
-#define MICROPY_INCLUDED_ESPRESSIF_SUPERVISOR_PORT_H
+#include "supervisor/port.h"
 
-#include "freertos/FreeRTOS.h"
-#include "freertos/task.h"
+MP_WEAK void port_wake_main_task(void) {
+}
 
-extern TaskHandle_t circuitpython_task;
-
-#endif // MICROPY_INCLUDED_ESPRESSIF_SUPERVISOR_PORT_H
+MP_WEAK void port_wake_main_task_from_isr(void) {
+}
diff --git a/supervisor/shared/serial.c b/supervisor/shared/serial.c
@@ -207,10 +207,17 @@ char serial_read(void) {
 
     #if CIRCUITPY_WEB_WORKFLOW
     if (websocket_available()) {
-        return websocket_read_char();
+        char c = websocket_read_char();
+        if (c != -1) {
+            return c;
+        }
     }
     #endif
 
+    if (port_serial_bytes_available() > 0) {
+        return port_serial_read();
+    }
+
     #if CIRCUITPY_USB_CDC
     if (!usb_cdc_console_enabled()) {
         return -1;
@@ -220,9 +227,6 @@ char serial_read(void) {
     return (char)tud_cdc_read_char();
     #endif
 
-    if (port_serial_bytes_available() > 0) {
-        return port_serial_read();
-    }
     return -1;
 }
 
diff --git a/supervisor/shared/title_bar.c b/supervisor/shared/title_bar.c
@@ -0,0 +1,93 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include <stdbool.h>
+#include "genhdr/mpversion.h"
+#include "py/mpconfig.h"
+#include "supervisor/background_callback.h"
+#include "supervisor/serial.h"
+#include "supervisor/shared/title_bar.h"
+
+#if CIRCUITPY_WEB_WORKFLOW
+#include "supervisor/shared/web_workflow/web_workflow.h"
+#endif
+static background_callback_t title_bar_background_cb;
+
+static bool _forced_dirty = false;
+static bool _suspended = false;
+
+static void title_bar_background(void *data) {
+    if (_suspended) {
+        return;
+    }
+    bool dirty = _forced_dirty;
+
+    #if CIRCUITPY_WEB_WORKFLOW
+    dirty = dirty || supervisor_web_workflow_status_dirty();
+    #endif
+
+    if (!dirty) {
+        return;
+    }
+    _forced_dirty = false;
+    #if CIRCUITPY_STATUS_BAR
+    // Neighboring "" "" are concatenated by the compiler. Without this separation, the hex code
+    // doesn't get terminated after two following characters and the value is invalid.
+    // This is the OSC command to set the title and the icon text. It can be up to 255 characters
+    // but some may be cut off.
+    serial_write("\x1b" "]0;");
+    serial_write("🐍 ");
+    #if CIRCUITPY_WEB_WORKFLOW
+    supervisor_web_workflow_status();
+    #endif
+    serial_write("|");
+    serial_write(MICROPY_GIT_TAG);
+    // Send string terminator
+    serial_write("\x1b" "\\");
+    #endif
+}
+
+void supervisor_title_bar_start(void) {
+    title_bar_background_cb.fun = title_bar_background;
+    title_bar_background_cb.data = NULL;
+    supervisor_title_bar_request_update(true);
+}
+
+void supervisor_title_bar_request_update(bool force_dirty) {
+    if (force_dirty) {
+        _forced_dirty = true;
+    }
+    background_callback_add_core(&title_bar_background_cb);
+}
+
+void supervisor_title_bar_suspend(void) {
+    _suspended = true;
+}
+
+void supervisor_title_bar_resume(void) {
+    _suspended = false;
+    supervisor_title_bar_request_update(false);
+}
diff --git a/supervisor/shared/title_bar.h b/supervisor/shared/title_bar.h
@@ -0,0 +1,34 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#pragma once
+
+#include <stdbool.h>
+
+void supervisor_title_bar_start(void);
+void supervisor_title_bar_suspend(void);
+void supervisor_title_bar_resume(void);
+void supervisor_title_bar_request_update(bool force_dirty);
diff --git a/supervisor/shared/web_workflow/static/serial.js b/supervisor/shared/web_workflow/static/serial.js
@@ -63,10 +63,12 @@ input.addEventListener("beforeinput", function(e) {
     input.value = "";
     input.focus();
     e.preventDefault();
-  } else if (e.inputType == "insertText") {
+  } else if (e.inputType == "insertText" || e.inputType == "insertFromPaste") {
     ws.send(e.data);
   } else if (e.inputType == "deleteContentBackward") {
     ws.send("\b");
+  } else {
+    console.log(e);
   }
 });
 
diff --git a/supervisor/shared/web_workflow/web_workflow.c b/supervisor/shared/web_workflow/web_workflow.c
diff --git a/supervisor/shared/web_workflow/web_workflow.h b/supervisor/shared/web_workflow/web_workflow.h
diff --git a/supervisor/shared/web_workflow/websocket.c b/supervisor/shared/web_workflow/websocket.c
diff --git a/supervisor/shared/workflow.c b/supervisor/shared/workflow.c
diff --git a/supervisor/supervisor.mk b/supervisor/supervisor.mk

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,14 @@ CONFIG_PARTITION_TABLE_FILENAME="esp-idf-config/partitions-4MB-no-uf2.csv"`
`30`	`30`	`#`
`31`	`31`	`# Component config`
`32`	`32`	`#`
	`33`	`+#`
	`34`	`+`
	`35`	`+#`
	`36`	`+# PHY`
	`37`	`+#`
	`38`	`+CONFIG_ESP_PHY_ENABLE_USB=y`
	`39`	`+# end of PHY`
	`40`	`+`
`33`	`41`	`#`
`34`	`42`	`# ESP System Settings`
`35`	`43`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,9 @@`
	`1`	`+#`
	`2`	`+# PHY`
	`3`	`+#`
	`4`	`+CONFIG_ESP_PHY_ENABLE_USB=y`
	`5`	`+# end of PHY`
	`6`	`+`
`1`	`7`	`#`
`2`	`8`	`# LWIP`
`3`	`9`	`#`