BOARD_DIR - custom location

[iot49]

How do I compile micropython for a custom board specification located in a folder different from ports/esp32/boards?

I've created a custom spec. When I copy it to ports/esp32/boards in a micropython clone and compile with make BOARD=ESP32_S3_WROOM_1_N16R8, everything works as expected.

This

export BOARD=ESP32_S3_WROOM_1_N16R8
export BOARD_DIR= /project/custom/boards/
make V=1 BOARD_DIR=$(BOARD_DIR) BOARD=$(BOARD)

results in the following error:

CMake Error at CMakeLists.txt:19 (message):
  Invalid MICROPY_BOARD specified: ESP32_S3_WROOM_1_N16R8

[andrewleech]

Try:

export BOARD="ESP32_S3_WROOM_1_N16R8"
export BOARD_DIR="/project/custom/boards/${BOARD}"
make V=1 BOARD_DIR=${BOARD_DIR} BOARD=${BOARD}

[andrewleech]

Oh yeah ok esp32 can be a bit tricky with these things because cmake is weird and difficult.

That example project has nice simple makefiles to run against in the other boards but the esp32 one isn't so obvious.

With that example:

cd micropython-example-boards
cd boards/CUSTOM_ESP32
idf.py build

[iot49]

Thanks!

Next issue - when compiling for an S3. I've checked out the lib/tinyusb module, but it still won't find tinyusb.h. Perhaps a -I directive needs to be added - somewhere. Would you know?

Error message:

