include/sunxi_image.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2007-2011
   4  * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
   5  * Tom Cubie <[email protected]>
   6  *
   7  * Constants and data structures used in Allwinner "eGON" images, as
   8  * parsed by the Boot-ROM.
   9  *
  10  * Shared between mkimage and the SPL.
  11  */
  12 #ifndef SUNXI_IMAGE_H
  13 #define SUNXI_IMAGE_H
  14
  15 #define BOOT0_MAGIC             "eGON.BT0"
  16 #define SPL_SIGNATURE           "SPL" /* marks "sunxi" SPL header */
  17 #define SPL_MAJOR_BITS          3
  18 #define SPL_MINOR_BITS          5
  19 #define SPL_VERSION(maj, min)                                           \
  20         ((((maj) & ((1U << SPL_MAJOR_BITS) - 1)) << SPL_MINOR_BITS) | \
  21         ((min) & ((1U << SPL_MINOR_BITS) - 1)))
  22
  23 #define SPL_HEADER_VERSION      SPL_VERSION(0, 2)
  24
  25 #define SPL_ENV_HEADER_VERSION  SPL_VERSION(0, 1)
  26 #define SPL_DT_HEADER_VERSION   SPL_VERSION(0, 2)
  27 #define SPL_DRAM_HEADER_VERSION SPL_VERSION(0, 3)
  28
  29 /* boot head definition from sun4i boot code */
  30 struct boot_file_head {
  31         uint32_t b_instruction; /* one intruction jumping to real code */
  32         uint8_t magic[8];       /* ="eGON.BT0" or "eGON.BT1", not C-style str */
  33         uint32_t check_sum;     /* generated by PC */
  34         uint32_t length;        /* generated by PC */
  35         /*
  36          * We use a simplified header, only filling in what is needed
  37          * by the boot ROM. To be compatible with Allwinner tools we
  38          * would need to implement the proper fields here instead of
  39          * padding.
  40          *
  41          * Actually we want the ability to recognize our "sunxi" variant
  42          * of the SPL. To do so, let's place a special signature into the
  43          * "pub_head_size" field. We can reasonably expect Allwinner's
  44          * boot0 to always have the upper 16 bits of this set to 0 (after
  45          * all the value shouldn't be larger than the limit imposed by
  46          * SRAM size).
  47          * If the signature is present (at 0x14), then we know it's safe
  48          * to use the remaining 8 bytes (at 0x18) for our own purposes.
  49          * (E.g. sunxi-tools "fel" utility can pass information there.)
  50          */
  51         union {
  52                 uint32_t pub_head_size;
  53                 uint8_t spl_signature[4];
  54         };
  55         uint32_t fel_script_address;    /* since v0.1, set by sunxi-fel */
  56         /*
  57          * If the fel_uEnv_length member below is set to a non-zero value,
  58          * it specifies the size (byte count) of data at fel_script_address.
  59          * At the same time this indicates that the data is in uEnv.txt
  60          * compatible format, ready to be imported via "env import -t".
  61          */
  62         uint32_t fel_uEnv_length;       /* since v0.1, set by sunxi-fel */
  63         /*
  64          * Offset of an ASCIIZ string (relative to the SPL header), which
  65          * contains the default device tree name (CONFIG_DEFAULT_DEVICE_TREE).
  66          * This is optional and may be set to NULL. Is intended to be used
  67          * by flash programming tools for providing nice informative messages
  68          * to the users.
  69          */
  70         uint32_t dt_name_offset;        /* since v0.2, set by mksunxiboot */
  71         uint32_t dram_size;             /* in MiB, since v0.3, set by SPL */
  72         uint32_t boot_media;            /* written here by the boot ROM */
  73         /* A padding area (may be used for storing text strings) */
  74         uint32_t string_pool[13];       /* since v0.2, filled by mksunxiboot */
  75         /* The header must be a multiple of 32 bytes (for VBAR alignment) */
  76 };
  77
  78 /* Compile time check to assure proper alignment of structure */
  79 typedef char boot_file_head_not_multiple_of_32[1 - 2*(sizeof(struct boot_file_head) % 32)];
  80
  81 #endif