tools/imximage.h

   1 /*
   2  * (C) Copyright 2009
   3  * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #ifndef _IMXIMAGE_H_
   9 #define _IMXIMAGE_H_
  10
  11 #define MAX_HW_CFG_SIZE_V2 121 /* Max number of registers imx can set for v2 */
  12 #define MAX_HW_CFG_SIZE_V1 60  /* Max number of registers imx can set for v1 */
  13 #define APP_CODE_BARKER 0xB1
  14 #define DCD_BARKER      0xB17219E9
  15
  16 /*
  17  * NOTE: This file must be kept in sync with arch/arm/include/asm/\
  18  *       imx-common/imximage.cfg because tools/imximage.c can not
  19  *       cross-include headers from arch/arm/ and vice-versa.
  20  */
  21 #define CMD_DATA_STR    "DATA"
  22
  23 /* Initial Vector Table Offset */
  24 #define FLASH_OFFSET_UNDEFINED  0xFFFFFFFF
  25 #define FLASH_OFFSET_STANDARD   0x400
  26 #define FLASH_OFFSET_NAND       FLASH_OFFSET_STANDARD
  27 #define FLASH_OFFSET_SD         FLASH_OFFSET_STANDARD
  28 #define FLASH_OFFSET_SPI        FLASH_OFFSET_STANDARD
  29 #define FLASH_OFFSET_ONENAND    0x100
  30 #define FLASH_OFFSET_NOR        0x1000
  31 #define FLASH_OFFSET_SATA       FLASH_OFFSET_STANDARD
  32
  33 /* Initial Load Region Size */
  34 #define FLASH_LOADSIZE_UNDEFINED        0xFFFFFFFF
  35 #define FLASH_LOADSIZE_STANDARD         0x1000
  36 #define FLASH_LOADSIZE_NAND             FLASH_LOADSIZE_STANDARD
  37 #define FLASH_LOADSIZE_SD               FLASH_LOADSIZE_STANDARD
  38 #define FLASH_LOADSIZE_SPI              FLASH_LOADSIZE_STANDARD
  39 #define FLASH_LOADSIZE_ONENAND          0x400
  40 #define FLASH_LOADSIZE_NOR              0x0 /* entire image */
  41 #define FLASH_LOADSIZE_SATA             FLASH_LOADSIZE_STANDARD
  42
  43 #define IVT_HEADER_TAG 0xD1
  44 #define IVT_VERSION 0x40
  45 #define DCD_HEADER_TAG 0xD2
  46 #define DCD_COMMAND_TAG 0xCC
  47 #define DCD_VERSION 0x40
  48 #define DCD_COMMAND_PARAM 0x4
  49
  50 enum imximage_cmd {
  51         CMD_INVALID,
  52         CMD_IMAGE_VERSION,
  53         CMD_BOOT_FROM,
  54         CMD_BOOT_OFFSET,
  55         CMD_DATA
  56 };
  57
  58 enum imximage_fld_types {
  59         CFG_INVALID = -1,
  60         CFG_COMMAND,
  61         CFG_REG_SIZE,
  62         CFG_REG_ADDRESS,
  63         CFG_REG_VALUE
  64 };
  65
  66 enum imximage_version {
  67         IMXIMAGE_VER_INVALID = -1,
  68         IMXIMAGE_V1 = 1,
  69         IMXIMAGE_V2
  70 };
  71
  72 typedef struct {
  73         uint32_t type; /* Type of pointer (byte, halfword, word, wait/read) */
  74         uint32_t addr; /* Address to write to */
  75         uint32_t value; /* Data to write */
  76 } dcd_type_addr_data_t;
  77
  78 typedef struct {
  79         uint32_t barker; /* Barker for sanity check */
  80         uint32_t length; /* Device configuration length (without preamble) */
  81 } dcd_preamble_t;
  82
  83 typedef struct {
  84         dcd_preamble_t preamble;
  85         dcd_type_addr_data_t addr_data[MAX_HW_CFG_SIZE_V1];
  86 } dcd_v1_t;
  87
  88 typedef struct {
  89         uint32_t app_code_jump_vector;
  90         uint32_t app_code_barker;
  91         uint32_t app_code_csf;
  92         uint32_t dcd_ptr_ptr;
  93         uint32_t super_root_key;
  94         uint32_t dcd_ptr;
  95         uint32_t app_dest_ptr;
  96 } flash_header_v1_t;
  97
  98 typedef struct {
  99         uint32_t length;        /* Length of data to be read from flash */
 100 } flash_cfg_parms_t;
 101
 102 typedef struct {
 103         flash_header_v1_t fhdr;
 104         dcd_v1_t dcd_table;
 105         flash_cfg_parms_t ext_header;
 106 } imx_header_v1_t;
 107
 108 typedef struct {
 109         uint32_t addr;
 110         uint32_t value;
 111 } dcd_addr_data_t;
 112
 113 typedef struct {
 114         uint8_t tag;
 115         uint16_t length;
 116         uint8_t version;
 117 } __attribute__((packed)) ivt_header_t;
 118
 119 typedef struct {
 120         uint8_t tag;
 121         uint16_t length;
 122         uint8_t param;
 123 } __attribute__((packed)) write_dcd_command_t;
 124
 125 typedef struct {
 126         ivt_header_t header;
 127         write_dcd_command_t write_dcd_command;
 128         dcd_addr_data_t addr_data[MAX_HW_CFG_SIZE_V2];
 129 } dcd_v2_t;
 130
 131 typedef struct {
 132         uint32_t start;
 133         uint32_t size;
 134         uint32_t plugin;
 135 } boot_data_t;
 136
 137 typedef struct {
 138         ivt_header_t header;
 139         uint32_t entry;
 140         uint32_t reserved1;
 141         uint32_t dcd_ptr;
 142         uint32_t boot_data_ptr;
 143         uint32_t self;
 144         uint32_t csf;
 145         uint32_t reserved2;
 146 } flash_header_v2_t;
 147
 148 typedef struct {
 149         flash_header_v2_t fhdr;
 150         boot_data_t boot_data;
 151         dcd_v2_t dcd_table;
 152 } imx_header_v2_t;
 153
 154 /* The header must be aligned to 4k on MX53 for NAND boot */
 155 struct imx_header {
 156         union {
 157                 imx_header_v1_t hdr_v1;
 158                 imx_header_v2_t hdr_v2;
 159         } header;
 160 };
 161
 162 typedef void (*set_dcd_val_t)(struct imx_header *imxhdr,
 163                                         char *name, int lineno,
 164                                         int fld, uint32_t value,
 165                                         uint32_t off);
 166
 167 typedef void (*set_dcd_rst_t)(struct imx_header *imxhdr,
 168                                         uint32_t dcd_len,
 169                                         char *name, int lineno);
 170
 171 typedef void (*set_imx_hdr_t)(struct imx_header *imxhdr, uint32_t dcd_len,
 172                 uint32_t entry_point, uint32_t flash_offset);
 173
 174 #endif /* _IMXIMAGE_H_ */