tcl.c 32.8 KB
Newer Older
1 2 3 4 5
/***************************************************************************
 *   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>             *
6
 *   Copyright (C) 2017-2018 Tomas Vanek <vanekt@fbl.cz>                   *
7 8 9 10 11 12 13 14 15 16 17 18
 *                                                                         *
 *   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     *
19
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
20 21 22 23 24
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "imp.h"
25 26 27
#include <helper/time_support.h>
#include <target/image.h>

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

33 34
COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
	       struct flash_bank **bank, bool do_probe)
35 36
{
	const char *name = CMD_ARGV[name_index];
37 38 39 40 41 42 43 44
	int retval;
	if (do_probe) {
		retval = get_flash_bank_by_name(name, bank);
	} else {
		*bank  = get_flash_bank_by_name_noprobe(name);
		retval = ERROR_OK;
	}

45 46
	if (retval != ERROR_OK)
		return retval;
47 48 49 50 51 52
	if (*bank)
		return ERROR_OK;

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

53 54 55 56 57 58 59 60 61 62 63 64 65 66
	if (do_probe) {
		return get_flash_bank_by_num(bank_num, bank);
	} else {
		*bank  = get_flash_bank_by_num_noprobe(bank_num);
		retval = (bank) ? ERROR_OK : ERROR_FAIL;
		return retval;
	}
}

COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
	struct flash_bank **bank)
{
	return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
				    name_index, bank, true);
67 68 69 70 71 72 73
}

COMMAND_HANDLER(handle_flash_info_command)
{
	struct flash_bank *p;
	int j = 0;
	int retval;
74 75
	bool show_sectors = false;
	bool prot_block_available;
76

77
	if (CMD_ARGC < 1 || CMD_ARGC > 2)
78 79
		return ERROR_COMMAND_SYNTAX_ERROR;

80 81 82 83 84 85 86
	if (CMD_ARGC == 2) {
		if (strcmp("sectors", CMD_ARGV[1]) == 0)
			show_sectors = true;
		else
			return ERROR_COMMAND_SYNTAX_ERROR;
	}

87 88 89
	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
	if (retval != ERROR_OK)
		return retval;
90

91
	if (p != NULL) {
92
		char buf[1024];
93 94
		int num_blocks;
		struct flash_sector *block_array;
95 96

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

101 102 103 104 105 106 107 108 109 110 111 112
		/* If the driver does not implement protection, we show the default
		 * state of is_protected array - usually protection state unknown */
		if (p->driver->protect_check == NULL) {
			retval = ERROR_FLASH_OPER_UNSUPPORTED;
		} else {
			/* We must query the hardware to avoid printing stale information! */
			retval = p->driver->protect_check(p);
			if (retval != ERROR_OK && retval != ERROR_FLASH_OPER_UNSUPPORTED)
				return retval;
		}
		if (retval == ERROR_FLASH_OPER_UNSUPPORTED)
			LOG_WARNING("Flash protection check is not implemented.");
113

114
		command_print(CMD_CTX,
115
			"#%d : %s at " TARGET_ADDR_FMT ", size 0x%8.8" PRIx32
116 117 118 119 120 121 122
			", buswidth %i, chipwidth %i",
			p->bank_number,
			p->driver->name,
			p->base,
			p->size,
			p->bus_width,
			p->chip_width);
123

124 125 126 127 128 129 130 131 132 133 134 135 136
		prot_block_available = p->num_prot_blocks && p->prot_blocks;
		if (!show_sectors && prot_block_available) {
			block_array = p->prot_blocks;
			num_blocks = p->num_prot_blocks;
		} else {
			block_array = p->sectors;
			num_blocks = p->num_sectors;
		}

		for (j = 0; j < num_blocks; j++) {
			char *protect_state = "";

			if (block_array[j].is_protected == 0)
137
				protect_state = "not protected";
138
			else if (block_array[j].is_protected == 1)
139
				protect_state = "protected";
140
			else if (!show_sectors || !prot_block_available)
141 142 143
				protect_state = "protection state unknown";

			command_print(CMD_CTX,
144 145
				"\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
				j,
146 147 148
				block_array[j].offset,
				block_array[j].size,
				block_array[j].size >> 10,
149
				protect_state);
150 151
		}

