tools/mkimage.h

   1 /*
   2  * (C) Copyright 2000-2004
   3  * DENX Software Engineering
   4  * Wolfgang Denk, wd@denx.de
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of
   9  * the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  19  * MA 02111-1307 USA
  20  */
  21
  22 #ifndef _MKIIMAGE_H_
  23 #define _MKIIMAGE_H_
  24
  25 #include "os_support.h"
  26 #include <errno.h>
  27 #include <fcntl.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <sys/stat.h>
  32 #include <time.h>
  33 #include <unistd.h>
  34 #include <sha1.h>
  35 #include "fdt_host.h"
  36
  37 #undef MKIMAGE_DEBUG
  38
  39 #ifdef MKIMAGE_DEBUG
  40 #define debug(fmt,args...)      printf (fmt ,##args)
  41 #else
  42 #define debug(fmt,args...)
  43 #endif /* MKIMAGE_DEBUG */
  44
  45 #define MKIMAGE_TMPFILE_SUFFIX          ".tmp"
  46 #define MKIMAGE_MAX_TMPFILE_LEN         256
  47 #define MKIMAGE_DEFAULT_DTC_OPTIONS     "-I dts -O dtb -p 500"
  48 #define MKIMAGE_MAX_DTC_CMDLINE_LEN     512
  49 #define MKIMAGE_DTC                     "dtc"   /* assume dtc is in $PATH */
  50
  51 /*
  52  * This structure defines all such variables those are initialized by
  53  * mkimage main core and need to be referred by image type specific
  54  * functions
  55  */
  56 struct mkimage_params {
  57         int dflag;
  58         int eflag;
  59         int fflag;
  60         int lflag;
  61         int vflag;
  62         int xflag;
  63         int skipcpy;
  64         int os;
  65         int arch;
  66         int type;
  67         int comp;
  68         char *dtc;
  69         unsigned int addr;
  70         unsigned int ep;
  71         char *imagename;
  72         char *imagename2;
  73         char *datafile;
  74         char *imagefile;
  75         char *cmdname;
  76 };
  77
  78 /*
  79  * image type specific variables and callback functions
  80  */
  81 struct image_type_params {
  82         /* name is an identification tag string for added support */
  83         char *name;
  84         /*
  85          * header size is local to the specific image type to be supported,
  86          * mkimage core treats this as number of bytes
  87          */
  88         uint32_t header_size;
  89         /* Image type header pointer */
  90         void *hdr;
  91         /*
  92          * There are several arguments that are passed on the command line
  93          * and are registered as flags in mkimage_params structure.
  94          * This callback function can be used to check the passed arguments
  95          * are in-lined with the image type to be supported
  96          *
  97          * Returns 1 if parameter check is successful
  98          */
  99         int (*check_params) (struct mkimage_params *);
 100         /*
 101          * This function is used by list command (i.e. mkimage -l <filename>)
 102          * image type verification code must be put here
 103          *
 104          * Returns 0 if image header verification is successful
 105          * otherwise, returns respective negative error codes
 106          */
 107         int (*verify_header) (unsigned char *, int, struct mkimage_params *);
 108         /* Prints image information abstracting from image header */
 109         void (*print_header) (const void *);
 110         /*
 111          * The header or image contents need to be set as per image type to
 112          * be generated using this callback function.
 113          * further output file post processing (for ex. checksum calculation,
 114          * padding bytes etc..) can also be done in this callback function.
 115          */
 116         void (*set_header) (void *, struct stat *, int,
 117                                         struct mkimage_params *);
 118         /*
 119          * Some image generation support for ex (default image type) supports
 120          * more than one type_ids, this callback function is used to check
 121          * whether input (-T <image_type>) is supported by registered image
 122          * generation/list low level code
 123          */
 124         int (*check_image_type) (uint8_t);
 125         /* This callback function will be executed if fflag is defined */
 126         int (*fflag_handle) (struct mkimage_params *);
 127         /*
 128          * This callback function will be executed for variable size record
 129          * It is expected to build this header in memory and return its length
 130          * and a pointer to it
 131          */
 132         int (*vrec_header) (struct mkimage_params *,
 133                 struct image_type_params *);
 134         /* pointer to the next registered entry in linked list */
 135         struct image_type_params *next;
 136 };
 137
 138 /*
 139  * Exported functions
 140  */
 141 void mkimage_register (struct image_type_params *tparams);
 142
 143 /*
 144  * There is a c file associated with supported image type low level code
 145  * for ex. default_image.c, fit_image.c
 146  * init is the only function referred by mkimage core.
 147  * to avoid a single lined header file, you can define them here
 148  *
 149  * Supported image types init functions
 150  */
 151 void pbl_load_uboot(int fd, struct mkimage_params *mparams);
 152 void init_pbl_image_type(void);
 153 void init_ais_image_type(void);
 154 void init_kwb_image_type (void);
 155 void init_imx_image_type (void);
 156 void init_default_image_type (void);
 157 void init_fit_image_type (void);
 158 void init_ubl_image_type(void);
 159 void init_omap_image_type(void);
 160
 161 #endif /* _MKIIMAGE_H_ */