Add support for M5Stack M5Paper

locale/circuitpython.pot

@@ -2377,6 +2377,10 @@ msgstr ""
 msgid "You pressed button A at start up."
 msgstr ""
 
+#: ports/espressif/boards/m5stack_m5paper/mpconfigboard.h
+msgid "You pressed button DOWN at start up."
+msgstr ""
+
 #: supervisor/shared/safe_mode.c
 msgid "You pressed the BOOT button at start up"
 msgstr ""

ports/espressif/boards/m5stack_m5paper/board.c

@@ -0,0 +1,100 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 fonix232
+ *
+ * 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 "mpconfigboard.h"
+#include "shared-bindings/busio/SPI.h"
+#include "shared-bindings/displayio/FourWire.h"
+#include "shared-bindings/microcontroller/Pin.h"
+#include "shared-module/displayio/__init__.h"
+#include "shared-bindings/board/__init__.h"
+
+
+const uint8_t display_start_sequence[] = { };
+
+const uint8_t display_stop_sequence[] = { };
+
+const uint8_t display_refresh_sequence[] = { };
+
+
+void board_init(void) {
+
+    // TODO: Investigate how to initialise display
+
+    // // Set up the SPI object used to control the display
+    // busio_spi_obj_t *spi = common_hal_board_create_spi(0);
+    // common_hal_busio_spi_never_reset(spi);
+
+    // // Set up the DisplayIO pin object
+    // displayio_fourwire_obj_t *bus = &allocate_display_bus()->fourwire_bus;
+    // bus->base.type = &displayio_fourwire_type;
+    // common_hal_displayio_fourwire_construct(bus,
+    //     spi,
+    //     &pin_GPIO20, // EPD_DC Command or data
+    //     &pin_GPIO15, // EPD_CS Chip select
+    //     &pin_GPIO23, // EPD_RST Reset
+    //     1200000, // Baudrate
+    //     0, // Polarity
+    //     0); // Phase
+
+    // displayio_epaperdisplay_obj_t *display = &allocate_display()->epaper_display;
+    // display->base.type = &displayio_epaperdisplay_type;
+
+    // common_hal_displayio_epaperdisplay_construct(
+    //     display,
+    //     bus,
+    //     display_start_sequence, sizeof(display_start_sequence),
+    //     1.0, // start up time
+    //     display_stop_sequence, sizeof(display_stop_sequence),
+    //     540,  // width
+    //     960,  // height
+    //     540,  // ram_width
+    //     960,  // ram_height
+    //     0,  // colstart
+    //     0,  // rowstart
+    //     90,  // rotation
+    //     NO_COMMAND,  // set_column_window_command
+    //     NO_COMMAND,  // set_row_window_command
+    //     NO_COMMAND,  // set_current_column_command
+    //     NO_COMMAND,  // set_current_row_command
+    //     NO_COMMAND,  // write_black_ram_command
+    //     false,  // black_bits_inverted
+    //     NO_COMMAND,  // write_color_ram_command
+    //     false,  // color_bits_inverted
+    //     0x000000,  // highlight_color
+    //     refresh_sequence, sizeof(refresh_sequence),
+    //     28.0,  // refresh_time
+    //     &pin_GPIO27,  // busy_pin
+    //     false,  // busy_state
+    //     30.0, // seconds_per_frame
+    //     false,  // always_toggle_chip_select
+    //     false, // grayscale
+    //     true, // acep
+    //     false,  // two_byte_sequence_length
+    //     false  // address_little_endian
+    // );
+}

ports/espressif/boards/m5stack_m5paper/mpconfigboard.h

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2023 fonix232
+ *
+ * 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.
+ */
+
+// Micropython setup
+
+#define MICROPY_HW_BOARD_NAME       "M5Stack M5Paper"
+#define MICROPY_HW_MCU_NAME         "ESP32"
+
+#define CIRCUITPY_BOARD_I2C         (2)
+#define CIRCUITPY_BOARD_I2C_PIN     {{.scl = &pin_GPIO22, .sda = &pin_GPIO21}, \
+                                     {.scl = &pin_GPIO32, .sda = &pin_GPIO25}}
+
+#define CIRCUITPY_BOARD_SPI         (1)
+#define CIRCUITPY_BOARD_SPI_PIN     {{.clock = &pin_GPIO14, .mosi = &pin_GPIO12, .miso = &pin_GPIO13}}
+
+#define CIRCUITPY_BOARD_UART        (1)
+#define CIRCUITPY_BOARD_UART_PIN    {{.tx = &pin_GPIO19, .rx = &pin_GPIO18}}
+
+// For entering safe mode
+#define CIRCUITPY_BOOT_BUTTON       (&pin_GPIO39)
+
+// Explanation of how a user got into safe mode
+#define BOARD_USER_SAFE_MODE_ACTION translate("You pressed button DOWN at start up.")
+
+// UART pins attached to the USB-serial converter chip
+#define CIRCUITPY_CONSOLE_UART_TX (&pin_GPIO1)
+#define CIRCUITPY_CONSOLE_UART_RX (&pin_GPIO3)

