tcl.c 22.9 KB
Newer Older
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
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
 *   Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com>       *
 *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
 *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "imp.h"
26
27
28
#include <helper/time_support.h>
#include <target/image.h>

David Brownell's avatar
David Brownell committed
29
30
31
32
33
/**
 * @file
 * Implements Tcl commands used to access NOR flash facilities.
 */

34
35
36
37
COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
		struct flash_bank **bank)
{
	const char *name = CMD_ARGV[name_index];
38
39
40
	int retval = get_flash_bank_by_name(name, bank);
	if (retval != ERROR_OK)
		return retval;
41
42
43
44
45
46
	if (*bank)
		return ERROR_OK;

	unsigned bank_num;
	COMMAND_PARSE_NUMBER(uint, name, bank_num);

47
	return get_flash_bank_by_num(bank_num, bank);
48
49
50
51
52
53
54
55
56
57
58
59
}


COMMAND_HANDLER(handle_flash_info_command)
{
	struct flash_bank *p;
	int j = 0;
	int retval;

	if (CMD_ARGC != 1)
		return ERROR_COMMAND_SYNTAX_ERROR;

60
61
62
	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
	if (retval != ERROR_OK)
		return retval;
63

64
	if (p != NULL)
65
66
67
68
69
70
71
	{
		char buf[1024];

		/* attempt auto probe */
		if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
			return retval;

72
73
74
75
76
		/* We must query the hardware to avoid printing stale information! */
		retval = p->driver->protect_check(p);
		if (retval != ERROR_OK)
			return retval;

77
		command_print(CMD_CTX,
78
79
			      "#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i",
			      p->bank_number,
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
			      p->driver->name,
			      p->base,
			      p->size,
			      p->bus_width,
			      p->chip_width);
		for (j = 0; j < p->num_sectors; j++)
		{
			char *protect_state;

			if (p->sectors[j].is_protected == 0)
				protect_state = "not protected";
			else if (p->sectors[j].is_protected == 1)
				protect_state = "protected";
			else
				protect_state = "protection state unknown";

			command_print(CMD_CTX,
				      "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
				      j,
				      p->sectors[j].offset,
				      p->sectors[j].size,
				      p->sectors[j].size >> 10,
				      protect_state);
		}

		*buf = '\0'; /* initialize buffer, otherwise it migh contain garbage if driver function fails */
		retval = p->driver->info(p, buf, sizeof(buf));
		command_print(CMD_CTX, "%s", buf);
		if (retval != ERROR_OK)
			LOG_ERROR("error retrieving flash info (%d)", retval);
	}

	return ERROR_OK;
}