152 153 154 155 156 157 158
		if (p->driver->info != NULL) {
			retval = p->driver->info(p, buf, sizeof(buf));
			if (retval == ERROR_OK)
				command_print(CMD_CTX, "%s", buf);
			else
				LOG_ERROR("error retrieving flash info");
		}
159 160
	}

Rodrigo L. Rosa's avatar
Rodrigo L. Rosa committed
161
	return retval;
162 163 164 165
}

COMMAND_HANDLER(handle_flash_probe_command)
{
166
	struct flash_bank *p;
167 168 169 170 171
	int retval;

	if (CMD_ARGC != 1)
		return ERROR_COMMAND_SYNTAX_ERROR;

172
	retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
173 174 175
	if (retval != ERROR_OK)
		return retval;

176 177 178 179
	if (p) {
		retval = p->driver->probe(p);
		if (retval == ERROR_OK)
			command_print(CMD_CTX,
180
				"flash '%s' found at " TARGET_ADDR_FMT,
181 182 183
				p->driver->name,
				p->base);
	} else {
184
		command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
Øyvind Harboe's avatar
Øyvind Harboe committed
185
		retval = ERROR_FAIL;
186 187
	}

Øyvind Harboe's avatar
Øyvind Harboe committed
188
	return retval;
189 190 191 192
}

COMMAND_HANDLER(handle_flash_erase_check_command)
{
193
	bool blank = true;
194 195 196 197 198 199 200 201 202
	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;
203 204
	retval = p->driver->erase_check(p);
	if (retval == ERROR_OK)
205
		command_print(CMD_CTX, "successfully checked erase state");
206 207
	else {
		command_print(CMD_CTX,
208 209
			"unknown error when checking erase state of flash bank #%s at "
			TARGET_ADDR_FMT,
210 211
			CMD_ARGV[0],
			p->base);
212 213
	}

214
	for (j = 0; j < p->num_sectors; j++) {
215 216 217 218 219
		char *erase_state;

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

224
		blank = false;
225
		command_print(CMD_CTX,
226 227 228 229 230 231
			"\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);
232 233
	}

234 235
	if (blank)
		command_print(CMD_CTX, "\tBank is erased");
Rodrigo L. Rosa's avatar
Rodrigo L. Rosa committed
236
	return retval;
237 238 239 240 241
}

COMMAND_HANDLER(handle_flash_erase_address_command)
{
	struct flash_bank *p;
242
	int retval = ERROR_OK;
243
	target_addr_t address;
244
	uint32_t length;
245
	bool do_pad = false;
246
	bool do_unlock = false;
247 248
	struct target *target = get_current_target(CMD_CTX);

249
	while (CMD_ARGC >= 3) {
250 251 252 253
		/* 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.
		 */
254 255
		if (strcmp("pad", CMD_ARGV[0]) == 0)
			do_pad = true;
256
		else if (strcmp("unlock", CMD_ARGV[0]) == 0)
257
			do_unlock = true;
258
		else
259 260 261
			return ERROR_COMMAND_SYNTAX_ERROR;
		CMD_ARGC--;
		CMD_ARGV++;
262 263
	}
	if (CMD_ARGC != 2)
264 265
		return ERROR_COMMAND_SYNTAX_ERROR;

266
	COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
267
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
268

269
	if (length <= 0) {
270 271 272 273
		command_print(CMD_CTX, "Length must be >0");
		return ERROR_COMMAND_SYNTAX_ERROR;
	}

274 275 276
	retval = get_flash_bank_by_addr(target, address, true, &p);
	if (retval != ERROR_OK)
		return retval;
277

278 279
	/* We can't know if we did a resume + halt, in which case we no longer know the erased state
	 **/
280 281 282 283 284
	flash_set_dirty();

	struct duration bench;
	duration_start(&bench);

285 286 287 288 289
	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);
290

291
	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
292 293
		command_print(CMD_CTX, "erased address " TARGET_ADDR_FMT " (length %"
				PRIi32 ")"
294 295
			" in %fs (%0.3f KiB/s)", address, length,
			duration_elapsed(&bench), duration_kbps(&bench, length));
296 297 298 299 300 301 302 303 304 305 306 307 308
	}

	return retval;
}

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

	uint32_t first;
	uint32_t last;

