fel.c 42.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*
 * Copyright (C) 2012  Henrik Nordstrom <henrik@henriknordstrom.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

18
19
#include "common.h"
#include "portable_endian.h"
20
#include "fel_lib.h"
21

22
23
#include <assert.h>
#include <ctype.h>
24
#include <errno.h>
25
26
27
28
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
29
#include <unistd.h>
30
#include <sys/stat.h>
31

32
static bool verbose = false; /* If set, makes the 'fel' tool more talkative */
33
34
static uint32_t uboot_entry = 0; /* entry point (address) of U-Boot */
static uint32_t uboot_size  = 0; /* size of U-Boot binary */
35
36
37
38
39
40
41
42
43
44

static void pr_info(const char *fmt, ...)
{
	va_list arglist;
	if (verbose) {
		va_start(arglist, fmt);
		vprintf(fmt, arglist);
		va_end(arglist);
	}
}
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
/* Constants taken from ${U-BOOT}/include/image.h */
#define IH_MAGIC	0x27051956	/* Image Magic Number	*/
#define IH_ARCH_ARM		2	/* ARM			*/
#define IH_TYPE_INVALID		0	/* Invalid Image	*/
#define IH_TYPE_FIRMWARE	5	/* Firmware Image	*/
#define IH_TYPE_SCRIPT		6	/* Script file		*/
#define IH_NMLEN		32	/* Image Name Length	*/

/* Additional error codes, newly introduced for get_image_type() */
#define IH_TYPE_ARCH_MISMATCH	-1

#define HEADER_NAME_OFFSET	32	/* offset of name field	*/
#define HEADER_SIZE		(HEADER_NAME_OFFSET + IH_NMLEN)

/*
 * Utility function to determine the image type from a mkimage-compatible
 * header at given buffer (address).
 *
 * For invalid headers (insufficient size or 'magic' mismatch) the function
 * will return IH_TYPE_INVALID. Negative return values might indicate
 * special error conditions, e.g. IH_TYPE_ARCH_MISMATCH signals that the
 * image doesn't match the expected (ARM) architecture.
 * Otherwise the function will return the "ih_type" field for valid headers.
 */
int get_image_type(const uint8_t *buf, size_t len)
{
	uint32_t *buf32 = (uint32_t *)buf;

	if (len <= HEADER_SIZE) /* insufficient length/size */
		return IH_TYPE_INVALID;
	if (be32toh(buf32[0]) != IH_MAGIC) /* signature mismatch */
		return IH_TYPE_INVALID;
	/* For sunxi, we always expect ARM architecture here */
	if (buf[29] != IH_ARCH_ARM)
		return IH_TYPE_ARCH_MISMATCH;

	/* assume a valid header, and return ih_type */
	return buf[30];
}

86
void aw_fel_print_version(feldev_handle *dev)
87
{
88
	struct aw_fel_version buf = dev->soc_version;
89

Henrik Nordstrom's avatar
Henrik Nordstrom committed
90
	const char *soc_name="unknown";
91
	switch (buf.soc_id) {
Bernhard Nortmann's avatar
Bernhard Nortmann committed
92
93
94
95
96
	case 0x1623: soc_name="A10"; break;
	case 0x1625: soc_name="A13"; break;
	case 0x1633: soc_name="A31"; break;
	case 0x1651: soc_name="A20"; break;
	case 0x1650: soc_name="A23"; break;
97
	case 0x1689: soc_name="A64"; break;
Bernhard Nortmann's avatar
Bernhard Nortmann committed
98
99
100
101
	case 0x1639: soc_name="A80"; break;
	case 0x1667: soc_name="A33"; break;
	case 0x1673: soc_name="A83T"; break;
	case 0x1680: soc_name="H3"; break;
102
	case 0x1701: soc_name="R40"; break;
103
	case 0x1718: soc_name="H5"; break;
Henrik Nordstrom's avatar
Henrik Nordstrom committed
104
105
	}

106
107
108
109
	printf("%.8s soc=%08x(%s) %08x ver=%04x %02x %02x scratchpad=%08x %08x %08x\n",
		buf.signature, buf.soc_id, soc_name, buf.unknown_0a,
		buf.protocol, buf.unknown_12, buf.unknown_13,
		buf.scratchpad, buf.pad[0], buf.pad[1]);
110
111
}

112
/*
113
114
 * This wrapper for the FEL write functionality safeguards against overwriting
 * an already loaded U-Boot binary.
115
116
 * The return value represents elapsed time in seconds (needed for execution).
 */
117
double aw_write_buffer(feldev_handle *dev, void *buf, uint32_t offset,
118
		       size_t len, bool progress)
119
120
121
122
123
124
125
{
	/* safeguard against overwriting an already loaded U-Boot binary */
	if (uboot_size > 0 && offset <= uboot_entry + uboot_size
			   && offset + len >= uboot_entry)
	{
		fprintf(stderr, "ERROR: Attempt to overwrite U-Boot! "
			"Request 0x%08X-0x%08X overlaps 0x%08X-0x%08X.\n",
126
			offset, (uint32_t)(offset + len),
127
128
129
130
			uboot_entry, uboot_entry + uboot_size);
		exit(1);
	}
	double start = gettime();
131
	aw_fel_write_buffer(dev, buf, offset, len, progress);
132
133
134
	return gettime() - start;
}

135
136
137
138
139
140
void hexdump(void *data, uint32_t offset, size_t size)
{
	size_t j;
	unsigned char *buf = data;
	for (j = 0; j < size; j+=16) {
		size_t i;
141
		printf("%08zx: ", offset + j);
142
		for (i = 0; i < 16; i++) {
143
			if (j + i < size)
144
				printf("%02x ", buf[j+i]);
145
			else
146
147
				printf("__ ");
		}
148
		putchar(' ');
149
		for (i = 0; i < 16; i++) {
150
151
152
153
			if (j + i >= size)
				putchar('.');
			else
				putchar(isprint(buf[j+i]) ? buf[j+i] : '.');
154
		}
155
		putchar('\n');
156
157
	}
}
158

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
unsigned int file_size(const char *filename)
{
	struct stat st;
	if (stat(filename, &st) != 0) {
		fprintf(stderr, "stat() error on file \"%s\": %s\n", filename,
			strerror(errno));
		exit(1);
	}
	if (!S_ISREG(st.st_mode)) {
		fprintf(stderr, "error: \"%s\" is not a regular file\n", filename);
		exit(1);
	}
	return st.st_size;
}

174
175
176
177
int save_file(const char *name, void *data, size_t size)
{
	FILE *out = fopen(name, "wb");
	int rc;
178
	if (!out) {
179
		perror("Failed to open output file");
180
181
		exit(1);
	}
182
183
184
185
186
	rc = fwrite(data, size, 1, out);
	fclose(out);
	return rc;
}

187
188
189
190
191
192
193
194
195
196
void *load_file(const char *name, size_t *size)
{
	size_t bufsize = 8192;
	size_t offset = 0;
	char *buf = malloc(bufsize);
	FILE *in;
	if (strcmp(name, "-") == 0)
		in = stdin;
	else
		in = fopen(name, "rb");
197
	if (!in) {
198
		perror("Failed to open input file");
199
200
		exit(1);
	}
201
	
Bernhard Nortmann's avatar
Bernhard Nortmann committed
202
	while (true) {
203
204
		ssize_t len = bufsize - offset;
		ssize_t n = fread(buf+offset, 1, len, in);
205
		offset += n;
206
		if (n < len)
207
208
209
210
211
212
213
214
215
216
217
			break;
		bufsize <<= 1;
		buf = realloc(buf, bufsize);
	}
	if (size) 
		*size = offset;
	if (in != stdin)
		fclose(in);
	return buf;
}

