Merge pull request #21 from wolfSSL/dotconfig

Dotconfig: Single entry point for all options

Author: dgarske

.gitignore

@@ -67,11 +67,18 @@ tools/ecc256/ecc256_keygen
 cscope.out
 tags
 
-# Generated files using target.h
+# Generated files
+.wolfboot-config
+include/target.h
 .wolfboot-arch-offset
 .wolfboot-offset
 .wolfboot-partition-size
+.bootloader-partition-size
 
 # Test tools
 tools/test-expect-version/test-expect-version
 tools/test-update-server/server
+config/*.ld
+
+# Generated confiuguration file
+.config

Makefile

@@ -3,34 +3,13 @@
 # Configure by passing alternate values
 # via environment variables.
 #
-# Default values:
-ARCH?=ARM
-TARGET?=stm32f4
-SIGN?=ED25519
-KINETIS?=$(HOME)/src/FRDM-K64F
-KINETIS_CPU=MK64FN1M0VLL12
-KINETIS_DRIVERS?=$(KINETIS)/devices/MK64F12
-KINETIS_CMSIS?=$(KINETIS)/CMSIS
-FREEDOM_E_SDK?=$(HOME)/src/freedom-e-sdk
-DEBUG?=0
-VTOR?=1
-CORTEX_M0?=0
-NO_ASM?=0
-EXT_FLASH?=0
-SPI_FLASH?=0
-ALLOW_DOWNGRADE?=0
-NVM_FLASH_WRITEONCE?=0
-WOLFBOOT_VERSION?=0
-V?=0
-SPMATH?=1
-RAM_CODE?=0
-DUALBANK_SWAP=0
-
-
+# Configuration values: see tools/config.mk
+-include .config
+include tools/config.mk
 
 ## Initializers
 CFLAGS:=-D__WOLFBOOT  -DWOLFBOOT_VERSION=$(WOLFBOOT_VERSION)UL
-LSCRIPT:=hal/$(TARGET).ld
+LSCRIPT:=config/target.ld
 LDFLAGS:=-T $(LSCRIPT) -Wl,-gc-sections -Wl,-Map=wolfboot.map -ffreestanding -nostartfiles
 OBJS:= \
 ./hal/$(TARGET).o \
@@ -43,6 +22,7 @@ OBJS:= \
 ./lib/wolfssl/wolfcrypt/src/wolfmath.o \
 ./lib/wolfssl/wolfcrypt/src/fe_low_mem.o
 
+
 ## Architecture/CPU configuration
 include arch.mk
 
@@ -136,26 +116,23 @@ wolfboot.hex: wolfboot.elf
 	$(Q)$(OBJCOPY) -O ihex $^ $@
 
 align: wolfboot-align.bin
-
-wolfboot-align.bin: wolfboot.bin
-	@cat include/target.h | grep WOLFBOOT_PARTITION_BOOT_ADDRESS | tr -d "\n\r" | sed -e "s/.*[ ]//g" > .wolfboot-offset
-	@printf "%d" `cat .wolfboot-offset` > .wolfboot-offset
+	
+.bootloader-partition-size:
+	@printf "%d" $(WOLFBOOT_PARTITION_BOOT_ADDRESS) > .wolfboot-offset
 	@printf "%d" $(ARCH_FLASH_OFFSET) > .wolfboot-arch-offset
-	@expr `cat .wolfboot-offset` - `cat .wolfboot-arch-offset` > .wolfboot-partition-size
-	@dd if=/dev/zero bs=`cat .wolfboot-partition-size` count=1 2>/dev/null | tr "\000" "\377" > $(@)
-	@#rm -f .wolfboot-partition-size .wolfboot-offset .wolfboot-arch-offset
-	@dd if=$^ of=$(@) conv=notrunc 2>/dev/null
+	@expr `cat .wolfboot-offset` - `cat .wolfboot-arch-offset` > .bootloader-partition-size
+	@rm -f .wolfboot-offset .wolfboot-arch-offset
+
+wolfboot-align.bin: .bootloader-partition-size wolfboot.bin
+	@dd if=/dev/zero bs=`cat .bootloader-partition-size` count=1 2>/dev/null | tr "\000" "\377" > $(@)
+	@dd if=wolfboot.bin of=$(@) conv=notrunc 2>/dev/null
 	@echo
 	@echo "\t[SIZE]"
 	@$(SIZE) wolfboot.elf
 	@echo
 
-test-app/image.bin:
-	@make -C test-app TARGET=$(TARGET) EXT_FLASH=$(EXT_FLASH) SPI_FLASH=$(SPI_FLASH) ARCH=$(ARCH) \
-    V=$(V) RAM_CODE=$(RAM_CODE) WOLFBOOT_VERSION=$(WOLFBOOT_VERSION)\
-	KINETIS=$(KINETIS) KINETIS_CPU=$(KINETIS_CPU) KINETIS_DRIVERS=$(KINETIS_DRIVERS) \
-	KINETIS_CMSIS=$(KINETIS_CMSIS) NVM_FLASH_WRITEONCE=$(NVM_FLASH_WRITEONCE) \
-	FREEDOM_E_SDK=$(FREEDOM_E_SDK)
+test-app/image.bin: wolfboot-align.bin
+	@make -C test-app
 	@rm -f src/*.o hal/*.o
 	@$(SIZE) test-app/image.elf
 
@@ -173,10 +150,15 @@ factory.bin: $(BOOT_IMG) wolfboot-align.bin $(PRIVATE_KEY)
 	@echo "\t[MERGE] $@"
 	@cat wolfboot-align.bin test-app/image_v1_signed.bin > $@
 
-wolfboot.elf: $(OBJS) $(LSCRIPT)
+wolfboot.elf: include/target.h $(OBJS) $(LSCRIPT)
 	@echo "\t[LD] $@"
 	$(Q)$(LD) $(LDFLAGS) -Wl,--start-group $(OBJS) -Wl,--end-group -o $@
 
+$(LSCRIPT): hal/$(TARGET).ld .bootloader-partition-size FORCE
+	@cat hal/$(TARGET).ld | \
+		sed -e "s/##WOLFBOOT_PARTITION_BOOT_ADDRESS##/`cat .bootloader-partition-size`/g" \
+		> $@
+
 src/ed25519_pub_key.c: ed25519.der
 
 src/ecc256_pub_key.c: ecc256.der
@@ -185,12 +167,23 @@ keys: $(PRIVATE_KEY)
 
 clean:
 	@find . -type f -name "*.o" | xargs rm -f
-	@rm -f *.bin *.elf wolfboot.map *.bin  *.hex
+	@rm -f *.bin *.elf wolfboot.map *.bin  *.hex config/target.ld
 	@make -C test-app clean
 
 distclean: clean
-	@rm -f *.pem *.der tags ./src/ed25519_pub_key.c ./src/ecc256_pub_key.c
+	@rm -f *.pem *.der tags ./src/ed25519_pub_key.c ./src/ecc256_pub_key.c include/target.h
+
+include/target.h: include/target.h.in FORCE
+	@cat include/target.h.in | \
+	sed -e "s/##WOLFBOOT_PARTITION_SIZE##/$(WOLFBOOT_PARTITION_SIZE)/g" | \
+	sed -e "s/##WOLFBOOT_SECTOR_SIZE##/$(WOLFBOOT_SECTOR_SIZE)/g" | \
+	sed -e "s/##WOLFBOOT_PARTITION_BOOT_ADDRESS##/$(WOLFBOOT_PARTITION_BOOT_ADDRESS)/g" | \
+	sed -e "s/##WOLFBOOT_PARTITION_UPDATE_ADDRESS##/$(WOLFBOOT_PARTITION_UPDATE_ADDRESS)/g" | \
+	sed -e "s/##WOLFBOOT_PARTITION_SWAP_ADDRESS##/$(WOLFBOOT_PARTITION_SWAP_ADDRESS)/g" \
+		> $@
 
+config: FORCE
+	make -C config
 
 %.o:%.c
 	@echo "\t[CC-$(ARCH)] $@"
@@ -202,3 +195,4 @@ distclean: clean
 
 FORCE: 
 
+.PHONY: FORCE clean

config/Makefile

@@ -0,0 +1,8 @@
+-include ../.config
+include ../tools/config.mk
+config:
+	rm -f ../config/target.ld
+	rm -f ../.config
+	rm -f ../include/target.h
+	@$(foreach q, $(CONFIG_VARS), a=$($q); echo -n $q \? [$$a] :; a=$($q); read SH_$q; test -z $$SH_$q && SH_$q=$$a; echo "$q?=$$SH_$q" >> ../.config;)
+

config/examples/hifive1.config

@@ -0,0 +1,21 @@
+ARCH?=RISCV
+TARGET?=hifive1
+SIGN?=ECC256
+FREEDOM_E_SDK?=~/src/freedom-e-sdk
+DEBUG?=0
+VTOR?=1
+CORTEX_M0?=0
+NO_ASM?=1
+ALLOW_DOWNGRADE?=0
+NVM_FLASH_WRITEONCE?=0
+WOLFBOOT_VERSION?=1
+V?=0
+SPMATH?=1
+RAM_CODE?=1
+DUALBANK_SWAP?=0
+IMAGE_HEADER_SIZE?=256
+WOLFBOOT_PARTITION_SIZE?=0x80000
+WOLFBOOT_SECTOR_SIZE?=0x1000
+WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x20020000
+WOLFBOOT_PARTITION_UPDATE_ADDRESS?=0x20060000
+WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x200A0000

config/examples/stm32f4.config

@@ -0,0 +1,22 @@
+ARCH?=ARM
+TARGET?=stm32f4
+SIGN?=ED25519
+DEBUG?=0
+VTOR?=1
+CORTEX_M0?=0
+NO_ASM?=0
+EXT_FLASH?=0
+SPI_FLASH?=0
+ALLOW_DOWNGRADE?=0
+NVM_FLASH_WRITEONCE?=0
+WOLFBOOT_VERSION?=0
+V?=0
+SPMATH?=1
+RAM_CODE?=0
+DUALBANK_SWAP?=0
+IMAGE_HEADER_SIZE?=256
+WOLFBOOT_PARTITION_SIZE?=0x20000
+WOLFBOOT_SECTOR_SIZE?=0x20000
+WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x20000
+WOLFBOOT_PARTITION_UPDATE_ADDRESS?=0x40000
+WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x60000

config/examples/stm32f7-dualbank.config

@@ -0,0 +1,22 @@
+ARCH?=ARM
+TARGET?=stm32f7
+SIGN?=ECC256
+DEBUG?=0
+VTOR?=1
+CORTEX_M0?=0
+NO_ASM?=0
+EXT_FLASH?=0
+SPI_FLASH?=0
+ALLOW_DOWNGRADE?=0
+NVM_FLASH_WRITEONCE?=0
+WOLFBOOT_VERSION?=1
+V?=0
+SPMATH?=1
+RAM_CODE?=1
+DUALBANK_SWAP?=1
+IMAGE_HEADER_SIZE?=256
+WOLFBOOT_PARTITION_SIZE?=0x80000
+WOLFBOOT_SECTOR_SIZE?=0x20000
+WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x8020000
+WOLFBOOT_PARTITION_UPDATE_ADDRESS?=0x8120000
+WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x0

config/examples/stm32g0.config

@@ -0,0 +1,22 @@
+ARCH?=ARM
+TARGET?=stm32g0
+SIGN?=ED25519
+DEBUG?=0
+VTOR?=1
+CORTEX_M0?=1
+NO_ASM?=0
+EXT_FLASH?=0
+SPI_FLASH?=0
+ALLOW_DOWNGRADE?=0
+NVM_FLASH_WRITEONCE?=1
+WOLFBOOT_VERSION?=0
+V?=0
+SPMATH?=1
+RAM_CODE?=0
+DUALBANK_SWAP?=0
+IMAGE_HEADER_SIZE?=256
+WOLFBOOT_PARTITION_SIZE?=0xB000
+WOLFBOOT_SECTOR_SIZE?=0x800
+WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x8000
+WOLFBOOT_PARTITION_UPDATE_ADDRESS?=0x13000
+WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x1E000

config/examples/stm32l0.config

@@ -0,0 +1,22 @@
+ARCH?=ARM
+TARGET?=stm32l0
+SIGN?=ED25519
+DEBUG?=0
+VTOR?=1
+CORTEX_M0?=1
+NO_ASM?=0
+EXT_FLASH?=0
+SPI_FLASH?=0
+ALLOW_DOWNGRADE?=0
+NVM_FLASH_WRITEONCE?=0
+WOLFBOOT_VERSION?=0
+V?=0
+SPMATH?=1
+RAM_CODE?=0
+DUALBANK_SWAP?=0
+IMAGE_HEADER_SIZE?=256
+WOLFBOOT_PARTITION_SIZE?=0x10000
+WOLFBOOT_SECTOR_SIZE?=0x1000
+WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x8000
+WOLFBOOT_PARTITION_UPDATE_ADDRESS?=0x18000
+WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x28000

config/examples/stm32wb-small.config

@@ -0,0 +1,4 @@
+TARGET=stm32wb
+SIGN=ECC256
+WOLFBOOT_PARTITION_BOOT_ADDRESS=0xA000
+WOLFBOOT_PARTITION_SIZE=0x4000

docs/compile.md

@@ -7,6 +7,23 @@ To enable specific compile options, use environment variables while calling make
 
 `make CORTEX_M0=1`
 
+As an alternative, you can provide a .config file in the root directory of wolfBoot.
+Command line options have priority on `.config` options, as long as .config options are
+defined using the `?=` operator, e.g.:
+
+`WOLFBOOT_PARTITION_BOOT_ADDRESS?=0x14000`
+
+## Generate a new configuration
+
+A new `.config` file with a set of default parameters
+can be generated by running `make config`. The build script will ask to enter a default value for
+each configuration parameter. Enter confirm the current value, indicated in between `[]`.
+
+Once a .config file is in place, it will change the default compile-time options when running `make`
+without parameters.
+
+.config can be modified with a text editor to alter the default options later on.
+
 ## Platform selection
 
 If supported natively, the target platform can be specified using the `TARGET` variable.
@@ -27,11 +44,11 @@ By default, wolfBoot is compiled for ARM Cortex-M3/4/7. To compile for Cortex-M0
 
 ### Flash partitions
 
-The file [include/target.h](../include/target.h) must be modified according to flash geometry,
+The file [include/target.h](../include/target.h) is generated according to the configured flash geometry,
 partitions size and offset of the target system. The following values must be set to provide the
-desired flash configuration:
+desired flash configuration, either via the command line, or using the .config file: 
 
-`WOLFBOOT_SECTOR_SIZE` 
+ - `WOLFBOOT_SECTOR_SIZE` 
 
 This variable determines the size of the physical sector on the flash memory. If areas with different
 block sizes are used for the two partitions (e.g. update partition on an external flash), this variable
@@ -40,26 +57,26 @@ should indicate the size of the biggest sector shared between the two partitions
 WolfBoot uses this value as minimum unit when swapping the firmware images in place. For this reason,
 this value is also used to set the size of the SWAP partition. 
 
-`WOLFBOOT_PARTITION_BOOT_ADDRESS`
+ - `WOLFBOOT_PARTITION_BOOT_ADDRESS`
 
 This is the start address of the boot partition, aligned to the beginning of a new flash sector.
 The application code starts after a further offset, equal to the partition header size (256B 
 for Ed25519 and ECC signature headers).
 
-`WOLFBOOT_PARTITION_UPDATE_ADDRESS`
+ - `WOLFBOOT_PARTITION_UPDATE_ADDRESS`
 
 This is the start address of the update partition. If an external memory is used via the 
 `EXT_FLASH` option, this variable contains the offset of the update partition from the
 beginning of the external memory addressable space.
 
-`WOLFBOOT_PARTITION_SWAP_ADDRESS`
+ - `WOLFBOOT_PARTITION_SWAP_ADDRESS`
 
 The address for the swap spaced used by wolfBoot to swap the two firmware images in place,
 in order to perform a reversable update. The size of the SWAP partition is exactly one sector on the flash.
 If an external memory is used, the variable contains the offset of the SWAP area from the beginning
 of its addressable space.
 
-`WOLFBOOT_PARTITION_SIZE`
+ - `WOLFBOOT_PARTITION_SIZE`
 
 The size of the BOOT and UPDATE partition. The size is the same for both partitions.