COMMAND_HANDLER(handle_flash_probe_command)
{
117
	struct flash_bank *p;
118
119
120
121
122
123
124
	int retval;

	if (CMD_ARGC != 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

125
126
127
128
	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
	if (retval != ERROR_OK)
		return retval;

129
130
131
132
133
134
135
136
137
138
	if (p)
	{
		if ((retval = p->driver->probe(p)) == ERROR_OK)
		{
			command_print(CMD_CTX, "flash '%s' found at 0x%8.8" PRIx32, p->driver->name, p->base);
		}
	}
	else
	{
		command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
Øyvind Harboe's avatar
Øyvind Harboe committed
139
		retval = ERROR_FAIL;
140
141
	}

Øyvind Harboe's avatar
Øyvind Harboe committed
142
	return retval;
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
}

COMMAND_HANDLER(handle_flash_erase_check_command)
{
	if (CMD_ARGC != 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

	struct flash_bank *p;
	int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
	if (ERROR_OK != retval)
		return retval;

	int j;
	if ((retval = p->driver->erase_check(p)) == ERROR_OK)
	{
		command_print(CMD_CTX, "successfully checked erase state");
	}
	else
	{
		command_print(CMD_CTX, "unknown error when checking erase state of flash bank #%s at 0x%8.8" PRIx32,
			CMD_ARGV[0], p->base);
	}

	for (j = 0; j < p->num_sectors; j++)
	{
		char *erase_state;

		if (p->sectors[j].is_erased == 0)
			erase_state = "not erased";
		else if (p->sectors[j].is_erased == 1)
			erase_state = "erased";
		else
			erase_state = "erase state unknown";

		command_print(CMD_CTX,
			      "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
			      j,
			      p->sectors[j].offset,
			      p->sectors[j].size,
			      p->sectors[j].size >> 10,
			      erase_state);
	}

	return ERROR_OK;
}

COMMAND_HANDLER(handle_flash_erase_address_command)
{
	struct flash_bank *p;
194
	int retval = ERROR_OK;
195
196
	uint32_t address;
	uint32_t length;
197
	bool do_pad = false;
198
	bool do_unlock = false;
199
200
	struct target *target = get_current_target(CMD_CTX);

201
202
	while (CMD_ARGC >= 3)
	{
203
204
205
206
		/* Optionally pad out the address range to block/sector
		 * boundaries.  We can't know if there's data in that part
		 * of the flash; only do padding if we're told to.
		 */
207
208
209
210
211
212
213
214
		if (strcmp("pad", CMD_ARGV[0]) == 0)
		{
			do_pad = true;
		} else if (strcmp("unlock", CMD_ARGV[0]) == 0)
		{
			do_unlock = true;
		} else
		{
215
			return ERROR_COMMAND_SYNTAX_ERROR;
216
		}
217
218
		CMD_ARGC--;
		CMD_ARGV++;
219
220
221
	}
	if (CMD_ARGC != 2)
	{
222
		return ERROR_COMMAND_SYNTAX_ERROR;
223
	}
224

225
226
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
227

228
229
230
231
232
233
	if (length <= 0)
	{
		command_print(CMD_CTX, "Length must be >0");
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

234
235
236
	retval = get_flash_bank_by_addr(target, address, true, &p);
	if (retval != ERROR_OK)
		return retval;
237
238
239
240
241
242
243

	/* We can't know if we did a resume + halt, in which case we no longer know the erased state */
	flash_set_dirty();

	struct duration bench;
	duration_start(&bench);

244
245
246
247
248
249
250
251
252
	if (do_unlock)
	{
		retval = flash_unlock_address_range(target, address, length);
	}

	if (retval == ERROR_OK)
	{
		retval = flash_erase_address_range(target, do_pad, address, length);
	}
253
254
255
256

	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
	{
		command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
257
				" in %fs (%0.3f KiB/s)", address, length,
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
				duration_elapsed(&bench), duration_kbps(&bench, length));
	}

	return retval;
}

static int flash_check_sector_parameters(struct command_context *cmd_ctx,
		uint32_t first, uint32_t last, uint32_t num_sectors)
{
	if (!(first <= last)) {
		command_print(cmd_ctx, "ERROR: "
				"first sector must be <= last sector");
		return ERROR_FAIL;
	}

	if (!(last <= (num_sectors - 1))) {
		command_print(cmd_ctx, "ERROR: last sector must be <= %d",
				(int) num_sectors - 1);
		return ERROR_FAIL;
	}

	return ERROR_OK;
}

COMMAND_HANDLER(handle_flash_erase_command)
{
	if (CMD_ARGC != 3)
		return ERROR_COMMAND_SYNTAX_ERROR;

	uint32_t first;
	uint32_t last;

290
291
	struct flash_bank *p;
	int retval;
292
293

	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
294
295
	if (retval != ERROR_OK)
		return retval;
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315

	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
	if (strcmp(CMD_ARGV[2], "last") == 0)
		last = p->num_sectors - 1;
	else
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);

	if ((retval = flash_check_sector_parameters(CMD_CTX,
			first, last, p->num_sectors)) != ERROR_OK)
		return retval;

	struct duration bench;
	duration_start(&bench);

	retval = flash_driver_erase(p, first, last);

	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
	{
		command_print(CMD_CTX, "erased sectors %" PRIu32 " "
				"through %" PRIu32" on flash bank %" PRIu32 " "
316
				"in %fs", first, last, p->bank_number, duration_elapsed(&bench));
317
318
319
320
321
322
323
324
325
326
327
328
329
	}

	return ERROR_OK;
}

COMMAND_HANDLER(handle_flash_protect_command)
{
	if (CMD_ARGC != 4)
		return ERROR_COMMAND_SYNTAX_ERROR;

	uint32_t first;
	uint32_t last;

330
	struct flash_bank *p;
331
332
333
	int retval;

	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
334
335
	if (retval != ERROR_OK)
		return retval;
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
	if (strcmp(CMD_ARGV[2], "last") == 0)
		last = p->num_sectors - 1;
	else
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);

	bool set;
	COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);

	if ((retval = flash_check_sector_parameters(CMD_CTX,
			first, last, p->num_sectors)) != ERROR_OK)
		return retval;

	retval = flash_driver_protect(p, set, first, last);
	if (retval == ERROR_OK) {
		command_print(CMD_CTX, "%s protection for sectors %i "
353
				"through %i on flash bank %" PRIu32 "",
354
			(set) ? "set" : "cleared", (int) first,
355
			(int) last, p->bank_number);
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
	}

	return ERROR_OK;
}

