colibri_imx6: fix video stdout in default environment
[oweals/u-boot.git] / tools / mksunxiboot.c
index 1f0fbae8e17dd4432912d95be4883d2dca273772..a18c9d98bc7d1b814b1e0c775bcfcbc1809ab512 100644 (file)
@@ -1,11 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2007-2011
  * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
  * Tom Cubie <tangliang@allwinnertech.com>
  *
  * a simple tool to generate bootable image for sunxi platform.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 #include <fcntl.h>
 #include <stdio.h>
 #include <errno.h>
 #include <sys/types.h>
 #include <sys/stat.h>
+#include "imagetool.h"
+#include "../arch/arm/include/asm/arch-sunxi/spl.h"
 
-/* boot head definition from sun4i boot code */
-struct boot_file_head {
-       uint32_t b_instruction; /* one intruction jumping to real code */
-       uint8_t magic[8];       /* ="eGON.BT0" or "eGON.BT1", not C-style str */
-       uint32_t check_sum;     /* generated by PC */
-       uint32_t length;        /* generated by PC */
-       /*
-        * We use a simplified header, only filling in what is needed
-        * by the boot ROM. To be compatible with Allwinner tools we
-        * would need to implement the proper fields here instead of
-        * padding.
-        */
-       uint8_t pad[12];                /* align to 32 bytes */
-};
-
-#define BOOT0_MAGIC                     "eGON.BT0"
 #define STAMP_VALUE                     0x5F0A6C39
 
 /* check sum functon from sun4i boot code */
@@ -43,29 +28,32 @@ int gen_check_sum(struct boot_file_head *head_p)
        uint32_t i;
        uint32_t sum;
 
-       length = head_p->length;
+       length = le32_to_cpu(head_p->length);
        if ((length & 0x3) != 0)        /* must 4-byte-aligned */
                return -1;
        buf = (uint32_t *)head_p;
-       head_p->check_sum = STAMP_VALUE;        /* fill stamp */
+       head_p->check_sum = cpu_to_le32(STAMP_VALUE);   /* fill stamp */
        loop = length >> 2;
 
        /* calculate the sum */
        for (i = 0, sum = 0; i < loop; i++)
-               sum += buf[i];
+               sum += le32_to_cpu(buf[i]);
 
        /* write back check sum */
-       head_p->check_sum = sum;
+       head_p->check_sum = cpu_to_le32(sum);
 
        return 0;
 }
 
-#define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a)-1)
-#define __ALIGN_MASK(x, mask) (((x)+(mask))&~(mask))
+#define SUNXI_SRAM_SIZE 0x8000 /* SoC with smaller size are limited before */
+#define SRAM_LOAD_MAX_SIZE (SUNXI_SRAM_SIZE - sizeof(struct boot_file_head))
 
-#define SUN4I_SRAM_SIZE 0x7600 /* 0x7748+ is used by BROM */
-#define SRAM_LOAD_MAX_SIZE (SUN4I_SRAM_SIZE - sizeof(struct boot_file_head))
-#define BLOCK_SIZE 512
+/*
+ * BROM (at least on A10 and A20) requires NAND-images to be explicitly aligned
+ * to a multiple of 8K, and rejects the image otherwise. MMC-images are fine
+ * with 512B blocks. To cater for both, align to the largest of the two.
+ */
+#define BLOCK_SIZE 0x2000
 
 struct boot_img {
        struct boot_file_head header;
@@ -79,11 +67,40 @@ int main(int argc, char *argv[])
        struct boot_img img;
        unsigned file_size;
        int count;
+       char *tool_name = argv[0];
+       char *default_dt = 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 {
+                       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 (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");
                return EXIT_FAILURE;
        }
 
@@ -93,7 +110,7 @@ int main(int argc, char *argv[])
                return EXIT_FAILURE;
        }
 
-       memset(img.pad, 0, BLOCK_SIZE);
+       memset(&img, 0, sizeof(img));
 
        /* get input file size */
        file_size = lseek(fd_in, 0, SEEK_END);
@@ -125,10 +142,28 @@ int main(int argc, char *argv[])
        memcpy(img.header.magic, BOOT0_MAGIC, 8);       /* no '0' termination */
        img.header.length =
                ALIGN(file_size + sizeof(struct boot_file_head), BLOCK_SIZE);
+       img.header.b_instruction = cpu_to_le32(img.header.b_instruction);
+       img.header.length = cpu_to_le32(img.header.length);
+
+       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.dt_name_offset =
+                               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");
+               }
+       }
+
        gen_check_sum(&img.header);
 
-       count = write(fd_out, &img, img.header.length);
-       if (count != img.header.length) {
+       count = write(fd_out, &img, le32_to_cpu(img.header.length));
+       if (count != le32_to_cpu(img.header.length)) {
                perror("Writing output");
                return EXIT_FAILURE;
        }