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 <tangliang@allwinnertech.com>
   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
  13 #ifndef SUNXI_IMAGE_H
  14 #define SUNXI_IMAGE_H
  15
  16 #include <linux/compiler_attributes.h>
  17 #include <linux/types.h>
  18
  19 #define BOOT0_MAGIC             "eGON.BT0"
  20 #define BROM_STAMP_VALUE        0x5f0a6c39
  21 #define SPL_SIGNATURE           "SPL" /* marks "sunxi" SPL header */
  22 #define SPL_MAJOR_BITS          3
  23 #define SPL_MINOR_BITS          5
  24 #define SPL_VERSION(maj, min)                                           \
  25         ((((maj) & ((1U << SPL_MAJOR_BITS) - 1)) << SPL_MINOR_BITS) | \
  26         ((min) & ((1U << SPL_MINOR_BITS) - 1)))
  27
  28 #define SPL_HEADER_VERSION      SPL_VERSION(0, 2)
  29
  30 #define SPL_ENV_HEADER_VERSION  SPL_VERSION(0, 1)
  31 #define SPL_DT_HEADER_VERSION   SPL_VERSION(0, 2)
  32 #define SPL_DRAM_HEADER_VERSION SPL_VERSION(0, 3)
  33
  34 /* boot head definition from sun4i boot code */
  35 struct boot_file_head {
  36         uint32_t b_instruction; /* one intruction jumping to real code */
  37         uint8_t magic[8];       /* ="eGON.BT0" or "eGON.BT1", not C-style str */
  38         uint32_t check_sum;     /* generated by PC */
  39         uint32_t length;        /* generated by PC */
  40         /*
  41          * We use a simplified header, only filling in what is needed
  42          * by the boot ROM. To be compatible with Allwinner tools we
  43          * would need to implement the proper fields here instead of
  44          * padding.
  45          *
  46          * Actually we want the ability to recognize our "sunxi" variant
  47          * of the SPL. To do so, let's place a special signature into the
  48          * "pub_head_size" field. We can reasonably expect Allwinner's
  49          * boot0 to always have the upper 16 bits of this set to 0 (after
  50          * all the value shouldn't be larger than the limit imposed by
  51          * SRAM size).
  52          * If the signature is present (at 0x14), then we know it's safe
  53          * to use the remaining 8 bytes (at 0x18) for our own purposes.
  54          * (E.g. sunxi-tools "fel" utility can pass information there.)
  55          */
  56         union {
  57                 uint32_t pub_head_size;
  58                 uint8_t spl_signature[4];
  59         };
  60         uint32_t fel_script_address;    /* since v0.1, set by sunxi-fel */
  61         /*
  62          * If the fel_uEnv_length member below is set to a non-zero value,
  63          * it specifies the size (byte count) of data at fel_script_address.
  64          * At the same time this indicates that the data is in uEnv.txt
  65          * compatible format, ready to be imported via "env import -t".
  66          */
  67         uint32_t fel_uEnv_length;       /* since v0.1, set by sunxi-fel */
  68         /*
  69          * Offset of an ASCIIZ string (relative to the SPL header), which
  70          * contains the default device tree name (CONFIG_DEFAULT_DEVICE_TREE).
  71          * This is optional and may be set to NULL. Is intended to be used
  72          * by flash programming tools for providing nice informative messages
  73          * to the users.
  74          */
  75         uint32_t dt_name_offset;        /* since v0.2, set by mksunxiboot */
  76         uint32_t dram_size;             /* in MiB, since v0.3, set by SPL */
  77         uint32_t boot_media;            /* written here by the boot ROM */
  78         /* A padding area (may be used for storing text strings) */
  79         uint32_t string_pool[13];       /* since v0.2, filled by mksunxiboot */
  80         /* The header must be a multiple of 32 bytes (for VBAR alignment) */
  81 };
  82
  83 /* Compile time check to assure proper alignment of structure */
  84 typedef char boot_file_head_not_multiple_of_32[1 - 2*(sizeof(struct boot_file_head) % 32)];
  85
  86 struct __packed toc0_main_info {
  87         uint8_t name[8];
  88         __le32  magic;
  89         __le32  checksum;
  90         __le32  serial;
  91         __le32  status;
  92         __le32  num_items;
  93         __le32  length;
  94         uint8_t platform[4];
  95         uint8_t reserved[8];
  96         uint8_t end[4];
  97 };
  98
  99 #define TOC0_MAIN_INFO_NAME             "TOC0.GLH"
 100 #define TOC0_MAIN_INFO_MAGIC            0x89119800
 101 #define TOC0_MAIN_INFO_END              "MIE;"
 102
 103 struct __packed toc0_item_info {
 104         __le32  name;
 105         __le32  offset;
 106         __le32  length;
 107         __le32  status;
 108         __le32  type;
 109         __le32  load_addr;
 110         uint8_t reserved[4];
 111         uint8_t end[4];
 112 };
 113
 114 #define TOC0_ITEM_INFO_NAME_CERT        0x00010101
 115 #define TOC0_ITEM_INFO_NAME_FIRMWARE    0x00010202
 116 #define TOC0_ITEM_INFO_NAME_KEY         0x00010303
 117 #define TOC0_ITEM_INFO_END              "IIE;"
 118
 119 #endif