Resolved peer review items. Thanks Daniele. Documentation improvements. Added open() check for update server example.

Author: dgarske

.gitignore

@@ -36,6 +36,7 @@
 *.x86_64
 *.hex
 *.rom
+*.bin
 
 # Debug files
 *.dSYM/
@@ -66,14 +67,11 @@ tools/ecc256/ecc256_keygen
 cscope.out
 tags
 
-
-image.bin
-image_v1_signed.bin
+# Generated files using target.h
 .wolfboot-arch-offset
 .wolfboot-offset
 .wolfboot-partition-size
-factory.bin
-wolfboot-align.bin
-wolfboot.bin
+
+# Test tools
 tools/test-expect-version/test-expect-version
 tools/test-update-server/server

arch.mk

@@ -2,7 +2,7 @@
 
 # check for FASTMATH or SP_MATH
 ifeq ($(SPMATH),1)
-  MATH_OBJS:=./lib/wolfssl/wolfcrypt/src/sp_int.o ./lib/wolfssl/wolfcrypt/src/sp_c32.o
+  MATH_OBJS:=./lib/wolfssl/wolfcrypt/src/sp_int.o
 else
   MATH_OBJS:=./lib/wolfssl/wolfcrypt/src/integer.o
 endif
@@ -47,13 +47,14 @@ ifeq ($(ARCH),RISCV)
   CROSS_COMPILE:=riscv32-unknown-elf-
   CFLAGS+=-fno-builtin-printf -DUSE_PLIC -DUSE_M_TIME -g -march=rv32imac -mabi=ilp32 -mcmodel=medany -nostartfiles -DARCH_RISCV
   LDFLAGS+=-march=rv32imac -mabi=ilp32 -mcmodel=medany
+  MATH_OBJS += ./lib/wolfssl/wolfcrypt/src/sp_c32.o 
 
   # Prune unused functions and data
   CFLAGS +=-ffunction-sections -fdata-sections
   LDFLAGS+=-Wl,--gc-sections
 
   OBJS+=src/boot_riscv.o src/vector_riscv.o
-  ARCH_FLASH_OFFSET=0x20000000
+  ARCH_FLASH_OFFSET=0x20010000
 endif
 
 CFLAGS+=-DARCH_FLASH_OFFSET=$(ARCH_FLASH_OFFSET)

docs/Targets.md

@@ -1,5 +1,41 @@
 # Targets
 
+## STM32-F407
+
+Example 512KB partitioning on STM32-F407
+
+The example firmware provided in the `test-app` is configured to boot from the primary partition
+starting at address 0x20000. The flash layout is provided by the default example using the following
+configuration in `target.h`:
+
+```C
+#define WOLFBOOT_SECTOR_SIZE              0x20000
+#define WOLFBOOT_PARTITION_SIZE           0x20000
+
+#define WOLFBOOT_PARTITION_BOOT_ADDRESS   0x20000
+#define WOLFBOOT_PARTITION_UPDATE_ADDRESS 0x40000
+#define WOLFBOOT_PARTITION_SWAP_ADDRESS   0x60000
+```
+
+This results in the following partition configuration:
+
+![example partitions](png/example_partitions.png)
+
+This configuration demonstrates one of the possible layouts, with the slots
+aligned to the beginning of the physical sector on the flash.
+
+The entry point for all the runnable firmware images on this target will be `0x20100`, 
+256 Bytes after the beginning of the first flash partition. This is due to the presence
+of the firmware image header at the beginning of the partition, as explained more in details
+in [Firmware image](firmware_image.md)
+
+In this particular case, due to the flash geometry, the swap space must be as big as 64KB, to account for proper sector swapping between the two images.
+
+On other systems, the SWAP space can be as small as 512B, if multiple smaller flash blocks are used.
+
+More information about the geometry of the flash and in-application programming (IAP) can be found in the manufacturer manual of each target device.
+
+
 ## SiFive HiFive1 RISC-V
 
 ### Features
@@ -19,7 +55,7 @@ Start Address: 0x20010000
 
 ### wolfBoot configuration
 
-The default wolfBoot configuration will add a second stage bootloader, leaving the stock "double tap" bootloader for safety.
+The default wolfBoot configuration will add a second stage bootloader, leaving the stock "double tap" bootloader as a fallback for recovery. Your production implementation should replace this and partition addresses in `target.h` will need updated, so they are `0x10000` less.
 
 For testing wolfBoot here are the changes required:
 
@@ -45,14 +81,15 @@ For testing wolfBoot here are the changes required:
 
 Bootloader Size: 0x10000 (64KB)
 Application Size 0x40000 (256KB)