309 310
	struct flash_bank *p;
	int retval;
311 312

	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
313 314
	if (retval != ERROR_OK)
		return retval;
315 316 317 318 319 320 321

	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);

322 323 324 325 326 327 328 329 330 331 332 333
	if (!(first <= last)) {
		command_print(CMD_CTX, "ERROR: "
			"first sector must be <= last");
		return ERROR_FAIL;
	}

	if (!(last <= (uint32_t)(p->num_sectors - 1))) {
		command_print(CMD_CTX, "ERROR: "
			"last sector must be <= %" PRIu32,
			p->num_sectors - 1);
		return ERROR_FAIL;
	}
334 335 336 337 338 339

	struct duration bench;
	duration_start(&bench);

	retval = flash_driver_erase(p, first, last);

340
	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
341
		command_print(CMD_CTX, "erased sectors %" PRIu32 " "
342
			"through %" PRIu32 " on flash bank %d "
343
			"in %fs", first, last, p->bank_number, duration_elapsed(&bench));
344 345
	}

346
	return retval;
347 348 349 350 351 352 353 354 355 356
}

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

	uint32_t first;
	uint32_t last;

357
	struct flash_bank *p;
358
	int retval;
359
	int num_blocks;
360 361

	retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
362 363
	if (retval != ERROR_OK)
		return retval;
364

365 366 367 368 369
	if (p->num_prot_blocks)
		num_blocks = p->num_prot_blocks;
	else
		num_blocks = p->num_sectors;

370 371
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
	if (strcmp(CMD_ARGV[2], "last") == 0)
372
		last = num_blocks - 1;
373 374 375 376 377 378
	else
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);

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

379 380 381 382 383 384 385 386 387 388 389 390 391 392
	if (!(first <= last)) {
		command_print(CMD_CTX, "ERROR: "
			"first %s must be <= last",
			(p->num_prot_blocks) ? "block" : "sector");
		return ERROR_FAIL;
	}

	if (!(last <= (uint32_t)(num_blocks - 1))) {
		command_print(CMD_CTX, "ERROR: "
			"last %s must be <= %" PRIu32,
			(p->num_prot_blocks) ? "block" : "sector",
			num_blocks - 1);
		return ERROR_FAIL;
	}
393 394 395

	retval = flash_driver_protect(p, set, first, last);
	if (retval == ERROR_OK) {
396
		command_print(CMD_CTX, "%s protection for %s %" PRIu32
397
			" through %" PRIu32 " on flash bank %d",
398 399 400
			(set) ? "set" : "cleared",
			(p->num_prot_blocks) ? "blocks" : "sectors",
			first, last, p->bank_number);
401 402
	}

Rodrigo L. Rosa's avatar
Rodrigo L. Rosa committed
403
	return retval;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
}

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

	struct image image;
	uint32_t written;

	int retval;

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

419
	while (CMD_ARGC) {
420
		if (strcmp(CMD_ARGV[0], "erase") == 0) {
421 422 423 424
			auto_erase = 1;
			CMD_ARGV++;
			CMD_ARGC--;
			command_print(CMD_CTX, "auto erase enabled");
425
		} else if (strcmp(CMD_ARGV[0], "unlock") == 0) {
426 427 428 429 430 431 432 433 434 435 436
			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;

437
	if (!target) {
438 439 440 441 442 443 444
		LOG_ERROR("no target selected");
		return ERROR_FAIL;
	}

	struct duration bench;
	duration_start(&bench);

445
	if (CMD_ARGC >= 2) {
446
		image.base_address_set = 1;
447
		COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
448
	} else {
449 450 451 452 453 454 455 456 457 458 459
		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);
460
	if (retval != ERROR_OK) {
461 462 463 464
		image_close(&image);
		return retval;
	}

465
	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
David Brownell's avatar
David Brownell committed
466
		command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
467 468
			"in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
			duration_elapsed(&bench), duration_kbps(&bench, written));
469 470 471 472 473 474 475 476 477
	}

	image_close(&image);

	return retval;
}

