components/bootloader/Makefile.projbuild

   1 # Bootloader component (top-level project parts)
   2 #
   3 # The bootloader is not a real component that gets linked into the project.
   4 # Instead it is an entire standalone project (in subproject/) that gets
   5 # built in the upper project's build directory. This Makefile.projbuild provides
   6 # the glue to build the bootloader project from the original project. It
   7 # basically runs Make in the subproject/ directory but it needs to
   8 # zero some variables the ESP-IDF project.mk makefile exports first, to not
   9 # let them interfere.
  10 #
  11 BOOTLOADER_COMPONENT_PATH := $(COMPONENT_PATH)
  12 BOOTLOADER_BUILD_DIR=$(abspath $(BUILD_DIR_BASE)/bootloader)
  13 BOOTLOADER_BIN=$(BOOTLOADER_BUILD_DIR)/bootloader.bin
  14
  15 # signing key path is resolved relative to the project directory
  16 CONFIG_SECURE_BOOT_SIGNING_KEY ?=
  17 SECURE_BOOT_SIGNING_KEY=$(abspath $(call dequote,$(CONFIG_SECURE_BOOT_SIGNING_KEY)))
  18 export SECURE_BOOT_SIGNING_KEY  # used by bootloader_support component
  19
  20 # Has a matching value in bootloader_support esp_flash_partitions.h
  21 BOOTLOADER_OFFSET := 0x1000
  22
  23 # Custom recursive make for bootloader sub-project
  24 #
  25 # NB: Some variables are cleared in the environment, not
  26 # overriden, because they need to be re-defined in the child
  27 # project.
  28 BOOTLOADER_MAKE= +\
  29         PROJECT_PATH= \
  30         COMPONENT_DIRS= \
  31         $(MAKE) -C $(BOOTLOADER_COMPONENT_PATH)/subproject \
  32         V=$(V) \
  33         BUILD_DIR_BASE=$(BOOTLOADER_BUILD_DIR) \
  34         TEST_COMPONENTS= \
  35         TESTS_ALL=
  36
  37 .PHONY: bootloader-clean bootloader-flash bootloader-list-components bootloader $(BOOTLOADER_BIN)
  38
  39 $(BOOTLOADER_BIN): $(SDKCONFIG_MAKEFILE)
  40         $(BOOTLOADER_MAKE) $@
  41
  42 clean: bootloader-clean
  43
  44 bootloader-list-components:
  45         $(BOOTLOADER_MAKE) list-components
  46
  47 ifndef CONFIG_SECURE_BOOT_ENABLED
  48 # If secure boot disabled, bootloader flashing is integrated
  49 # with 'make flash' and no warnings are printed.
  50
  51 bootloader: $(BOOTLOADER_BIN)
  52         @echo $(SEPARATOR)
  53         @echo "Bootloader built. Default flash command is:"
  54         @echo "$(ESPTOOLPY_WRITE_FLASH) $(BOOTLOADER_OFFSET) $^"
  55
  56 ESPTOOL_ALL_FLASH_ARGS += $(BOOTLOADER_OFFSET) $(BOOTLOADER_BIN)
  57
  58 bootloader-flash: $(BOOTLOADER_BIN) $(call prereq_if_explicit,erase_flash)
  59         $(ESPTOOLPY_WRITE_FLASH) 0x1000 $^
  60
  61 else ifdef CONFIG_SECURE_BOOTLOADER_ONE_TIME_FLASH
  62
  63 # One time flashing requires user to run esptool.py command themselves,
  64 # and warning is printed about inability to reflash.
  65 #
  66 # The flashing command is deliberately printed without an auto-reset
  67 # step, so the device doesn't immediately reset to flash itself.
  68
  69 bootloader: $(BOOTLOADER_BIN)
  70         @echo $(SEPARATOR)
  71         @echo "Bootloader built. One-time flash command is:"
  72         @echo "$(subst hard_reset,no_reset,$(ESPTOOLPY_WRITE_FLASH)) $(BOOTLOADER_OFFSET) $(BOOTLOADER_BIN)"
  73         @echo $(SEPARATOR)
  74         @echo "* IMPORTANT: After first boot, BOOTLOADER CANNOT BE RE-FLASHED on same device"
  75
  76 else ifdef CONFIG_SECURE_BOOTLOADER_REFLASHABLE
  77 # Reflashable secure bootloader
  78 # generates a digest binary (bootloader + digest)
  79
  80 BOOTLOADER_DIGEST_BIN := $(BOOTLOADER_BUILD_DIR)/bootloader-reflash-digest.bin
  81 SECURE_BOOTLOADER_KEY := $(BOOTLOADER_BUILD_DIR)/secure-bootloader-key.bin
  82
  83 ifdef CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES
  84 $(SECURE_BOOTLOADER_KEY): $(SECURE_BOOT_SIGNING_KEY)
  85         $(ESPSECUREPY) digest_private_key -k $< $@
  86 else
  87 $(SECURE_BOOTLOADER_KEY):
  88         @echo "No pre-generated key for a reflashable secure bootloader is available, due to signing configuration."
  89         @echo "To generate one, you can use this command:"
  90         @echo "espsecure.py generate_flash_encryption_key $@"
  91         @echo "then re-run make."
  92         exit 1
  93 endif
  94
  95 bootloader: $(BOOTLOADER_DIGEST_BIN)
  96         @echo $(SEPARATOR)
  97         @echo "Bootloader built and secure digest generated. First time flash command is:"
  98         @echo "$(ESPEFUSEPY) burn_key secure_boot $(SECURE_BOOTLOADER_KEY)"
  99         @echo "$(ESPTOOLPY_WRITE_FLASH) $(BOOTLOADER_OFFSET) $(BOOTLOADER_BIN)"
 100         @echo $(SEPARATOR)
 101         @echo "To reflash the bootloader after initial flash:"
 102         @echo "$(ESPTOOLPY_WRITE_FLASH) 0x0 $(BOOTLOADER_DIGEST_BIN)"
 103         @echo $(SEPARATOR)
 104         @echo "* After first boot, only re-flashes of this kind (with same key) will be accepted."
 105         @echo "* Not recommended to re-use the same secure boot keyfile on multiple production devices."
 106
 107 $(BOOTLOADER_DIGEST_BIN): $(BOOTLOADER_BIN) $(SECURE_BOOTLOADER_KEY)
 108         @echo "DIGEST $(notdir $@)"
 109         $(Q) $(ESPSECUREPY) digest_secure_bootloader -k $(SECURE_BOOTLOADER_KEY) -o $@ $<
 110
 111 else # CONFIG_SECURE_BOOT_ENABLED && !CONFIG_SECURE_BOOTLOADER_REFLASHABLE && !CONFIG_SECURE_BOOTLOADER_ONE_TIME_FLASH
 112 bootloader:
 113         @echo "Invalid bootloader target: bad sdkconfig?"
 114         @exit 1
 115 endif
 116
 117 ifndef CONFIG_SECURE_BOOT_ENABLED
 118 # don't build bootloader by default is secure boot is enabled
 119 all_binaries: $(BOOTLOADER_BIN)
 120 endif
 121
 122 bootloader-clean: $(SDKCONFIG_MAKEFILE)
 123         $(BOOTLOADER_MAKE) app-clean
 124 ifdef CONFIG_SECURE_BOOTLOADER_REFLASHABLE
 125         rm -f $(SECURE_BOOTLOADER_KEY) $(BOOTLOADER_DIGEST_BIN)
 126 endif