[1217/1269] Building C object esp-idf/main/CMakeFiles/__idf_main.dir/project/lib/micropython/ports/esp32/usb.c.obj
FAILED: esp-idf/main/CMakeFiles/__idf_main.dir/project/lib/micropython/ports/esp32/usb.c.obj 
ccache /opt/esp/tools/xtensa-esp32s3-elf/esp-2022r1-11.2.0/xtensa-esp32s3-elf/bin/xtensa-esp32s3-elf-gcc -DFFCONF_H=\"/project/lib/micropython/lib/oofatfs/ffconf.h\" -DLFS1_NO_ASSERT -DLFS1_NO_DEBUG -DLFS1_NO_ERROR -DLFS1_NO_MALLOC -DLFS1_NO_WARN -DLFS2_NO_ASSERT -DLFS2_NO_DEBUG -DLFS2_NO_ERROR -DLFS2_NO_MALLOC -DLFS2_NO_WARN -DMBEDTLS_CONFIG_FILE=\"mbedtls/esp_config.h\" -DMICROPY_ESP_IDF_4=1 -DMICROPY_MODULE_FROZEN_MPY="(1)" -DMICROPY_PY_BTREE=1 -DMICROPY_QSTR_EXTRA_POOL=mp_qstr_frozen_const_pool -DMICROPY_VFS_FAT=1 -DMICROPY_VFS_LFS2=1 -DSOC_MMU_PAGE_SIZE=CONFIG_MMU_PAGE_SIZE -D__DBINTERFACE_PRIVATE=1 -Dvirt_fd_t="void*" -I/project/boards/ESP32_S3_WROOM_1_N16R8/build/config -I/project/lib/micropython -I/project/lib/micropython/lib/berkeley-db-1.xx/PORT/include -I/project/src/cmodules/cexample -I/project/src/cmodules/cexample2 -I/project/src/modules/esp32can -I/project/lib/micropython/ports/esp32 -I/project/boards/ESP32_S3_WROOM_1_N16R8 -I/project/boards/ESP32_S3_WROOM_1_N16R8/build -I/opt/esp/idf/components/bt/host/nimble/nimble -I/opt/esp/idf/components/newlib/platform_include -I/opt/esp/idf/components/freertos/FreeRTOS-Kernel/include -I/opt/esp/idf/components/freertos/esp_additions/include/freertos -I/opt/esp/idf/components/freertos/FreeRTOS-Kernel/portable/xtensa/include -I/opt/esp/idf/components/freertos/esp_additions/include -I/opt/esp/idf/components/esp_hw_support/include -I/opt/esp/idf/components/esp_hw_support/include/soc -I/opt/esp/idf/components/esp_hw_support/include/soc/esp32s3 -I/opt/esp/idf/components/esp_hw_support/port/esp32s3/. -I/opt/esp/idf/components/esp_hw_support/port/esp32s3/private_include -I/opt/esp/idf/components/heap/include -I/opt/esp/idf/components/log/include -I/opt/esp/idf/components/soc/include -I/opt/esp/idf/components/soc/esp32s3/. -I/opt/esp/idf/components/soc/esp32s3/include -I/opt/esp/idf/components/hal/esp32s3/include -I/opt/esp/idf/components/hal/include -I/opt/esp/idf/components/hal/platform_port/include -I/opt/esp/idf/components/esp_rom/include -I/opt/esp/idf/components/esp_rom/include/esp32s3 -I/opt/esp/idf/components/esp_rom/esp32s3 -I/opt/esp/idf/components/esp_common/include -I/opt/esp/idf/components/esp_system/include -I/opt/esp/idf/components/esp_system/port/soc -I/opt/esp/idf/components/esp_system/port/include/private -I/opt/esp/idf/components/xtensa/include -I/opt/esp/idf/components/xtensa/esp32s3/include -I/opt/esp/idf/components/lwip/include -I/opt/esp/idf/components/lwip/include/apps -I/opt/esp/idf/components/lwip/include/apps/sntp -I/opt/esp/idf/components/lwip/lwip/src/include -I/opt/esp/idf/components/lwip/port/esp32/include -I/opt/esp/idf/components/lwip/port/esp32/include/arch -I/opt/esp/idf/components/app_update/include -I/opt/esp/idf/components/bootloader_support/include -I/opt/esp/idf/components/bootloader_support/bootloader_flash/include -I/opt/esp/idf/components/esp_app_format/include -I/opt/esp/idf/components/esp_partition/include -I/opt/esp/idf/components/bt/include/esp32c3/include -I/opt/esp/idf/components/bt/common/osi/include -I/opt/esp/idf/components/bt/common/api/include/api -I/opt/esp/idf/components/bt/common/btc/profile/esp/blufi/include -I/opt/esp/idf/components/bt/common/btc/profile/esp/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/ans/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/bas/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/dis/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/gap/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/gatt/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/htp/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/ias/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/ipss/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/lls/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/services/tps/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/util/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/store/ram/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/host/store/config/include -I/opt/esp/idf/components/bt/porting/include -I/opt/esp/idf/components/bt/host/nimble/nimble/porting/nimble/include -I/opt/esp/idf/components/bt/host/nimble/port/include -I/opt/esp/idf/components/bt/host/nimble/nimble/porting/npl/freertos/include -I/opt/esp/idf/components/bt/host/nimble/nimble/nimble/include -I/opt/esp/idf/components/bt/host/nimble/esp-hci/include -I/opt/esp/idf/components/esp_timer/include -I/opt/esp/idf/components/esp_wifi/include -I/opt/esp/idf/components/esp_event/include -I/opt/esp/idf/components/esp_phy/include -I/opt/esp/idf/components/esp_phy/esp32s3/include -I/opt/esp/idf/components/esp_netif/include -I/opt/esp/idf/components/driver/include -I/opt/esp/idf/components/driver/deprecated -I/opt/esp/idf/components/driver/esp32s3/include -I/opt/esp/idf/components/esp_pm/include -I/opt/esp/idf/components/esp_ringbuf/include -I/opt/esp/idf/components/esp_adc/include -I/opt/esp/idf/components/esp_adc/interface -I/opt/esp/idf/components/esp_adc/esp32s3/include -I/opt/esp/idf/components/esp_adc/deprecated/include -I/opt/esp/idf/components/esp_eth/include -I/opt/esp/idf/components/esp_psram/include -I/opt/esp/idf/components/mbedtls/port/include -I/opt/esp/idf/components/mbedtls/mbedtls/include -I/opt/esp/idf/components/mbedtls/mbedtls/library -I/opt/esp/idf/components/mbedtls/esp_crt_bundle/include -I/opt/esp/idf/components/nvs_flash/include -I/opt/esp/idf/components/sdmmc/include -I/opt/esp/idf/components/spi_flash/include -I/opt/esp/idf/components/ulp/ulp_common/include -I/opt/esp/idf/components/ulp/ulp_common/include/esp32s3 -I/opt/esp/idf/components/ulp/ulp_fsm/include -I/opt/esp/idf/components/ulp/ulp_fsm/include/esp32s3 -I/opt/esp/idf/components/vfs/include -I/project/boards/ESP32_S3_WROOM_1_N16R8/managed_components/espressif__mdns/include -I/opt/esp/idf/components/console -mlongcalls  -fdiagnostics-color=always -ffunction-sections -fdata-sections -Wall -Werror=all -Wno-error=unused-function -Wno-error=unused-variable -Wno-error=deprecated-declarations -Wextra -Wno-unused-parameter -Wno-sign-compare -Wno-enum-conversion -gdwarf-4 -ggdb -O2 -fmacro-prefix-map=/project/boards/ESP32_S3_WROOM_1_N16R8=. -fmacro-prefix-map=/opt/esp/idf=/IDF -fstrict-volatile-bitfields -Wno-error=unused-but-set-variable -fno-jump-tables -fno-tree-switch-conversion -DconfigENABLE_FREERTOS_DEBUG_OCDAWARE=1 -std=gnu17 -Wno-old-style-declaration -D_GNU_SOURCE -DIDF_VER=\"v5.0.4\" -DESP_PLATFORM -DNDEBUG -D_POSIX_READER_WRITER_LOCKS -Wno-clobbered -Wno-deprecated-declarations -Wno-missing-field-initializers -MD -MT esp-idf/main/CMakeFiles/__idf_main.dir/project/lib/micropython/ports/esp32/usb.c.obj -MF esp-idf/main/CMakeFiles/__idf_main.dir/project/lib/micropython/ports/esp32/usb.c.obj.d -o esp-idf/main/CMakeFiles/__idf_main.dir/project/lib/micropython/ports/esp32/usb.c.obj -c /project/lib/micropython/ports/esp32/usb.c
/project/lib/micropython/ports/esp32/usb.c:35:10: fatal error: tinyusb.h: No such file or directory
   35 | #include "tinyusb.h"
      |          ^~~~~~~~~~~