COMMAND_HANDLER(handle_flash_fill_command)
{
478
	target_addr_t address;
479 480 481
	uint32_t pattern;
	uint32_t count;
	struct target *target = get_current_target(CMD_CTX);
Øyvind Harboe's avatar
Øyvind Harboe committed
482
	unsigned i;
483
	uint32_t wordsize;
484
	int retval;
485

486 487
	if (CMD_ARGC != 3)
		return ERROR_COMMAND_SYNTAX_ERROR;
488

489
	COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
490 491 492
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
	COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);

493 494 495 496
	struct flash_bank *bank;
	retval = get_flash_bank_by_addr(target, address, true, &bank);
	if (retval != ERROR_OK)
		return retval;
497

498 499 500 501 502 503 504 505 506 507 508
	switch (CMD_NAME[4]) {
		case 'w':
			wordsize = 4;
			break;
		case 'h':
			wordsize = 2;
			break;
		case 'b':
			wordsize = 1;
			break;
		default:
509 510 511 512 513 514
			return ERROR_COMMAND_SYNTAX_ERROR;
	}

	if (count == 0)
		return ERROR_OK;

515
	if (address + count * wordsize > bank->base + bank->size) {
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
		LOG_ERROR("Cannot cross flash bank borders");
		return ERROR_FAIL;
	}

	uint32_t size_bytes = count * wordsize;
	target_addr_t aligned_start = flash_write_align_start(bank, address);
	target_addr_t end_addr = address + size_bytes - 1;
	target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
	uint32_t aligned_size = aligned_end + 1 - aligned_start;
	uint32_t padding_at_start = address - aligned_start;
	uint32_t padding_at_end = aligned_end - end_addr;

	uint8_t *buffer = malloc(aligned_size);
	if (buffer == NULL)
		return ERROR_FAIL;

	if (padding_at_start) {
		memset(buffer, bank->default_padded_value, padding_at_start);
		LOG_WARNING("Start address " TARGET_ADDR_FMT
			" breaks the required alignment of flash bank %s",
			address, bank->name);
		LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
		    padding_at_start, aligned_start);
539 540
	}

541 542
	uint8_t *ptr = buffer + padding_at_start;

543 544
	switch (wordsize) {
		case 4:
545 546
			for (i = 0; i < count; i++, ptr += wordsize)
				target_buffer_set_u32(target, ptr, pattern);
547 548
			break;
		case 2:
549 550
			for (i = 0; i < count; i++, ptr += wordsize)
				target_buffer_set_u16(target, ptr, pattern);
551 552
			break;
		case 1:
553 554
			memset(ptr, pattern, count);
			ptr += count;
555 556 557 558
			break;
		default:
			LOG_ERROR("BUG: can't happen");
			exit(-1);
559 560
	}

561 562 563 564 565 566 567
	if (padding_at_end) {
		memset(ptr, bank->default_padded_value, padding_at_end);
		LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
			" bytes (bank write end alignment)",
			end_addr + 1, padding_at_end);
	}

568 569 570
	struct duration bench;
	duration_start(&bench);

571 572 573
	retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
	if (retval != ERROR_OK)
		goto done;
574

575 576 577
	retval = flash_driver_read(bank, buffer, address - bank->base, size_bytes);
	if (retval != ERROR_OK)
		goto done;
578

579 580
	for (i = 0, ptr = buffer; i < count; i++) {
		uint32_t readback = 0;
581

582 583 584 585 586 587 588 589 590 591
		switch (wordsize) {
			case 4:
				readback = target_buffer_get_u32(target, ptr);
				break;
			case 2:
				readback = target_buffer_get_u16(target, ptr);
				break;
			case 1:
				readback = *ptr;
				break;
592
		}
593 594 595 596 597 598 599
		if (readback != pattern) {
			LOG_ERROR(
				"Verification error address " TARGET_ADDR_FMT
				", read back 0x%02" PRIx32 ", expected 0x%02" PRIx32,
				address + i * wordsize, readback, pattern);
			retval = ERROR_FAIL;
			goto done;
600
		}
601
		ptr += wordsize;
602 603
	}

604
	if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK)) {
605 606 607
		command_print(CMD_CTX, "wrote %" PRIu32 " bytes to " TARGET_ADDR_FMT
			" in %fs (%0.3f KiB/s)", size_bytes, address,
			duration_elapsed(&bench), duration_kbps(&bench, size_bytes));
608 609
	}

610
done:
611
	free(buffer);
612 613 614 615 616 617 618 619

	return retval;
}

