RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity
faa3727b1f
RIOT/makefiles/tools/esptool.inc.mk

57 lines
1.8 KiB
Makefile
Raw Normal View History

cpu/esp8266: Build the SDK bootloader from source. We had four versions of pre-built bootloaders for the esp8266 with different settings of logging and color logging. These bootloaders were manually built from the SDK and shipped with RIOT-OS source code. However there are more settings that affect the bootloader build that are relevant to the app or final board that uses this bootloader. In particular, flash size and flash speed is important for the bootloader to be able to load an app from a large partition table at the fastest speed supported by the board layout and flash chip. Another example is the UART baudrate of the logging output from the bootloader. The boot ROM will normally start at a baud rate of 74880 (depending on the crystal installed), so it might make sense to keep the UART output at the same speed so we can debug boot modes and bootloader with the same terminal. This patch builds the bootloader.bin file from the ESP8266 SDK source code. The code is built as a module (esp8266_bootloader) which at the moment doesn't generate any object code for the application and only produces a bootloader.bin file set to the BOOTLOADER_BIN make variable for the esptool.inc.mk to flash. The code needs to be compiled and linked with custom rules defined in the module's Makefile since the bootloader.bin is its own separate application. The `BOOTLOADER_BIN` variable is changed from a path relative to the `$(RIOTCPU)/$(CPU)/bin/` directory to be full path. This makes it easier for applications or board to provide their own bootloader binary if needed. As a result of building the bootloader from source we fixed the issue of having a large partition table. Fixes #16402.
2021-05-06 03:00:04 +02:00
# ESP-IDF uses dio as flash mode for esptool.py when qout or qio mode are
# configured to always boot in dual SPI mode
ifneq (,$(filter qout qio,$(FLASH_MODE)))
FLASH_MODE = dio
cpu/esp32: compile bootloader from ESP-IDF v4.4 source
2022-02-01 22:15:47 +01:00
endif
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
dist/tools: rename esptool to esptools to use it for several tools The directory `dist/tools/esptool` already contains a couple of ESP tools and not only esptool.py. As the location for a couple of ESP related tools, it is more clear to call it `esptools` instead of `esptool`.
2022-03-04 08:34:19 +01:00
ESPTOOL ?= $(RIOTTOOLS)/esptools/esptool.py
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
# flasher configuration
ifneq (,$(filter esp_qemu,$(USEMODULE)))
tools/esptool: cleanup preflash and qemu integration
2021-02-23 10:53:49 +01:00
FLASHER =
FFLAGS =
FLASHDEPS += esp-qemu
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
else
PROGRAMMER_SPEED ?= 460800
FLASHER = $(ESPTOOL)
FFLAGS += --chip $(FLASH_CHIP) --port $(PROG_DEV) --baud $(PROGRAMMER_SPEED)
FFLAGS += --before default_reset write_flash -z
FFLAGS += --flash_mode $(FLASH_MODE) --flash_freq $(FLASH_FREQ)
cpu/esp_common: esptool can detect the flash size
2022-03-09 13:31:42 +01:00
FFLAGS += --flash_size detect
cpu/esp32: compile bootloader from ESP-IDF v4.4 source
2022-02-01 22:15:47 +01:00
FFLAGS += $(BOOTLOADER_POS) $(BOOTLOADER_BIN)
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
FFLAGS += 0x8000 $(BINDIR)/partitions.bin
cpu/esp: use FLASHFILE_POS for image position in flash Instead of using a fixed position of the image file in the flash, the variable `FLASHFILE_POS` is used which allows to override the default position of the image in the flash at 0x10000.
2022-12-27 01:55:28 +01:00
FFLAGS += $(FLASHFILE_POS) $(FLASHFILE)
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
endif
esptool: Allow to pass the partition table CSV. The partition table of the device in the esp8266 and esp32 based boards was set to a default table with one "factory" partition with exactly the size of the compiled firmware. This is problematic if we want to update the device on the field. This patch allows to set the `PARTITION_TABLE_CSV` variable from the Makefile to a .csv file with a custom partition table, for example this could be set to a partition table with two ota entries, or with a single factory entry but of a known fixed size.
2021-04-11 02:37:56 +02:00
.PHONY: esp-qemu
tools/esptool: cleanup preflash and qemu integration
2021-02-23 10:53:49 +01:00
makefile/tools/esptool.inc.mk: fix esp-qemu dependency
2022-12-31 13:09:37 +01:00
esp-qemu: $(FLASHFILE)
makefiles/tools/esptool.mk: inverse CPU* conditionals The CPU* conditionals are inverted so that they can be tested for ESP8266. In all other cases the MCU is any ESP32x SoC
2022-06-23 07:28:49 +02:00
ifeq (esp32,$(CPU))
dist/tools/esptool: upgrade to v3.2 for ESP32
2022-03-02 15:13:05 +01:00
$(Q)echo \
"--flash_mode $(FLASH_MODE) --flash_freq $(FLASH_FREQ) " \
"--flash_size $(FLASH_SIZE)MB" \
cpu/esp_common: esptool can detect the flash size
2022-03-09 13:31:42 +01:00
"$(BOOTLOADER_POS) $(BOOTLOADER_BIN)" \
dist/tools/esptool: upgrade to v3.2 for ESP32
2022-03-02 15:13:05 +01:00
"0x8000 $(BINDIR)/partitions.bin" \
cpu/esp: use FLASHFILE_POS for image position in flash Instead of using a fixed position of the image file in the flash, the variable `FLASHFILE_POS` is used which allows to override the default position of the image in the flash at 0x10000.
2022-12-27 01:55:28 +01:00
"$(FLASHFILE_POS) $(FLASHFILE)" > $(BINDIR)/qemu_flash_args
dist/tools/esptool: upgrade to v3.2 for ESP32
2022-03-02 15:13:05 +01:00
$(Q)$(ESPTOOL) \
makefiles/tools/esptool.mk: inverse CPU* conditionals The CPU* conditionals are inverted so that they can be tested for ESP8266. In all other cases the MCU is any ESP32x SoC
2022-06-23 07:28:49 +02:00
--chip $(CPU_FAM) merge_bin \
dist/tools/esptool: upgrade to v3.2 for ESP32
2022-03-02 15:13:05 +01:00
--fill-flash-size 4MB \
-o $(BINDIR)/qemu_flash_image.bin @$(BINDIR)/qemu_flash_args
$(Q)cp $(RIOTCPU)/$(CPU)/bin/rom_0x3ff90000_0x00010000.bin $(BINDIR)/rom1.bin
$(Q)cp $(RIOTCPU)/$(CPU)/bin/rom_0x40000000_0x000c2000.bin $(BINDIR)/rom.bin
else
tools/esptool: cleanup preflash and qemu integration
2021-02-23 10:53:49 +01:00
$(Q)dd if=/dev/zero bs=1M count=$(FLASH_SIZE) | \
tr "\\000" "\\377" > tmp.bin && cat tmp.bin | \
head -c $$(($(BOOTLOADER_POS))) | \
cpu/esp32: compile bootloader from ESP-IDF v4.4 source
2022-02-01 22:15:47 +01:00
cat - $(BOOTLOADER_BIN) tmp.bin | \
tools/esptool: cleanup preflash and qemu integration
2021-02-23 10:53:49 +01:00
head -c $$((0x8000)) | \
cat - $(BINDIR)/partitions.bin tmp.bin | \
cpu/esp: use FLASHFILE_POS for image position in flash Instead of using a fixed position of the image file in the flash, the variable `FLASHFILE_POS` is used which allows to override the default position of the image in the flash at 0x10000.
2022-12-27 01:55:28 +01:00
head -c $$(($(FLASHFILE_POS))) | \
esptool: Allow to pass the partition table CSV. The partition table of the device in the esp8266 and esp32 based boards was set to a default table with one "factory" partition with exactly the size of the compiled firmware. This is problematic if we want to update the device on the field. This patch allows to set the `PARTITION_TABLE_CSV` variable from the Makefile to a .csv file with a custom partition table, for example this could be set to a partition table with two ota entries, or with a single factory entry but of a known fixed size.
2021-04-11 02:37:56 +02:00
cat - $(FLASHFILE) tmp.bin | \
tools/esptool: cleanup preflash and qemu integration
2021-02-23 10:53:49 +01:00
head -c $(FLASH_SIZE)MB > $(BINDIR)/$(CPU)flash.bin && rm tmp.bin
endif
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
# reset tool configuration
dist/tools: rename esptool to esptools to use it for several tools The directory `dist/tools/esptool` already contains a couple of ESP tools and not only esptool.py. As the location for a couple of ESP related tools, it is more clear to call it `esptools` instead of `esptool`.
2022-03-04 08:34:19 +01:00
RESET ?= $(RIOTTOOLS)/esptools/espreset.py
makefiles/tools: add common esptool configuration
2020-12-01 10:22:26 +01:00
RESET_FLAGS ?= --port $(PROG_DEV)
Copy Permalink