COMMAND_HANDLER(handle_flash_write_image_command)
{
	struct target *target = get_current_target(CMD_CTX);

	struct image image;
	uint32_t written;

	int retval;

	if (CMD_ARGC < 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

	/* flash auto-erase is disabled by default*/
	int auto_erase = 0;
	bool auto_unlock = false;

	for (;;)
	{
		if (strcmp(CMD_ARGV[0], "erase") == 0)
		{
			auto_erase = 1;
			CMD_ARGV++;
			CMD_ARGC--;
			command_print(CMD_CTX, "auto erase enabled");
		} else if (strcmp(CMD_ARGV[0], "unlock") == 0)
		{
			auto_unlock = true;
			CMD_ARGV++;
			CMD_ARGC--;
			command_print(CMD_CTX, "auto unlock enabled");
		} else
		{
			break;
		}
	}

	if (CMD_ARGC < 1)
	{
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

	if (!target)
	{
		LOG_ERROR("no target selected");
		return ERROR_FAIL;
	}

	struct duration bench;
	duration_start(&bench);

	if (CMD_ARGC >= 2)
	{
		image.base_address_set = 1;
416
		COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
	}
	else
	{
		image.base_address_set = 0;
		image.base_address = 0x0;
	}

	image.start_address_set = 0;

	retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
	if (retval != ERROR_OK)
	{
		return retval;
	}

	retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
	if (retval != ERROR_OK)
	{
		image_close(&image);
		return retval;
	}

	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
	{
David Brownell's avatar
David Brownell committed
441
		command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
442
				"in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
				duration_elapsed(&bench), duration_kbps(&bench, written));
	}

	image_close(&image);

	return retval;
}

COMMAND_HANDLER(handle_flash_fill_command)
{
	int err = ERROR_OK;
	uint32_t address;
	uint32_t pattern;
	uint32_t count;
	uint32_t wrote = 0;
	uint32_t cur_size = 0;
	uint32_t chunk_count;
	struct target *target = get_current_target(CMD_CTX);
Øyvind Harboe's avatar
Øyvind Harboe committed
461
	unsigned i;
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
	uint32_t wordsize;
	int retval = ERROR_OK;

	static size_t const chunksize = 1024;
	uint8_t *chunk = malloc(chunksize);
	if (chunk == NULL)
		return ERROR_FAIL;

	uint8_t *readback = malloc(chunksize);
	if (readback == NULL)
	{
		free(chunk);
		return ERROR_FAIL;
	}


	if (CMD_ARGC != 3)
	{
		retval = ERROR_COMMAND_SYNTAX_ERROR;
		goto done;
	}


	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);

	if (count == 0)
		goto done;

	switch (CMD_NAME[4])
	{
	case 'w':
		wordsize = 4;
		break;
	case 'h':
		wordsize = 2;
		break;
	case 'b':
		wordsize = 1;
		break;
	default:
		retval = ERROR_COMMAND_SYNTAX_ERROR;
		goto done;
	}

	chunk_count = MIN(count, (chunksize / wordsize));
	switch (wordsize)
	{
	case 4:
		for (i = 0; i < chunk_count; i++)
		{
			target_buffer_set_u32(target, chunk + i * wordsize, pattern);
		}
		break;
	case 2:
		for (i = 0; i < chunk_count; i++)
		{
			target_buffer_set_u16(target, chunk + i * wordsize, pattern);
		}
		break;
	case 1:
		memset(chunk, pattern, chunk_count);
		break;
	default:
		LOG_ERROR("BUG: can't happen");
		exit(-1);
	}

	struct duration bench;
	duration_start(&bench);

	for (wrote = 0; wrote < (count*wordsize); wrote += cur_size)
	{
		struct flash_bank *bank;
537

538
539
		retval = get_flash_bank_by_addr(target, address, true, &bank );
		if (retval != ERROR_OK)
540
			goto done;
541
542

		cur_size = MIN((count * wordsize - wrote), chunksize);
543
544
545
546
547
548
549
		err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
		if (err != ERROR_OK)
		{
			retval = err;
			goto done;
		}

550
		err = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
551
552
553
554
555
556
557
558
559
560
		if (err != ERROR_OK)
		{
			retval = err;
			goto done;
		}

		for (i = 0; i < cur_size; i++)
		{
			if (readback[i]!=chunk[i])
			{
561
				LOG_ERROR("Verification error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
562
563
564
565
566
567
568
						  address + wrote + i, readback[i], chunk[i]);
				retval = ERROR_FAIL;
				goto done;
			}
		}
	}

569
	if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK))