COMMAND_HANDLER(handle_flash_write_bank_command)
{
	uint32_t offset;
	uint8_t *buffer;
620
	size_t length;
621
	struct fileio *fileio;
622

623
	if (CMD_ARGC < 2 || CMD_ARGC > 3)
624 625 626 627 628
		return ERROR_COMMAND_SYNTAX_ERROR;

	struct duration bench;
	duration_start(&bench);

629 630
	struct flash_bank *bank;
	int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &bank);
631 632 633
	if (ERROR_OK != retval)
		return retval;

634 635 636 637 638
	offset = 0;

	if (CMD_ARGC > 2)
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);

639
	if (offset > bank->size) {
640 641 642 643
		LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
			offset);
		return ERROR_COMMAND_ARGUMENT_INVALID;
	}
644 645

	if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
646
		return ERROR_FAIL;
647

648
	size_t filesize;
649
	retval = fileio_size(fileio, &filesize);
650
	if (retval != ERROR_OK) {
651
		fileio_close(fileio);
652 653 654
		return retval;
	}

655
	length = MIN(filesize, bank->size - offset);
656 657 658 659 660 661 662 663 664 665 666

	if (!length) {
		LOG_INFO("Nothing to write to flash bank");
		fileio_close(fileio);
		return ERROR_OK;
	}

	if (length != filesize)
		LOG_INFO("File content exceeds flash bank size. Only writing the "
			"first %zu bytes of the file", length);

667 668 669 670 671 672 673 674 675
	target_addr_t start_addr = bank->base + offset;
	target_addr_t aligned_start = flash_write_align_start(bank, start_addr);
	target_addr_t end_addr = start_addr + length - 1;
	target_addr_t aligned_end = flash_write_align_end(bank, end_addr);
	uint32_t aligned_size = aligned_end + 1 - aligned_start;
	uint32_t padding_at_start = start_addr - aligned_start;
	uint32_t padding_at_end = aligned_end - end_addr;

	buffer = malloc(aligned_size);
676
	if (buffer == NULL) {
677
		fileio_close(fileio);
678 679 680
		LOG_ERROR("Out of memory");
		return ERROR_FAIL;
	}
681 682 683 684 685 686 687 688 689 690 691

	if (padding_at_start) {
		memset(buffer, bank->default_padded_value, padding_at_start);
		LOG_WARNING("Start offset 0x%08" PRIx32
			" breaks the required alignment of flash bank %s",
			offset, bank->name);
		LOG_WARNING("Padding %" PRId32 " bytes from " TARGET_ADDR_FMT,
		    padding_at_start, aligned_start);
	}

	uint8_t *ptr = buffer + padding_at_start;
692
	size_t buf_cnt;
693
	if (fileio_read(fileio, length, ptr, &buf_cnt) != ERROR_OK) {
694
		free(buffer);
695
		fileio_close(fileio);
696
		return ERROR_FAIL;
697 698
	}

699 700 701 702 703 704
	if (buf_cnt != length) {
		LOG_ERROR("Short read");
		free(buffer);
		return ERROR_FAIL;
	}

705 706 707 708 709 710 711 712 713 714
	ptr += length;

	if (padding_at_end) {
		memset(ptr, bank->default_padded_value, padding_at_end);
		LOG_INFO("Padding at " TARGET_ADDR_FMT " with %" PRId32
			" bytes (bank write end alignment)",
			end_addr + 1, padding_at_end);
	}

	retval = flash_driver_write(bank, buffer, aligned_start - bank->base, aligned_size);
715 716 717

	free(buffer);

718
	if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
719
		command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u"
720
			" at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
721
			length, CMD_ARGV[1], bank->bank_number, offset,
722
			duration_elapsed(&bench), duration_kbps(&bench, length));
723 724
	}

725
	fileio_close(fileio);
726 727 728 729

	return retval;
}

730 731 732 733
COMMAND_HANDLER(handle_flash_read_bank_command)
{
	uint32_t offset;
	uint8_t *buffer;
734
	struct fileio *fileio;
735 736 737
	uint32_t length;
	size_t written;

738
	if (CMD_ARGC < 2 || CMD_ARGC > 4)
739 740 741 742 743 744 745
		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);
746

747 748 749
	if (ERROR_OK != retval)
		return retval;

