aboutsummaryrefslogtreecommitdiffstats
path: root/tools/firmware-utils/src/fix-u-media-header.c
blob: 8b6a81a5e3aac4c070a13fc7446f55ee531aff1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
// SPDX-License-Identifier: GPL-2.0-only
/*
 *  Copyright (C) 2012 Gabor Juhos <juhosg@openwrt.org>
 */
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <unistd.h>     /* for unlink() */
#include <libgen.h>
#include <getopt.h>     /* for getopt() */
#include <stdarg.h>
#include <errno.h>
#include <sys/stat.h>

#include "cyg_crc.h"

#include <arpa/inet.h>
#include <netinet/in.h>

#define IH_MAGIC	0x27051956	/* Image Magic Number		*/
#define IH_NMLEN	32		/* Image Name Length		*/

#define UM_MAGIC	0x55525F46
#define UM_HEADER_LEN	12

/*
 * all data in network byte order (aka natural aka bigendian)
 */
struct u_media_header {
	uint32_t	ih_magic;	/* Image Header Magic Number	*/
	uint32_t	ih_hcrc;	/* Image Header CRC Checksum	*/
	uint32_t	ih_time;	/* Image Creation Timestamp	*/
	uint32_t	ih_size;	/* Image Data Size		*/
	uint32_t	ih_load;	/* Data	 Load  Address		*/
	uint32_t	ih_ep;		/* Entry Point Address		*/
	uint32_t	ih_dcrc;	/* Image Data CRC Checksum	*/
	uint8_t		ih_os;		/* Operating System		*/
	uint8_t		ih_arch;	/* CPU architecture		*/
	uint8_t		ih_type;	/* Image Type			*/
	uint8_t		ih_comp;	/* Compression Type		*/
	uint8_t		ih_name[IH_NMLEN - UM_HEADER_LEN]; /* Image Name		*/

	uint32_t	ih_UMedia_magic;	/* U-Media magic number	*/
	uint32_t	ih_UMedia_boardID;	/* U-Media board ID	*/
	uint8_t		ih_UMedia_imageType;	/* U-Media image type */
	uint8_t		ih_UMedia_LoadDefault;	/* U-Media load to factory default setting */
	uint8_t		ih_UMedia_temp1;	/* U-Media didn't use this tag */
	uint8_t		ih_UMedia_temp2;	/* U-Media didn't use this tag */
} __attribute__ ((packed));

struct if_info {
	char		*file_name;	/* name of the file */
	uint32_t	file_size;	/* length of the file */
};

static char *progname;
static char *ofname;
static struct if_info if_info;
static int factory_defaults;
static uint32_t board_id;
static uint8_t image_type;

/*
 * Message macros
 */
#define ERR(fmt, ...) do { \
	fflush(0); \
	fprintf(stderr, "[%s] *** error: " fmt "\n", \
			progname, ## __VA_ARGS__ ); \
} while (0)

#define ERRS(fmt, ...) do { \
	int save = errno; \
	fflush(0); \
	fprintf(stderr, "[%s] *** error: " fmt " (%s)\n", \
			progname, ## __VA_ARGS__, strerror(save)); \
} while (0)

#define DBG(fmt, ...) do { \
	fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
} while (0)

static void usage(int status)
{
	FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;

	fprintf(stream, "Usage: %s [OPTIONS...]\n", progname);
	fprintf(stream,
"\n"
"Options:\n"
"  -B <board_id>   set board ID to <board_id>\n"
"  -i <file>       read input from the file <file>\n"
"  -F              load factory defaults\n"
"  -o <file>       write output to the file <file>\n"
"  -T <type>       set image type to <type>\n"
"  -h              show this screen\n"
	);

	exit(status);
}

static int str2u32(char *arg, uint32_t *val)
{
	char *err = NULL;
	uint32_t t;

	errno=0;
	t = strtoul(arg, &err, 0);
	if (errno || (err==arg) || ((err != NULL) && *err)) {
		return -1;
	}

	*val = t;
	return 0;
}

static int str2u8(char *arg, uint8_t *val)
{
	char *err = NULL;
	uint32_t t;

	errno=0;
	t = strtoul(arg, &err, 0);
	if (errno || (err==arg) || ((err != NULL) && *err)) {
		return -1;
	}

	if (t > 255)
		return -1;

	*val = t;
	return 0;
}

static int get_file_stat(struct if_info *fdata)
{
	struct stat st;
	int res;

	if (fdata->file_name == NULL)
		return 0;

	res = stat(fdata->file_name, &st);
	if (res){
		ERRS("stat failed on %s", fdata->file_name);
		return res;
	}

	fdata->file_size = st.st_size;
	return 0;
}

