Prepare v2023.10
[platform/kernel/u-boot.git] / tools / imagetool.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2013
4  *
5  * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
6  */
7
8 #include "imagetool.h"
9
10 #include <image.h>
11
12 struct image_type_params *imagetool_get_type(int type)
13 {
14         struct image_type_params **curr;
15         INIT_SECTION(image_type);
16
17         struct image_type_params **start = __start_image_type;
18         struct image_type_params **end = __stop_image_type;
19
20         for (curr = start; curr != end; curr++) {
21                 if ((*curr)->check_image_type) {
22                         if (!(*curr)->check_image_type(type))
23                                 return *curr;
24                 }
25         }
26         return NULL;
27 }
28
29 static int imagetool_verify_print_header_by_type(
30         void *ptr,
31         struct stat *sbuf,
32         struct image_type_params *tparams,
33         struct image_tool_params *params);
34
35 int imagetool_verify_print_header(
36         void *ptr,
37         struct stat *sbuf,
38         struct image_type_params *tparams,
39         struct image_tool_params *params)
40 {
41         int retval = -1;
42         struct image_type_params **curr;
43         INIT_SECTION(image_type);
44
45         struct image_type_params **start = __start_image_type;
46         struct image_type_params **end = __stop_image_type;
47
48         if (tparams)
49                 return imagetool_verify_print_header_by_type(ptr, sbuf, tparams, params);
50
51         for (curr = start; curr != end; curr++) {
52                 /*
53                  * Basically every data file can be guessed / verified as gpimage,
54                  * so skip autodetection of data file as gpimage as it does not work.
55                  */
56                 if ((*curr)->check_image_type && (*curr)->check_image_type(IH_TYPE_GPIMAGE) == 0)
57                         continue;
58                 if ((*curr)->verify_header) {
59                         retval = (*curr)->verify_header((unsigned char *)ptr,
60                                                      sbuf->st_size, params);
61
62                         if (retval == 0) {
63                                 /*
64                                  * Print the image information if verify is
65                                  * successful
66                                  */
67                                 if ((*curr)->print_header) {
68                                         if (!params->quiet)
69                                                 (*curr)->print_header(ptr, params);
70                                 } else {
71                                         fprintf(stderr,
72                                                 "%s: print_header undefined for %s\n",
73                                                 params->cmdname, (*curr)->name);
74                                 }
75                                 break;
76                         }
77                 }
78         }
79
80         if (retval != 0) {
81                 fprintf(stderr, "%s: cannot detect image type\n",
82                         params->cmdname);
83         }
84
85         return retval;
86 }
87
88 static int imagetool_verify_print_header_by_type(
89         void *ptr,
90         struct stat *sbuf,
91         struct image_type_params *tparams,
92         struct image_tool_params *params)
93 {
94         int retval = -1;
95
96         if (tparams->verify_header) {
97                 retval = tparams->verify_header((unsigned char *)ptr,
98                                                 sbuf->st_size, params);
99
100                 if (retval == 0) {
101                         /*
102                          * Print the image information if verify is successful
103                          */
104                         if (tparams->print_header) {
105                                 if (!params->quiet)
106                                         tparams->print_header(ptr, params);
107                         } else {
108                                 fprintf(stderr,
109                                         "%s: print_header undefined for %s\n",
110                                         params->cmdname, tparams->name);
111                         }
112                 } else {
113                         fprintf(stderr,
114                                 "%s: verify_header failed for %s with exit code %d\n",
115                                 params->cmdname, tparams->name, retval);
116                 }
117
118         } else {
119                 fprintf(stderr, "%s: verify_header undefined for %s\n",
120                         params->cmdname, tparams->name);
121         }
122
123         return retval;
124 }
125
126 int imagetool_save_subimage(
127         const char *file_name,
128         ulong file_data,
129         ulong file_len)
130 {
131         int dfd;
132
133         dfd = open(file_name, O_RDWR | O_CREAT | O_TRUNC | O_BINARY,
134                    S_IRUSR | S_IWUSR);
135         if (dfd < 0) {
136                 fprintf(stderr, "Can't open \"%s\": %s\n",
137                         file_name, strerror(errno));
138                 return -1;
139         }
140
141         if (write(dfd, (void *)file_data, file_len) != (ssize_t)file_len) {
142                 fprintf(stderr, "Write error on \"%s\": %s\n",
143                         file_name, strerror(errno));
144                 close(dfd);
145                 return -1;
146         }
147
148         close(dfd);
149
150         return 0;
151 }
152
153 int imagetool_get_filesize(struct image_tool_params *params, const char *fname)
154 {
155         struct stat sbuf;
156         int fd;
157
158         fd = open(fname, O_RDONLY | O_BINARY);
159         if (fd < 0) {
160                 fprintf(stderr, "%s: Can't open %s: %s\n",
161                         params->cmdname, fname, strerror(errno));
162                 return -1;
163         }
164
165         if (fstat(fd, &sbuf) < 0) {
166                 fprintf(stderr, "%s: Can't stat %s: %s\n",
167                         params->cmdname, fname, strerror(errno));
168                 close(fd);
169                 return -1;
170         }
171         close(fd);
172
173         return sbuf.st_size;
174 }
175
176 time_t imagetool_get_source_date(
177          const char *cmdname,
178          time_t fallback)
179 {
180         char *source_date_epoch = getenv("SOURCE_DATE_EPOCH");
181
182         if (source_date_epoch == NULL)
183                 return fallback;
184
185         time_t time = (time_t) strtol(source_date_epoch, NULL, 10);
186
187         if (gmtime(&time) == NULL) {
188                 fprintf(stderr, "%s: SOURCE_DATE_EPOCH is not valid\n",
189                         cmdname);
190                 time = 0;
191         }
192
193         return time;
194 }