Merge pull request #5089 from tannewt/disable_ble_workflow

Add ability to disable BLE workflow

Author: tannewt

main.c

@@ -832,6 +832,7 @@ int __attribute__((used)) main(void) {
     serial_init();
 
     #if CIRCUITPY_BLEIO
+    supervisor_bluetooth_enable_workflow();
     supervisor_start_bluetooth();
     #endif
 

ports/nrf/Makefile

@@ -120,7 +120,7 @@ CFLAGS += \
 # TODO: check this
 CFLAGS += -D__START=main
 
-LDFLAGS = $(CFLAGS) -nostartfiles -Wl,-nostdlib -Wl,-T,$(GENERATED_LD_FILE) -Wl,-Map=$@.map -Wl,-cref -Wl,-gc-sections -specs=nano.specs
+LDFLAGS = $(CFLAGS) -nostartfiles -Wl,-nostdlib -Wl,-z,max-page-size=0x1000 -Wl,-T,$(GENERATED_LD_FILE) -Wl,-Map=$@.map -Wl,-cref -Wl,-gc-sections -specs=nano.specs
 LIBS := -lgcc -lc
 
 LDFLAGS += -mthumb -mcpu=cortex-m4

shared-bindings/supervisor/__init__.c

@@ -32,6 +32,7 @@
 
 #include "lib/utils/interrupt_char.h"
 #include "supervisor/shared/autoreload.h"
+#include "supervisor/shared/bluetooth/bluetooth.h"
 #include "supervisor/shared/status_leds.h"
 #include "supervisor/shared/stack.h"
 #include "supervisor/shared/traceback.h"
@@ -283,6 +284,21 @@ STATIC mp_obj_t supervisor_get_previous_traceback(void) {
 }
 MP_DEFINE_CONST_FUN_OBJ_0(supervisor_get_previous_traceback_obj, supervisor_get_previous_traceback);
 
+//| def disable_ble_workflow() -> None:
+//|     """Disable ble workflow until a reset. This prevents BLE advertising outside of the VM and
+//|        the services used for it."""
+//|     ...
+//|
+STATIC mp_obj_t supervisor_disable_ble_workflow(void) {
+    #if !CIRCUITPY_BLE_FILE_SERVICE && !CIRCUITPY_SERIAL_BLE
+    mp_raise_NotImplementedError(NULL);
+    #else
+    supervisor_bluetooth_disable_workflow();
+    #endif
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_0(supervisor_disable_ble_workflow_obj, supervisor_disable_ble_workflow);
+
 STATIC const mp_rom_map_elem_t supervisor_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_supervisor) },
     { MP_ROM_QSTR(MP_QSTR_enable_autoreload),  MP_ROM_PTR(&supervisor_enable_autoreload_obj) },
@@ -295,6 +311,7 @@ STATIC const mp_rom_map_elem_t supervisor_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_set_next_code_file),  MP_ROM_PTR(&supervisor_set_next_code_file_obj) },
     { MP_ROM_QSTR(MP_QSTR_ticks_ms),  MP_ROM_PTR(&supervisor_ticks_ms_obj) },
     { MP_ROM_QSTR(MP_QSTR_get_previous_traceback),  MP_ROM_PTR(&supervisor_get_previous_traceback_obj) },
+    { MP_ROM_QSTR(MP_QSTR_disable_ble_workflow),  MP_ROM_PTR(&supervisor_disable_ble_workflow_obj) },
 };
 
 STATIC MP_DEFINE_CONST_DICT(supervisor_module_globals, supervisor_module_globals_table);

shared-module/terminalio/Terminal.c

