From 318ea7c8cb8ac49a741d58f60947d68a9c921909 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Thu, 26 Aug 2021 16:04:43 -0500 Subject: [PATCH 1/2] Add Espressif's HMI DevKit this is only tested to come up to the REPL & mount CIRCUITPY. Pin assignments should be right but were not double-checked. The screen is unsupported so far. This board depends on the I/O pull ups for the I2C bus (verified by schematic) so this adds a compile time option that enables pull ups for ANY i2c bus on a board. --- .github/workflows/build.yml | 1 + .../boards/espressif_hmi_devkit_1/board.c | 50 ++++++++++++ .../espressif_hmi_devkit_1/mpconfigboard.h | 47 +++++++++++ .../espressif_hmi_devkit_1/mpconfigboard.mk | 17 ++++ .../boards/espressif_hmi_devkit_1/pins.c | 78 +++++++++++++++++++ .../boards/espressif_hmi_devkit_1/sdkconfig | 33 ++++++++ ports/esp32s2/common-hal/busio/I2C.c | 12 ++- ports/esp32s2/mpconfigport.h | 9 +++ 8 files changed, 246 insertions(+), 1 deletion(-) create mode 100644 ports/esp32s2/boards/espressif_hmi_devkit_1/board.c create mode 100644 ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.h create mode 100644 ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk create mode 100644 ports/esp32s2/boards/espressif_hmi_devkit_1/pins.c create mode 100644 ports/esp32s2/boards/espressif_hmi_devkit_1/sdkconfig diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a29a702d87..10468a7da8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -509,6 +509,7 @@ jobs: - "atmegazero_esp32s2" - "crumpspace_crumps2" - "electroniccats_bastwifi" + - "espressif_hmi_devkit_1" - "espressif_kaluga_1" - "espressif_kaluga_1.3" - "espressif_saola_1_wroom" diff --git a/ports/esp32s2/boards/espressif_hmi_devkit_1/board.c b/ports/esp32s2/boards/espressif_hmi_devkit_1/board.c new file mode 100644 index 0000000000..ff5d9cfb6c --- /dev/null +++ b/ports/esp32s2/boards/espressif_hmi_devkit_1/board.c @@ -0,0 +1,50 @@ +/* + * This file is part of the MicroPython project, http://micropython.org/ + * + * The MIT License (MIT) + * + * Copyright (c) 2020 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 "mpconfigboard.h" +#include "shared-bindings/microcontroller/Pin.h" + +void board_init(void) { + // USB + common_hal_never_reset_pin(&pin_GPIO19); + common_hal_never_reset_pin(&pin_GPIO20); + + // Debug UART + common_hal_never_reset_pin(&pin_GPIO43); + common_hal_never_reset_pin(&pin_GPIO44); +} + +bool board_requests_safe_mode(void) { + return false; +} + +void reset_board(void) { + +} + +void board_deinit(void) { +} diff --git a/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.h b/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.h new file mode 100644 index 0000000000..9379c015b2 --- /dev/null +++ b/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.h @@ -0,0 +1,47 @@ +/* + * This file is part of the MicroPython project, http://micropython.org/ + * + * The MIT License (MIT) + * + * Copyright (c) 2019 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. + */ + +// Micropython setup + +#define MICROPY_HW_BOARD_NAME "HMI-DevKit-1.1" +#define MICROPY_HW_MCU_NAME "ESP32S2" + +#define MICROPY_HW_NEOPIXEL (&pin_GPIO21) + +#define CIRCUITPY_BOOT_BUTTON (&pin_GPIO0) + +#define BOARD_USER_SAFE_MODE_ACTION translate("pressing boot button at start up.\n") + +#define AUTORESET_DELAY_MS 500 + +#define DEFAULT_I2C_BUS_SCL (&pin_GPIO39) +#define DEFAULT_I2C_BUS_SDA (&pin_GPIO40) + +#define DEFAULT_SPI_BUS_SCK (&pin_GPIO36) +#define DEFAULT_SPI_BUS_MOSI (&pin_GPIO35) +#define DEFAULT_SPI_BUS_MISO (&pin_GPIO37) + +#define CIRCUITPY_I2C_ALLOW_INTERNAL_PULL_UP (1) diff --git a/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk b/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk new file mode 100644 index 0000000000..a7542e9ae8 --- /dev/null +++ b/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk @@ -0,0 +1,17 @@ +USB_VID = 0x303A +USB_PID = 0x80B9 +USB_PRODUCT = "ESP32-S2-HMI-DevKit-1" +USB_MANUFACTURER = "Espressif" + +INTERNAL_FLASH_FILESYSTEM = 1 +LONGINT_IMPL = MPZ + +# The default queue depth of 16 overflows on release builds, +# so increase it to 32. +CFLAGS += -DCFG_TUD_TASK_QUEUE_SZ=32 + +CIRCUITPY_ESP_FLASH_MODE=dio +CIRCUITPY_ESP_FLASH_FREQ=80m +CIRCUITPY_ESP_FLASH_SIZE=4MB + +CIRCUITPY_MODULE=wrover diff --git a/ports/esp32s2/boards/espressif_hmi_devkit_1/pins.c b/ports/esp32s2/boards/espressif_hmi_devkit_1/pins.c new file mode 100644 index 0000000000..1b4779f374 --- /dev/null +++ b/ports/esp32s2/boards/espressif_hmi_devkit_1/pins.c @@ -0,0 +1,78 @@ +#include "py/objtuple.h" +#include "shared-bindings/board/__init__.h" + +STATIC const mp_rom_obj_tuple_t lcd_data_tuple = { + {&mp_type_tuple}, + 8, + { + MP_ROM_PTR(&pin_GPIO1), + MP_ROM_PTR(&pin_GPIO10), + MP_ROM_PTR(&pin_GPIO2), + MP_ROM_PTR(&pin_GPIO11), + MP_ROM_PTR(&pin_GPIO3), + MP_ROM_PTR(&pin_GPIO12), + MP_ROM_PTR(&pin_GPIO4), + MP_ROM_PTR(&pin_GPIO13), + MP_ROM_PTR(&pin_GPIO5), + MP_ROM_PTR(&pin_GPIO14), + MP_ROM_PTR(&pin_GPIO6), + MP_ROM_PTR(&pin_GPIO15), + MP_ROM_PTR(&pin_GPIO7), + MP_ROM_PTR(&pin_GPIO16), + MP_ROM_PTR(&pin_GPIO8), + MP_ROM_PTR(&pin_GPIO17), + } +}; + +STATIC const mp_rom_map_elem_t board_global_dict_table[] = { + { MP_ROM_QSTR(MP_QSTR_NEOPIXEL), MP_ROM_PTR(&pin_GPIO45) }, + { MP_ROM_QSTR(MP_QSTR_LCD_RS), MP_ROM_PTR(&pin_GPIO38) }, + + // LCD + { MP_ROM_QSTR(MP_QSTR_LCD_DATA), MP_ROM_PTR(&lcd_data_tuple) }, + { MP_ROM_QSTR(MP_QSTR_LCD_WR), MP_ROM_PTR(&pin_GPIO33) }, + { MP_ROM_QSTR(MP_QSTR_LCD_RS), MP_ROM_PTR(&pin_GPIO38) }, + + // SPI and SD + { MP_ROM_QSTR(MP_QSTR_CS_SD), MP_ROM_PTR(&pin_GPIO34) }, + { MP_ROM_QSTR(MP_QSTR_CS_CNN), MP_ROM_PTR(&pin_GPIO45) }, + { MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(DEFAULT_SPI_BUS_MISO) }, + { MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(DEFAULT_SPI_BUS_MOSI) }, + { MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(DEFAULT_SPI_BUS_SCK) }, + { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) }, + + // I2C + { MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(DEFAULT_I2C_BUS_SCL) }, + { MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(DEFAULT_I2C_BUS_SDA) }, + { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) }, + + // canbus (TWAI) + { MP_ROM_QSTR(MP_QSTR_CAN_RX), MP_ROM_PTR(&pin_GPIO41) }, + { MP_ROM_QSTR(MP_QSTR_CAN_TX), MP_ROM_PTR(&pin_GPIO42) }, + + // Audio + { MP_ROM_QSTR(MP_QSTR_MIC_ADC_M), MP_ROM_PTR(&pin_GPIO9) }, + { MP_ROM_QSTR(MP_QSTR_DAC_OUT), MP_ROM_PTR(&pin_GPIO18) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_SPI_MISO), MP_ROM_PTR(&pin_GPIO42) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_SPI_MOSI), MP_ROM_PTR(&pin_GPIO40) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_SPI_SCK), MP_ROM_PTR(&pin_GPIO38) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_SPI_CS), MP_ROM_PTR(&pin_GPIO33) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_BT_ADC), MP_ROM_PTR(&pin_GPIO6) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_SCL), MP_ROM_PTR(&pin_GPIO7) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_SDA), MP_ROM_PTR(&pin_GPIO8) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S0_MCLK), MP_ROM_PTR(&pin_GPIO41) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S0_BCLK), MP_ROM_PTR(&pin_GPIO39) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S0_LRCK), MP_ROM_PTR(&pin_GPIO21) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S0_SDI), MP_ROM_PTR(&pin_GPIO1) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S0_SDO), MP_ROM_PTR(&pin_GPIO3) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_RST), MP_ROM_PTR(&pin_GPIO5) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_WAKE_INT), MP_ROM_PTR(&pin_GPIO46) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S1_MCLK), MP_ROM_PTR(&pin_GPIO35) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_PA_CTRL), MP_ROM_PTR(&pin_GPIO10) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S1_SDI), MP_ROM_PTR(&pin_GPIO34) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S1_SDO), MP_ROM_PTR(&pin_GPIO12) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S1_LRCK_DAC1), MP_ROM_PTR(&pin_GPIO17) }, + { MP_ROM_QSTR(MP_QSTR_AUDIO_I2S1_BCLK_DAC2), MP_ROM_PTR(&pin_GPIO18) }, + +}; +MP_DEFINE_CONST_DICT(board_module_globals, board_global_dict_table); diff --git a/ports/esp32s2/boards/espressif_hmi_devkit_1/sdkconfig b/ports/esp32s2/boards/espressif_hmi_devkit_1/sdkconfig new file mode 100644 index 0000000000..9d8bbde967 --- /dev/null +++ b/ports/esp32s2/boards/espressif_hmi_devkit_1/sdkconfig @@ -0,0 +1,33 @@ +CONFIG_ESP32S2_SPIRAM_SUPPORT=y + +# +# SPI RAM config +# +# CONFIG_SPIRAM_TYPE_AUTO is not set +CONFIG_SPIRAM_TYPE_ESPPSRAM16=y +# CONFIG_SPIRAM_TYPE_ESPPSRAM32 is not set +# CONFIG_SPIRAM_TYPE_ESPPSRAM64 is not set +CONFIG_SPIRAM_SIZE=2097152 + +# +# PSRAM clock and cs IO for ESP32S2 +# +CONFIG_DEFAULT_PSRAM_CLK_IO=30 +CONFIG_DEFAULT_PSRAM_CS_IO=26 +# end of PSRAM clock and cs IO for ESP32S2 + +# CONFIG_SPIRAM_FETCH_INSTRUCTIONS is not set +# CONFIG_SPIRAM_RODATA is not set +# CONFIG_SPIRAM_SPEED_80M is not set +CONFIG_SPIRAM_SPEED_40M=y +# 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 +# end of SPI RAM config diff --git a/ports/esp32s2/common-hal/busio/I2C.c b/ports/esp32s2/common-hal/busio/I2C.c index fd887c31ac..be80538582 100644 --- a/ports/esp32s2/common-hal/busio/I2C.c +++ b/ports/esp32s2/common-hal/busio/I2C.c @@ -78,8 +78,13 @@ void common_hal_busio_i2c_construct(busio_i2c_obj_t *self, gpio_pulldown_dis(sda->number); gpio_pulldown_dis(scl->number); + #if CIRCUITPY_I2C_ALLOW_INTERNAL_PULL_UP + gpio_pullup_en(sda->number); + gpio_pullup_en(scl->number); + #endif + // We must pull up within 3us to achieve 400khz. - common_hal_mcu_delay_us(3); + common_hal_mcu_delay_us((1200000 + frequency - 1) / frequency); if (gpio_get_level(sda->number) == 0 || gpio_get_level(scl->number) == 0) { reset_pin_number(sda->number); @@ -112,8 +117,13 @@ void common_hal_busio_i2c_construct(busio_i2c_obj_t *self, .mode = I2C_MODE_MASTER, .sda_io_num = self->sda_pin->number, .scl_io_num = self->scl_pin->number, + #if CIRCUITPY_I2C_ALLOW_INTERNAL_PULL_UP + .sda_pullup_en = GPIO_PULLUP_ENABLE, /*!< Internal GPIO pull mode for I2C sda signal*/ + .scl_pullup_en = GPIO_PULLUP_ENABLE, /*!< Internal GPIO pull mode for I2C scl signal*/ + #else .sda_pullup_en = GPIO_PULLUP_DISABLE, /*!< Internal GPIO pull mode for I2C sda signal*/ .scl_pullup_en = GPIO_PULLUP_DISABLE, /*!< Internal GPIO pull mode for I2C scl signal*/ + #endif .master = { .clk_speed = frequency, diff --git a/ports/esp32s2/mpconfigport.h b/ports/esp32s2/mpconfigport.h index a3db0ab3d5..6a05b474ec 100644 --- a/ports/esp32s2/mpconfigport.h +++ b/ports/esp32s2/mpconfigport.h @@ -46,4 +46,13 @@ #define CIRCUITPY_INTERNAL_NVM_SIZE (20 * 1024) #endif +// Define to (1) in mpconfigboard.h if the board has a defined I2C port that +// lacks pull up resistors (Espressif's HMI Devkit), and the internal pull-up +// resistors will be enabled for all busio.I2C objects. This is only to +// compensate for design decisions that are out of the control of the authors +// of CircuitPython and is not an endorsement of running without appropriate +// external pull up resistors. +#ifndef CIRCUITPY_I2C_ALLOW_INTERNAL_PULL_UP +#define CIRCUITPY_I2C_ALLOW_INTERNAL_PULL_UP (0) +#endif #endif // __INCLUDED_ESP32S2_MPCONFIGPORT_H From 9557ca89f24aec215c5bd01e4b266d9c8d5c2788 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Wed, 1 Sep 2021 10:50:48 -0700 Subject: [PATCH 2/2] Update USB PID --- ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk b/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk index a7542e9ae8..f9dbcfeee3 100644 --- a/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk +++ b/ports/esp32s2/boards/espressif_hmi_devkit_1/mpconfigboard.mk @@ -1,5 +1,5 @@ USB_VID = 0x303A -USB_PID = 0x80B9 +USB_PID = 0x7001 USB_PRODUCT = "ESP32-S2-HMI-DevKit-1" USB_MANUFACTURER = "Espressif"