750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
	offset = 0;

	if (CMD_ARGC > 2)
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);

	if (offset > p->size) {
		LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
			offset);
		return ERROR_COMMAND_ARGUMENT_INVALID;
	}

	length = p->size - offset;

	if (CMD_ARGC > 3)
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);

	if (offset + length > p->size) {
		LOG_ERROR("Length of %" PRIu32 " bytes with offset 0x%8.8" PRIx32
			" is out of range of the flash bank", length, offset);
		return ERROR_COMMAND_ARGUMENT_INVALID;
	}
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791

	buffer = malloc(length);
	if (buffer == NULL) {
		LOG_ERROR("Out of memory");
		return ERROR_FAIL;
	}

	retval = flash_driver_read(p, buffer, offset, length);
	if (retval != ERROR_OK) {
		LOG_ERROR("Read error");
		free(buffer);
		return retval;
	}

	retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
	if (retval != ERROR_OK) {
		LOG_ERROR("Could not open file");
		free(buffer);
		return retval;
	}

792 793
	retval = fileio_write(fileio, length, buffer, &written);
	fileio_close(fileio);
794 795 796 797 798 799 800
	free(buffer);
	if (retval != ERROR_OK) {
		LOG_ERROR("Could not write file");
		return ERROR_FAIL;
	}

	if (duration_measure(&bench) == ERROR_OK)
801
		command_print(CMD_CTX, "wrote %zd bytes to file %s from flash bank %u"
802
			" at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
803
			written, CMD_ARGV[1], p->bank_number, offset,
804 805 806 807 808 809 810 811 812 813
			duration_elapsed(&bench), duration_kbps(&bench, written));

	return retval;
}


COMMAND_HANDLER(handle_flash_verify_bank_command)
{
	uint32_t offset;
	uint8_t *buffer_file, *buffer_flash;
814
	struct fileio *fileio;
815
	size_t read_cnt;
816
	size_t filesize;
817
	size_t length;
818 819
	int differ;

820
	if (CMD_ARGC < 2 || CMD_ARGC > 3)
821 822 823 824 825 826 827 828 829 830
		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;

831 832 833 834 835 836 837 838 839 840
	offset = 0;

	if (CMD_ARGC > 2)
		COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);

	if (offset > p->size) {
		LOG_ERROR("Offset 0x%8.8" PRIx32 " is out of range of the flash bank",
			offset);
		return ERROR_COMMAND_ARGUMENT_INVALID;
	}
841 842 843 844 845 846 847

	retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
	if (retval != ERROR_OK) {
		LOG_ERROR("Could not open file");
		return retval;
	}

848
	retval = fileio_size(fileio, &filesize);
849
	if (retval != ERROR_OK) {
850
		fileio_close(fileio);
851 852 853
		return retval;
	}

854 855 856 857 858 859 860 861 862 863 864 865 866
	length = MIN(filesize, p->size - offset);

	if (!length) {
		LOG_INFO("Nothing to compare with flash bank");
		fileio_close(fileio);
		return ERROR_OK;
	}

	if (length != filesize)
		LOG_INFO("File content exceeds flash bank size. Only comparing the "
			"first %zu bytes of the file", length);

	buffer_file = malloc(length);
867 868
	if (buffer_file == NULL) {
		LOG_ERROR("Out of memory");
869
		fileio_close(fileio);
870 871 872
		return ERROR_FAIL;
	}

873
	retval = fileio_read(fileio, length, buffer_file, &read_cnt);
874
	fileio_close(fileio);
875 876 877 878 879 880
	if (retval != ERROR_OK) {
		LOG_ERROR("File read failure");
		free(buffer_file);
		return retval;
	}

881
	if (read_cnt != length) {
882 883 884 885 886
		LOG_ERROR("Short read");
		free(buffer_file);
		return ERROR_FAIL;
	}

887
	buffer_flash = malloc(length);
888 889 890 891 892 893
	if (buffer_flash == NULL) {
		LOG_ERROR("Out of memory");
		free(buffer_file);
		return ERROR_FAIL;
	}

894
	retval = flash_driver_read(p, buffer_flash, offset, length);
895 896 897 898 899 900 901 902
	if (retval != ERROR_OK) {
		LOG_ERROR("Flash read error");
		free(buffer_flash);
		free(buffer_file);
		return retval;
	}

	if (duration_measure(&bench) == ERROR_OK)