218
void aw_fel_hexdump(feldev_handle *dev, uint32_t offset, size_t size)
219
220
{
	unsigned char buf[size];
221
	aw_fel_read(dev, offset, buf, size);
222
223
224
	hexdump(buf, offset, size);
}

225
void aw_fel_dump(feldev_handle *dev, uint32_t offset, size_t size)
226
227
{
	unsigned char buf[size];
228
	aw_fel_read(dev, offset, buf, size);
229
230
	fwrite(buf, size, 1, stdout);
}
231
void aw_fel_fill(feldev_handle *dev, uint32_t offset, size_t size, unsigned char value)
232
233
{
	unsigned char buf[size];
Henrik Nordstrom's avatar
Henrik Nordstrom committed
234
	memset(buf, value, size);
235
	aw_write_buffer(dev, buf, offset, size, false);
236
237
}

238
239
240
241
static uint32_t fel_to_spl_thunk[] = {
	#include "fel-to-spl-thunk.h"
};

242
243
244
#define	DRAM_BASE		0x40000000
#define	DRAM_SIZE		0x80000000

245
uint32_t aw_read_arm_cp_reg(feldev_handle *dev, soc_info_t *soc_info,
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
			    uint32_t coproc, uint32_t opc1, uint32_t crn,
			    uint32_t crm, uint32_t opc2)
{
	uint32_t val = 0;
	uint32_t opcode = 0xEE000000 | (1 << 20) | (1 << 4) |
			  ((opc1 & 7) << 21)    |
			  ((crn & 15) << 16)    |
			  ((coproc & 15) << 8)  |
			  ((opc2 & 7) << 5)     |
			  (crm & 15);
	uint32_t arm_code[] = {
		htole32(opcode),     /* mrc  coproc, opc1, r0, crn, crm, opc2 */
		htole32(0xe58f0000), /* str  r0, [pc]                         */
		htole32(0xe12fff1e), /* bx   lr                               */
	};
261
262
263
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
	aw_fel_read(dev, soc_info->scratch_addr + 12, &val, sizeof(val));
264
265
266
	return le32toh(val);
}

267
void aw_write_arm_cp_reg(feldev_handle *dev, soc_info_t *soc_info,
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
			 uint32_t coproc, uint32_t opc1, uint32_t crn,
			 uint32_t crm, uint32_t opc2, uint32_t val)
{
	uint32_t opcode = 0xEE000000 | (0 << 20) | (1 << 4) |
			  ((opc1 & 7) << 21)                |
			  ((crn & 15) << 16)                |
			  ((coproc & 15) << 8)              |
			  ((opc2 & 7) << 5)                 |
			  (crm & 15);
	uint32_t arm_code[] = {
		htole32(0xe59f000c), /* ldr  r0, [pc, #12]                    */
		htole32(opcode),     /* mcr  coproc, opc1, r0, crn, crm, opc2 */
		htole32(0xf57ff04f), /* dsb  sy                               */
		htole32(0xf57ff06f), /* isb  sy                               */
		htole32(0xe12fff1e), /* bx   lr                               */
		htole32(val)
	};
285
286
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
287
288
}

289
290
291
292
293
294
295
296
297
298
/*
 * We don't want the scratch code/buffer to exceed a maximum size of 0x400 bytes
 * (256 32-bit words) on readl_n/writel_n transfers. To guarantee this, we have
 * to account for the amount of space the ARM code uses.
 */
#define LCODE_ARM_WORDS  12 /* word count of the [read/write]l_n scratch code */
#define LCODE_ARM_SIZE   (LCODE_ARM_WORDS << 2) /* code size in bytes */
#define LCODE_MAX_TOTAL  0x100 /* max. words in buffer */
#define LCODE_MAX_WORDS  (LCODE_MAX_TOTAL - LCODE_ARM_WORDS) /* data words */

299
/* multiple "readl" from sequential addresses to a destination buffer */
300
void aw_fel_readl_n(feldev_handle *dev, uint32_t addr,
301
302
		    uint32_t *dst, size_t count)
{
303
304
305
306
307
308
	if (count == 0) return;
	if (count > LCODE_MAX_WORDS) {
		fprintf(stderr,
			"ERROR: Max. word count exceeded, truncating aw_fel_readl_n() transfer\n");
		count = LCODE_MAX_WORDS;
	}
309
	soc_info_t *soc_info = dev->soc_info;
310
311

	assert(LCODE_MAX_WORDS < 256); /* protect against corruption of ARM code */
312
	uint32_t arm_code[] = {
313
314
315
316
317
318
319
320
321
322
323
324
325
326
		htole32(0xe59f0020), /* ldr  r0, [pc, #32] ; ldr r0,[read_addr]  */
		htole32(0xe28f1024), /* add  r1, pc, #36   ; adr r1, read_data   */
		htole32(0xe59f201c), /* ldr  r2, [pc, #28] ; ldr r2,[read_count] */
		htole32(0xe3520000 + LCODE_MAX_WORDS), /* cmp	r2, #LCODE_MAX_WORDS */
		htole32(0xc3a02000 + LCODE_MAX_WORDS), /* movgt	r2, #LCODE_MAX_WORDS */
		/* read_loop: */
		htole32(0xe2522001), /* subs r2, r2, #1    ; r2 -= 1             */
		htole32(0x412fff1e), /* bxmi lr            ; return if (r2 < 0)  */
		htole32(0xe4903004), /* ldr  r3, [r0], #4  ; load and post-inc   */
		htole32(0xe4813004), /* str  r3, [r1], #4  ; store and post-inc  */
		htole32(0xeafffffa), /* b    read_loop                           */
		htole32(addr),       /* read_addr */
		htole32(count)       /* read_count */
		/* read_data (buffer) follows, i.e. values go here */
327
	};
328
329
330
	assert(sizeof(arm_code) == LCODE_ARM_SIZE);

	/* scratch buffer setup: transfers ARM code, including addr and count */
331
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
332
	/* execute code, read back the result */
333
	aw_fel_execute(dev, soc_info->scratch_addr);
334
	uint32_t buffer[count];
335
	aw_fel_read(dev, soc_info->scratch_addr + LCODE_ARM_SIZE,
336
337
338
339
340
		    buffer, sizeof(buffer));
	/* extract values to destination buffer */
	uint32_t *val = buffer;
	while (count-- > 0)
		*dst++ = le32toh(*val++);
341
342
343
}

/* "readl" of a single value */
344
uint32_t aw_fel_readl(feldev_handle *dev, uint32_t addr)
345
346
{
	uint32_t val;
347
	aw_fel_readl_n(dev, addr, &val, 1);
348
349
350
	return val;
}

351
352
353
354
/*
 * aw_fel_readl_n() wrapper that can handle large transfers. If necessary,
 * those will be done in separate 'chunks' of no more than LCODE_MAX_WORDS.
 */
355
void fel_readl_n(feldev_handle *dev, uint32_t addr, uint32_t *dst, size_t count)
356
357
358
{
	while (count > 0) {
		size_t n = count > LCODE_MAX_WORDS ? LCODE_MAX_WORDS : count;
359
		aw_fel_readl_n(dev, addr, dst, n);
360
361
362
363
364
365
		addr += n * sizeof(uint32_t);
		dst += n;
		count -= n;
	}
}

