blob: af491544e42b5557a1e06c0afd0aef50d6fa010d [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 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02006 * SPDX-License-Identifier: GPL-2.0+
Marian Balakowiczb97a2a02008-01-08 18:14:09 +01007 */
8
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +05309#ifndef _MKIIMAGE_H_
10#define _MKIIMAGE_H_
11
Peter Tyser2f8d3962009-03-13 18:54:51 -050012#include "os_support.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010013#include <errno.h>
14#include <fcntl.h>
15#include <stdio.h>
16#include <stdlib.h>
17#include <string.h>
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010018#include <sys/stat.h>
19#include <time.h>
20#include <unistd.h>
Bartlomiej Siekaa6e530f2008-02-29 16:00:23 +010021#include <sha1.h>
Bartlomiej Sieka8cf30802008-02-29 16:00:24 +010022#include "fdt_host.h"
Marian Balakowiczb97a2a02008-01-08 18:14:09 +010023
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053024#undef MKIMAGE_DEBUG
Marian Balakowicz5dfb5212008-02-29 21:24:06 +010025
26#ifdef MKIMAGE_DEBUG
27#define debug(fmt,args...) printf (fmt ,##args)
28#else
29#define debug(fmt,args...)
30#endif /* MKIMAGE_DEBUG */
31
Simon Glass816cb032013-05-07 06:11:49 +000032#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
33
Simon Glass2434c662013-05-16 13:53:20 +000034static inline void *map_sysmem(ulong paddr, unsigned long len)
35{
36 return (void *)(uintptr_t)paddr;
37}
38
39static inline ulong map_to_sysmem(void *ptr)
40{
41 return (ulong)(uintptr_t)ptr;
42}
43
Bartlomiej Sieka9d254382008-03-11 12:34:47 +010044#define MKIMAGE_TMPFILE_SUFFIX ".tmp"
45#define MKIMAGE_MAX_TMPFILE_LEN 256
46#define MKIMAGE_DEFAULT_DTC_OPTIONS "-I dts -O dtb -p 500"
47#define MKIMAGE_MAX_DTC_CMDLINE_LEN 512
48#define MKIMAGE_DTC "dtc" /* assume dtc is in $PATH */
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053049
Simon Glass2434c662013-05-16 13:53:20 +000050#define IH_ARCH_DEFAULT IH_ARCH_INVALID
51
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053052/*
53 * This structure defines all such variables those are initialized by
54 * mkimage main core and need to be referred by image type specific
55 * functions
56 */
57struct mkimage_params {
58 int dflag;
59 int eflag;
60 int fflag;
61 int lflag;
62 int vflag;
63 int xflag;
Stefano Babicf0662102011-09-15 23:50:16 +000064 int skipcpy;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053065 int os;
66 int arch;
67 int type;
68 int comp;
69 char *dtc;
70 unsigned int addr;
71 unsigned int ep;
72 char *imagename;
Shaohui Xie5d898a02012-08-10 02:49:35 +000073 char *imagename2;
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053074 char *datafile;
75 char *imagefile;
76 char *cmdname;
Simon Glass80e4df82013-06-13 15:10:03 -070077 const char *keydir; /* Directory holding private keys */
Simon Glasse29495d2013-06-13 15:10:04 -070078 const char *keydest; /* Destination .dtb for public key */
Simon Glass4f610422013-06-13 15:10:06 -070079 const char *comment; /* Comment to add to signature node */
Simon Glass399c7442013-06-13 15:10:07 -070080 int require_keys; /* 1 to mark signing keys as 'required' */
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +053081};
82
83/*
84 * image type specific variables and callback functions
85 */
86struct image_type_params {
87 /* name is an identification tag string for added support */
88 char *name;
89 /*
90 * header size is local to the specific image type to be supported,
91 * mkimage core treats this as number of bytes
92 */
93 uint32_t header_size;
94 /* Image type header pointer */
95 void *hdr;
96 /*
97 * There are several arguments that are passed on the command line
98 * and are registered as flags in mkimage_params structure.
99 * This callback function can be used to check the passed arguments
100 * are in-lined with the image type to be supported
101 *
102 * Returns 1 if parameter check is successful
103 */
104 int (*check_params) (struct mkimage_params *);
105 /*
106 * This function is used by list command (i.e. mkimage -l <filename>)
107 * image type verification code must be put here
108 *
109 * Returns 0 if image header verification is successful
110 * otherwise, returns respective negative error codes
111 */
112 int (*verify_header) (unsigned char *, int, struct mkimage_params *);
113 /* Prints image information abstracting from image header */
Wolfgang Denk3a2003f2009-08-19 11:42:56 +0200114 void (*print_header) (const void *);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530115 /*
116 * The header or image contents need to be set as per image type to
117 * be generated using this callback function.
118 * further output file post processing (for ex. checksum calculation,
119 * padding bytes etc..) can also be done in this callback function.
120 */
121 void (*set_header) (void *, struct stat *, int,
122 struct mkimage_params *);
123 /*
124 * Some image generation support for ex (default image type) supports
125 * more than one type_ids, this callback function is used to check
126 * whether input (-T <image_type>) is supported by registered image
127 * generation/list low level code
128 */
129 int (*check_image_type) (uint8_t);
130 /* This callback function will be executed if fflag is defined */
131 int (*fflag_handle) (struct mkimage_params *);
Stefano Babicf0662102011-09-15 23:50:16 +0000132 /*
133 * This callback function will be executed for variable size record
134 * It is expected to build this header in memory and return its length
Stefano Babic9bac0bb2013-08-19 19:03:19 +0200135 * and a pointer to it by using image_type_params.header_size and
136 * image_type_params.hdr. The return value shall indicate if an
137 * additional padding should be used when copying the data image
138 * by returning the padding length.
Stefano Babicf0662102011-09-15 23:50:16 +0000139 */
140 int (*vrec_header) (struct mkimage_params *,
141 struct image_type_params *);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530142 /* pointer to the next registered entry in linked list */
143 struct image_type_params *next;
144};
145
146/*
147 * Exported functions
148 */
149void mkimage_register (struct image_type_params *tparams);
150
151/*
152 * There is a c file associated with supported image type low level code
153 * for ex. default_image.c, fit_image.c
154 * init is the only function referred by mkimage core.
155 * to avoid a single lined header file, you can define them here
156 *
157 * Supported image types init functions
158 */
Shaohui Xie5d898a02012-08-10 02:49:35 +0000159void pbl_load_uboot(int fd, struct mkimage_params *mparams);
160void init_pbl_image_type(void);
Stefano Babic4962e382011-10-17 00:07:43 +0000161void init_ais_image_type(void);
Prafulla Wadaskaraa0c7a82009-09-07 15:05:02 +0530162void init_kwb_image_type (void);
Stefano Babic8edcde52010-01-20 18:19:10 +0100163void init_imx_image_type (void);
Marek Vasutbce88372013-08-26 20:43:33 +0200164void init_mxs_image_type(void);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530165void init_default_image_type (void);
166void init_fit_image_type (void);
Heiko Schocher7816f2c2011-07-16 00:06:42 +0000167void init_ubl_image_type(void);
John Rigby3decb142011-07-21 09:10:30 -0400168void init_omap_image_type(void);
Prafulla Wadaskar89a4d6b2009-08-19 17:36:46 +0530169
170#endif /* _MKIIMAGE_H_ */