static int read_to_buf(struct if_info *fdata, char *buf)
{
	FILE *f;
	int ret = EXIT_FAILURE;

	f = fopen(fdata->file_name, "r");
	if (f == NULL) {
		ERRS("could not open \"%s\" for reading", fdata->file_name);
		goto out;
	}

	errno = 0;
	fread(buf, fdata->file_size, 1, f);
	if (errno != 0) {
		ERRS("unable to read from file \"%s\"", fdata->file_name);
		goto out_close;
	}

	ret = EXIT_SUCCESS;

out_close:
	fclose(f);
out:
	return ret;
}

static int check_options(void)
{
	int ret;

	if (ofname == NULL) {
		ERR("no %s specified", "output file");
		return -1;
	}

	if (if_info.file_name == NULL) {
		ERR("no %s specified", "input file");
		return -1;
	}

	ret = get_file_stat(&if_info);
	if (ret)
		return ret;

	return 0;
}

static int write_fw(char *data, int len)
{
	FILE *f;
	int ret = EXIT_FAILURE;

	f = fopen(ofname, "w");
	if (f == NULL) {
		ERRS("could not open \"%s\" for writing", ofname);
		goto out;
	}

	errno = 0;
	fwrite(data, len, 1, f);
	if (errno) {
		ERRS("unable to write output file");
		goto out_flush;
	}

	ret = EXIT_SUCCESS;

out_flush:
	fflush(f);
	fclose(f);
	if (ret != EXIT_SUCCESS) {
		unlink(ofname);
	}
out:
	return ret;
}

static int fix_header(void)
{
	int buflen;
	char *buf;
	uint32_t crc, crc_orig;
	struct u_media_header *hdr;
	int ret = EXIT_FAILURE;

	buflen = if_info.file_size;
	if (buflen < sizeof(*hdr)) {
		ERR("invalid input file\n");
		return ret;
	}

	buf = malloc(buflen);
	if (!buf) {
		ERR("no memory for buffer\n");
		goto out;
	}

	ret = read_to_buf(&if_info, buf);
	if (ret)
		goto out_free_buf;

	hdr = (struct u_media_header *) buf;
	if (ntohl(hdr->ih_magic) != IH_MAGIC) {
		ERR("invalid input file, bad magic\n");
		goto out_free_buf;
	}

	/* verify header CRC */
	crc_orig = ntohl(hdr->ih_hcrc);
	hdr->ih_hcrc = 0;
	crc = cyg_ether_crc32((unsigned char *)hdr, sizeof(*hdr));
	if (crc != crc_orig) {
		ERR("invalid input file, bad header CRC\n");
		goto out_free_buf;
	}

	hdr->ih_name[IH_NMLEN - UM_HEADER_LEN - 1] = '\0';

	/* set U-Media specific fields */
	hdr->ih_UMedia_magic = htonl(UM_MAGIC);
	hdr->ih_UMedia_boardID = htonl(board_id);
	hdr->ih_UMedia_imageType = image_type;
	hdr->ih_UMedia_LoadDefault = (factory_defaults) ? 1 : 0;

	/* update header CRC */
	crc = cyg_ether_crc32((unsigned char *)hdr, sizeof(*hdr));
	hdr->ih_hcrc = htonl(crc);

	ret = write_fw(buf, buflen);
	if (ret)
		goto out_free_buf;

	DBG("U-Media header fixed in \"%s\"", ofname);

	ret = EXIT_SUCCESS;

out_free_buf:
	free(buf);
out:
	return ret;
}

int main(int argc, char *argv[])
{
	int ret = EXIT_FAILURE;

	progname = basename(argv[0]);

	while (1) {
		int c;

		c = getopt(argc, argv, "B:Fi:o:T:h");
		if (c == -1)
			break;

		switch (c) {
		case 'B':
			if (str2u32(optarg, &board_id)) {
				ERR("%s is invalid '%s'",
				    "board ID", optarg);
				goto out;
			}
			break;
		case 'T':
			if (str2u8(optarg, &image_type)) {
				ERR("%s is invalid '%s'",
				    "image type", optarg);
				goto out;
			}
			break;
		case 'F':
			factory_defaults = 1;
			break;
		case 'i':
			if_info.file_name = optarg;
			break;
		case 'o':
			ofname = optarg;
			break;
		case 'h':
			usage(EXIT_SUCCESS);
			break;
		default:
			usage(EXIT_FAILURE);
			break;
		}
	}

	ret = check_options();
	if (ret)
		goto out;

	ret = fix_header();

out:
	return ret;
}