tools: replace flasher_stub location

Replace esptool hosted flasher_stub by the snapshot of the
https://github.com/espressif/esptool-legacy-flasher-stub
(sha256: bd267d361412dbbba410cc36c6e7aa58812fc1bd)

Signed-off-by: Marek Matej <marek.matej@espressif.com>

Author: Marek Matej

tools/flasher_stub/Makefile

@@ -0,0 +1,199 @@
+# Makefile to compile the flasher stub program
+#
+# Note that YOU DO NOT NEED TO COMPILE THIS IN ORDER TO JUST USE
+# esptool.py - a precompiled version is included in esptool.py,
+# so if you don't want to modify the stub code then you are good to go.
+#
+# See the comments in the top of the Makefile for parameters that
+# you probably want to override.
+#
+# Copyright (c) 2016 Cesanta Software Limited & Angus Gratton
+# All rights reserved
+#
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
+# Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# Adapted from Cesanta's original Makefile at
+# https://github.com/cesanta/fnc/tree/master/common/platforms/esp8266/stubs
+
+# Override these variables on the command line
+# or set them in a local.mk
+-include local.mk
+
+# Prefix for each cross compiler (can include a directory path)
+# These can be overridden via environment variables or on the make command line
+CROSS_8266 ?= xtensa-lx106-elf-
+CROSS_32 ?= xtensa-esp32-elf-
+CROSS_32S2 ?= xtensa-esp32s2-elf-
+CROSS_32S3 ?= xtensa-esp32s3-elf-
+CROSS_ESPRISCV32 ?= riscv32-esp-elf-
+
+# extra CFLAGS to be passed on the compiler, in addition to the stock ones
+EXTRA_CFLAGS ?=
+EXTRA_CFLAGS_ESPRISCV32 ?=
+
+# Python command to invoke wrap_stub.py
+WRAP_STUB ?= ./wrap_stub.py
+
+# Pass V=1 to see the commands being executed by make
+ifneq ("$(V)","1")
+Q = @
+endif
+
+STUB = esp
+SRCS = stub_flasher.c slip.c stub_commands.c stub_write_flash.c stub_io.c
+SRCS_8266 = miniz.c
+
+BUILD_DIR = build
+ESPTOOL_STUBS_DIR = ..
+
+STUB_ELF_8266 = $(BUILD_DIR)/$(STUB)8266.elf
+STUB_ELF_32 = $(BUILD_DIR)/$(STUB)32.elf
+STUB_ELF_32S2 = $(BUILD_DIR)/$(STUB)32s2.elf
+STUB_ELF_32S3_BETA_2 = $(BUILD_DIR)/$(STUB)32s3beta2.elf
+STUB_ELF_32S3 = $(BUILD_DIR)/$(STUB)32s3.elf
+STUB_ELF_32C3 = $(BUILD_DIR)/$(STUB)32c3.elf
+STUB_ELF_32C6BETA = $(BUILD_DIR)/$(STUB)32c6beta.elf
+STUB_ELF_32H2_BETA_1 = $(BUILD_DIR)/$(STUB)32h2beta1.elf
+STUB_ELF_32H2_BETA_2 = $(BUILD_DIR)/$(STUB)32h2beta2.elf
+STUB_ELF_32C2 = $(BUILD_DIR)/$(STUB)32c2.elf
+STUB_ELF_32C6 = $(BUILD_DIR)/$(STUB)32c6.elf
+STUB_ELF_32C61 = $(BUILD_DIR)/$(STUB)32c61.elf
+STUB_ELF_32C5 = $(BUILD_DIR)/$(STUB)32c5.elf
+STUB_ELF_32C5_BETA_3 = $(BUILD_DIR)/$(STUB)32c5beta3.elf
+STUB_ELF_32H2 = $(BUILD_DIR)/$(STUB)32h2.elf
+STUB_ELF_32P4 = $(BUILD_DIR)/$(STUB)32p4.elf
+
+STUBS_ELF =
+ifneq ($(WITHOUT_ESP8266),1)
+STUBS_ELF += \
+  $(STUB_ELF_8266)
+endif
+
+ifneq ($(WITHOUT_ESP32_XTENSA),1)
+STUBS_ELF += \
+  $(STUB_ELF_32) \
+  $(STUB_ELF_32S2) \
+  $(STUB_ELF_32S3_BETA_2) \
+  $(STUB_ELF_32S3)
+endif
+
+ifneq ($(WITHOUT_ESP32_RISCV32),1)
+STUBS_ELF += \
+  $(STUB_ELF_32C3) \
+  $(STUB_ELF_32C6BETA) \
+  $(STUB_ELF_32H2_BETA_1) \
+  $(STUB_ELF_32H2_BETA_2) \
+  $(STUB_ELF_32C2) \
+  $(STUB_ELF_32C6) \
+  $(STUB_ELF_32C61) \
+  $(STUB_ELF_32C5) \
+  $(STUB_ELF_32C5_BETA_3) \
+  $(STUB_ELF_32H2) \
+  $(STUB_ELF_32P4)
+endif
+
+.PHONY: all clean install
+
+all: $(STUBS_ELF:.elf=.json)
+
+install: $(patsubst $(BUILD_DIR)/%.elf,$(ESPTOOL_STUBS_DIR)/%.json,$(STUBS_ELF))
+
+$(BUILD_DIR):
+	$(Q) mkdir $@
+
+$(BUILD_DIR)/%.json: $(BUILD_DIR)/%.elf
+	@echo "  WRAP $^ -> $(BUILD_DIR)"
+	$(Q) $(WRAP_STUB) $^
+
+$(ESPTOOL_STUBS_DIR)/%.json: $(BUILD_DIR)/%.json
+	@echo "  INSTALL $^ -> $@"
+	$(Q) cp $^ $@
+
+CFLAGS = -std=c99 -Wall -Werror -Os \
+         -mtext-section-literals -mlongcalls -nostdlib -fno-builtin -flto \
+         -Wl,-static -g -ffunction-sections -Wl,--gc-sections -Iinclude -Lld \
+         $(EXTRA_CFLAGS)
+CFLAGS_ESPRISCV32 = -std=c99 -Wall -Werror -Os \
+		 -march=rv32imc -mabi=ilp32 -msmall-data-limit=0 \
+         -nostdlib -fno-builtin -flto \
+         -Wl,-static -g -ffunction-sections -Wl,--gc-sections -Iinclude -Lld \
+         $(EXTRA_CFLAGS_ESPRISCV32)
+LDLIBS = -lgcc
+
+$(STUB_ELF_8266): $(SRCS) $(SRCS_8266) $(BUILD_DIR) ld/stub_8266.ld | Makefile
+	@echo "  CC(8266)   $^ -> $@"
+	$(Q) $(CROSS_8266)gcc $(CFLAGS) -DESP8266=1 -Tstub_8266.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32): $(SRCS) $(BUILD_DIR) ld/stub_32.ld | Makefile
+	@echo "  CC(32)   $^ -> $@"
+	$(Q) $(CROSS_32)gcc $(CFLAGS) -DESP32=1 -Tstub_32.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32S2): $(SRCS) $(BUILD_DIR) ld/stub_32s2.ld
+	@echo "  CC(32S2)   $^ -> $@"
+	$(Q) $(CROSS_32S2)gcc $(CFLAGS) -DESP32S2=1 -Tstub_32s2.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32S3_BETA_2): $(SRCS) $(BUILD_DIR) ld/stub_32s3_beta_2.ld
+	@echo "  CC(32S3)   $^ -> $@"
+	$(Q) $(CROSS_32S3)gcc $(CFLAGS) -DESP32S3BETA2=1 -Tstub_32s3_beta_2.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32S3): $(SRCS) $(BUILD_DIR) ld/stub_32s3.ld
+	@echo "  CC(32S3)   $^ -> $@"
+	$(Q) $(CROSS_32S3)gcc $(CFLAGS) -DESP32S3=1 -Tstub_32s3.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C3): $(SRCS) $(BUILD_DIR) ld/stub_32c3.ld
+	@echo "  CC(32C3)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C3=1 -Tstub_32c3.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C6BETA): $(SRCS) $(BUILD_DIR) ld/stub_32c6_beta.ld
+	@echo "  CC(32C6BETA)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C6BETA=1 -Tstub_32c6_beta.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32H2_BETA_1): $(SRCS) $(BUILD_DIR) ld/stub_32h2_beta_1.ld
+	@echo "  CC(32H2BETA1)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32H2BETA1=1 -Tstub_32h2_beta_1.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32H2_BETA_2): $(SRCS) $(BUILD_DIR) ld/stub_32h2_beta_2.ld
+	@echo "  CC(32H2BETA2)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32H2BETA2=1 -Tstub_32h2_beta_2.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C2): $(SRCS) $(BUILD_DIR) ld/stub_32c2.ld
+	@echo "  CC(32C2)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C2=1 -Tstub_32c2.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C6): $(SRCS) $(BUILD_DIR) ld/stub_32c6.ld
+	@echo "  CC(32C6)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C6=1 -Tstub_32c6.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C61): $(SRCS) $(BUILD_DIR) ld/stub_32c61.ld
+	@echo "  CC(32C61)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C61=1 -Tstub_32c61.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C5): $(SRCS) $(BUILD_DIR) ld/stub_32c5.ld
+	@echo "  CC(32C5)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C5=1 -Tstub_32c5.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32C5_BETA_3): $(SRCS) $(BUILD_DIR) ld/stub_32c5_beta_3.ld
+	@echo "  CC(32C5BETA3)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32C5BETA3=1 -Tstub_32c5_beta_3.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32H2): $(SRCS) $(BUILD_DIR) ld/stub_32h2.ld
+	@echo "  CC(32H2)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32H2=1 -Tstub_32h2.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+$(STUB_ELF_32P4): $(SRCS) $(BUILD_DIR) ld/stub_32p4.ld
+	@echo "  CC(32P4)   $^ -> $@"
+	$(Q) $(CROSS_ESPRISCV32)gcc $(CFLAGS_ESPRISCV32) -DESP32P4=1 -Tstub_32p4.ld -Wl,-Map=$(@:.elf=.map) -o $@ $(filter %.c, $^) $(LDLIBS)
+
+clean:
+	$(Q) rm -rf $(BUILD_DIR)

