From patchwork Thu Jun 2 10:32:17 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Siarhei Siamashka X-Patchwork-Id: 629172 X-Patchwork-Delegate: hdegoede@redhat.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from theia.denx.de (theia.denx.de [85.214.87.163]) by ozlabs.org (Postfix) with ESMTP id 3rL3Sz2jmmz9sDG for ; Thu, 2 Jun 2016 20:32:34 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b=st9HY96H; dkim-atps=neutral Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id D7AE8A74D0; Thu, 2 Jun 2016 12:32:29 +0200 (CEST) Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id RBTMroVKfNlN; Thu, 2 Jun 2016 12:32:29 +0200 (CEST) Received: from theia.denx.de (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 250B54BD3D; Thu, 2 Jun 2016 12:32:29 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id B99DB4BD3D for ; Thu, 2 Jun 2016 12:32:25 +0200 (CEST) Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 9rxnZ8KOk2qs for ; Thu, 2 Jun 2016 12:32:25 +0200 (CEST) X-policyd-weight: NOT_IN_SBL_XBL_SPAMHAUS=-1.5 NOT_IN_SPAMCOP=-1.5 NOT_IN_BL_NJABL=-1.5 (only DNSBL check requested) Received: from mail-wm0-f67.google.com (mail-wm0-f67.google.com [74.125.82.67]) by theia.denx.de (Postfix) with ESMTPS id 6D7BA4BA68 for ; Thu, 2 Jun 2016 12:32:22 +0200 (CEST) Received: by mail-wm0-f67.google.com with SMTP id e3so14505079wme.2 for ; Thu, 02 Jun 2016 03:32:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id; bh=CKt54VJAF0C9BRpPsMn5Cm8HaRYmBg/QbCMzthfaXyY=; b=st9HY96HVwLpZ1yBQ6g++yo72+F1CDMFERdoXv6ThbfNYgK6SEEXkBJs0tZphwN+r/ w50NB/2jE8Elcy707U1PqB3t4iy4G8OqYNBXcc2ZnyPKDs0gtJEWRxyOwA2uhI3D2Fbq Pcr6duivGmW7haNaQS5RLGz+40YZFbQGsdhEz58LpaggjkUN1DjxSLxJtdoeZSUbm10T r54RQb2E7Lv9Lt0dB4jm5KmnH7TaiscnwIKggrQaveAd0l3KguR3QCUAMorB0/TYU9vr Hxu/zUsxg1TWLMCsUahexILdWHxXYHp2/CmcPO8idHXzpZWjZ0JrxFI4BwPFa3jewq4X GTjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=CKt54VJAF0C9BRpPsMn5Cm8HaRYmBg/QbCMzthfaXyY=; b=L0FyBrNfl52DnuTDtg2otHXNF228AZxsSdqvzh8Qp2/RktQhWGQnOUnx3mqBKh0FAF +1xANQxPQaxmr5mryuO5N0Yvy7q85lPa8dADg3lMz5uCrs0+hpiH1bmOb8ANF6BwZXvi oHQC+4nUAUg7FgEVEfkPpCw56+oUx7yWRZ9k9EozsgXSvYy7vLpi97OhssyKAPIl0qRS Kra89RVfckPV1hHB1BCjDDGuA77HIyv1edihWc4gbta5uQthd9XHLcOXth1KEou2f9pY CnDejEUyKRTRgdX1bpeT4YoZZ0KihvFXiZ9gZwga2y5ocquNIi09PHjLp8ae3fT2HG0I oI6w== X-Gm-Message-State: ALyK8tJpcymilKb6GF//8N+uwz8DWUJYhObtY+0S/l4+8AOiCfWjAqAm6dsixCrdhZN6+A== X-Received: by 10.28.155.197 with SMTP id d188mr26289593wme.30.1464863540679; Thu, 02 Jun 2016 03:32:20 -0700 (PDT) Received: from localhost.localdomain (dsl-espbrasgw1-54fa71-124.dhcp.inet.fi. [84.250.113.124]) by smtp.gmail.com with ESMTPSA id a128sm39874427wme.16.2016.06.02.03.32.19 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 02 Jun 2016 03:32:19 -0700 (PDT) From: Siarhei Siamashka To: u-boot@lists.denx.de Date: Thu, 2 Jun 2016 13:32:17 +0300 Message-Id: <1464863537-2307-1-git-send-email-siarhei.siamashka@gmail.com> X-Mailer: git-send-email 2.7.3 Cc: Andre Przywara , Ian Campbell , Bernhard Nortmann Subject: [U-Boot] [RFC] sunxi: Store the device tree name in the SPL header X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.15 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" This patch updates the mksunxiboot tool to optionally add the default device tree name string to the SPL header. This information can be used by the firmware upgrade tools to protect users from harming themselves by trying to upgrade to an incompatible bootloader. The primary use case here is a non-removable bootable media (such as NAND, eMMC or SPI flash), which already may have a properly working, but a little bit outdated bootloader installed. For example, the user may download or build a new U-Boot image for "Cubieboard", and then attemept to install it on a "Cubieboard2" hardware by mistake as a replacement for the already existing bootloader. If this happens, the flash programming tool can identify this problem and warn the user. CONFIG_OF_LIST may provide more than one compatible device tree name when supporting multiple boards by a single defconfig. In such cases, the right device tree name is getting identified at runtime from the list of multiple options. The patch calculates a 32-bit hash value (crc32) of this list and stores it to the SPL header too, because this is better than nothing and still can be used to warn about potentially incompatible upgrades. The size of the SPL header is also increased from 64 bytes to 96 bytes to provide enough space for the device tree name string. Signed-off-by: Siarhei Siamashka --- arch/arm/include/asm/arch-sunxi/spl.h | 26 +++++++++++-- include/configs/sunxi-common.h | 12 +++--- scripts/Makefile.spl | 3 +- tools/Makefile | 1 + tools/mksunxiboot.c | 71 +++++++++++++++++++++++++++++++++-- 5 files changed, 98 insertions(+), 15 deletions(-) diff --git a/arch/arm/include/asm/arch-sunxi/spl.h b/arch/arm/include/asm/arch-sunxi/spl.h index a0f33b0..f370222 100644 --- a/arch/arm/include/asm/arch-sunxi/spl.h +++ b/arch/arm/include/asm/arch-sunxi/spl.h @@ -10,7 +10,7 @@ #define BOOT0_MAGIC "eGON.BT0" #define SPL_SIGNATURE "SPL" /* marks "sunxi" SPL header */ -#define SPL_HEADER_VERSION 1 +#define SPL_HEADER_VERSION 2 #if defined(CONFIG_MACH_SUN9I) || defined(CONFIG_MACH_SUN50I) #define SPL_ADDR 0x10000 @@ -49,9 +49,27 @@ struct boot_file_head { uint8_t spl_signature[4]; }; uint32_t fel_script_address; - uint32_t reserved1[3]; - uint32_t boot_media; /* written here by the boot ROM */ - uint32_t reserved2[5]; /* padding, align to 64 bytes */ + uint32_t reserved1[1]; + /* + * Offset of an ASCIIZ string (relative to the SPL header), which + * contains the default device tree name (CONFIG_DEFAULT_DEVICE_TREE). + * This is optional and may be set to NULL. Is intended to be used + * by flash programming tools for providing nice informative messages + * to the users. + */ + uint32_t offset_of_the_default_device_tree_name; + /* + * A 32-bit hash value, calculated from the list of compatible device + * tree names (CONFIG_OF_LIST or CONFIG_DEFAULT_DEVICE_TREE). Is + * intended to be used by flash programming tools for safeguearding + * against upgrading to an incompatible firmware. + */ + uint32_t crc32_of_the_compatible_device_tree_list; + /* The 'boot_media' code is written here by the boot ROM */ + uint32_t boot_media; + /* A padding area (may be used for storing text strings) */ + uint32_t string_pool[13]; + /* The header must be a multiple of 32 bytes (for VBAR alignment) */ }; #define is_boot0_magic(addr) (memcmp((void *)addr, BOOT0_MAGIC, 8) == 0) diff --git a/include/configs/sunxi-common.h b/include/configs/sunxi-common.h index b33cfb8..e184d0c 100644 --- a/include/configs/sunxi-common.h +++ b/include/configs/sunxi-common.h @@ -189,14 +189,14 @@ #define CONFIG_SPL_BOARD_LOAD_IMAGE #if defined(CONFIG_MACH_SUN9I) -#define CONFIG_SPL_TEXT_BASE 0x10040 /* sram start+header */ -#define CONFIG_SPL_MAX_SIZE 0x5fc0 /* ? KiB on sun9i */ +#define CONFIG_SPL_TEXT_BASE 0x10060 /* sram start+header */ +#define CONFIG_SPL_MAX_SIZE 0x5fa0 /* ? KiB on sun9i */ #elif defined(CONFIG_MACH_SUN50I) -#define CONFIG_SPL_TEXT_BASE 0x10040 /* sram start+header */ -#define CONFIG_SPL_MAX_SIZE 0x7fc0 /* 32 KiB on sun50i */ +#define CONFIG_SPL_TEXT_BASE 0x10060 /* sram start+header */ +#define CONFIG_SPL_MAX_SIZE 0x7fa0 /* 32 KiB on sun50i */ #else -#define CONFIG_SPL_TEXT_BASE 0x40 /* sram start+header */ -#define CONFIG_SPL_MAX_SIZE 0x5fc0 /* 24KB on sun4i/sun7i */ +#define CONFIG_SPL_TEXT_BASE 0x60 /* sram start+header */ +#define CONFIG_SPL_MAX_SIZE 0x5fa0 /* 24KB on sun4i/sun7i */ #endif #define CONFIG_SPL_LIBDISK_SUPPORT diff --git a/scripts/Makefile.spl b/scripts/Makefile.spl index 6d2017d..54d8a2e 100644 --- a/scripts/Makefile.spl +++ b/scripts/Makefile.spl @@ -240,7 +240,8 @@ $(obj)/$(SPL_BIN).sfp: $(obj)/$(SPL_BIN).bin FORCE $(call if_changed,mkimage) quiet_cmd_mksunxiboot = MKSUNXI $@ -cmd_mksunxiboot = $(objtree)/tools/mksunxiboot $< $@ +cmd_mksunxiboot = $(objtree)/tools/mksunxiboot --default-dt "$(CONFIG_DEFAULT_DEVICE_TREE)" \ + --compatible-dt-list "$(CONFIG_OF_LIST)" $< $@ $(obj)/sunxi-spl.bin: $(obj)/$(SPL_BIN).bin FORCE $(call if_changed,mksunxiboot) diff --git a/tools/Makefile b/tools/Makefile index 63355aa..e6c0481 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -155,6 +155,7 @@ hostprogs-$(CONFIG_MX28) += mxsboot HOSTCFLAGS_mxsboot.o := -pedantic hostprogs-$(CONFIG_SUNXI) += mksunxiboot +mksunxiboot-objs := mksunxiboot.o lib/crc32.o hostprogs-$(CONFIG_NETCONSOLE) += ncb hostprogs-$(CONFIG_SHA1_CHECK_UB_IMG) += ubsha1 diff --git a/tools/mksunxiboot.c b/tools/mksunxiboot.c index 9c1c5b7..b45acec 100644 --- a/tools/mksunxiboot.c +++ b/tools/mksunxiboot.c @@ -17,6 +17,8 @@ #include #include "asm/arch/spl.h" +#include + #define STAMP_VALUE 0x5F0A6C39 /* check sum functon from sun4i boot code */ @@ -70,11 +72,55 @@ int main(int argc, char *argv[]) struct boot_img img; unsigned file_size; int count; + char *tool_name = argv[0]; + char *default_dt = NULL; + char *compatible_dt_list = NULL; + + /* a sanity check */ + if ((sizeof(img.header) % 32) != 0) { + fprintf(stderr, "ERROR: the SPL header must be a multiple "); + fprintf(stderr, "of 32 bytes.\n"); + return EXIT_FAILURE; + } + + /* process optional command line switches */ + while (argc >= 2 && argv[1][0] == '-') { + if (strcmp(argv[1], "--default-dt") == 0) { + if (argc >= 3) { + default_dt = argv[2]; + argv += 2; + argc -= 2; + continue; + } + fprintf(stderr, "ERROR: no --default-dt arg\n"); + return EXIT_FAILURE; + } else if (strcmp(argv[1], "--compatible-dt-list") == 0) { + if (argc >= 3) { + compatible_dt_list = argv[2]; + argv += 2; + argc -= 2; + continue; + } + fprintf(stderr, "ERROR: no --compatible-dt-list arg\n"); + return EXIT_FAILURE; + } else { + fprintf(stderr, "ERROR: bad option '%s'\n", argv[1]); + return EXIT_FAILURE; + } + } - if (argc < 2) { - printf("\tThis program makes an input bin file to sun4i " \ - "bootable image.\n" \ - "\tUsage: %s input_file out_putfile\n", argv[0]); + if (!compatible_dt_list || strlen(compatible_dt_list) == 0) + compatible_dt_list = default_dt; + + if (argc < 3) { + printf("This program converts an input binary file to a sunxi bootable image.\n"); + printf("\nUsage: %s [options] input_file output_file\n", + tool_name); + printf("Where [options] may be:\n"); + printf(" --default-dt arg - 'arg' is the default device tree name\n"); + printf(" (CONFIG_DEFAULT_DEVICE_TREE).\n"); + printf(" --compatible-dt-list arg - 'arg' is the space separated list of the\n"); + printf(" compatible device tree names (CONFIG_OF_LIST).\n"); return EXIT_FAILURE; } @@ -122,6 +168,23 @@ int main(int argc, char *argv[]) memcpy(img.header.spl_signature, SPL_SIGNATURE, 3); /* "sunxi" marker */ img.header.spl_signature[3] = SPL_HEADER_VERSION; + if (default_dt) { + if (strlen(default_dt) + 1 <= sizeof(img.header.string_pool)) { + strcpy((char *)img.header.string_pool, default_dt); + img.header.offset_of_the_default_device_tree_name = + cpu_to_le32(offsetof(struct boot_file_head, + string_pool)); + } else { + printf("WARNING: The SPL header is too small\n"); + printf(" and has no space to store the dt name.\n"); + } + } + if (compatible_dt_list) { + img.header.crc32_of_the_compatible_device_tree_list = + cpu_to_le32(crc32(0, (uint8_t *)compatible_dt_list, + strlen(compatible_dt_list))); + } + gen_check_sum(&img.header); count = write(fd_out, &img, le32_to_cpu(img.header.length));