570
571
	{
		command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32
572
				" in %fs (%0.3f KiB/s)", wrote, address,
573
574
575
				duration_elapsed(&bench), duration_kbps(&bench, wrote));
	}

576
done:
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
	free(readback);
	free(chunk);

	return retval;
}

COMMAND_HANDLER(handle_flash_write_bank_command)
{
	uint32_t offset;
	uint8_t *buffer;
	struct fileio fileio;

	if (CMD_ARGC != 3)
		return ERROR_COMMAND_SYNTAX_ERROR;

	struct duration bench;
	duration_start(&bench);

	struct flash_bank *p;
	int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
	if (ERROR_OK != retval)
		return retval;

	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);

	if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
	{
		return ERROR_OK;
	}

607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
	int filesize;
	retval = fileio_size(&fileio, &filesize);
	if (retval != ERROR_OK)
	{
		fileio_close(&fileio);
		return retval;
	}

	buffer = malloc(filesize);
	if (buffer == NULL)
	{
		fileio_close(&fileio);
		LOG_ERROR("Out of memory");
		return ERROR_FAIL;
	}
622
	size_t buf_cnt;
623
	if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK)
624
625
626
627
628
629
630
631
632
633
634
635
636
	{
		free(buffer);
		fileio_close(&fileio);
		return ERROR_OK;
	}

	retval = flash_driver_write(p, buffer, offset, buf_cnt);

	free(buffer);
	buffer = NULL;

	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
	{
Freddie Chopin's avatar
Freddie Chopin committed
637
		command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u"
638
				" at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
639
640
				(long)filesize, CMD_ARGV[1], p->bank_number, offset,
				duration_elapsed(&bench), duration_kbps(&bench, filesize));
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
	}

	fileio_close(&fileio);

	return retval;
}

void flash_set_dirty(void)
{
	struct flash_bank *c;
	int i;

	/* set all flash to require erasing */
	for (c = flash_bank_list(); c; c = c->next)
	{
		for (i = 0; i < c->num_sectors; i++)
		{
			c->sectors[i].is_erased = 0;
		}
	}
}