366
/* multiple "writel" from a source buffer to sequential addresses */
367
void aw_fel_writel_n(feldev_handle *dev, uint32_t addr,
368
369
		     uint32_t *src, size_t count)
{
370
371
372
373
374
375
	if (count == 0) return;
	if (count > LCODE_MAX_WORDS) {
		fprintf(stderr,
			"ERROR: Max. word count exceeded, truncating aw_fel_writel_n() transfer\n");
		count = LCODE_MAX_WORDS;
	}
376
	soc_info_t *soc_info = dev->soc_info;
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397

	assert(LCODE_MAX_WORDS < 256); /* protect against corruption of ARM code */
	/*
	 * We need a fixed array size to allow for (partial) initialization,
	 * so we'll claim the maximum total number of words (0x100) here.
	 */
	uint32_t arm_code[LCODE_MAX_TOTAL] = {
		htole32(0xe59f0020), /* ldr  r0, [pc, #32] ; ldr r0,[write_addr] */
		htole32(0xe28f1024), /* add  r1, pc, #36   ; adr r1, write_data  */
		htole32(0xe59f201c), /* ldr  r2, [pc, #28] ; ldr r2,[write_count]*/
		htole32(0xe3520000 + LCODE_MAX_WORDS), /* cmp	r2, #LCODE_MAX_WORDS */
		htole32(0xc3a02000 + LCODE_MAX_WORDS), /* movgt	r2, #LCODE_MAX_WORDS */
		/* write_loop: */
		htole32(0xe2522001), /* subs r2, r2, #1    ; r2 -= 1             */
		htole32(0x412fff1e), /* bxmi lr            ; return if (r2 < 0)  */
		htole32(0xe4913004), /* ldr  r3, [r1], #4  ; load and post-inc   */
		htole32(0xe4803004), /* str  r3, [r0], #4  ; store and post-inc  */
		htole32(0xeafffffa), /* b    write_loop                          */
		htole32(addr),       /* write_addr */
		htole32(count)       /* write_count */
		/* write_data (buffer) follows, i.e. values taken from here */
398
	};
399
400
401
402
403
404

	/* copy values from source buffer */
	size_t i;
	for (i = 0; i < count; i++)
		arm_code[LCODE_ARM_WORDS + i] = htole32(*src++);
	/* scratch buffer setup: transfers ARM code and data */
405
	aw_fel_write(dev, arm_code, soc_info->scratch_addr,
406
407
	             (LCODE_ARM_WORDS + count) * sizeof(uint32_t));
	/* execute, and we're done */
408
	aw_fel_execute(dev, soc_info->scratch_addr);
409
410
411
}

/* "writel" of a single value */
412
void aw_fel_writel(feldev_handle *dev, uint32_t addr, uint32_t val)
413
{
414
	aw_fel_writel_n(dev, addr, &val, 1);
415
416
}

417
418
419
420
/*
 * aw_fel_writel_n() wrapper that can handle large transfers. If necessary,
 * those will be done in separate 'chunks' of no more than LCODE_MAX_WORDS.
 */
421
void fel_writel_n(feldev_handle *dev, uint32_t addr, uint32_t *src, size_t count)
422
423
424
{
	while (count > 0) {
		size_t n = count > LCODE_MAX_WORDS ? LCODE_MAX_WORDS : count;
425
		aw_fel_writel_n(dev, addr, src, n);
426
427
428
429
430
431
		addr += n * sizeof(uint32_t);
		src += n;
		count -= n;
	}
}

432
void aw_fel_print_sid(feldev_handle *dev)
433
{
434
	soc_info_t *soc_info = dev->soc_info;
435
436
437
438
	if (soc_info->sid_addr) {
		pr_info("SID key (e-fuses) at 0x%08X\n", soc_info->sid_addr);

		uint32_t key[4];
439
		aw_fel_readl_n(dev, soc_info->sid_addr, key, 4);
440
441

		unsigned int i;
Bernhard Nortmann's avatar
Bernhard Nortmann committed
442
		/* output SID in "xxxxxxxx:xxxxxxxx:xxxxxxxx:xxxxxxxx" format */
443
		for (i = 0; i <= 3; i++)
Bernhard Nortmann's avatar
Bernhard Nortmann committed
444
			printf("%08x%c", key[i], i < 3 ? ':' : '\n');
445
446
447
448
449
450
	} else {
		printf("SID registers for your SoC (id=%04X) are unknown or inaccessible.\n",
			soc_info->soc_id);
	}
}

451
void aw_enable_l2_cache(feldev_handle *dev, soc_info_t *soc_info)
452
453
454
455
456
457
458
459
{
	uint32_t arm_code[] = {
		htole32(0xee112f30), /* mrc        15, 0, r2, cr1, cr0, {1}  */
		htole32(0xe3822002), /* orr        r2, r2, #2                */
		htole32(0xee012f30), /* mcr        15, 0, r2, cr1, cr0, {1}  */
		htole32(0xe12fff1e), /* bx         lr                        */
	};

460
461
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
462
463
}

464
void aw_get_stackinfo(feldev_handle *dev, soc_info_t *soc_info,
465
                      uint32_t *sp_irq, uint32_t *sp)
466
467
468
469
470
471
472
473
474
475
476
{
	uint32_t results[2] = { 0 };
#if 0
	/* Does not work on Cortex-A8 (needs Virtualization Extensions) */
	uint32_t arm_code[] = {
		htole32(0xe1010300), /* mrs        r0, SP_irq                */
		htole32(0xe58f0004), /* str        r0, [pc, #4]              */
		htole32(0xe58fd004), /* str        sp, [pc, #4]              */
		htole32(0xe12fff1e), /* bx         lr                        */
	};

477
478
479
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
	aw_fel_read(dev, soc_info->scratch_addr + 0x10, results, 8);
480
481
482
483
484
485
486
487
488
489
490
491
492
493
#else
	/* Works everywhere */
	uint32_t arm_code[] = {
		htole32(0xe10f0000), /* mrs        r0, CPSR                  */
		htole32(0xe3c0101f), /* bic        r1, r0, #31               */
		htole32(0xe3811012), /* orr        r1, r1, #18               */
		htole32(0xe121f001), /* msr        CPSR_c, r1                */
		htole32(0xe1a0100d), /* mov        r1, sp                    */
		htole32(0xe121f000), /* msr        CPSR_c, r0                */
		htole32(0xe58f1004), /* str        r1, [pc, #4]              */
		htole32(0xe58fd004), /* str        sp, [pc, #4]              */
		htole32(0xe12fff1e), /* bx         lr                        */
	};

494
495
496
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
	aw_fel_read(dev, soc_info->scratch_addr + 0x24, results, 8);
497
498
499
500
501
#endif
	*sp_irq = le32toh(results[0]);
	*sp     = le32toh(results[1]);
}

502
uint32_t aw_get_ttbr0(feldev_handle *dev, soc_info_t *soc_info)
503
{
504
	return aw_read_arm_cp_reg(dev, soc_info, 15, 0, 2, 0, 0);
505
506
}

507
uint32_t aw_get_ttbcr(feldev_handle *dev, soc_info_t *soc_info)
508
{
509
	return aw_read_arm_cp_reg(dev, soc_info, 15, 0, 2, 0, 2);
510
511
}

512
uint32_t aw_get_dacr(feldev_handle *dev, soc_info_t *soc_info)
513
{
514
	return aw_read_arm_cp_reg(dev, soc_info, 15, 0, 3, 0, 0);
515
516
}

517
uint32_t aw_get_sctlr(feldev_handle *dev, soc_info_t *soc_info)
518
{
519
	return aw_read_arm_cp_reg(dev, soc_info, 15, 0, 1, 0, 0);
520
521
}