tools/flasher_stub/README.md

@@ -0,0 +1,41 @@
+This is the source of the software flasher stub.
+
+esptool.py loads the flasher stub into memory and executes it to:
+
+* Add features that the Espressif chips bootloader ROMs do not have.
+
+* Add features to the ESP8266 bootloader ROM which are only in the ROM of newer chips.
+
+* Improve flashing performance over the ROM bootloaders.
+
+* Work around bugs in the ESP8266 ROM bootloader.
+
+Thanks to [Cesanta](http://cesanta.com/) who provided the original ESP8266 stub loader upon which this loader is based.
+
+# To Use
+
+The stub loader is already automatically integrated into esptool.py. You don't need to do anything special to use it.
+
+# To Build
+
+If you want to build the stub to test modifications or updates, here's how:
+
+* You will need an ESP8266 gcc toolchain (xtensa-lx106-elf-) and toolchains for ESP32 and later chips (xtensa-esp32-elf-, riscv32-esp-elf-) on your PATH. If you are developing the stub flasher and plan to send a pull request, please use the latest toolchains available.
+
+* Set the environment variables SDK_PATH to the path to an ESP8266 IoT NON-OS SDK directory (last stub was built with SDK v1.5.1).
+
+* Set the environment variable IDF_PATH to the path to an ESP-IDF directory.
+
+* Set any other environment variables you'd like to override in the Makefile.
+
+* To build type `make`. To build only for the ESP32 family, type `make WITHOUT_ESP8266=1` (this negates the need of an ESP8266 toolchain).
+
+Activating an ESP-IDF environment takes care of most of these steps (only the ESP8266 gcc toolchain has to be manually added to PATH).
+
+# To Test
+
+To test the built stub, you can run `make install` (or `make install WITHOUT_ESP8266=1`), which will update the stubs in `esptool.py` to the newly compiled ones. Or there are some convenience wrappers to make testing quicker to iterate on:
+
+* Running `esptool_test_stub.py` is the same as running `esptool.py`, only it uses the just-compiled stubs from the build directory.
+
+* Running `run_tests_with_stub.sh` is the same as running `pytest test/test_esptool.py`, only it uses the just-compiled stubs from the build directory. See the [Automated Integration Tests](https://docs.espressif.com/projects/esptool/en/latest/contributing.html#automated-integration-tests) docs for more information.

tools/flasher_stub/compare_stubs.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+#
+# SPDX-FileCopyrightText: 2014-2022 Fredrik Ahlberg, Angus Gratton,
+# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import os
+import sys
+
+import esptool
+
+# Compare the esptool stub loaders to freshly built ones in the build directory
+#
+# (Used by CI to verify the stubs are up to date.)
+
+THIS_SCRIPT_DIR = os.path.dirname(__file__)
+STUB_DIR = "../esptool/targets/stub_flasher/"
+BUILD_DIR = "build/"
+JSON_NAME = "stub_flasher_{}.json"
+
+
+def diff(path_to_new, path_to_old):
+    output = ""
+    new = esptool.loader.StubFlasher(path_to_new)
+    old = esptool.loader.StubFlasher(path_to_old)
+
+    if new.data_start != old.data_start:
+        output += "  Data start: New {:#x}, old {:#x} \n".format(
+            new.data_start, old.data_start
+        )
+    if new.text_start != old.text_start:
+        output += "  Text start: New {:#x}, old {:#x} \n".format(
+            new.text_start, old.text_start
+        )
+    if new.entry != old.entry:
+        output += "  Entrypoint: New {:#x}, old {:#x} \n".format(new.entry, old.entry)
+
+    # data
+    if new.data != old.data:
+        if len(new.data) == len(old.data):
+            for i, (new_b, old_b) in enumerate(zip(new.data, old.data)):
+                if new_b != old_b:
+                    output += "  Data byte {:#x}: new {:#04x} old {:#04x} \n".format(
+                        i, new_b, old_b
+                    )
+        else:
+            output += "  Data length: New {} bytes, old {} bytes \n".format(
+                len(new.data), len(old.data)
+            )
+
+    # text
+    if new.text != old.text:
+        if len(new.text) == len(old.text):
+            for i, (new_b, old_b) in enumerate(zip(new.text, old.text)):
+                if new_b != old_b:
+                    output += "  Text byte {:#x}: new {:#04x} old {:#04x} \n".format(
+                        i, new_b, old_b
+                    )
+        else:
+            output += "  Text length: New {} bytes, old {} bytes \n".format(
+                len(new.text), len(old.text)
+            )
+    return output
+
+
+if __name__ == "__main__":
+    same = True
+    for chip in esptool.CHIP_LIST:
+        print("Comparing {} stub: ".format(chip), end="")
+        # TODO: [ESP32C5] ESPTOOL-825 remove when supported stub flasher
+        # TODO: [ESP32C61] IDF-9241 remove when supported stub flasher
+        if chip in ["esp32c5", "esp32c61"]:
+            print(f"{chip} has not supported stub yet, skipping...")
+            continue
+
+        chip = chip.replace("esp", "")
+        old = os.path.join(THIS_SCRIPT_DIR, STUB_DIR, JSON_NAME.format(chip))
+        new = os.path.join(THIS_SCRIPT_DIR, BUILD_DIR, JSON_NAME.format(chip))
+
+        output = diff(new, old)
+        if output != "":
+            same = False
+            print("FAIL")
+            print(
+                "  Mismatch: {} json file in esptool/targets/stub_flasher/ differs "
+                "from the just-built stub".format("esp" + chip)
+            )
+            print(output)
+        else:
+            print("OK")
+
+    if not same:
+        sys.exit(1)
+    else:
+        print("Stub flasher json files are the same")
+        sys.exit(0)

tools/flasher_stub/esptool_test_stub.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+#
+# SPDX-FileCopyrightText: 2014-2022 Fredrik Ahlberg, Angus Gratton,
+# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+# Trivial wrapper program to run esptool.py using the just-compiled
+# flasher stub in the build/ subdirectory
+#
+# For use when developing new flasher_stubs, not important otherwise.
+
+import os.path
+import sys
+
+THIS_DIR = os.path.dirname(__file__)
+STUBS_BUILD_DIR = os.path.join(THIS_DIR, "build/")
+
+sys.path.append("..")
+import esptool  # noqa: E402
+
+# Python hackiness: change the path to stub json files in the context of the esptool
+# module, so it edits the esptool's global variables
+exec(
+    "loader.STUBS_DIR = '{}'".format(STUBS_BUILD_DIR),
+    esptool.__dict__,
+    esptool.__dict__,
+)
+
+
+if __name__ == "__main__":
+    try:
+        esptool.main()
+    except esptool.FatalError as e:
+        print("\nA fatal error occurred: %s" % e)
+        sys.exit(2)