static const struct command_registration flash_exec_command_handlers[] = {
	{
		.name = "probe",
666
		.handler = handle_flash_probe_command,
667
		.mode = COMMAND_EXEC,
668
669
		.usage = "bank_id",
		.help = "Identify a flash bank.",
670
671
672
	},
	{
		.name = "info",
673
		.handler = handle_flash_info_command,
674
		.mode = COMMAND_EXEC,
675
676
		.usage = "bank_id",
		.help = "Print information about a flash bank.",
677
678
679
	},
	{
		.name = "erase_check",
680
		.handler = handle_flash_erase_check_command,
681
		.mode = COMMAND_EXEC,
682
683
684
		.usage = "bank_id",
		.help = "Check erase state of all blocks in a "
			"flash bank.",
685
686
687
	},
	{
		.name = "erase_sector",
688
		.handler = handle_flash_erase_command,
689
		.mode = COMMAND_EXEC,
690
691
		.usage = "bank_id first_sector_num last_sector_num",
		.help = "Erase a range of sectors in a flash bank.",
692
693
694
	},
	{
		.name = "erase_address",
695
		.handler = handle_flash_erase_address_command,
696
		.mode = COMMAND_EXEC,
697
		.usage = "['pad'] ['unlock'] address length",
698
699
700
701
		.help = "Erase flash sectors starting at address and "
			"continuing for length bytes.  If 'pad' is specified, "
			"data outside that range may also be erased: the start "
			"address may be decreased, and length increased, so "
702
703
704
705
			"that all of the first and last sectors are erased. "
			"If 'unlock' is specified, then the flash is unprotected "
			"before erasing.",

706
707
708
	},
	{
		.name = "fillw",
709
		.handler = handle_flash_fill_command,
710
		.mode = COMMAND_EXEC,
711
712
713
		.usage = "address value n",
		.help = "Fill n words with 32-bit value, starting at "
			"word address.  (No autoerase.)",
714
715
716
	},
	{
		.name = "fillh",
717
		.handler = handle_flash_fill_command,
718
		.mode = COMMAND_EXEC,
719
720
721
		.usage = "address value n",
		.help = "Fill n halfwords with 16-bit value, starting at "
			"word address.  (No autoerase.)",
722
723
724
	},
	{
		.name = "fillb",
725
		.handler = handle_flash_fill_command,
726
		.mode = COMMAND_EXEC,
727
728
729
		.usage = "address value n",
		.help = "Fill n bytes with 8-bit value, starting at "
			"word address.  (No autoerase.)",
730
731
732
	},
	{
		.name = "write_bank",
733
		.handler = handle_flash_write_bank_command,
734
		.mode = COMMAND_EXEC,
735
736
737
738
		.usage = "bank_id filename offset",
		.help = "Write binary data from file to flash bank, "
			"starting at specified byte offset from the "
			"beginning of the bank.",
739
740
741
	},
	{
		.name = "write_image",
742
		.handler = handle_flash_write_image_command,
743
		.mode = COMMAND_EXEC,
744
745
746
747
		.usage = "[erase] [unlock] filename [offset [file_type]]",
		.help = "Write an image to flash.  Optionally first unprotect "
			"and/or erase the region to be used.  Allow optional "
			"offset from beginning of bank (defaults to zero)",
748
749
750
	},
	{
		.name = "protect",
751
		.handler = handle_flash_protect_command,
752
		.mode = COMMAND_EXEC,
753
754
755
756
		.usage = "bank_id first_sector [last_sector|'last'] "
			"('on'|'off')",
		.help = "Turn protection on or off for a range of sectors "
			"in a given flash bank.",
757
758
759
760
	},
	COMMAND_REGISTRATION_DONE
};

761
static int flash_init_drivers(struct command_context *cmd_ctx)
762
763
764
765
766
767
768
769
{
	if (!flash_bank_list())
		return ERROR_OK;

	struct command *parent = command_find_in_context(cmd_ctx, "flash");
	return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
}

770
771
772
773
774
775

COMMAND_HANDLER(handle_flash_bank_command)
{
	if (CMD_ARGC < 7)
	{
		LOG_ERROR("usage: flash bank <name> <driver> "
Antonio Borneo's avatar
Antonio Borneo committed
776
				"<base> <size> <chip_width> <bus_width> <target>");
777
778
779
780
781
782
783
784
785
786
787
788
789
790
		return ERROR_COMMAND_SYNTAX_ERROR;
	}
	// save bank name and advance arguments for compatibility
	const char *bank_name = *CMD_ARGV++;
	CMD_ARGC--;

	struct target *target;
	if ((target = get_target(CMD_ARGV[5])) == NULL)
	{
		LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
		return ERROR_FAIL;
	}

	const char *driver_name = CMD_ARGV[0];
Zachary T Welch's avatar
Zachary T Welch committed
791
792
	struct flash_driver *driver = flash_driver_find_by_name(driver_name);
	if (NULL == driver)
793
	{
Zachary T Welch's avatar
Zachary T Welch committed
794
795
796
797
		/* no matching flash driver found */
		LOG_ERROR("flash driver '%s' not found", driver_name);
		return ERROR_FAIL;
	}
798

799
	/* check the flash bank name is unique */
800
	if (get_flash_bank_by_name_noprobe(bank_name) != NULL)
801
802
803
804
805
806
	{
		/* flash bank name already exists  */
		LOG_ERROR("flash bank name '%s' already exists", bank_name);
		return ERROR_FAIL;
	}

Zachary T Welch's avatar
Zachary T Welch committed
807
808
809
810
811
	/* register flash specific commands */
	if (NULL != driver->commands)
	{
		int retval = register_commands(CMD_CTX, NULL,
				driver->commands);
812
813
		if (ERROR_OK != retval)
		{
Zachary T Welch's avatar
Zachary T Welch committed
814
815
816
			LOG_ERROR("couldn't register '%s' commands",
					driver_name);
			return ERROR_FAIL;
817
		}
Zachary T Welch's avatar
Zachary T Welch committed
818
	}
819

Zachary T Welch's avatar
Zachary T Welch committed
820
821
822
823
824
825
826
827
828
829
830
831
	struct flash_bank *c = malloc(sizeof(*c));
	c->name = strdup(bank_name);
	c->target = target;
	c->driver = driver;
	c->driver_priv = NULL;
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], c->base);
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
	COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
	COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
	c->num_sectors = 0;
	c->sectors = NULL;
	c->next = NULL;