522
void aw_set_ttbr0(feldev_handle *dev, soc_info_t *soc_info,
523
524
		  uint32_t ttbr0)
{
525
	return aw_write_arm_cp_reg(dev, soc_info, 15, 0, 2, 0, 0, ttbr0);
526
527
}

528
void aw_set_ttbcr(feldev_handle *dev, soc_info_t *soc_info,
529
530
		  uint32_t ttbcr)
{
531
	return aw_write_arm_cp_reg(dev, soc_info, 15, 0, 2, 0, 2, ttbcr);
532
533
}

534
void aw_set_dacr(feldev_handle *dev, soc_info_t *soc_info,
535
536
		 uint32_t dacr)
{
537
	aw_write_arm_cp_reg(dev, soc_info, 15, 0, 3, 0, 0, dacr);
538
539
}

540
void aw_set_sctlr(feldev_handle *dev, soc_info_t *soc_info,
541
542
		  uint32_t sctlr)
{
543
	aw_write_arm_cp_reg(dev, soc_info, 15, 0, 1, 0, 0, sctlr);
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
}

/*
 * Reconstruct the same MMU translation table as used by the A20 BROM.
 * We are basically reverting the changes, introduced in newer SoC
 * variants. This works fine for the SoC variants with the memory
 * layout similar to A20 (the SRAM is in the first megabyte of the
 * address space and the BROM is in the last megabyte of the address
 * space).
 */
uint32_t *aw_generate_mmu_translation_table(void)
{
	uint32_t *tt = malloc(4096 * sizeof(uint32_t));
	uint32_t i;

	/*
	 * Direct mapping using 1MB sections with TEXCB=00000 (Strongly
	 * ordered) for all memory except the first and the last sections,
	 * which have TEXCB=00100 (Normal). Domain bits are set to 1111
	 * and AP bits are set to 11, but this is mostly irrelevant.
	 */
	for (i = 0; i < 4096; i++)
		tt[i] = 0x00000DE2 | (i << 20);
	tt[0x000] |= 0x1000;
	tt[0xFFF] |= 0x1000;

	return tt;
}

573
uint32_t *aw_backup_and_disable_mmu(feldev_handle *dev,
574
                                    soc_info_t *soc_info)
575
{
576
	uint32_t *tt = NULL;
577
	uint32_t sctlr, ttbr0, ttbcr, dacr;
578
579
580
	uint32_t i;

	uint32_t arm_code[] = {
581
		/* Disable I-cache, MMU and branch prediction */
582
583
		htole32(0xee110f10), /* mrc        15, 0, r0, cr1, cr0, {0}  */
		htole32(0xe3c00001), /* bic        r0, r0, #1                */
584
585
		htole32(0xe3c00a01), /* bic        r0, r0, #4096             */
		htole32(0xe3c00b02), /* bic        r0, r0, #2048             */
586
587
588
589
590
		htole32(0xee010f10), /* mcr        15, 0, r0, cr1, cr0, {0}  */
		/* Return back to FEL */
		htole32(0xe12fff1e), /* bx         lr                        */
	};

591
592
593
594
595
596
597
598
599
600
601
	/*
	 * Below are some checks for the register values, which are known
	 * to be initialized in this particular way by the existing BROM
	 * implementations. We don't strictly need them to exactly match,
	 * but still have these safety guards in place in order to detect
	 * and review any potential configuration changes in future SoC
	 * variants (if one of these checks fails, then it is not a serious
	 * problem but more likely just an indication that one of these
	 * checks needs to be relaxed).
	 */

602
	/* Basically, ignore M/Z/I/V/UNK bits and expect no TEX remap */
603
	sctlr = aw_get_sctlr(dev, soc_info);
604
	if ((sctlr & ~((0x7 << 11) | (1 << 6) | 1)) != 0x00C50038) {
605
606
607
608
		fprintf(stderr, "Unexpected SCTLR (%08X)\n", sctlr);
		exit(1);
	}

609
	if (!(sctlr & 1)) {
610
611
		pr_info("MMU is not enabled by BROM\n");
		return NULL;
612
613
	}

614
	dacr = aw_get_dacr(dev, soc_info);
615
616
617
618
619
	if (dacr != 0x55555555) {
		fprintf(stderr, "Unexpected DACR (%08X)\n", dacr);
		exit(1);
	}

620
	ttbcr = aw_get_ttbcr(dev, soc_info);
621
622
	if (ttbcr != 0x00000000) {
		fprintf(stderr, "Unexpected TTBCR (%08X)\n", ttbcr);
623
624
625
		exit(1);
	}

626
	ttbr0 = aw_get_ttbr0(dev, soc_info);
627
628
629
630
631
	if (ttbr0 & 0x3FFF) {
		fprintf(stderr, "Unexpected TTBR0 (%08X)\n", ttbr0);
		exit(1);
	}

632
	tt = malloc(16 * 1024);
633
	pr_info("Reading the MMU translation table from 0x%08X\n", ttbr0);
634
	aw_fel_read(dev, ttbr0, tt, 16 * 1024);
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
	for (i = 0; i < 4096; i++)
		tt[i] = le32toh(tt[i]);

	/* Basic sanity checks to be sure that this is a valid table */
	for (i = 0; i < 4096; i++) {
		if (((tt[i] >> 1) & 1) != 1 || ((tt[i] >> 18) & 1) != 0) {
			fprintf(stderr, "MMU: not a section descriptor\n");
			exit(1);
		}
		if ((tt[i] >> 20) != i) {
			fprintf(stderr, "MMU: not a direct mapping\n");
			exit(1);
		}
	}

650
	pr_info("Disabling I-cache, MMU and branch prediction...");
651
652
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
653
654
655
656
657
	pr_info(" done.\n");

	return tt;
}

658
void aw_restore_and_enable_mmu(feldev_handle *dev,
659
                               soc_info_t *soc_info,
660
                               uint32_t *tt)
661
662
{
	uint32_t i;
663
	uint32_t ttbr0 = aw_get_ttbr0(dev, soc_info);
664
665

	uint32_t arm_code[] = {
666
667
668
669
670
671
672
673
		/* Invalidate I-cache, TLB and BTB */
		htole32(0xe3a00000), /* mov        r0, #0                    */
		htole32(0xee080f17), /* mcr        15, 0, r0, cr8, cr7, {0}  */
		htole32(0xee070f15), /* mcr        15, 0, r0, cr7, cr5, {0}  */
		htole32(0xee070fd5), /* mcr        15, 0, r0, cr7, cr5, {6}  */
		htole32(0xf57ff04f), /* dsb        sy                        */
		htole32(0xf57ff06f), /* isb        sy                        */
		/* Enable I-cache, MMU and branch prediction */
674
675
		htole32(0xee110f10), /* mrc        15, 0, r0, cr1, cr0, {0}  */
		htole32(0xe3800001), /* orr        r0, r0, #1                */
676
677
		htole32(0xe3800a01), /* orr        r0, r0, #4096             */
		htole32(0xe3800b02), /* orr        r0, r0, #2048             */
678
679
680
681
682
		htole32(0xee010f10), /* mcr        15, 0, r0, cr1, cr0, {0}  */
		/* Return back to FEL */
		htole32(0xe12fff1e), /* bx         lr                        */
	};

683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
	pr_info("Setting write-combine mapping for DRAM.\n");
	for (i = (DRAM_BASE >> 20); i < ((DRAM_BASE + DRAM_SIZE) >> 20); i++) {
		/* Clear TEXCB bits */
		tt[i] &= ~((7 << 12) | (1 << 3) | (1 << 2));
		/* Set TEXCB to 00100 (Normal uncached mapping) */
		tt[i] |= (1 << 12);
	}

	pr_info("Setting cached mapping for BROM.\n");
	/* Clear TEXCB bits first */
	tt[0xFFF] &= ~((7 << 12) | (1 << 3) | (1 << 2));
	/* Set TEXCB to 00111 (Normal write-back cached mapping) */
	tt[0xFFF] |= (1 << 12) | /* TEX */
		     (1 << 3)  | /* C */
		     (1 << 2);   /* B */

699
700
701
	pr_info("Writing back the MMU translation table.\n");
	for (i = 0; i < 4096; i++)
		tt[i] = htole32(tt[i]);
702
	aw_fel_write(dev, tt, ttbr0, 16 * 1024);
703

704
	pr_info("Enabling I-cache, MMU and branch prediction...");
705
706
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
	aw_fel_execute(dev, soc_info->scratch_addr);
707
708
709
710
711
	pr_info(" done.\n");

	free(tt);
}

