Merge branch 'master' of git://git.denx.de/u-boot-arm
[kernel/u-boot.git] / tools / default_image.c
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2004
5  * DENX Software Engineering
6  * Wolfgang Denk, wd@denx.de
7  *
8  * Updated-by: Prafulla Wadaskar <prafulla@marvell.com>
9  *              default_image specific code abstracted from mkimage.c
10  *              some functions added to address abstraction
11  *
12  * All rights reserved.
13  *
14  * SPDX-License-Identifier:     GPL-2.0+
15  */
16
17 #include "imagetool.h"
18 #include <image.h>
19 #include <u-boot/crc.h>
20
21 static image_header_t header;
22
23 static int image_check_image_types(uint8_t type)
24 {
25         if (((type > IH_TYPE_INVALID) && (type < IH_TYPE_FLATDT)) ||
26             (type == IH_TYPE_KERNEL_NOLOAD))
27                 return EXIT_SUCCESS;
28         else
29                 return EXIT_FAILURE;
30 }
31
32 static int image_check_params(struct image_tool_params *params)
33 {
34         return  ((params->dflag && (params->fflag || params->lflag)) ||
35                 (params->fflag && (params->dflag || params->lflag)) ||
36                 (params->lflag && (params->dflag || params->fflag)));
37 }
38
39 static int image_verify_header(unsigned char *ptr, int image_size,
40                         struct image_tool_params *params)
41 {
42         uint32_t len;
43         const unsigned char *data;
44         uint32_t checksum;
45         image_header_t header;
46         image_header_t *hdr = &header;
47
48         /*
49          * create copy of header so that we can blank out the
50          * checksum field for checking - this can't be done
51          * on the PROT_READ mapped data.
52          */
53         memcpy(hdr, ptr, sizeof(image_header_t));
54
55         if (be32_to_cpu(hdr->ih_magic) != IH_MAGIC) {
56                 fprintf(stderr,
57                         "%s: Bad Magic Number: \"%s\" is no valid image\n",
58                         params->cmdname, params->imagefile);
59                 return -FDT_ERR_BADMAGIC;
60         }
61
62         data = (const unsigned char *)hdr;
63         len  = sizeof(image_header_t);
64
65         checksum = be32_to_cpu(hdr->ih_hcrc);
66         hdr->ih_hcrc = cpu_to_be32(0);  /* clear for re-calculation */
67
68         if (crc32(0, data, len) != checksum) {
69                 fprintf(stderr,
70                         "%s: ERROR: \"%s\" has bad header checksum!\n",
71                         params->cmdname, params->imagefile);
72                 return -FDT_ERR_BADSTATE;
73         }
74
75         data = (const unsigned char *)ptr + sizeof(image_header_t);
76         len  = image_size - sizeof(image_header_t) ;
77
78         checksum = be32_to_cpu(hdr->ih_dcrc);
79         if (crc32(0, data, len) != checksum) {
80                 fprintf(stderr,
81                         "%s: ERROR: \"%s\" has corrupted data!\n",
82                         params->cmdname, params->imagefile);
83                 return -FDT_ERR_BADSTRUCTURE;
84         }
85         return 0;
86 }
87
88 static void image_set_header(void *ptr, struct stat *sbuf, int ifd,
89                                 struct image_tool_params *params)
90 {
91         uint32_t checksum;
92
93         image_header_t * hdr = (image_header_t *)ptr;
94
95         checksum = crc32(0,
96                         (const unsigned char *)(ptr +
97                                 sizeof(image_header_t)),
98                         sbuf->st_size - sizeof(image_header_t));
99
100         /* Build new header */
101         image_set_magic(hdr, IH_MAGIC);
102         image_set_time(hdr, sbuf->st_mtime);
103         image_set_size(hdr, sbuf->st_size - sizeof(image_header_t));
104         image_set_load(hdr, params->addr);
105         image_set_ep(hdr, params->ep);
106         image_set_dcrc(hdr, checksum);
107         image_set_os(hdr, params->os);
108         image_set_arch(hdr, params->arch);
109         image_set_type(hdr, params->type);
110         image_set_comp(hdr, params->comp);
111
112         image_set_name(hdr, params->imagename);
113
114         checksum = crc32(0, (const unsigned char *)hdr,
115                                 sizeof(image_header_t));
116
117         image_set_hcrc(hdr, checksum);
118 }
119
120 static int image_save_datafile(struct image_tool_params *params,
121                                ulong file_data, ulong file_len)
122 {
123         int dfd;
124         const char *datafile = params->outfile;
125
126         dfd = open(datafile, O_RDWR | O_CREAT | O_TRUNC | O_BINARY,
127                    S_IRUSR | S_IWUSR);
128         if (dfd < 0) {
129                 fprintf(stderr, "%s: Can't open \"%s\": %s\n",
130                         params->cmdname, datafile, strerror(errno));
131                 return -1;
132         }
133
134         if (write(dfd, (void *)file_data, file_len) != (ssize_t)file_len) {
135                 fprintf(stderr, "%s: Write error on \"%s\": %s\n",
136                         params->cmdname, datafile, strerror(errno));
137                 close(dfd);
138                 return -1;
139         }
140
141         close(dfd);
142
143         return 0;
144 }
145
146 static int image_extract_datafile(void *ptr, struct image_tool_params *params)
147 {
148         const image_header_t *hdr = (const image_header_t *)ptr;
149         ulong file_data;
150         ulong file_len;
151
152         if (image_check_type(hdr, IH_TYPE_MULTI)) {
153                 ulong idx = params->pflag;
154                 ulong count;
155
156                 /* get the number of data files present in the image */
157                 count = image_multi_count(hdr);
158
159                 /* retrieve the "data file" at the idx position */
160                 image_multi_getimg(hdr, idx, &file_data, &file_len);
161
162                 if ((file_len == 0) || (idx >= count)) {
163                         fprintf(stderr, "%s: No such data file %ld in \"%s\"\n",
164                                 params->cmdname, idx, params->imagefile);
165                         return -1;
166                 }
167         } else {
168                 file_data = image_get_data(hdr);
169                 file_len = image_get_size(hdr);
170         }
171
172         /* save the "data file" into the file system */
173         return image_save_datafile(params, file_data, file_len);
174 }
175
176 /*
177  * Default image type parameters definition
178  */
179 static struct image_type_params defimage_params = {
180         .name = "Default Image support",
181         .header_size = sizeof(image_header_t),
182         .hdr = (void*)&header,
183         .check_image_type = image_check_image_types,
184         .verify_header = image_verify_header,
185         .print_header = image_print_contents,
186         .set_header = image_set_header,
187         .extract_datafile = image_extract_datafile,
188         .check_params = image_check_params,
189 };
190
191 void init_default_image_type(void)
192 {
193         register_image_type(&defimage_params);
194 }