Fixes for Device Tree (DTS) handling. Updated documentation.

Author: dgarske

IDE/XilinxSDK/README.md

@@ -6,7 +6,20 @@ To use this example project:
 
 ## wolfBoot Configuration
 
-A build settings template for Zynq UltraScale+ can be found here `./config/examples/zynqmp.config`. This file can be copied to wolfBoot root as `.config` for building from the command line. These template settings are also in this `.cproject` as preprocessor macros.
+A build settings template for Zynq UltraScale+ can be found here `./config/examples/zynqmp.config`. This file can be copied to wolfBoot root as `.config` for building from the command line. These template settings are also in this `.cproject` as preprocessor macros. These settings are loaded into the `target.h.in` template by the wolfBoot `make`. If not using the built-in make then the following defines will need to be manually created in `target.h`:
+
+```
+#define WOLFBOOT_SECTOR_SIZE                 0x20000
+#define WOLFBOOT_PARTITION_BOOT_ADDRESS      0x800000
+#define WOLFBOOT_LOAD_ADDRESS                0x10000000
+#define WOLFBOOT_PARTITION_SIZE              0x2A00000 
+#define WOLFBOOT_PARTITION_UPDATE_ADDRESS    0x3A00000
+#define WOLFBOOT_PARTITION_SWAP_ADDRESS      0x63E0000
+
+#define WOLFBOOT_DTS_BOOT_ADDRESS            0x7E0000
+#define WOLFBOOT_DTS_UPDATE_ADDRESS          0x39E0000
+#define WOLFBOOT_LOAD_DTS_ADDRESS            0x11800000
+```
 
 Note: If not using Position Independent Code (PIC) the linker script `ldscript.ld` must have the start address offset to match the `WOLFBOOT_LOAD_ADDRESS`.
 
@@ -52,6 +65,9 @@ Xilinx uses a `bootgen` tool for generating a boot binary image that has Xilinx
 6. Build “boot.bin” image:
     * `bootgen.exe -image boot.bif -arch zynqmp -o i BOOT.BIN -w`
 