712
713
714
715
/*
 * Maximum size of SPL, at the same time this is the start offset
 * of the main U-Boot image within u-boot-sunxi-with-spl.bin
 */
716
#define SPL_LEN_LIMIT 0x8000
717

718
void aw_fel_write_and_execute_spl(feldev_handle *dev, uint8_t *buf, size_t len)
719
{
720
	soc_info_t *soc_info = dev->soc_info;
721
722
723
724
	sram_swap_buffers *swap_buffers;
	char header_signature[9] = { 0 };
	size_t i, thunk_size;
	uint32_t *thunk_buf;
725
	uint32_t sp, sp_irq;
726
	uint32_t spl_checksum, spl_len, spl_len_limit = SPL_LEN_LIMIT;
727
	uint32_t *buf32 = (uint32_t *)buf;
728
	uint32_t cur_addr = soc_info->spl_addr;
729
	uint32_t *tt = NULL;
730

731
	if (!soc_info || !soc_info->swap_buffers) {
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
		fprintf(stderr, "SPL: Unsupported SoC type\n");
		exit(1);
	}

	if (len < 32 || memcmp(buf + 4, "eGON.BT0", 8) != 0) {
		fprintf(stderr, "SPL: eGON header is not found\n");
		exit(1);
	}

	spl_checksum = 2 * le32toh(buf32[3]) - 0x5F0A6C39;
	spl_len = le32toh(buf32[4]);

	if (spl_len > len || (spl_len % 4) != 0) {
		fprintf(stderr, "SPL: bad length in the eGON header\n");
		exit(1);
	}

	len = spl_len;
	for (i = 0; i < len / 4; i++)
		spl_checksum -= le32toh(buf32[i]);

	if (spl_checksum != 0) {
		fprintf(stderr, "SPL: checksum check failed\n");
		exit(1);
	}

758
	if (soc_info->needs_l2en) {
759
		pr_info("Enabling the L2 cache\n");
760
		aw_enable_l2_cache(dev, soc_info);
761
762
	}

763
	aw_get_stackinfo(dev, soc_info, &sp_irq, &sp);
764
765
	pr_info("Stack pointers: sp_irq=0x%08X, sp=0x%08X\n", sp_irq, sp);

766
	tt = aw_backup_and_disable_mmu(dev, soc_info);
767
768
	if (!tt && soc_info->mmu_tt_addr) {
		if (soc_info->mmu_tt_addr & 0x3FFF) {
769
770
771
772
			fprintf(stderr, "SPL: 'mmu_tt_addr' must be 16K aligned\n");
			exit(1);
		}
		pr_info("Generating the new MMU translation table at 0x%08X\n",
773
		        soc_info->mmu_tt_addr);
774
775
776
777
778
779
780
781
782
783
		/*
		 * These settings are used by the BROM in A10/A13/A20 and
		 * we replicate them here when enabling the MMU. The DACR
		 * value 0x55555555 means that accesses are checked against
		 * the permission bits in the translation tables for all
		 * domains. The TTBCR value 0x00000000 means that the short
		 * descriptor translation table format is used, TTBR0 is used
		 * for all the possible virtual addresses (N=0) and that the
		 * translation table must be aligned at a 16K boundary.
		 */
784
785
786
		aw_set_dacr(dev, soc_info, 0x55555555);
		aw_set_ttbcr(dev, soc_info, 0x00000000);
		aw_set_ttbr0(dev, soc_info, soc_info->mmu_tt_addr);
787
788
		tt = aw_generate_mmu_translation_table();
	}
789

790
	swap_buffers = soc_info->swap_buffers;
791
	for (i = 0; swap_buffers[i].size; i++) {
792
793
794
		if ((swap_buffers[i].buf2 >= soc_info->spl_addr) &&
		    (swap_buffers[i].buf2 < soc_info->spl_addr + spl_len_limit))
			spl_len_limit = swap_buffers[i].buf2 - soc_info->spl_addr;
795
796
		if (len > 0 && cur_addr < swap_buffers[i].buf1) {
			uint32_t tmp = swap_buffers[i].buf1 - cur_addr;
797
798
			if (tmp > len)
				tmp = len;
799
			aw_fel_write(dev, buf, cur_addr, tmp);
800
			cur_addr += tmp;
801
802
803
			buf += tmp;
			len -= tmp;
		}
804
		if (len > 0 && cur_addr == swap_buffers[i].buf1) {
805
806
807
			uint32_t tmp = swap_buffers[i].size;
			if (tmp > len)
				tmp = len;
808
			aw_fel_write(dev, buf, swap_buffers[i].buf2, tmp);
809
			cur_addr += tmp;
810
811
812
813
814
815
			buf += tmp;
			len -= tmp;
		}
	}

	/* Clarify the SPL size limitations, and bail out if they are not met */
816
817
	if (soc_info->thunk_addr < spl_len_limit)
		spl_len_limit = soc_info->thunk_addr;
818
819
820
821
822
823
824
825
826

	if (spl_len > spl_len_limit) {
		fprintf(stderr, "SPL: too large (need %d, have %d)\n",
			(int)spl_len, (int)spl_len_limit);
		exit(1);
	}

	/* Write the remaining part of the SPL */
	if (len > 0)
827
		aw_fel_write(dev, buf, cur_addr, len);
828

829
	thunk_size = sizeof(fel_to_spl_thunk) + sizeof(soc_info->spl_addr) +
830
		     (i + 1) * sizeof(*swap_buffers);
831

832
	if (thunk_size > soc_info->thunk_size) {
833
		fprintf(stderr, "SPL: bad thunk size (need %d, have %d)\n",
834
			(int)sizeof(fel_to_spl_thunk), soc_info->thunk_size);
835
836
837
838
839
840
		exit(1);
	}

	thunk_buf = malloc(thunk_size);
	memcpy(thunk_buf, fel_to_spl_thunk, sizeof(fel_to_spl_thunk));
	memcpy(thunk_buf + sizeof(fel_to_spl_thunk) / sizeof(uint32_t),
841
	       &soc_info->spl_addr, sizeof(soc_info->spl_addr));
842
	memcpy(thunk_buf + sizeof(fel_to_spl_thunk) / sizeof(uint32_t) + 1,
843
844
845
846
847
	       swap_buffers, (i + 1) * sizeof(*swap_buffers));

	for (i = 0; i < thunk_size / sizeof(uint32_t); i++)
		thunk_buf[i] = htole32(thunk_buf[i]);

848
	pr_info("=> Executing the SPL...");
849
850
	aw_fel_write(dev, thunk_buf, soc_info->thunk_addr, thunk_size);
	aw_fel_execute(dev, soc_info->thunk_addr);
851
	pr_info(" done.\n");
852
853
854
855
856
857
858

	free(thunk_buf);

	/* TODO: Try to find and fix the bug, which needs this workaround */
	usleep(250000);

	/* Read back the result and check if everything was fine */
859
	aw_fel_read(dev, soc_info->spl_addr + 4, header_signature, 8);
860
861
862
863
864
	if (strcmp(header_signature, "eGON.FEL") != 0) {
		fprintf(stderr, "SPL: failure code '%s'\n",
			header_signature);
		exit(1);
	}
865

866
	/* re-enable the MMU if it was enabled by BROM */
Bernhard Nortmann's avatar
Bernhard Nortmann committed
867
	if (tt != NULL)
868
		aw_restore_and_enable_mmu(dev, soc_info, tt);
869
870
}

