Add Bangle.js 2, JDI memory displays and ACeP epd

This 2-in-1 PR started with the goal of support the Bangle.js 2
smartwatch with *no USB*.
* Adds "secure" DFU build support with a committed private key.
* Adds 3-bit color support with one dummy bit for the JDI memory display
* Allows nrf boards to have a board_background_task() run in RUN_BACKGROUND_TASK.
  This is needed because the Bangle.js 2 uses the watchdog to reset.
* Renamed port_background_task() to port_background_tick() to indicate it
  runs on tick, not RUN_BACKGROUND_TASK.
* Marks serial connected when the display terminal is inited. This means
  that safe mode messages show up on the display.

ACep, 7-color epaper displays also pack 3 bits in 4. So, I added that
support as well.
* Adds 3-bit ACeP color support for 7-color e-paper displays. (Not
  watch related but similar due to color depth.)
* Allows a refresh sequence instead of a single int command. The 7" ACeP
  display requires a data byte for refresh.
* Adds optional delay after resetting the display. The ACeP displays
  need this. (Probably to load LUTs from flash.)
* Adds a cleaning phase for ACeP displays before the real refresh.

For both:
* Add dither support to Palette.
* Palette no longer converts colors when set. Instead, it caches
  converted colors at each index.
* ColorConverter now caches the last converted color. It should make
  conversions faster for repeated colors (not dithering.)

Author: tannewt

data/nvm.toml

@@ -202,10 +202,6 @@ msgstr ""
 msgid "%q out of range"
 msgstr ""
 
-#: ports/atmel-samd/common-hal/microcontroller/Pin.c
-msgid "%q pin invalid"
-msgstr ""
-
 #: py/objrange.c py/objslice.c shared-bindings/random/__init__.c
 msgid "%q step cannot be zero"
 msgstr ""
@@ -1210,9 +1206,11 @@ msgid "Internal watchdog timer expired."
 msgstr ""
 
 #: py/argcheck.c shared-bindings/digitalio/DigitalInOut.c
+#: shared-bindings/displayio/EPaperDisplay.c
 msgid "Invalid %q"
 msgstr ""
 
+#: ports/atmel-samd/common-hal/microcontroller/Pin.c
 #: shared-bindings/microcontroller/Pin.c
 msgid "Invalid %q pin"
 msgstr ""

locale/circuitpython.pot

@@ -57,5 +57,8 @@ void port_finish_background_task(void) {
 }
 #endif
 
+void port_background_tick(void) {
+}
+
 void port_background_task(void) {
 }

ports/atmel-samd/background.c

@@ -52,6 +52,10 @@ uint8_t stop_sequence[] = {
     0x02, 0x80, 0xf0  // Power off
 };
 
+uint8_t refresh_sequence[] = {
+    0x12, 0x00
+};
+
 void board_init(void) {
     busio_spi_obj_t *spi = &displays[0].fourwire_bus.inline_bus;
     common_hal_busio_spi_construct(spi, &pin_PB13, &pin_PB15, NULL, false);
@@ -74,6 +78,7 @@ void board_init(void) {
         bus,
         start_sequence,
         sizeof(start_sequence),
+        0, // start up time
         stop_sequence,
         sizeof(stop_sequence),
         300, // width
@@ -92,13 +97,15 @@ void board_init(void) {
         NO_COMMAND, // write_color_ram_command (can add this for grayscale eventually)
         false, // color_bits_inverted
         0x000000, // highlight_color
-        0x12, // refresh_display_command
+        refresh_sequence, // refresh_display_sequence
+        sizeof(refresh_sequence),
         40, // refresh_time
         &pin_PA01, // busy_pin
         false, // busy_state
         5, // seconds_per_frame
         false, // chip_select (don't always toggle chip select)
         false, // grayscale
+        false, // acep
         false); // two_byte_sequence_length
 }
 

ports/atmel-samd/boards/openbook_m4/board.c

@@ -53,3 +53,10 @@ CIRCUITPY_DISPLAY_FONT = $(TOP)/ports/atmel-samd/boards/ugame10/brutalist-6.bdf
 
 # Override optimization to keep binary small
 OPTIMIZATION_FLAGS = -Os
+
+# We don't have room for the fonts for terminalio for certain languages,
+# so turn off terminalio and force a clean build.
+ifneq (,$(filter $(TRANSLATION),ja ko ru))
+CIRCUITPY_TERMINALIO = 0
+RELEASE_NEEDS_CLEAN_BUILD = 1
+endif

ports/atmel-samd/boards/pewpew_m4/mpconfigboard.mk

@@ -211,5 +211,5 @@ mcu_pin_function_t *mcu_find_pin_function(mcu_pin_function_t *table, const mcu_p
             return table;
         }
     }
-    mp_raise_ValueError_varg(translate("%q pin invalid"), name);
+    mp_raise_ValueError_varg(translate("Invalid %q pin"), name);
 }