+Note: To generate a report of a boot.bin use the `bootgen_utility`:
+`bootgen_utility -arch zynqmp -bin boot.bin -out boot.bin.txt`
+
 ### References:
 * [ZAPP1319](https://www.xilinx.com/support/documentation/application_notes/xapp1319-zynq-usp-prog-nvm.pdf): Programming BBRAM and eFUSEs
 * [UG1283](https://www.xilinx.com/support/documentation/sw_manuals/xilinx2018_2/ug1283-bootgen-user-guide.pdf): Bootgen User Guide

IDE/XilinxSDK/boot_auth.bif

@@ -17,9 +17,13 @@ the_ROM_image:
 	[destination_cpu=a53-0, exception_level=el-3, trustzone, authentication=rsa] bl31.elf
 	[destination_cpu=a53-0, authentication=rsa, load=0x11800000] system.dtb
 
+	// ARM Device Tree (loaded to RAM at 0x11800000 by wolfBoot)
+	[ destination_cpu=a53-0, authentication=rsa, offset=0x007E0000, partition_owner=uboot] system.dtb
+
 	// Second Stage wolfBoot Bootloader (in RAM at 0x0)
 	[destination_cpu=a53-0, exception_level=el-2, authentication=rsa] wolfboot.elf
 
-	// Using partition_owner=uboot prevents partition from being loaded to RAM
-	[destination_cpu=a53-0, offset=0x800000, partition_owner=uboot] helloworld_v1_signed.bin
+	// Kernel / Application (load to RAM at 0x10000000 by wolfBoot)
+	// Using partition_owner=uboot prevents FSBL from loading to RAM
+	[destination_cpu=a53-0, offset=0x800000, partition_owner=uboot] kernel.ui
 }

config/examples/zynqmp.config

@@ -35,5 +35,5 @@ WOLFBOOT_PARTITION_SWAP_ADDRESS?=0x63E0000
 
 # DTS (Device Tree)
 WOLFBOOT_LOAD_DTS_ADDRESS?=0x11800000
-WOLFBOOT_DTS_BOOT_ADDRESS?=0x0
-WOLFBOOT_DTS_UPDATE_ADDRESS?=0x0
+WOLFBOOT_DTS_BOOT_ADDRESS?=0x7B0000
+WOLFBOOT_DTS_UPDATE_ADDRESS?=0x39B0000

docs/Signing.md

@@ -1,6 +1,8 @@
 # wolfBoot Signing
 
-Instructions for setting up Python, wolfCrypt-py module and wolfBoot for firmware signing.
+Instructions for setting up Python, wolfCrypt-py module and wolfBoot for firmware signing. 
+
+Note: There is a pure C signing tool available as well. See [C Signing Tool](#c-signing-tool) below.
 
 ## Install Python3
 
@@ -61,3 +63,11 @@ openssl rsautl -sign -keyform der -inkey rsa4096.der -in test-app/image_v1_diges
 # Generate final signed binary
 python3 ./tools/keytools/sign.py --rsa4096 --sha3 --manual-sign test-app/image.bin rsa4096_pub.der 1 test-app/image_v1.sig
 ```
+
+## C Signing Tool
+
+A standalone C version of the signing tool is available here: `./tools/keytools/sign.c`. Build using `make keytools`
+
+```sh
+./tools/keytools/sign --rsa4096 --sha3 test-app/image.bin rsa4096.der 1
+```

include/image.h

@@ -92,8 +92,8 @@ uint16_t wolfBoot_find_header(uint8_t *haystack, uint16_t type, uint8_t **ptr);
 #  define SWAP_EXT 0
 # endif
 # define PARTN_IS_EXT(pn) \
-    ((pn == PART_BOOT)?BOOT_EXT: \
-        ((pn == PART_UPDATE)?UPDATE_EXT: \
+    ((pn == PART_BOOT || pn == PART_DTS_BOOT)?BOOT_EXT: \
+        ((pn == PART_UPDATE || pn == PART_DTS_UPDATE)?UPDATE_EXT: \
             ((pn == PART_SWAP)?SWAP_EXT:0)))
 # define PART_IS_EXT(x)  PARTN_IS_EXT(((x)->part))
 #include "hal.h"
@@ -152,7 +152,7 @@ static inline int wb_flash_write_verify_word(struct wolfBoot_image *img, uint32_
 #define UBOOT_IMG_HDR_SZ    64
 
 /* --- Flattened Device Tree Blob */
-#define UBOOT_FDT_MAGIC	    0xD00DFEEDUL
+#define UBOOT_FDT_MAGIC	    0xEDFE0DD0UL
 
 
 #endif /* !IMAGE_H */

src/image.c

@@ -453,25 +453,45 @@ int wolfBoot_open_image(struct wolfBoot_image *img, uint8_t part)
     uint8_t *image;
     if (!img)
         return -1;
+
+#ifdef EXT_FLASH
+    hdr_cpy_done = 0; /* reset hdr "open" flag */
+#endif
+
     memset(img, 0, sizeof(struct wolfBoot_image));
     img->part = part;
     if (part == PART_SWAP) {
-        img->part = PART_SWAP;
-        img->hdr = (void *)WOLFBOOT_PARTITION_SWAP_ADDRESS;
+        img->hdr_ok = 1;
+        img->hdr = (void*)WOLFBOOT_PARTITION_SWAP_ADDRESS;
         img->fw_base = img->hdr;
         img->fw_size = WOLFBOOT_SECTOR_SIZE;
         return 0;
     }
-    if (part == PART_BOOT) {
-        img->hdr = (void *)WOLFBOOT_PARTITION_BOOT_ADDRESS;
-    } else if (part == PART_UPDATE) {
-        img->hdr = (void *)WOLFBOOT_PARTITION_UPDATE_ADDRESS;
 #ifdef MMU
-    } else if (part == PART_DTS_BOOT) {
-        img->hdr = (void *)WOLFBOOT_DTS_BOOT_ADDRESS;
-    } else if (part == PART_DTS_UPDATE) {
-        img->hdr = (void *)WOLFBOOT_DTS_UPDATE_ADDRESS;
+    if (part == PART_DTS_BOOT || part == PART_DTS_UPDATE) {
+        img->hdr = (part == PART_DTS_BOOT) ? (void*)WOLFBOOT_DTS_BOOT_ADDRESS 
+                                           : (void*)WOLFBOOT_DTS_UPDATE_ADDRESS;
+        if (PART_IS_EXT(img))
+            image = fetch_hdr_cpy(img);
+        else
+            image = (uint8_t*)img->hdr;
+        if (*((uint32_t*)image) != UBOOT_FDT_MAGIC)
+            return -1;
+        img->hdr_ok = 1;
+        img->fw_base = img->hdr;
+        /* DTS data is big endian */
+        size = (uint32_t*)(image + sizeof(uint32_t));
+        img->fw_size = (((*size & 0x000000FF) << 24) |
+                        ((*size & 0x0000FF00) <<  8) |
+                        ((*size & 0x00FF0000) >>  8) |
+                        ((*size & 0xFF000000) >> 24));
+        return 0;
+    }
 #endif
+    if (part == PART_BOOT) {
+        img->hdr = (void*)WOLFBOOT_PARTITION_BOOT_ADDRESS;
+    } else if (part == PART_UPDATE) {
+        img->hdr = (void*)WOLFBOOT_PARTITION_UPDATE_ADDRESS;
     } else
         return -1;
 

src/update_ram.c

@@ -45,7 +45,7 @@ void RAMFUNCTION wolfBoot_start(void)
     uint8_t* image_ptr;
     uint8_t p_state;
 #ifdef MMU
-    uint32_t* dts_address;
+    uint32_t* dts_address = NULL;
 #endif
 
     active = wolfBoot_dualboot_candidate();
@@ -116,10 +116,18 @@ void RAMFUNCTION wolfBoot_start(void)
 #endif
 
 #ifdef MMU
-    /* Device Tree - Check */
-    dts_address = (uint32_t*)WOLFBOOT_LOAD_DTS_ADDRESS;
-    if (*dts_address != UBOOT_FDT_MAGIC) {
-        dts_address = NULL;
+    /* Device Tree Blob (DTB) Handling */
+    if (wolfBoot_open_image(&os_image, PART_DTS_BOOT) >= 0) {
+        dts_address = (uint32_t*)WOLFBOOT_LOAD_DTS_ADDRESS;
+
+    #ifdef EXT_FLASH
+        /* Load DTS to RAM */
+        if (PART_IS_EXT(&os_image)) {
+            ext_flash_read((uintptr_t)os_image.fw_base, 
+                        (uint8_t*)dts_address,
+                        os_image.fw_size);
+        }
+    #endif
     }
 #endif