871
872
873
874
875
876
/*
 * This function tests a given buffer address and length for a valid U-Boot
 * image. Upon success, the image data gets transferred to the default memory
 * address stored within the image header; and the function preserves the
 * U-Boot entry point (offset) and size values.
 */
877
void aw_fel_write_uboot_image(feldev_handle *dev, uint8_t *buf, size_t len)
878
879
880
881
882
883
{
	if (len <= HEADER_SIZE)
		return; /* Insufficient size (no actual data), just bail out */

	uint32_t *buf32 = (uint32_t *)buf;

884
885
886
887
888
889
890
891
892
893
894
895
896
897
	/* Check for a valid mkimage header */
	int image_type = get_image_type(buf, len);
	if (image_type <= IH_TYPE_INVALID) {
		switch (image_type) {
		case IH_TYPE_INVALID:
			fprintf(stderr, "Invalid U-Boot image: bad size or signature\n");
			break;
		case IH_TYPE_ARCH_MISMATCH:
			fprintf(stderr, "Invalid U-Boot image: wrong architecture\n");
			break;
		default:
			fprintf(stderr, "Invalid U-Boot image: error code %d\n",
				image_type);
		}
898
899
		exit(1);
	}
900
901
902
	if (image_type != IH_TYPE_FIRMWARE) {
		fprintf(stderr, "U-Boot image type mismatch: "
			"expected IH_TYPE_FIRMWARE, got %02X\n", image_type);
903
904
905
906
		exit(1);
	}
	uint32_t data_size = be32toh(buf32[3]); /* Image Data Size */
	uint32_t load_addr = be32toh(buf32[4]); /* Data Load Address */
907
	if (data_size != len - HEADER_SIZE) {
908
		fprintf(stderr, "U-Boot image data size mismatch: "
909
			"expected %zu, got %u\n", len - HEADER_SIZE, data_size);
910
911
912
913
914
915
		exit(1);
	}
	/* TODO: Verify image data integrity using the checksum field ih_dcrc,
	 * available from be32toh(buf32[6])
	 *
	 * However, this requires CRC routines that mimic their U-Boot
Bernhard Nortmann's avatar
Bernhard Nortmann committed
916
	 * counterparts, namely image_check_dcrc() in ${U-BOOT}/common/image.c
917
918
919
920
921
922
923
924
925
926
927
	 * and crc_wd() in ${U-BOOT}/lib/crc32.c
	 *
	 * It should be investigated if existing CRC routines in sunxi-tools
	 * could be factored out and reused for this purpose - e.g. calc_crc32()
	 * from nand-part-main.c
	 */

	/* If we get here, we're "good to go" (i.e. actually write the data) */
	pr_info("Writing image \"%.*s\", %u bytes @ 0x%08X.\n",
		IH_NMLEN, buf + HEADER_NAME_OFFSET, data_size, load_addr);

928
	aw_write_buffer(dev, buf + HEADER_SIZE, load_addr, data_size, false);
929
930
931
932
933
934
935
936
937

	/* keep track of U-Boot memory region in global vars */
	uboot_entry = load_addr;
	uboot_size = data_size;
}

/*
 * This function handles the common part of both "spl" and "uboot" commands.
 */
938
void aw_fel_process_spl_and_uboot(feldev_handle *dev, const char *filename)
939
940
941
942
943
{
	/* load file into memory buffer */
	size_t size;
	uint8_t *buf = load_file(filename, &size);
	/* write and execute the SPL from the buffer */
944
	aw_fel_write_and_execute_spl(dev, buf, size);
945
	/* check for optional main U-Boot binary (and transfer it, if applicable) */
946
	if (size > SPL_LEN_LIMIT)
947
		aw_fel_write_uboot_image(dev, buf + SPL_LEN_LIMIT, size - SPL_LEN_LIMIT);
948
	free(buf);
949
950
}

951
952
953
954
955
956
957
958
959
960
/*
 * Test the SPL header for our "sunxi" variant. We want to make sure that
 * we can safely use specific header fields to pass information to U-Boot.
 * In case of a missing signature (e.g. Allwinner boot0) or header version
 * mismatch, this function will return "false". If all seems fine,
 * the result is "true".
 */
#define SPL_SIGNATURE			"SPL" /* marks "sunxi" header */
#define SPL_MIN_VERSION			1 /* minimum required version */
#define SPL_MAX_VERSION			1 /* maximum supported version */
961
bool have_sunxi_spl(feldev_handle *dev, uint32_t spl_addr)
962
963
964
{
	uint8_t spl_signature[4];

965
	aw_fel_read(dev, spl_addr + 0x14,
966
967
968
		&spl_signature, sizeof(spl_signature));

	if (memcmp(spl_signature, SPL_SIGNATURE, 3) != 0)
969
		return false; /* signature mismatch, no "sunxi" SPL */
970
971
972
973
974
975

	if (spl_signature[3] < SPL_MIN_VERSION) {
		fprintf(stderr, "sunxi SPL version mismatch: "
			"found 0x%02X < required minimum 0x%02X\n",
			spl_signature[3], SPL_MIN_VERSION);
		fprintf(stderr, "You need to update your U-Boot (mksunxiboot) to a more recent version.\n");
976
		return false;
977
978
979
980
981
982
	}
	if (spl_signature[3] > SPL_MAX_VERSION) {
		fprintf(stderr, "sunxi SPL version mismatch: "
			"found 0x%02X > maximum supported 0x%02X\n",
			spl_signature[3], SPL_MAX_VERSION);
		fprintf(stderr, "You need a more recent version of this (sunxi-tools) fel utility.\n");
983
		return false;
984
	}
985
	return true; /* sunxi SPL and suitable version */
986
987
988
989
}

/*
 * Pass information to U-Boot via specialized fields in the SPL header
990
991
 * (see "boot_file_head" in ${U-BOOT}/arch/arm/include/asm/arch-sunxi/spl.h),
 * providing the boot script address (DRAM location of boot.scr).
992
 */
993
void pass_fel_information(feldev_handle *dev,
994
			  uint32_t script_address, uint32_t uEnv_length)
995
{
996
	soc_info_t *soc_info = dev->soc_info;
997
998

	/* write something _only_ if we have a suitable SPL header */
999
	if (have_sunxi_spl(dev, soc_info->spl_addr)) {
1000
1001
1002
1003
1004
1005
1006
		pr_info("Passing boot info via sunxi SPL: "
			"script address = 0x%08X, uEnv length = %u\n",
			script_address, uEnv_length);
		uint32_t transfer[] = {
			htole32(script_address),
			htole32(uEnv_length)
		};
1007
		aw_fel_write(dev, transfer,
1008
			soc_info->spl_addr + 0x18, sizeof(transfer));
1009
1010
1011
	}
}

