summaryrefslogtreecommitdiff
path: root/tools/mkimage.h
diff options
context:
space:
mode:
authorPrafulla Wadaskar <prafulla@marvell.com>2009-08-19 17:36:46 +0530
committerWolfgang Denk <wd@denx.de>2009-09-10 22:58:48 +0200
commit89a4d6b12fd6394898b8a454cbabeaf1cd59bae5 (patch)
tree9cf4f2afe41f1206b11e8e58dbfce0af9e24973a /tools/mkimage.h
parent449609f5b11cce6beba7338bc4ce0f3345376a0b (diff)
downloadu-boot-imx-89a4d6b12fd6394898b8a454cbabeaf1cd59bae5.zip
u-boot-imx-89a4d6b12fd6394898b8a454cbabeaf1cd59bae5.tar.gz
u-boot-imx-89a4d6b12fd6394898b8a454cbabeaf1cd59bae5.tar.bz2
tools: mkimage: split code into core, default and FIT image specific
This is a first step towards reorganizing the mkimage code to make it easier to add support for additional images types. Current mkimage code is specific to generating uImage and FIT image files, but the same framework can be used to generate other image types like Kirkwood boot images (kwbimage-TBD). For this, the mkimage code gets reworked: Here is the brief plan for the same:- a) Split mkimage code into core and image specific support b) Implement callback functions for image specific code c) Move image type specific code to respective C files Currently there are two types of file generation/list supported (i.e uImage, FIT), the code is abstracted from mkimage.c/.h and put in default_image.c and fit_image.c; all code in these file is static except init function call d) mkimage_register API is added to add new image type support All above is addressed in this patch e) Add kwbimage type support to this new framework (TBD) This will be implemented in a following commit. Signed-off-by: Prafulla Wadaskar <prafulla@marvell.com> Edit commit message, fix coding style and typos. Signed-off-by: Wolfgang Denk <wd@denx.de>
Diffstat (limited to 'tools/mkimage.h')
-rw-r--r--tools/mkimage.h101
1 files changed, 100 insertions, 1 deletions
diff --git a/tools/mkimage.h b/tools/mkimage.h
index c077dc9..120970f 100644
--- a/tools/mkimage.h
+++ b/tools/mkimage.h
@@ -19,6 +19,9 @@
* MA 02111-1307 USA
*/
+#ifndef _MKIIMAGE_H_
+#define _MKIIMAGE_H_
+
#include "os_support.h"
#include <errno.h>
#include <fcntl.h>
@@ -31,7 +34,7 @@
#include <sha1.h>
#include "fdt_host.h"
-#define MKIMAGE_DEBUG
+#undef MKIMAGE_DEBUG
#ifdef MKIMAGE_DEBUG
#define debug(fmt,args...) printf (fmt ,##args)
@@ -44,3 +47,99 @@
#define MKIMAGE_DEFAULT_DTC_OPTIONS "-I dts -O dtb -p 500"
#define MKIMAGE_MAX_DTC_CMDLINE_LEN 512
#define MKIMAGE_DTC "dtc" /* assume dtc is in $PATH */
+
+/*
+ * This structure defines all such variables those are initialized by
+ * mkimage main core and need to be referred by image type specific
+ * functions
+ */
+struct mkimage_params {
+ int dflag;
+ int eflag;
+ int fflag;
+ int lflag;
+ int vflag;
+ int xflag;
+ int os;
+ int arch;
+ int type;
+ int comp;
+ char *dtc;
+ unsigned int addr;
+ unsigned int ep;
+ char *imagename;
+ char *datafile;
+ char *imagefile;
+ char *cmdname;
+};
+
+/*
+ * image type specific variables and callback functions
+ */
+struct image_type_params {
+ /* name is an identification tag string for added support */
+ char *name;
+ /*
+ * header size is local to the specific image type to be supported,
+ * mkimage core treats this as number of bytes
+ */
+ uint32_t header_size;
+ /* Image type header pointer */
+ void *hdr;
+ /*
+ * There are several arguments that are passed on the command line
+ * and are registered as flags in mkimage_params structure.
+ * This callback function can be used to check the passed arguments
+ * are in-lined with the image type to be supported
+ *
+ * Returns 1 if parameter check is successful
+ */
+ int (*check_params) (struct mkimage_params *);
+ /*
+ * This function is used by list command (i.e. mkimage -l <filename>)
+ * image type verification code must be put here
+ *
+ * Returns 0 if image header verification is successful
+ * otherwise, returns respective negative error codes
+ */
+ int (*verify_header) (unsigned char *, int, struct mkimage_params *);
+ /* Prints image information abstracting from image header */
+ void (*print_header) (void *);
+ /*
+ * The header or image contents need to be set as per image type to
+ * be generated using this callback function.
+ * further output file post processing (for ex. checksum calculation,
+ * padding bytes etc..) can also be done in this callback function.
+ */
+ void (*set_header) (void *, struct stat *, int,
+ struct mkimage_params *);
+ /*
+ * Some image generation support for ex (default image type) supports
+ * more than one type_ids, this callback function is used to check
+ * whether input (-T <image_type>) is supported by registered image
+ * generation/list low level code
+ */
+ int (*check_image_type) (uint8_t);
+ /* This callback function will be executed if fflag is defined */
+ int (*fflag_handle) (struct mkimage_params *);
+ /* pointer to the next registered entry in linked list */
+ struct image_type_params *next;
+};
+
+/*
+ * Exported functions
+ */
+void mkimage_register (struct image_type_params *tparams);
+
+/*
+ * There is a c file associated with supported image type low level code
+ * for ex. default_image.c, fit_image.c
+ * init is the only function referred by mkimage core.
+ * to avoid a single lined header file, you can define them here
+ *
+ * Supported image types init functions
+ */
+void init_default_image_type (void);
+void init_fit_image_type (void);
+
+#endif /* _MKIIMAGE_H_ */