903
		command_print(CMD_CTX, "read %zd bytes from file %s and flash bank %u"
904
			" at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
905 906
			length, CMD_ARGV[1], p->bank_number, offset,
			duration_elapsed(&bench), duration_kbps(&bench, length));
907

908
	differ = memcmp(buffer_file, buffer_flash, length);
909 910 911 912
	command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
	if (differ) {
		uint32_t t;
		int diffs = 0;
913
		for (t = 0; t < length; t++) {
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
			if (buffer_flash[t] == buffer_file[t])
				continue;
			command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
					diffs, t + offset, buffer_flash[t], buffer_file[t]);
			if (diffs++ >= 127) {
				command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
				break;
			}
			keep_alive();
		}
	}
	free(buffer_flash);
	free(buffer_file);

	return differ ? ERROR_FAIL : ERROR_OK;
}

931 932 933 934 935 936
void flash_set_dirty(void)
{
	struct flash_bank *c;
	int i;

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

Spencer Oliver's avatar
Spencer Oliver committed
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
COMMAND_HANDLER(handle_flash_padded_value_command)
{
	if (CMD_ARGC != 2)
		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;

	COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);

	command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
			p->default_padded_value, p->bank_number);

	return retval;
}

961 962 963
static const struct command_registration flash_exec_command_handlers[] = {
	{
		.name = "probe",
964
		.handler = handle_flash_probe_command,
965
		.mode = COMMAND_EXEC,
966 967
		.usage = "bank_id",
		.help = "Identify a flash bank.",
968 969 970
	},
	{
		.name = "info",
971
		.handler = handle_flash_info_command,
972
		.mode = COMMAND_EXEC,
973
		.usage = "bank_id ['sectors']",
974
		.help = "Print information about a flash bank.",
975 976 977
	},
	{
		.name = "erase_check",
978
		.handler = handle_flash_erase_check_command,
979
		.mode = COMMAND_EXEC,
980 981 982
		.usage = "bank_id",
		.help = "Check erase state of all blocks in a "
			"flash bank.",
983 984 985
	},
	{
		.name = "erase_sector",
986
		.handler = handle_flash_erase_command,
987
		.mode = COMMAND_EXEC,
988 989
		.usage = "bank_id first_sector_num last_sector_num",
		.help = "Erase a range of sectors in a flash bank.",
990 991 992
	},
	{
		.name = "erase_address",
993
		.handler = handle_flash_erase_address_command,
994
		.mode = COMMAND_EXEC,
995
		.usage = "['pad'] ['unlock'] address length",
996 997 998 999
		.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 "
1000 1001 1002 1003
			"that all of the first and last sectors are erased. "
			"If 'unlock' is specified, then the flash is unprotected "
			"before erasing.",

1004 1005 1006
	},
	{
		.name = "fillw",
1007
		.handler = handle_flash_fill_command,
1008
		.mode = COMMAND_EXEC,
1009 1010 1011
		.usage = "address value n",
		.help = "Fill n words with 32-bit value, starting at "
			"word address.  (No autoerase.)",
1012 1013 1014
	},
	{
		.name = "fillh",
1015
		.handler = handle_flash_fill_command,
1016
		.mode = COMMAND_EXEC,
1017 1018 1019
		.usage = "address value n",
		.help = "Fill n halfwords with 16-bit value, starting at "
			"word address.  (No autoerase.)",
1020 1021 1022
	},
	{
		.name = "fillb",
1023
		.handler = handle_flash_fill_command,
1024
		.mode = COMMAND_EXEC,
1025 1026 1027
		.usage = "address value n",
		.help = "Fill n bytes with 8-bit value, starting at "
			"word address.  (No autoerase.)",
1028 1029 1030
	},
	{
		.name = "write_bank",
1031
		.handler = handle_flash_write_bank_command,
1032
		.mode = COMMAND_EXEC,
1033 1034 1035
		.usage = "bank_id filename [offset]",
		.help = "Write binary data from file to flash bank. Allow optional "
			"offset from beginning of the bank (defaults to zero).",
1036 1037 1038
	},
	{
		.name = "write_image",
1039
		.handler = handle_flash_write_image_command,