esp-idf-bootloader: add apeos copyright line to /components/bootloader/Makefile.projbuild
[apeos.git] / components / bootloader / Makefile.projbuild
blobf6960ae140a74ff5b8ec7d930db4215ba96764ec
1 # Copyright 2016-2017 Espressif Systems (Shanghai) PTE LTD
2 # Copyright 2018 apeos contributors
4 # Bootloader component (top-level project parts)
6 # The bootloader is not a real component that gets linked into the project.
7 # Instead it is an entire standalone project (in subproject/) that gets
8 # built in the upper project's build directory. This Makefile.projbuild provides
9 # the glue to build the bootloader project from the original project. It
10 # basically runs Make in the subproject/ directory but it needs to
11 # zero some variables the ESP-IDF project.mk makefile exports first, to not
12 # let them interfere.
14 # Licensed under the Apache License, Version 2.0 (the "License");
15 # you may not use this file except in compliance with the License.
16 # You may obtain a copy of the License at
18 #     http://www.apache.org/licenses/LICENSE-2.0
20 # Unless required by applicable law or agreed to in writing, software
21 # distributed under the License is distributed on an "AS IS" BASIS,
22 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 # See the License for the specific language governing permissions and
24 # limitations under the License.
26 BOOTLOADER_COMPONENT_PATH := $(COMPONENT_PATH)
27 BOOTLOADER_BUILD_DIR=$(abspath $(BUILD_DIR_BASE)/bootloader)
28 BOOTLOADER_BIN=$(BOOTLOADER_BUILD_DIR)/bootloader.bin
30 # signing key path is resolved relative to the project directory
31 CONFIG_SECURE_BOOT_SIGNING_KEY ?=
32 SECURE_BOOT_SIGNING_KEY=$(abspath $(call dequote,$(CONFIG_SECURE_BOOT_SIGNING_KEY)))
33 export SECURE_BOOT_SIGNING_KEY  # used by bootloader_support component
35 # Has a matching value in bootloader_support esp_flash_partitions.h
36 BOOTLOADER_OFFSET := 0x1000
38 # Custom recursive make for bootloader sub-project
40 # NB: Some variables are cleared in the environment, not
41 # overriden, because they need to be re-defined in the child
42 # project.
43 BOOTLOADER_MAKE= +\
44         PROJECT_PATH= \
45         COMPONENT_DIRS= \
46         $(MAKE) -C $(BOOTLOADER_COMPONENT_PATH)/subproject \
47         V=$(V) \
48         BUILD_DIR_BASE=$(BOOTLOADER_BUILD_DIR) \
49         TEST_COMPONENTS= \
50         TESTS_ALL=
52 .PHONY: bootloader-clean bootloader-flash bootloader-list-components bootloader $(BOOTLOADER_BIN)
54 $(BOOTLOADER_BIN): $(SDKCONFIG_MAKEFILE)
55         $(BOOTLOADER_MAKE) $@
57 clean: bootloader-clean
59 bootloader-list-components:
60         $(BOOTLOADER_MAKE) list-components
62 ifndef CONFIG_SECURE_BOOT_ENABLED
63 # If secure boot disabled, bootloader flashing is integrated
64 # with 'make flash' and no warnings are printed.
66 bootloader: $(BOOTLOADER_BIN)
67         @echo $(SEPARATOR)
68         @echo "Bootloader built. Default flash command is:"
69         @echo "$(ESPTOOLPY_WRITE_FLASH) $(BOOTLOADER_OFFSET) $^"
71 ESPTOOL_ALL_FLASH_ARGS += $(BOOTLOADER_OFFSET) $(BOOTLOADER_BIN)
73 bootloader-flash: $(BOOTLOADER_BIN) $(call prereq_if_explicit,erase_flash)
74         $(ESPTOOLPY_WRITE_FLASH) 0x1000 $^
76 else ifdef CONFIG_SECURE_BOOTLOADER_ONE_TIME_FLASH
78 # One time flashing requires user to run esptool.py command themselves,
79 # and warning is printed about inability to reflash.
81 # The flashing command is deliberately printed without an auto-reset
82 # step, so the device doesn't immediately reset to flash itself.
84 bootloader: $(BOOTLOADER_BIN)
85         @echo $(SEPARATOR)
86         @echo "Bootloader built. One-time flash command is:"
87         @echo "$(subst hard_reset,no_reset,$(ESPTOOLPY_WRITE_FLASH)) $(BOOTLOADER_OFFSET) $(BOOTLOADER_BIN)"
88         @echo $(SEPARATOR)
89         @echo "* IMPORTANT: After first boot, BOOTLOADER CANNOT BE RE-FLASHED on same device"
91 else ifdef CONFIG_SECURE_BOOTLOADER_REFLASHABLE
92 # Reflashable secure bootloader
93 # generates a digest binary (bootloader + digest)
95 BOOTLOADER_DIGEST_BIN := $(BOOTLOADER_BUILD_DIR)/bootloader-reflash-digest.bin
96 SECURE_BOOTLOADER_KEY := $(BOOTLOADER_BUILD_DIR)/secure-bootloader-key.bin
98 ifdef CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES
99 $(SECURE_BOOTLOADER_KEY): $(SECURE_BOOT_SIGNING_KEY)
100         $(ESPSECUREPY) digest_private_key -k $< $@
101 else
102 $(SECURE_BOOTLOADER_KEY):
103         @echo "No pre-generated key for a reflashable secure bootloader is available, due to signing configuration."
104         @echo "To generate one, you can use this command:"
105         @echo "espsecure.py generate_flash_encryption_key $@"
106         @echo "then re-run make."
107         exit 1
108 endif
110 bootloader: $(BOOTLOADER_DIGEST_BIN)
111         @echo $(SEPARATOR)
112         @echo "Bootloader built and secure digest generated. First time flash command is:"
113         @echo "$(ESPEFUSEPY) burn_key secure_boot $(SECURE_BOOTLOADER_KEY)"
114         @echo "$(ESPTOOLPY_WRITE_FLASH) $(BOOTLOADER_OFFSET) $(BOOTLOADER_BIN)"
115         @echo $(SEPARATOR)
116         @echo "To reflash the bootloader after initial flash:"
117         @echo "$(ESPTOOLPY_WRITE_FLASH) 0x0 $(BOOTLOADER_DIGEST_BIN)"
118         @echo $(SEPARATOR)
119         @echo "* After first boot, only re-flashes of this kind (with same key) will be accepted."
120         @echo "* Not recommended to re-use the same secure boot keyfile on multiple production devices."
122 $(BOOTLOADER_DIGEST_BIN): $(BOOTLOADER_BIN) $(SECURE_BOOTLOADER_KEY)
123         @echo "DIGEST $(notdir $@)"
124         $(Q) $(ESPSECUREPY) digest_secure_bootloader -k $(SECURE_BOOTLOADER_KEY) -o $@ $<
126 else # CONFIG_SECURE_BOOT_ENABLED && !CONFIG_SECURE_BOOTLOADER_REFLASHABLE && !CONFIG_SECURE_BOOTLOADER_ONE_TIME_FLASH
127 bootloader:
128         @echo "Invalid bootloader target: bad sdkconfig?"
129         @exit 1
130 endif
132 ifndef CONFIG_SECURE_BOOT_ENABLED
133 # don't build bootloader by default is secure boot is enabled
134 all_binaries: $(BOOTLOADER_BIN)
135 endif
137 bootloader-clean: $(SDKCONFIG_MAKEFILE)
138         $(BOOTLOADER_MAKE) app-clean
139 ifdef CONFIG_SECURE_BOOTLOADER_REFLASHABLE
140         rm -f $(SECURE_BOOTLOADER_KEY) $(BOOTLOADER_DIGEST_BIN)
141 endif