832

Zachary T Welch's avatar
Zachary T Welch committed
833
834
835
836
837
838
839
840
	int retval;
	retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
	if (ERROR_OK != retval)
	{
		LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32,
				driver_name, c->base);
		free(c);
		return retval;
841
842
	}

Zachary T Welch's avatar
Zachary T Welch committed
843
844
	flash_bank_add(c);

Zachary T Welch's avatar
Zachary T Welch committed
845
	return ERROR_OK;
846
847
}

848
849
850
851
COMMAND_HANDLER(handle_flash_banks_command)
{
	if (CMD_ARGC != 0)
		return ERROR_INVALID_ARGUMENTS;
852

853
854
855
	unsigned n = 0;
	for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++)
	{
856
		LOG_USER("#%" PRIu32 " : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
857
			"buswidth %u, chipwidth %u", p->bank_number,
858
			p->name, p->driver->name, p->base, p->size,
859
860
861
862
863
864
			p->bus_width, p->chip_width);
	}
	return ERROR_OK;
}

static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
865
{
866
867
868
869
	if (argc != 1)
	{
		Jim_WrongNumArgs(interp, 1, argv,
				"no arguments to 'flash list' command");
870
871
872
873
		return JIM_ERR;
	}

	Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
Zachary T Welch's avatar
Zachary T Welch committed
874
875

	for (struct flash_bank *p = flash_bank_list(); p; p = p->next)
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
	{
		Jim_Obj *elem = Jim_NewListObj(interp, NULL, 0);

		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
		Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
		Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));

		Jim_ListAppendElement(interp, list, elem);
	}

	Jim_SetResult(interp, list);

	return JIM_OK;
}


COMMAND_HANDLER(handle_flash_init_command)
{
	if (CMD_ARGC != 0)
		return ERROR_COMMAND_SYNTAX_ERROR;

	static bool flash_initialized = false;
	if (flash_initialized)
	{
		LOG_INFO("'flash init' has already been called");
		return ERROR_OK;
	}
	flash_initialized = true;

	LOG_DEBUG("Initializing flash devices...");
	return flash_init_drivers(CMD_CTX);
}

static const struct command_registration flash_config_command_handlers[] = {
	{
		.name = "bank",
David Brownell's avatar
David Brownell committed
919
		.handler = handle_flash_bank_command,
920
		.mode = COMMAND_CONFIG,
921
922
		.usage = "bank_id driver_name base_address size_bytes "
			"chip_width_bytes bus_width_bytes target "
923
924
925
926
927
928
929
			"[driver_options ...]",
		.help = "Define a new bank with the given name, "
			"using the specified NOR flash driver.",
	},
	{
		.name = "init",
		.mode = COMMAND_CONFIG,
David Brownell's avatar
David Brownell committed
930
		.handler = handle_flash_init_command,
931
		.help = "Initialize flash devices.",
932
933
934
935
	},
	{
		.name = "banks",
		.mode = COMMAND_ANY,
David Brownell's avatar
David Brownell committed
936
		.handler = handle_flash_banks_command,
937
		.help = "Display table with information about flash banks.",
938
939
940
941
	},
	{
		.name = "list",
		.mode = COMMAND_ANY,
David Brownell's avatar
David Brownell committed
942
		.jim_handler = jim_flash_list,
943
		.help = "Returns a list of details about the flash banks.",
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
	},
	COMMAND_REGISTRATION_DONE
};
static const struct command_registration flash_command_handlers[] = {
	{
		.name = "flash",
		.mode = COMMAND_ANY,
		.help = "NOR flash command group",
		.chain = flash_config_command_handlers,
	},
	COMMAND_REGISTRATION_DONE
};

int flash_register_commands(struct command_context *cmd_ctx)
{
	return register_commands(cmd_ctx, NULL, flash_command_handlers);
}