ports/espressif/boards/m5stack_m5paper/mpconfigboard.mk

@@ -0,0 +1,9 @@
+CIRCUITPY_CREATOR_ID =  0x10151015
+CIRCUITPY_CREATION_ID = 0x0032000B
+
+IDF_TARGET = esp32
+
+CIRCUITPY_ESP_FLASH_MODE = qio
+CIRCUITPY_ESP_FLASH_FREQ = 80m
+CIRCUITPY_ESP_FLASH_SIZE = 16MB
+CIRCUITPY_ESPCAMERA = 0

ports/espressif/boards/m5stack_m5paper/pins.c

@@ -0,0 +1,78 @@
+#include "shared-bindings/board/__init__.h"
+#include "shared-module/displayio/__init__.h"
+
+CIRCUITPY_BOARD_BUS_SINGLETON(porta_i2c, i2c, 1)
+
+STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
+    CIRCUITPYTHON_BOARD_DICT_STANDARD_ITEMS
+
+    // Power MAIN
+    { MP_ROM_QSTR(MP_QSTR_POWER_MAIN), MP_ROM_PTR(&pin_GPIO2) },
+
+    // sd card
+    { MP_ROM_QSTR(MP_QSTR_SD_CS), MP_ROM_PTR(&pin_GPIO4) },
+
+    // Power EXT - Controls 5V rail on Port A, B and C
+    { MP_ROM_QSTR(MP_QSTR_POWER_EXT), MP_ROM_PTR(&pin_GPIO5) },
+
+    // SPI Internal
+    { MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(&pin_GPIO12) },
+    { MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(&pin_GPIO13) },
+    { MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(&pin_GPIO14) },
+
+    // IT8951
+    { MP_ROM_QSTR(MP_QSTR_IT8951_CS), MP_ROM_PTR(&pin_GPIO15) },
+    { MP_ROM_QSTR(MP_QSTR_IT8951_RESET), MP_ROM_PTR(&pin_GPIO23) },
+    { MP_ROM_QSTR(MP_QSTR_IT8951_POWER), MP_ROM_PTR(&pin_GPIO23) },
+    { MP_ROM_QSTR(MP_QSTR_IT8951_BUSY), MP_ROM_PTR(&pin_GPIO27) },
+
+    // Port C - UART Mode - External pins
+    { MP_ROM_QSTR(MP_QSTR_PORTC_RX), MP_ROM_PTR(&pin_GPIO18) },
+    { MP_ROM_QSTR(MP_QSTR_RX2), MP_ROM_PTR(&pin_GPIO18) },
+    { MP_ROM_QSTR(MP_QSTR_D18), MP_ROM_PTR(&pin_GPIO18) },
+
+    { MP_ROM_QSTR(MP_QSTR_PORTC_TX), MP_ROM_PTR(&pin_GPIO19) },
+    { MP_ROM_QSTR(MP_QSTR_TX2), MP_ROM_PTR(&pin_GPIO19) },
+    { MP_ROM_QSTR(MP_QSTR_D19), MP_ROM_PTR(&pin_GPIO19) },
+
+    // I2C
+    { MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_GPIO21) },
+    { MP_ROM_QSTR(MP_QSTR_D21), MP_ROM_PTR(&pin_GPIO21) },
+
+    { MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_GPIO22) },
+    { MP_ROM_QSTR(MP_QSTR_D22), MP_ROM_PTR(&pin_GPIO22) },
+
+    // Port A - I2C Mode - External pins
+    { MP_ROM_QSTR(MP_QSTR_PORTA_SDA), MP_ROM_PTR(&pin_GPIO25) },
+    { MP_ROM_QSTR(MP_QSTR_D25), MP_ROM_PTR(&pin_GPIO25) },
+
+    { MP_ROM_QSTR(MP_QSTR_PORTA_SCL), MP_ROM_PTR(&pin_GPIO32) },
+    { MP_ROM_QSTR(MP_QSTR_D32), MP_ROM_PTR(&pin_GPIO32) },
+
+    // Port B - Generic I/O Mode - External pins
+    { MP_ROM_QSTR(MP_QSTR_PORTB_IN), MP_ROM_PTR(&pin_GPIO26) },
+    { MP_ROM_QSTR(MP_QSTR_D26), MP_ROM_PTR(&pin_GPIO26) },
+
+    { MP_ROM_QSTR(MP_QSTR_PORTB_OUT), MP_ROM_PTR(&pin_GPIO33) },
+    { MP_ROM_QSTR(MP_QSTR_D33), MP_ROM_PTR(&pin_GPIO33) },
+
+    // Battery voltage
+    { MP_ROM_QSTR(MP_QSTR_BATTERY_VOLTAGE), MP_ROM_PTR(&pin_GPIO35) },
+
+    // Touch
+    { MP_ROM_QSTR(MP_QSTR_TOUCH_INT), MP_ROM_PTR(&pin_GPIO36) },
+
+    // buttons
+    { MP_ROM_QSTR(MP_QSTR_BTN_UP), MP_ROM_PTR(&pin_GPIO37) },
+    { MP_ROM_QSTR(MP_QSTR_BTN_CENTER), MP_ROM_PTR(&pin_GPIO38) },
+    { MP_ROM_QSTR(MP_QSTR_BTN_DOWN), MP_ROM_PTR(&pin_GPIO39) },
+
+
+    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
+    { MP_ROM_QSTR(MP_QSTR_PORTA_I2C), MP_ROM_PTR(&board_porta_i2c_obj) },
+    { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
+    { MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
+
+    { MP_ROM_QSTR(MP_QSTR_DISPLAY), MP_ROM_PTR(&displays[0].display)}
+};
+MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);