1012
1013
1014
1015
1016
1017
1018
1019
1020
/*
 * This function stores a given entry point to the RVBAR address for CPU0,
 * and then writes the Reset Management Register to request a warm boot.
 * It is useful with some AArch64 transitions, e.g. when passing control to
 * ARM Trusted Firmware (ATF) during the boot process of Pine64.
 *
 * The code was inspired by
 * https://github.com/apritzel/u-boot/commit/fda6bd1bf285c44f30ea15c7e6231bf53c31d4a8
 */
1021
void aw_rmr_request(feldev_handle *dev, uint32_t entry_point, bool aarch64)
1022
{
1023
	soc_info_t *soc_info = dev->soc_info;
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
	if (!soc_info->rvbar_reg) {
		fprintf(stderr, "ERROR: Can't issue RMR request!\n"
			"RVBAR is not supported or unknown for your SoC (id=%04X).\n",
			soc_info->soc_id);
		return;
	}

	uint32_t rmr_mode = (1 << 1) | (aarch64 ? 1 : 0); /* RR, AA64 flag */
	uint32_t arm_code[] = {
		htole32(0xe59f0028), /* ldr        r0, [rvbar_reg]          */
		htole32(0xe59f1028), /* ldr        r1, [entry_point]        */
		htole32(0xe5801000), /* str        r1, [r0]                 */
		htole32(0xf57ff04f), /* dsb        sy                       */
		htole32(0xf57ff06f), /* isb        sy                       */

		htole32(0xe59f101c), /* ldr        r1, [rmr_mode]           */
		htole32(0xee1c0f50), /* mrc        15, 0, r0, cr12, cr0, {2}*/
		htole32(0xe1800001), /* orr        r0, r0, r1               */
		htole32(0xee0c0f50), /* mcr        15, 0, r0, cr12, cr0, {2}*/
		htole32(0xf57ff06f), /* isb        sy                       */

		htole32(0xe320f003), /* loop:      wfi                      */
		htole32(0xeafffffd), /* b          <loop>                   */

		htole32(soc_info->rvbar_reg),
		htole32(entry_point),
		htole32(rmr_mode)
	};
	/* scratch buffer setup: transfers ARM code and parameter values */
1053
	aw_fel_write(dev, arm_code, soc_info->scratch_addr, sizeof(arm_code));
1054
1055
1056
1057
	/* execute the thunk code (triggering a warm reset on the SoC) */
	pr_info("Store entry point 0x%08X to RVBAR 0x%08X, "
		"and request warm reset with RMR mode %u...",
		entry_point, soc_info->rvbar_reg, rmr_mode);
1058
	aw_fel_execute(dev, soc_info->scratch_addr);
1059
1060
1061
	pr_info(" done.\n");
}

1062
1063
1064
1065
1066
1067
1068
1069
/* check buffer for magic "#=uEnv", indicating uEnv.txt compatible format */
static bool is_uEnv(void *buffer, size_t size)
{
	if (size <= 6)
		return false; /* insufficient size */
	return memcmp(buffer, "#=uEnv", 6) == 0;
}

1070
/* private helper function, gets used for "write*" and "multi*" transfers */
1071
static unsigned int file_upload(feldev_handle *dev, size_t count,
1072
				size_t argc, char **argv, progress_cb_t callback)
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
{
	if (argc < count * 2) {
		fprintf(stderr, "error: too few arguments for uploading %zu files\n",
			count);
		exit(1);
	}

	/* get all file sizes, keeping track of total bytes */
	size_t size = 0;
	unsigned int i;
	for (i = 0; i < count; i++)
		size += file_size(argv[i * 2 + 1]);

1086
	progress_start(callback, size); /* set total size and progress callback */
1087
1088
1089
1090
1091
1092

	/* now transfer each file in turn */
	for (i = 0; i < count; i++) {
		void *buf = load_file(argv[i * 2 + 1], &size);
		if (size > 0) {
			uint32_t offset = strtoul(argv[i * 2], NULL, 0);
1093
			aw_write_buffer(dev, buf, offset, size, callback != NULL);
1094

Bernhard Nortmann's avatar
Bernhard Nortmann committed
1095
			/* If we transferred a script, try to inform U-Boot about its address. */
1096
			if (get_image_type(buf, size) == IH_TYPE_SCRIPT)
1097
				pass_fel_information(dev, offset, 0);
1098
			if (is_uEnv(buf, size)) /* uEnv-style data */
1099
				pass_fel_information(dev, offset, size);
1100
1101
1102
1103
		}
		free(buf);
	}

Bernhard Nortmann's avatar
Bernhard Nortmann committed
1104
	return i; /* return number of files that were processed */
1105
1106
}

