blob: ea45f5c834910196560cc0c65612d51ddbbb7250 [file] [log] [blame]
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01001/*
2 * (C) Copyright 2000-2004
3 * DENX Software Engineering
4 * Wolfgang Denk, wd@denx.de
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01005 *
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
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053022#ifndef _MKIIMAGE_H_
23#define _MKIIMAGE_H_
24
Peter Tyser2f8d3962009-03-13 18:54:51 -050025#include "os_support.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010026#include <errno.h>
27#include <fcntl.h>
28#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010031#include <sys/stat.h>
32#include <time.h>
33#include <unistd.h>
Bartlomiej Siekaa6e530f2008-02-29 16:00:23 +010034#include <sha1.h>
Bartlomiej Sieka8cf30802008-02-29 16:00:24 +010035#include "fdt_host.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010036
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053037#undef MKIMAGE_DEBUG
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010038
39#ifdef MKIMAGE_DEBUG
40#define debug(fmt,args...) printf (fmt ,##args)
41#else
42#define debug(fmt,args...)
43#endif /* MKIMAGE_DEBUG */
44
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010045#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 */
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053050
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 */
56struct mkimage_params {
57 int dflag;
58 int eflag;
59 int fflag;
60 int lflag;
61 int vflag;
62 int xflag;
Stefano Babicf0662102011-09-15 23:50:16 +000063 int skipcpy;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053064 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;
Shaohui Xie5d898a02012-08-10 02:49:35 +000072 char *imagename2;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053073 char *datafile;
74 char *imagefile;
75 char *cmdname;
76};
77
78/*
79 * image type specific variables and callback functions
80 */
81struct 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 */
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200109 void (*print_header) (const void *);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530110 /*
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 *);
Stefano Babicf0662102011-09-15 23:50:16 +0000127 /*
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 *);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530134 /* pointer to the next registered entry in linked list */
135 struct image_type_params *next;
136};
137
138/*
139 * Exported functions
140 */
141void 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 */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000151void pbl_load_uboot(int fd, struct mkimage_params *mparams);
152void init_pbl_image_type(void);
Stefano Babic4962e382011-10-17 00:07:43 +0000153void init_ais_image_type(void);
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530154void init_kwb_image_type (void);
Stefano Babic8edcde52010-01-20 18:19:10 +0100155void init_imx_image_type (void);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530156void init_default_image_type (void);
157void init_fit_image_type (void);
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000158void init_ubl_image_type(void);
John Rigby3decb142011-07-21 09:10:30 -0400159void init_omap_image_type(void);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530160
161#endif /* _MKIIMAGE_H_ */