ports/espressif/boards/m5stack_m5paper/sdkconfig

@@ -0,0 +1,58 @@
+CONFIG_ESP32_ECO3_CACHE_LOCK_FIX=y
+CONFIG_ESP32_SPIRAM_SUPPORT=y
+CONFIG_ESP32_REV_MIN_3=y
+
+#
+# SPI RAM config
+#
+CONFIG_SPIRAM_TYPE_AUTO=y
+# CONFIG_SPIRAM_TYPE_ESPPSRAM16 is not set
+# CONFIG_SPIRAM_TYPE_ESPPSRAM32 is not set
+#CONFIG_SPIRAM_TYPE_ESPPSRAM64 is not set
+CONFIG_SPIRAM_SIZE=8388608
+# end of SPI RAM config
+
+#
+# PSRAM clock and cs IO for ESP32
+#
+CONFIG_D0WD_PSRAM_CLK_IO=17
+CONFIG_D0WD_PSRAM_CS_IO=16
+# end of PSRAM clock and cs IO for ESP32
+
+# CONFIG_SPIRAM_FETCH_INSTRUCTIONS is not set
+# CONFIG_SPIRAM_RODATA is not set
+CONFIG_SPIRAM_SPEED_80M=y
+# CONFIG_SPIRAM_SPEED_40M is not set
+# CONFIG_SPIRAM_SPEED_26M is not set
+# CONFIG_SPIRAM_SPEED_20M is not set
+CONFIG_SPIRAM=y
+CONFIG_SPIRAM_BOOT_INIT=y
+# CONFIG_SPIRAM_IGNORE_NOTFOUND is not set
+CONFIG_SPIRAM_USE_MEMMAP=y
+# CONFIG_SPIRAM_USE_CAPS_ALLOC is not set
+# CONFIG_SPIRAM_USE_MALLOC is not set
+CONFIG_SPIRAM_MEMTEST=y
+# CONFIG_SPIRAM_ALLOW_BSS_SEG_EXTERNAL_MEMORY is not set
+#
+# LWIP
+#
+CONFIG_LWIP_LOCAL_HOSTNAME="M5Paper"
+# end of LWIP
+
+# Uncomment (remove ###) to send ESP_LOG  output to TX/RX pins
+### #
+### # ESP System Settings
+### #
+### CONFIG_ESP_SYSTEM_PANIC_PRINT_HALT=y
+### # CONFIG_ESP_SYSTEM_PANIC_SILENT_REBOOT is not set
+### CONFIG_ESP_CONSOLE_UART_CUSTOM=y
+### CONFIG_ESP_CONSOLE_NONE is not set
+### CONFIG_ESP_CONSOLE_UART=y
+### CONFIG_ESP_CONSOLE_UART_CUSTOM_NUM_0=y
+### # CONFIG_ESP_CONSOLE_UART_CUSTOM_NUM_1 is not set
+### CONFIG_ESP_CONSOLE_UART_NUM=0
+### CONFIG_ESP_CONSOLE_UART_TX_GPIO=17
+### CONFIG_ESP_CONSOLE_UART_RX_GPIO=16
+### CONFIG_ESP_CONSOLE_UART_BAUDRATE=115200
+### # CONFIG_ESP_SYSTEM_CHECK_INT_LEVEL_5 is not set
+### # end of ESP System Settings