ports/atmel-samd/common-hal/microcontroller/Pin.c

@@ -33,5 +33,8 @@ void port_start_background_task(void) {
 void port_finish_background_task(void) {
 }
 
+void port_background_tick(void) {
+}
+
 void port_background_task(void) {
 }

ports/broadcom/background.c

@@ -30,6 +30,8 @@
 #include "supervisor/filesystem.h"
 #include "supervisor/shared/stack.h"
 
+void port_background_tick(void) {
+}
 void port_background_task(void) {
 }
 void port_start_background_task(void) {

ports/cxd56/background.c

@@ -40,14 +40,17 @@
 #include "common-hal/pulseio/PulseIn.h"
 #endif
 
-void port_background_task(void) {
+void port_background_tick(void) {
     // Zero delay in case FreeRTOS wants to switch to something else.
     vTaskDelay(0);
     #if CIRCUITPY_PULSEIO
     pulsein_background();
     #endif
 }
 
+void port_background_task(void) {
+}
+
 void port_start_background_task(void) {
 }
 

ports/espressif/background.c

@@ -109,6 +109,10 @@ const uint8_t display_stop_sequence[] = {
     0x02, 0x00  // Power off
 };
 
+const uint8_t refresh_sequence[] = {
+    0x12, 0x00
+};
+
 void board_init(void) {
     // Debug UART
     #ifdef DEBUG
@@ -137,6 +141,7 @@ void board_init(void) {
         display,
         bus,
         display_start_sequence, sizeof(display_start_sequence),
+        0, // start up time
         display_stop_sequence, sizeof(display_stop_sequence),
         296,  // width
         128,  // height
@@ -154,13 +159,14 @@ void board_init(void) {
         0x13,  // write_color_ram_command
         false,  // color_bits_inverted
         0x000000,  // highlight_color
-        0x12,  // refresh_display_command
+        refresh_sequence, sizeof(refresh_sequence),
         1.0,  // refresh_time
         &pin_GPIO5,  // busy_pin
         false,  // busy_state
         5.0, // seconds_per_frame
         false,  // always_toggle_chip_select
         true, // grayscale
+        false, // acep
         false);  // two_byte_sequence_length
 }
 

ports/espressif/boards/adafruit_magtag_2.9_grayscale/board.c

@@ -32,6 +32,8 @@
 
 void port_background_task(void) {
 }
+void port_background_tick(void) {
+}
 void port_start_background_task(void) {
 }
 void port_finish_background_task(void) {

ports/litex/background.c

@@ -28,10 +28,14 @@
 #include "supervisor/port.h"
 
 void port_background_task(void) {
+}
+
+void port_background_tick(void) {
     #if CIRCUITPY_AUDIOIO || CIRCUITPY_AUDIOBUSIO
     audio_dma_background();
     #endif
 }
+
 void port_start_background_task(void) {
 }
 void port_finish_background_task(void) {

ports/mimxrt10xx/background.c

@@ -206,7 +206,7 @@ UF2_FAMILY_ID_nrf52840 = 0xADA52840
 UF2_FAMILY_ID_nrf52833 = 0x621E937A
 
 
-all: $(BUILD)/firmware.bin $(BUILD)/firmware.uf2 $(BUILD)/firmware.combined.hex
+all: $(BUILD)/firmware.bin $(BUILD)/firmware.uf2 $(BUILD)/firmware.combined.hex $(BUILD)/firmware.espruino.zip
 
 $(BUILD)/firmware.elf: $(OBJ) $(GENERATED_LD_FILE)
 	$(STEPECHO) "LINK $@"
@@ -301,6 +301,11 @@ dfu-gen: $(BUILD)/dfu-package.zip
 $(BUILD)/dfu-package.zip: $(BUILD)/firmware.hex
 	$(NRFUTIL) dfu genpkg --sd-req 0xFFFE --dev-type 0x0052 --application $^ $(BUILD)/dfu-package.zip
 
+# Espruino DFU
+$(BUILD)/firmware.espruino.zip: $(BUILD)/firmware.hex
+	$(NRFUTIL) pkg generate $(BUILD)/firmware.espruino.zip --application $^ --application-version 0xff --hw-version 52 --sd-req 0xa9,0xae,0xb6 --key-file espruino_dfu_private_key.pem
+
+espruino-dfu-gen: $(BUILD)/firmware.espruino.zip
 
 include $(TOP)/py/mkrules.mk
 

ports/nrf/Makefile

@@ -24,6 +24,8 @@
  * THE SOFTWARE.
  */
 
+#include "background.h"
+
 #include "py/runtime.h"
 #include "supervisor/filesystem.h"
 #include "supervisor/port.h"
@@ -44,14 +46,23 @@
 
 void port_start_background_task(void) {
 }
+
 void port_finish_background_task(void) {
 }
 
-void port_background_task(void) {
+void port_background_tick(void) {
     #if CIRCUITPY_AUDIOPWMIO
     audiopwmout_background();
     #endif
     #if CIRCUITPY_AUDIOBUSIO
     i2s_background();
     #endif
 }
+
+// Allow boards to override this.
+MP_WEAK void board_background_task(void) {
+}
+
+void port_background_task(void) {
+    board_background_task();
+}

ports/nrf/background.c

@@ -27,4 +27,6 @@
 #ifndef MICROPY_INCLUDED_NRF_BACKGROUND_H
 #define MICROPY_INCLUDED_NRF_BACKGROUND_H
 
+void board_background_task(void);
+
 #endif  // MICROPY_INCLUDED_NRF_BACKGROUND_H

ports/nrf/background.h

@@ -0,0 +1,97 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 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 "supervisor/board.h"
+#include "background.h"
+#include "mpconfigboard.h"
+
+#include "shared-bindings/busio/SPI.h"
+#include "shared-bindings/displayio/FourWire.h"
+#include "shared-bindings/framebufferio/FramebufferDisplay.h"
+#include "shared-bindings/sharpdisplay/SharpMemoryFramebuffer.h"
+#include "shared-module/displayio/__init__.h"
+
+digitalio_digitalinout_obj_t extcomin;
+digitalio_digitalinout_obj_t display_on;
+
+uint32_t last_down_ticks_ms;
+
+void board_init(void) {
+    common_hal_digitalio_digitalinout_construct(&extcomin, &pin_P0_06);
+    common_hal_digitalio_digitalinout_switch_to_output(&extcomin, true, DRIVE_MODE_PUSH_PULL);
+    common_hal_digitalio_digitalinout_never_reset(&extcomin);
+
+    common_hal_digitalio_digitalinout_construct(&display_on, &pin_P0_07);
+    common_hal_digitalio_digitalinout_switch_to_output(&display_on, true, DRIVE_MODE_PUSH_PULL);
+    common_hal_digitalio_digitalinout_never_reset(&display_on);
+
+    sharpdisplay_framebuffer_obj_t *fb = &allocate_display_bus()->sharpdisplay;
+    fb->base.type = &sharpdisplay_framebuffer_type;
+
+    busio_spi_obj_t *spi = &fb->inline_bus;
+    common_hal_busio_spi_construct(spi, &pin_P0_26, &pin_P0_27, NULL, false);
+    common_hal_busio_spi_never_reset(spi);
+
+    common_hal_sharpdisplay_framebuffer_construct(fb, spi, &pin_P0_05, 500000, 176, 176, true);
+
+    primary_display_t *display = allocate_display();
+    framebufferio_framebufferdisplay_obj_t *self = &display->framebuffer_display;
+    self->base.type = &framebufferio_framebufferdisplay_type;
+    common_hal_framebufferio_framebufferdisplay_construct(self, fb, 0, true);
+}
+
+bool board_requests_safe_mode(void) {
+    return false;
+}
+
+void reset_board(void) {
+    nrf_gpio_cfg_input(17, NRF_GPIO_PIN_PULLUP);
+}
+
+void board_deinit(void) {
+    // common_hal_displayio_release_displays();
+}
+
+void board_background_task(void) {
+    if (!nrf_gpio_pin_read(17)) {
+        if (last_down_ticks_ms == 0) {
+            last_down_ticks_ms = supervisor_ticks_ms32();
+        }
+    } else {
+        last_down_ticks_ms = 0;
+    }
+    // If the button isn't pressed, then feed the watchdog.
+    if (last_down_ticks_ms == 0) {
+        NRF_WDT->RR[0] = 0x6E524635;
+        return;
+    }
+    // if the button has been pressed less than 5 seconds, then feed the watchdog.
+    uint32_t now = supervisor_ticks_ms32();
+    if (now - last_down_ticks_ms < 5000) {
+        NRF_WDT->RR[0] = 0x6E524635;
+    }
+    // Don't feed the watchdog so that it'll expire and kick us to the bootloader.
+}

ports/nrf/boards/espruino_banglejs2/board.c

@@ -0,0 +1,44 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Glenn Ruben Bakke
+ * Copyright (c) 2018 Dan Halbert 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 "nrfx/hal/nrf_gpio.h"
+
+#define MICROPY_HW_BOARD_NAME       "Espruino Bangle.js 2"
+#define MICROPY_HW_MCU_NAME         "nRF52840"
+
+#define MICROPY_HW_LED_STATUS       (&pin_P0_19)
+
+#if SPI_FLASH_FILESYSTEM
+#define SPI_FLASH_MOSI_PIN &pin_P0_15
+#define SPI_FLASH_MISO_PIN &pin_P0_13
+#define SPI_FLASH_SCK_PIN &pin_P0_16
+#define SPI_FLASH_CS_PIN &pin_P0_14
+#endif
+
+#define CIRCUITPY_BOOT_BUTTON (&pin_P0_17)
+
+#define BOARD_HAS_32KHZ_XTAL (1)