compilation terminated.

[andrewleech]

Is this with your custom board? I'm pretty sure esp idf uses its own copy of tinyusb, not the one in lib. It only uses it / adds it to include path if it's enabled in the build configuration properly eg.

micropython/ports/esp32/boards/ESP32_GENERIC_S3/mpconfigboard.cmake

Line 6 in 5114f2c

boards/sdkconfig.usb

[iot49]

Turns out that the idf (docker) I am using does not load tinyusb by default. Adding the following statement

idf.py add-dependency espressif/esp_tinyusb

before idf.py build solves the problem.

For posteriority, I am including my configuration here.

Makefile:

# board specifiation (in boards/ directory)
BOARD=ESP32_S3_WROOM_1_N16R8
BOARD_DIR=/project/boards/$(BOARD)

.PHONY: build submodules

build: submodules
	make -C lib/micropython/mpy-cross
	docker run --rm \
		-v .:/project \
		-w /project espressif/idf:v5.0.4 \
		bash -c " \
			make -C lib/micropython/ports/esp32 submodules; \
			rm -rf $(BOARD_DIR)/build; \
			rm -rf $(BOARD_DIR)/managed_components; \
			cd $(BOARD_DIR); \
			idf.py add-dependency espressif/esp_tinyusb; \
			idf.py build"

submodules:
	git submodule update --init lib/micropython
	cd lib/micropython; git submodule update --init lib/berkeley-db-1.xx # lib/tinyusb

mpconfigboard.cmake: (modified SDKCONFIG_DEFAULTS to load custom configuration which loads custom partition table; there may be a simpler solution for this that I am not aware of)

# Define the chip variant.
set(IDF_TARGET esp32s3)

# Set the sdkconfig fragments.
set(SDKCONFIG_DEFAULTS
    ${MICROPY_PORT_DIR}/boards/sdkconfig.base
    ${MICROPY_PORT_DIR}/boards/sdkconfig.usb
    ${MICROPY_PORT_DIR}/boards/sdkconfig.ble
    ${MICROPY_PORT_DIR}/boards/sdkconfig.240mhz
    ${MICROPY_PORT_DIR}/boards/sdkconfig.spiram_sx
    ${MICROPY_PORT_DIR}/boards/sdkconfig.spiram_oct
    ${PROJECT_DIR}/boards/ESP32_S3_WROOM_1_N16R8/sdkconfig.board
)

# Set the user C modules to include in the build.
set(USER_C_MODULES
    ${PROJECT_DIR}/src/cmodules/cexample/micropython.cmake
    ${PROJECT_DIR}/src/cmodules/cexample2/micropython.cmake
    ${PROJECT_DIR}/src/modules/micropython.cmake
)

# Set the manifest file for frozen Python code.
set(MICROPY_FROZEN_MANIFEST ${MICROPY_BOARD_DIR}/manifest.py)

sdkconfig.board:

CONFIG_ESPTOOLPY_FLASHMODE_QIO=y
CONFIG_ESPTOOLPY_FLASHFREQ_80M=y
CONFIG_ESPTOOLPY_AFTER_NORESET=y

CONFIG_ESPTOOLPY_FLASHSIZE_4MB=
CONFIG_ESPTOOLPY_FLASHSIZE_8MB=
CONFIG_ESPTOOLPY_FLASHSIZE_16MB=y
CONFIG_SPIRAM_MEMTEST=
CONFIG_PARTITION_TABLE_CUSTOM=y
CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions-S3-N16-custom.csv"

CONFIG_LWIP_LOCAL_HOSTNAME="leaf49"

CONFIG_TINYUSB_DESC_CUSTOM_VID=0x303A
CONFIG_TINYUSB_DESC_CUSTOM_PID=0x80D4
CONFIG_TINYUSB_DESC_BCD_DEVICE=0x0100
CONFIG_TINYUSB_DESC_MANUFACTURER_STRING="leaf49"
CONFIG_TINYUSB_DESC_PRODUCT_STRING="leaf49"
CONFIG_TINYUSB_DESC_SERIAL_STRING="_leaf49_"

partitions-S3-N16-custom.csv:

# Partition table for MicroPython with OTA support using 16MB flash
# Notes: the offset of the partition table itself is set in
# $IDF_PATH/components/partition_table/Kconfig.projbuild.
# Name,   Type, SubType, Offset,   Size,     Flags
nvs,      data, nvs,     0x9000,   0x4000,
otadata,  data, ota,     0xd000,   0x2000,
phy_init, data, phy,     0xf000,   0x1000,
ota_0,    app,  ota_0,   0x10000,  0x270000,
ota_1,    app,  ota_1,   0x280000, 0x270000,
vfs,      data, fat,     0x4f0000, 0x310000,
data,     data, undefined,  ,      0x800000,