@@ -46,6 +46,10 @@ void common_hal_terminalio_terminal_construct(terminalio_terminal_obj_t *self, d
 }
 
 size_t common_hal_terminalio_terminal_write(terminalio_terminal_obj_t *self, const byte *data, size_t len, int *errcode) {
+    // Make sure the terminal is initialized before we do anything with it.
+    if (self->tilegrid == NULL) {
+        return len;
+    }
     const byte *i = data;
     uint16_t start_y = self->cursor_y;
     while (i < data + len) {
@@ -169,5 +173,5 @@ size_t common_hal_terminalio_terminal_write(terminalio_terminal_obj_t *self, con
 }
 
 bool common_hal_terminalio_terminal_ready_to_tx(terminalio_terminal_obj_t *self) {
-    return true;
+    return self->tilegrid != NULL;
 }

supervisor/shared/bluetooth/bluetooth.c

@@ -83,13 +83,23 @@ uint8_t circuitpython_scan_response_data[] = {
     #endif
 };
 
-bool boot_in_discovery_mode = false;
-bool advertising = false;
+
+#if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+STATIC bool boot_in_discovery_mode = false;
+STATIC bool advertising = false;
+STATIC bool ble_started = false;
+
+#define WORKFLOW_UNSET 0
+#define WORKFLOW_ENABLED 1
+#define WORKFLOW_DISABLED 2
+
+STATIC uint8_t workflow_state = WORKFLOW_UNSET;
+STATIC bool was_connected = false;
 
 STATIC void supervisor_bluetooth_start_advertising(void) {
-    #if !CIRCUITPY_BLE_FILE_SERVICE && !CIRCUITPY_SERIAL_BLE
-    return;
-    #else
+    if (workflow_state != WORKFLOW_ENABLED) {
+        return;
+    }
     bool is_connected = common_hal_bleio_adapter_get_connected(&common_hal_bleio_adapter_obj);
     if (is_connected) {
         return;
@@ -130,16 +140,15 @@ STATIC void supervisor_bluetooth_start_advertising(void) {
         NULL);
     // This may fail if we are already advertising.
     advertising = status == NRF_SUCCESS;
-    #endif
 }
 
+#endif  // CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+
 #define BLE_DISCOVERY_DATA_GUARD 0xbb0000bb
 #define BLE_DISCOVERY_DATA_GUARD_MASK 0xff0000ff
 
 void supervisor_bluetooth_init(void) {
-    #if !CIRCUITPY_BLE_FILE_SERVICE && !CIRCUITPY_SERIAL_BLE
-    return;
-    #endif
+    #if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
     uint32_t reset_state = port_get_saved_word();
     uint32_t ble_mode = 0;
     if ((reset_state & BLE_DISCOVERY_DATA_GUARD_MASK) == BLE_DISCOVERY_DATA_GUARD) {
@@ -209,10 +218,14 @@ void supervisor_bluetooth_init(void) {
     status_led_deinit();
     #endif
     port_set_saved_word(reset_state);
+    #endif
 }
 
-STATIC bool was_connected;
 void supervisor_bluetooth_background(void) {
+    #if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+    if (!ble_started) {
+        return;
+    }
     bool is_connected = common_hal_bleio_adapter_get_connected(&common_hal_bleio_adapter_obj);
     if (was_connected && !is_connected) {
         #if CIRCUITPY_BLE_FILE_SERVICE
@@ -228,12 +241,15 @@ void supervisor_bluetooth_background(void) {
     #if CIRCUITPY_BLE_FILE_SERVICE
     supervisor_bluetooth_file_transfer_background();
     #endif
+    #endif
 }
 
 void supervisor_start_bluetooth(void) {
-    #if !CIRCUITPY_BLE_FILE_SERVICE && !CIRCUITPY_SERIAL_BLE
-    return;
-    #endif
+    #if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+
+    if (workflow_state != WORKFLOW_ENABLED) {
+        return;
+    }
 
     common_hal_bleio_adapter_set_enabled(&common_hal_bleio_adapter_obj, true);
 
@@ -245,16 +261,41 @@ void supervisor_start_bluetooth(void) {
     supervisor_start_bluetooth_serial();
     #endif
 
-    // Kick off advertisments
+    // Mark as started so that the background call does something.
+    ble_started = true;
+
+    // Kick off advertisements
     supervisor_bluetooth_background();
+
+    #endif
 }
 
 void supervisor_stop_bluetooth(void) {
-    #if !CIRCUITPY_BLE_FILE_SERVICE && !CIRCUITPY_SERIAL_BLE
-    return;
-    #endif
+    #if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+
+    if (!ble_started && workflow_state != WORKFLOW_ENABLED) {
+        return;
+    }
 
     #if CIRCUITPY_SERIAL_BLE
     supervisor_stop_bluetooth_serial();
     #endif
+
+    #endif
+}
+
+void supervisor_bluetooth_enable_workflow(void) {
+    #if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+    if (workflow_state == WORKFLOW_DISABLED) {
+        return;
+    }
+
+    workflow_state = WORKFLOW_ENABLED;
+    #endif
+}
+
+void supervisor_bluetooth_disable_workflow(void) {
+    #if CIRCUITPY_BLE_FILE_SERVICE || CIRCUITPY_SERIAL_BLE
+    workflow_state = WORKFLOW_DISABLED;
+    #endif
 }

supervisor/shared/bluetooth/bluetooth.h

@@ -34,4 +34,8 @@ void supervisor_bluetooth_init(void);
 void supervisor_start_bluetooth(void);
 void supervisor_stop_bluetooth(void);
 
+// Enable only works if it hasn't been set yet.
+void supervisor_bluetooth_enable_workflow(void);
+void supervisor_bluetooth_disable_workflow(void);
+
 #endif // MICROPY_INCLUDED_SUPERVISOR_SHARED_BLUETOOTH_H

supervisor/shared/bluetooth/serial.c

@@ -166,7 +166,7 @@ void ble_serial_write(const char *text, size_t len) {
     }
     size_t sent = 0;
     while (sent < len) {
-        uint16_t packet_size = MIN(len, (size_t)common_hal_bleio_packet_buffer_get_outgoing_packet_length(&_tx_packet_buffer));
+        uint16_t packet_size = MIN(len - sent, (size_t)common_hal_bleio_packet_buffer_get_outgoing_packet_length(&_tx_packet_buffer));
         mp_int_t written = common_hal_bleio_packet_buffer_write(&_tx_packet_buffer, (const uint8_t *)text + sent, packet_size, NULL, 0);
         // Error, so we drop characters to transmit.
         if (written < 0) {

supervisor/shared/display.c

@@ -123,6 +123,7 @@ void supervisor_stop_terminal(void) {
         free_memory(tilegrid_tiles);
         tilegrid_tiles = NULL;
         supervisor_terminal_text_grid.tiles = NULL;
+        supervisor_terminal.tilegrid = NULL;
     }
     #endif
 }

tools/gen_display_resources.py

@@ -228,7 +228,7 @@ def _load_row(self, y, row):
     .font = &supervisor_terminal_font,
     .cursor_x = 0,
     .cursor_y = 0,
-    .tilegrid = &supervisor_terminal_text_grid
+    .tilegrid = NULL
 };
 """
 )