+Swap Sector Size: 0x1000 (4KB)
 
 ```c
-#define WOLFBOOT_SECTOR_SIZE                 0x10000
-#define WOLFBOOT_PARTITION_SIZE              0x40000
-
+#define WOLFBOOT_SECTOR_SIZE                 0x1000
 #define WOLFBOOT_PARTITION_BOOT_ADDRESS      0x20020000
+
+#define WOLFBOOT_PARTITION_SIZE              0x40000
 #define WOLFBOOT_PARTITION_UPDATE_ADDRESS    0x20060000
-#define WOLFBOOT_PARTITION_SWAP_ADDRESS      0x20070000
+#define WOLFBOOT_PARTITION_SWAP_ADDRESS      0x200A0000
 ```
 
 ### Build Options
@@ -78,43 +115,7 @@ In one terminal:
 `JLinkGDBServer -device FE310 -port 3333`
 
 In another terminal:
-`riscv64-unknown-elf-gdb test-app/image.elf -ex "set remotetimeout 240" -ex "target extended-remote localhost:3333"`
-or
-`riscv64-unknown-elf-gdb wolfboot.elf -ex "set remotetimeout 240" -ex "target extended-remote localhost:3333"`
-
-
-
-## STM32-F407
-
-Example 512KB partitioning on STM32-F407
-
-The example firmware provided in the `test-app` is configured to boot from the primary partition
-starting at address 0x20000. The flash layout is provided by the default example using the following
-configuration in `target.h`:
-
-```C
-#define WOLFBOOT_SECTOR_SIZE              0x20000
-#define WOLFBOOT_PARTITION_SIZE           0x20000
-
-#define WOLFBOOT_PARTITION_BOOT_ADDRESS   0x20000
-#define WOLFBOOT_PARTITION_UPDATE_ADDRESS 0x40000
-#define WOLFBOOT_PARTITION_SWAP_ADDRESS   0x60000
 ```
-
-This results in the following partition configuration:
-
-![example partitions](png/example_partitions.png)
-
-This configuration demonstrates one of the possible layouts, with the slots
-aligned to the beginning of the physical sector on the flash.
-
-The entry point for all the runnable firmware images on this target will be `0x20100`, 
-256 Bytes after the beginning of the first flash partition. This is due to the presence
-of the firmware image header at the beginning of the partition, as explained more in details
-in [Firmware image](firmware_image.md)
-
-In this particular case, due to the flash geometry, the swap space must be as big as 64KB, to account for proper sector swapping between the two images.
-
-On other systems, the SWAP space can be as small as 512B, if multiple smaller flash blocks are used.
-
-More information about the geometry of the flash and in-application programming (IAP) can be found in the manufacturer manual of each target device.
+riscv64-unknown-elf-gdb wolfboot.elf -ex "set remotetimeout 240" -ex "target extended-remote localhost:3333"
+add-symbol-file test-app/image.elf 0x20020100
+```

docs/compile.md

@@ -135,3 +135,23 @@ both `PART_UPDATE_EXT` and `PART_SWAP_EXT` are defined.
 
 When external memory is used, the HAL API must be extended to define methods to access the custom memory.
 Refer to the [HAL](HAL.md) page for the description of the `ext_flash_*` API.
+
+### Using Mac OS/X
+
+If you see 0xC3 0xBF (C3BF) repeated in your factory.bin then your OS is using Unicode characters.
+
+The "tr" command for assembling the 0xFF padding between `"bootloader" ... 0xFF ... "application" = factory.bin`, which requires the "C" locale.
+
+Set this in your terminal
+```
+LANG=
+LC_COLLATE="C"
+LC_CTYPE="C"
+LC_MESSAGES="C"
+LC_MONETARY="C"
+LC_NUMERIC="C"
+LC_TIME="C"
+LC_ALL=
+```
+
+Then run the normal `make` steps.

tools/test-update-server/README.md

@@ -4,4 +4,4 @@ Tool to send binary image over UART to test application.
 
 Usage:
 
-`./server ../../factory.bin`
+`./server ../../test-app/image_v1_signed.bin`

tools/test-update-server/server.c

@@ -43,8 +43,8 @@
 
 #define MSGLEN      (4 + 4 + 8)
 #ifndef UART_DEV
-    #ifdef _MACH_
-        #define UART_DEV "/dev/usbmodem144241"
+    #ifdef __MACH__
+        #define UART_DEV "/dev/cu.usbmodem1411"
     #else
         #define UART_DEV "/dev/ttyACM0"
     #endif
@@ -149,7 +149,12 @@ int main(int argc, char** argv)
     tot_len = st.st_size;
 
     /* open UART */
+    printf("Opening %s UART\n", UART_DEV);
     serialfd = open(UART_DEV, O_RDWR | O_NOCTTY);
+    if (serialfd < 0) {
+        fprintf(stderr, "failed opening serial %s\n", UART_DEV);
+        exit(2);
+    }
     tcgetattr(serialfd, &tty);
     cfsetospeed(&tty, B115200);
     cfsetispeed(&tty, B115200);