1107
1108
int main(int argc, char **argv)
{
1109
	bool uboot_autostart = false; /* flag for "uboot" command = U-Boot autostart */
1110
	bool pflag_active = false; /* -p switch, causing "write" to output progress */
1111
	feldev_handle *handle;
1112
	int busnum = -1, devnum = -1;
1113
1114

	if (argc <= 1) {
1115
		puts("sunxi-fel " VERSION "\n");
1116
1117
		printf("Usage: %s [options] command arguments... [command...]\n"
			"	-v, --verbose			Verbose logging\n"
1118
			"	-p, --progress			\"write\" transfers show a progress bar\n"
1119
			"	-d, --dev bus:devnum		Use specific USB bus and device number\n"
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
			"\n"
			"	spl file			Load and execute U-Boot SPL\n"
			"		If file additionally contains a main U-Boot binary\n"
			"		(u-boot-sunxi-with-spl.bin), this command also transfers that\n"
			"		to memory (default address from image), but won't execute it.\n"
			"\n"
			"	uboot file-with-spl		like \"spl\", but actually starts U-Boot\n"
			"		U-Boot execution will take place when the fel utility exits.\n"
			"		This allows combining \"uboot\" with further \"write\" commands\n"
			"		(to transfer other files needed for the boot).\n"
			"\n"
1131
1132
1133
			"	hex[dump] address length	Dumps memory region in hex\n"
			"	dump address length		Binary memory dump\n"
			"	exe[cute] address		Call function address\n"
1134
			"	reset64 address			RMR request for AArch64 warm boot\n"
1135
1136
			"	readl address			Read 32-bit value from device memory\n"
			"	writel address value		Write 32-bit value to device memory\n"
1137
			"	read address length file	Write memory contents into file\n"
1138
			"	write address file		Store file contents into memory\n"
1139
			"	write-with-progress addr file	\"write\" with progress bar\n"
1140
1141
			"	write-with-gauge addr file	Output progress for \"dialog --gauge\"\n"
			"	write-with-xgauge addr file	Extended gauge output (updates prompt)\n"
1142
1143
			"	multi[write] # addr file ...	\"write-with-progress\" multiple files,\n"
			"					sharing a common progress status\n"
1144
1145
1146
			"	multi[write]-with-gauge ...	like their \"write-with-*\" counterpart,\n"
			"	multi[write]-with-xgauge ...	  but following the 'multi' syntax:\n"
			"					  <#> addr file [addr file [...]]\n"
1147
			"	echo-gauge \"some text\"		Update prompt/caption for gauge output\n"
1148
			"	ver[sion]			Show BROM version\n"
1149
			"	sid				Retrieve and output 128-bit SID key\n"
1150
			"	clear address length		Clear memory\n"
Henrik Nordstrom's avatar
Henrik Nordstrom committed
1151
			"	fill address length value	Fill memory\n"
1152
1153
			, argv[0]
		);
1154
		exit(0);
1155
1156
	}

1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
	/* process all "prefix"-type arguments first */
	while (argc > 1) {
		if (strcmp(argv[1], "--verbose") == 0 || strcmp(argv[1], "-v") == 0)
			verbose = true;
		else if (strcmp(argv[1], "--progress") == 0 || strcmp(argv[1], "-p") == 0)
			pflag_active = true;
		else if (strncmp(argv[1], "--dev", 5) == 0 || strncmp(argv[1], "-d", 2) == 0) {
			char *dev_arg = argv[1];
			dev_arg += strspn(dev_arg, "-dev="); /* skip option chars, ignore '=' */
			if (*dev_arg == 0 && argc > 2) { /* at end of argument, use the next one instead */
				dev_arg = argv[2];
				argc -= 1;
				argv += 1;
			}
			if (sscanf(dev_arg, "%d:%d", &busnum, &devnum) != 2
			    || busnum <= 0 || devnum <= 0) {
				fprintf(stderr, "ERROR: Expected 'bus:devnum', got '%s'.\n", dev_arg);
				exit(1);
			}
1176
			pr_info("Selecting USB Bus %03d Device %03d\n", busnum, devnum);
1177
1178
1179
1180
		} else
			break; /* no valid (prefix) option detected, exit loop */
		argc -= 1;
		argv += 1;
1181
	}
1182

1183
	handle = feldev_open(busnum, devnum, AW_USB_VENDOR_ID, AW_USB_PRODUCT_ID);
1184

1185
1186
	while (argc > 1 ) {
		int skip = 1;
1187

1188
		if (strncmp(argv[1], "hex", 3) == 0 && argc > 3) {
1189
1190
1191
1192
1193
			aw_fel_hexdump(handle, strtoul(argv[2], NULL, 0), strtoul(argv[3], NULL, 0));
			skip = 3;
		} else if (strncmp(argv[1], "dump", 4) == 0 && argc > 3) {
			aw_fel_dump(handle, strtoul(argv[2], NULL, 0), strtoul(argv[3], NULL, 0));
			skip = 3;
1194
1195
1196
1197
1198
1199
		} else if (strcmp(argv[1], "readl") == 0 && argc > 2) {
			printf("0x%08x\n", aw_fel_readl(handle, strtoul(argv[2], NULL, 0)));
			skip = 2;
		} else if (strcmp(argv[1], "writel") == 0 && argc > 3) {
			aw_fel_writel(handle, strtoul(argv[2], NULL, 0), strtoul(argv[3], NULL, 0));
			skip = 3;
1200
		} else if (strncmp(argv[1], "exe", 3) == 0 && argc > 2) {
1201
1202
			aw_fel_execute(handle, strtoul(argv[2], NULL, 0));
			skip=3;
1203
1204
1205
1206
1207
		} else if (strcmp(argv[1], "reset64") == 0 && argc > 2) {
			aw_rmr_request(handle, strtoul(argv[2], NULL, 0), true);
			/* Cancel U-Boot autostart, and stop processing args */
			uboot_autostart = false;
			break;
1208
		} else if (strncmp(argv[1], "ver", 3) == 0) {
1209
			aw_fel_print_version(handle);
1210
1211
		} else if (strcmp(argv[1], "sid") == 0) {
			aw_fel_print_sid(handle);
1212
		} else if (strcmp(argv[1], "write") == 0 && argc > 3) {
1213
1214
			skip += 2 * file_upload(handle, 1, argc - 2, argv + 2,
					pflag_active ? progress_bar : NULL);
1215
1216
1217
		} else if (strcmp(argv[1], "write-with-progress") == 0 && argc > 3) {
			skip += 2 * file_upload(handle, 1, argc - 2, argv + 2,
						progress_bar);
1218
1219
1220
1221
1222
1223
		} else if (strcmp(argv[1], "write-with-gauge") == 0 && argc > 3) {
			skip += 2 * file_upload(handle, 1, argc - 2, argv + 2,
						progress_gauge);
		} else if (strcmp(argv[1], "write-with-xgauge") == 0 && argc > 3) {
			skip += 2 * file_upload(handle, 1, argc - 2, argv + 2,
						progress_gauge_xxx);
1224
1225
1226
1227
1228
		} else if ((strcmp(argv[1], "multiwrite") == 0 ||
			    strcmp(argv[1], "multi") == 0) && argc > 4) {
			size_t count = strtoul(argv[2], NULL, 0); /* file count */
			skip = 2 + 2 * file_upload(handle, count, argc - 3,
						   argv + 3, progress_bar);
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
		} else if ((strcmp(argv[1], "multiwrite-with-gauge") == 0 ||
			    strcmp(argv[1], "multi-with-gauge") == 0) && argc > 4) {
			size_t count = strtoul(argv[2], NULL, 0); /* file count */
			skip = 2 + 2 * file_upload(handle, count, argc - 3,
						   argv + 3, progress_gauge);
		} else if ((strcmp(argv[1], "multiwrite-with-xgauge") == 0 ||
			    strcmp(argv[1], "multi-with-xgauge") == 0) && argc > 4) {
			size_t count = strtoul(argv[2], NULL, 0); /* file count */
			skip = 2 + 2 * file_upload(handle, count, argc - 3,
						   argv + 3, progress_gauge_xxx);
1239
1240
1241
1242
		} else if ((strcmp(argv[1], "echo-gauge") == 0) && argc > 2) {
			skip = 2;
			printf("XXX\n0\n%s\nXXX\n", argv[2]);
			fflush(stdout);
1243
1244
1245
1246
1247
1248
1249
		} else if (strcmp(argv[1], "read") == 0 && argc > 4) {
			size_t size = strtoul(argv[3], NULL, 0);
			void *buf = malloc(size);
			aw_fel_read(handle, strtoul(argv[2], NULL, 0), buf, size);
			save_file(argv[4], buf, size);
			free(buf);
			skip=4;
1250
		} else if (strcmp(argv[1], "clear") == 0 && argc > 2) {
Henrik Nordstrom's avatar
Henrik Nordstrom committed
1251
			aw_fel_fill(handle, strtoul(argv[2], NULL, 0), strtoul(argv[3], NULL, 0), 0);
1252
			skip=3;
Henrik Nordstrom's avatar
Henrik Nordstrom committed
1253
1254
1255
		} else if (strcmp(argv[1], "fill") == 0 && argc > 3) {
			aw_fel_fill(handle, strtoul(argv[2], NULL, 0), strtoul(argv[3], NULL, 0), (unsigned char)strtoul(argv[4], NULL, 0));
			skip=4;
1256
		} else if (strcmp(argv[1], "spl") == 0 && argc > 2) {
1257
1258
1259
1260
			aw_fel_process_spl_and_uboot(handle, argv[2]);
			skip=2;
		} else if (strcmp(argv[1], "uboot") == 0 && argc > 2) {
			aw_fel_process_spl_and_uboot(handle, argv[2]);
1261
1262
			uboot_autostart = (uboot_entry > 0 && uboot_size > 0);
			if (!uboot_autostart)
1263
				printf("Warning: \"uboot\" command failed to detect image! Can't execute U-Boot.\n");
1264
			skip=2;
1265
1266
1267
1268
1269
1270
1271
1272
		} else {
			fprintf(stderr,"Invalid command %s\n", argv[1]);
			exit(1);
		}
		argc-=skip;
		argv+=skip;
	}

Bernhard Nortmann's avatar
Bernhard Nortmann committed
1273
	/* auto-start U-Boot if requested (by the "uboot" command) */
1274
	if (uboot_autostart) {
1275
1276
1277
1278
		pr_info("Starting U-Boot (0x%08X).\n", uboot_entry);
		aw_fel_execute(handle, uboot_entry);
	}

1279
	feldev_done(handle);
1280

1281
1282
	return 0;
}