[J-u-boot.git] / cmd / sf.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Command for accessing SPI flash.
 *
 * Copyright (C) 2008 Atmel Corporation
 */

#include <common.h>
#include <div64.h>
#include <dm.h>
#include <malloc.h>
#include <mapmem.h>
#include <spi.h>
#include <spi_flash.h>
#include <jffs2/jffs2.h>
#include <linux/mtd/mtd.h>

#include <asm/io.h>
#include <dm/device-internal.h>

static struct spi_flash *flash;

/*
 * This function computes the length argument for the erase command.
 * The length on which the command is to operate can be given in two forms:
 * 1. <cmd> offset len  - operate on <'offset',  'len')
 * 2. <cmd> offset +len - operate on <'offset',  'round_up(len)')
 * If the second form is used and the length doesn't fall on the
 * sector boundary, than it will be adjusted to the next sector boundary.
 * If it isn't in the flash, the function will fail (return -1).
 * Input:
 *    arg: length specification (i.e. both command arguments)
 * Output:
 *    len: computed length for operation
 * Return:
 *    1: success
 *   -1: failure (bad format, bad address).
 */
static int sf_parse_len_arg(char *arg, ulong *len)
{
	char *ep;
	char round_up_len; /* indicates if the "+length" form used */
	ulong len_arg;

	round_up_len = 0;
	if (*arg == '+') {
		round_up_len = 1;
		++arg;
	}

	len_arg = simple_strtoul(arg, &ep, 16);
	if (ep == arg || *ep != '\0')
		return -1;

	if (round_up_len && flash->sector_size > 0)
		*len = ROUND(len_arg, flash->sector_size);
	else
		*len = len_arg;

	return 1;
}

/**
 * This function takes a byte length and a delta unit of time to compute the
 * approximate bytes per second
 *
 * @param len		amount of bytes currently processed
 * @param start_ms	start time of processing in ms
 * @return bytes per second if OK, 0 on error
 */
static ulong bytes_per_second(unsigned int len, ulong start_ms)
{
	/* less accurate but avoids overflow */
	if (len >= ((unsigned int) -1) / 1024)
		return len / (max(get_timer(start_ms) / 1024, 1UL));
	else
		return 1024 * len / max(get_timer(start_ms), 1UL);
}

static int do_spi_flash_probe(int argc, char * const argv[])
{
	unsigned int bus = CONFIG_SF_DEFAULT_BUS;
	unsigned int cs = CONFIG_SF_DEFAULT_CS;
	unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
	unsigned int mode = CONFIG_SF_DEFAULT_MODE;
	char *endp;
#ifdef CONFIG_DM_SPI_FLASH
	struct udevice *new, *bus_dev;
	int ret;
	/* In DM mode defaults will be taken from DT */
	speed = 0, mode = 0;
#else
	struct spi_flash *new;
#endif

	if (argc >= 2) {
		cs = simple_strtoul(argv[1], &endp, 0);
		if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
			return -1;
		if (*endp == ':') {
			if (endp[1] == 0)
				return -1;

			bus = cs;
			cs = simple_strtoul(endp + 1, &endp, 0);
			if (*endp != 0)
				return -1;
		}
	}

	if (argc >= 3) {
		speed = simple_strtoul(argv[2], &endp, 0);
		if (*argv[2] == 0 || *endp != 0)
			return -1;
	}
	if (argc >= 4) {
		mode = simple_strtoul(argv[3], &endp, 16);
		if (*argv[3] == 0 || *endp != 0)
			return -1;
	}

#ifdef CONFIG_DM_SPI_FLASH
	/* Remove the old device, otherwise probe will just be a nop */
	ret = spi_find_bus_and_cs(bus, cs, &bus_dev, &new);
	if (!ret) {
		device_remove(new, DM_REMOVE_NORMAL);
	}
	flash = NULL;
	ret = spi_flash_probe_bus_cs(bus, cs, speed, mode, &new);
	if (ret) {
		printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
		       bus, cs, ret);
		return 1;
	}

	flash = dev_get_uclass_priv(new);
#else
	if (flash)
		spi_flash_free(flash);

	new = spi_flash_probe(bus, cs, speed, mode);
	flash = new;

	if (!new) {
		printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
		return 1;
	}

	flash = new;
#endif

	return 0;
}

/**
 * Write a block of data to SPI flash, first checking if it is different from
 * what is already there.
 *
 * If the data being written is the same, then *skipped is incremented by len.
 *
 * @param flash		flash context pointer
 * @param offset	flash offset to write
 * @param len		number of bytes to write
 * @param buf		buffer to write from
 * @param cmp_buf	read buffer to use to compare data
 * @param skipped	Count of skipped data (incremented by this function)
 * @return NULL if OK, else a string containing the stage which failed
 */
static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
		size_t len, const char *buf, char *cmp_buf, size_t *skipped)
{
	char *ptr = (char *)buf;

	debug("offset=%#x, sector_size=%#x, len=%#zx\n",
	      offset, flash->sector_size, len);
	/* Read the entire sector so to allow for rewriting */
	if (spi_flash_read(flash, offset, flash->sector_size, cmp_buf))
		return "read";
	/* Compare only what is meaningful (len) */
	if (memcmp(cmp_buf, buf, len) == 0) {
		debug("Skip region %x size %zx: no change\n",
		      offset, len);
		*skipped += len;
		return NULL;
	}
	/* Erase the entire sector */
	if (spi_flash_erase(flash, offset, flash->sector_size))
		return "erase";
	/* If it's a partial sector, copy the data into the temp-buffer */
	if (len != flash->sector_size) {
		memcpy(cmp_buf, buf, len);
		ptr = cmp_buf;
	}
	/* Write one complete sector */
	if (spi_flash_write(flash, offset, flash->sector_size, ptr))
		return "write";

	return NULL;
}

/**
 * Update an area of SPI flash by erasing and writing any blocks which need
 * to change. Existing blocks with the correct data are left unchanged.
 *
 * @param flash		flash context pointer
 * @param offset	flash offset to write
 * @param len		number of bytes to write
 * @param buf		buffer to write from
 * @return 0 if ok, 1 on error
 */
static int spi_flash_update(struct spi_flash *flash, u32 offset,
		size_t len, const char *buf)
{
	const char *err_oper = NULL;
	char *cmp_buf;
	const char *end = buf + len;
	size_t todo;		/* number of bytes to do in this pass */
	size_t skipped = 0;	/* statistics */
	const ulong start_time = get_timer(0);
	size_t scale = 1;
	const char *start_buf = buf;
	ulong delta;

	if (end - buf >= 200)
		scale = (end - buf) / 100;
	cmp_buf = memalign(ARCH_DMA_MINALIGN, flash->sector_size);
	if (cmp_buf) {
		ulong last_update = get_timer(0);

		for (; buf < end && !err_oper; buf += todo, offset += todo) {
			todo = min_t(size_t, end - buf, flash->sector_size);
			if (get_timer(last_update) > 100) {
				printf("   \rUpdating, %zu%% %lu B/s",
				       100 - (end - buf) / scale,
					bytes_per_second(buf - start_buf,
							 start_time));
				last_update = get_timer(0);
			}
			err_oper = spi_flash_update_block(flash, offset, todo,
					buf, cmp_buf, &skipped);
		}
	} else {
		err_oper = "malloc";
	}
	free(cmp_buf);
	putc('\r');
	if (err_oper) {
		printf("SPI flash failed in %s step\n", err_oper);
		return 1;
	}

	delta = get_timer(start_time);
	printf("%zu bytes written, %zu bytes skipped", len - skipped,
	       skipped);
	printf(" in %ld.%lds, speed %ld B/s\n",
	       delta / 1000, delta % 1000, bytes_per_second(len, start_time));

	return 0;
}

static int do_spi_flash_read_write(int argc, char * const argv[])
{
	unsigned long addr;
	void *buf;
	char *endp;
	int ret = 1;
	int dev = 0;
	loff_t offset, len, maxsize;

	if (argc < 3)
		return -1;

	addr = simple_strtoul(argv[1], &endp, 16);
	if (*argv[1] == 0 || *endp != 0)
		return -1;

	if (mtd_arg_off_size(argc - 2, &argv[2], &dev, &offset, &len,
			     &maxsize, MTD_DEV_TYPE_NOR, flash->size))
		return -1;

	/* Consistency checking */
	if (offset + len > flash->size) {
		printf("ERROR: attempting %s past flash size (%#x)\n",
		       argv[0], flash->size);
		return 1;
	}

	buf = map_physmem(addr, len, MAP_WRBACK);
	if (!buf && addr) {
		puts("Failed to map physical memory\n");
		return 1;
	}

	if (strcmp(argv[0], "update") == 0) {
		ret = spi_flash_update(flash, offset, len, buf);
	} else if (strncmp(argv[0], "read", 4) == 0 ||
			strncmp(argv[0], "write", 5) == 0) {
		int read;

		read = strncmp(argv[0], "read", 4) == 0;
		if (read)
			ret = spi_flash_read(flash, offset, len, buf);
		else
			ret = spi_flash_write(flash, offset, len, buf);

		printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset,
		       read ? "Read" : "Written");
		if (ret)
			printf("ERROR %d\n", ret);
		else
			printf("OK\n");
	}

	unmap_physmem(buf, len);

	return ret == 0 ? 0 : 1;
}

static int do_spi_flash_erase(int argc, char * const argv[])
{
	int ret;
	int dev = 0;
	loff_t offset, len, maxsize;
	ulong size;

	if (argc < 3)
		return -1;

	if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize,
			MTD_DEV_TYPE_NOR, flash->size))
		return -1;

	ret = sf_parse_len_arg(argv[2], &size);
	if (ret != 1)
		return -1;

	/* Consistency checking */
	if (offset + size > flash->size) {
		printf("ERROR: attempting %s past flash size (%#x)\n",
		       argv[0], flash->size);
		return 1;
	}

	ret = spi_flash_erase(flash, offset, size);
	printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)size, (u32)offset,
	       ret ? "ERROR" : "OK");

	return ret == 0 ? 0 : 1;
}

static int do_spi_protect(int argc, char * const argv[])
{
	int ret = 0;
	loff_t start, len;
	bool prot = false;

	if (argc != 4)
		return -1;

	if (!str2off(argv[2], &start)) {
		puts("start sector is not a valid number\n");
		return 1;
	}

	if (!str2off(argv[3], &len)) {
		puts("len is not a valid number\n");
		return 1;
	}

	if (strcmp(argv[1], "lock") == 0)
		prot = true;
	else if (strcmp(argv[1], "unlock") == 0)
		prot = false;
	else
		return -1;  /* Unknown parameter */

	ret = spi_flash_protect(flash, start, len, prot);

	return ret == 0 ? 0 : 1;
}

#ifdef CONFIG_CMD_SF_TEST
enum {
	STAGE_ERASE,
	STAGE_CHECK,
	STAGE_WRITE,
	STAGE_READ,

	STAGE_COUNT,
};

static char *stage_name[STAGE_COUNT] = {
	"erase",
	"check",
	"write",
	"read",
};

struct test_info {
	int stage;
	int bytes;
	unsigned base_ms;
	unsigned time_ms[STAGE_COUNT];
};

static void show_time(struct test_info *test, int stage)
{
	uint64_t speed;	/* KiB/s */
	int bps;	/* Bits per second */

	speed = (long long)test->bytes * 1000;
	if (test->time_ms[stage])
		do_div(speed, test->time_ms[stage] * 1024);
	bps = speed * 8;

	printf("%d %s: %u ticks, %d KiB/s %d.%03d Mbps\n", stage,
	       stage_name[stage], test->time_ms[stage],
	       (int)speed, bps / 1000, bps % 1000);
}

static void spi_test_next_stage(struct test_info *test)
{
	test->time_ms[test->stage] = get_timer(test->base_ms);
	show_time(test, test->stage);
	test->base_ms = get_timer(0);
	test->stage++;
}

/**
 * Run a test on the SPI flash
 *
 * @param flash		SPI flash to use
 * @param buf		Source buffer for data to write
 * @param len		Size of data to read/write
 * @param offset	Offset within flash to check
 * @param vbuf		Verification buffer
 * @return 0 if ok, -1 on error
 */
static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
			   ulong offset, uint8_t *vbuf)
{
	struct test_info test;
	int i;

	printf("SPI flash test:\n");
	memset(&test, '\0', sizeof(test));
	test.base_ms = get_timer(0);
	test.bytes = len;
	if (spi_flash_erase(flash, offset, len)) {
		printf("Erase failed\n");
		return -1;
	}
	spi_test_next_stage(&test);

	if (spi_flash_read(flash, offset, len, vbuf)) {
		printf("Check read failed\n");
		return -1;
	}
	for (i = 0; i < len; i++) {
		if (vbuf[i] != 0xff) {
			printf("Check failed at %d\n", i);
			print_buffer(i, vbuf + i, 1,
				     min_t(uint, len - i, 0x40), 0);
			return -1;
		}
	}
	spi_test_next_stage(&test);

	if (spi_flash_write(flash, offset, len, buf)) {
		printf("Write failed\n");
		return -1;
	}
	memset(vbuf, '\0', len);
	spi_test_next_stage(&test);

	if (spi_flash_read(flash, offset, len, vbuf)) {
		printf("Read failed\n");
		return -1;
	}
	spi_test_next_stage(&test);

	for (i = 0; i < len; i++) {
		if (buf[i] != vbuf[i]) {
			printf("Verify failed at %d, good data:\n", i);
			print_buffer(i, buf + i, 1,
				     min_t(uint, len - i, 0x40), 0);
			printf("Bad data:\n");
			print_buffer(i, vbuf + i, 1,
				     min_t(uint, len - i, 0x40), 0);
			return -1;
		}
	}
	printf("Test passed\n");
	for (i = 0; i < STAGE_COUNT; i++)
		show_time(&test, i);

	return 0;
}

static int do_spi_flash_test(int argc, char * const argv[])
{
	unsigned long offset;
	unsigned long len;
	uint8_t *buf, *from;
	char *endp;
	uint8_t *vbuf;
	int ret;

	if (argc < 3)
		return -1;
	offset = simple_strtoul(argv[1], &endp, 16);
	if (*argv[1] == 0 || *endp != 0)
		return -1;
	len = simple_strtoul(argv[2], &endp, 16);
	if (*argv[2] == 0 || *endp != 0)
		return -1;

	vbuf = memalign(ARCH_DMA_MINALIGN, len);
	if (!vbuf) {
		printf("Cannot allocate memory (%lu bytes)\n", len);
		return 1;
	}
	buf = memalign(ARCH_DMA_MINALIGN, len);
	if (!buf) {
		free(vbuf);
		printf("Cannot allocate memory (%lu bytes)\n", len);
		return 1;
	}

	from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0);
	memcpy(buf, from, len);
	ret = spi_flash_test(flash, buf, len, offset, vbuf);
	free(vbuf);
	free(buf);
	if (ret) {
		printf("Test failed\n");
		return 1;
	}

	return 0;
}
#endif /* CONFIG_CMD_SF_TEST */

static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc,
			char * const argv[])
{
	const char *cmd;
	int ret;

	/* need at least two arguments */
	if (argc < 2)
		goto usage;

	cmd = argv[1];
	--argc;
	++argv;

	if (strcmp(cmd, "probe") == 0) {
		ret = do_spi_flash_probe(argc, argv);
		goto done;
	}

	/* The remaining commands require a selected device */
	if (!flash) {
		puts("No SPI flash selected. Please run `sf probe'\n");
		return 1;
	}

	if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
	    strcmp(cmd, "update") == 0)
		ret = do_spi_flash_read_write(argc, argv);
	else if (strcmp(cmd, "erase") == 0)
		ret = do_spi_flash_erase(argc, argv);
	else if (strcmp(cmd, "protect") == 0)
		ret = do_spi_protect(argc, argv);
#ifdef CONFIG_CMD_SF_TEST
	else if (!strcmp(cmd, "test"))
		ret = do_spi_flash_test(argc, argv);
#endif
	else
		ret = -1;

done:
	if (ret != -1)
		return ret;

usage:
	return CMD_RET_USAGE;
}

#ifdef CONFIG_CMD_SF_TEST
#define SF_TEST_HELP "\nsf test offset len		" \
		"- run a very basic destructive test"
#else
#define SF_TEST_HELP
#endif

U_BOOT_CMD(
	sf,	5,	1,	do_spi_flash,
	"SPI flash sub-system",
	"probe [[bus:]cs] [hz] [mode]	- init flash device on given SPI bus\n"
	"				  and chip select\n"
	"sf read addr offset|partition len	- read `len' bytes starting at\n"
	"				          `offset' or from start of mtd\n"
	"					  `partition'to memory at `addr'\n"
	"sf write addr offset|partition len	- write `len' bytes from memory\n"
	"				          at `addr' to flash at `offset'\n"
	"					  or to start of mtd `partition'\n"
	"sf erase offset|partition [+]len	- erase `len' bytes from `offset'\n"
	"					  or from start of mtd `partition'\n"
	"					 `+len' round up `len' to block size\n"
	"sf update addr offset|partition len	- erase and write `len' bytes from memory\n"
	"					  at `addr' to flash at `offset'\n"
	"					  or to start of mtd `partition'\n"
	"sf protect lock/unlock sector len	- protect/unprotect 'len' bytes starting\n"
	"					  at address 'sector'\n"
	SF_TEST_HELP
);
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
b6368467 HS	2	/*
	3	* Command for accessing SPI flash.
	4	*
	5	* Copyright (C) 2008 Atmel Corporation
	6	*/
4166ee58	7
b6368467	8	#include <common.h>
381c6e2c	9	#include <div64.h>
fbb09918	10	#include <dm.h>
8d1af942	11	#include <malloc.h>
0eb25b61	12	#include <mapmem.h>
ff0960f9	13	#include <spi.h>
b6368467	14	#include <spi_flash.h>
2ec1a405 HS	15	#include <jffs2/jffs2.h>
2ec1a405 HS	16	#include <linux/mtd/mtd.h>
b6368467 HS	17
b6368467 HS	18	#include <asm/io.h>
fbb09918	19	#include <dm/device-internal.h>
b6368467	20
b6368467 HS	21	static struct spi_flash *flash;
b6368467 HS	22
334eb4b0 RR	23	/*
	24	* This function computes the length argument for the erase command.
	25	* The length on which the command is to operate can be given in two forms:
	26	* 1. <cmd> offset len - operate on <'offset', 'len')
	27	* 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
	28	* If the second form is used and the length doesn't fall on the
	29	* sector boundary, than it will be adjusted to the next sector boundary.
	30	* If it isn't in the flash, the function will fail (return -1).
	31	* Input:
	32	* arg: length specification (i.e. both command arguments)
	33	* Output:
	34	* len: computed length for operation
	35	* Return:
	36	* 1: success
	37	* -1: failure (bad format, bad address).
	38	*/
	39	static int sf_parse_len_arg(char arg, ulong len)
	40	{
	41	char *ep;
	42	char round_up_len; /* indicates if the "+length" form used */
	43	ulong len_arg;
	44
	45	round_up_len = 0;
	46	if (*arg == '+') {
	47	round_up_len = 1;
	48	++arg;
	49	}
	50
	51	len_arg = simple_strtoul(arg, &ep, 16);
	52	if (ep == arg \|\| *ep != '\0')
	53	return -1;
	54
	55	if (round_up_len && flash->sector_size > 0)
155cfb5e	56	*len = ROUND(len_arg, flash->sector_size);
334eb4b0 RR	57	else
	58	*len = len_arg;
	59
	60	return 1;
	61	}
	62
a683c288 JM	63	/**
	64	* This function takes a byte length and a delta unit of time to compute the
	65	* approximate bytes per second
	66	*
	67	* @param len amount of bytes currently processed
	68	* @param start_ms start time of processing in ms
	69	* @return bytes per second if OK, 0 on error
	70	*/
	71	static ulong bytes_per_second(unsigned int len, ulong start_ms)
	72	{
	73	/* less accurate but avoids overflow */
	74	if (len >= ((unsigned int) -1) / 1024)
b4141195	75	return len / (max(get_timer(start_ms) / 1024, 1UL));
a683c288	76	else
b4141195	77	return 1024 * len / max(get_timer(start_ms), 1UL);
a683c288 JM	78	}
a683c288 JM	79
54841ab5	80	static int do_spi_flash_probe(int argc, char * const argv[])
b6368467	81	{
c1173bd0 EN	82	unsigned int bus = CONFIG_SF_DEFAULT_BUS;
c1173bd0 EN	83	unsigned int cs = CONFIG_SF_DEFAULT_CS;
b6368467 HS	84	unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
	85	unsigned int mode = CONFIG_SF_DEFAULT_MODE;
	86	char *endp;
fbb09918 SG	87	#ifdef CONFIG_DM_SPI_FLASH
	88	struct udevice new, bus_dev;
	89	int ret;
96907c0f V	90	/* In DM mode defaults will be taken from DT */
96907c0f V	91	speed = 0, mode = 0;
fbb09918	92	#else
b6368467	93	struct spi_flash *new;
fbb09918	94	#endif
b6368467	95
c1173bd0 EN	96	if (argc >= 2) {
	97	cs = simple_strtoul(argv[1], &endp, 0);
	98	if (argv[1] == 0 \|\| (endp != 0 && *endp != ':'))
8a07de03	99	return -1;
c1173bd0 EN	100	if (*endp == ':') {
	101	if (endp[1] == 0)
	102	return -1;
	103
	104	bus = cs;
	105	cs = simple_strtoul(endp + 1, &endp, 0);
	106	if (*endp != 0)
	107	return -1;
	108	}
b6368467 HS	109	}
	110
	111	if (argc >= 3) {
	112	speed = simple_strtoul(argv[2], &endp, 0);
	113	if (argv[2] == 0 \|\| endp != 0)
8a07de03	114	return -1;
b6368467 HS	115	}
b6368467 HS	116	if (argc >= 4) {
6e8d58d3	117	mode = simple_strtoul(argv[3], &endp, 16);
b6368467	118	if (argv[3] == 0 \|\| endp != 0)
8a07de03	119	return -1;
b6368467 HS	120	}
b6368467 HS	121
fbb09918 SG	122	#ifdef CONFIG_DM_SPI_FLASH
	123	/* Remove the old device, otherwise probe will just be a nop */
	124	ret = spi_find_bus_and_cs(bus, cs, &bus_dev, &new);
	125	if (!ret) {
706865af	126	device_remove(new, DM_REMOVE_NORMAL);
fbb09918 SG	127	}
	128	flash = NULL;
	129	ret = spi_flash_probe_bus_cs(bus, cs, speed, mode, &new);
	130	if (ret) {
	131	printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
	132	bus, cs, ret);
	133	return 1;
	134	}
	135
e564f054	136	flash = dev_get_uclass_priv(new);
fbb09918	137	#else
8ee81b7f HS	138	if (flash)
	139	spi_flash_free(flash);
	140
b6368467	141	new = spi_flash_probe(bus, cs, speed, mode);
8ee81b7f HS	142	flash = new;
8ee81b7f HS	143
b6368467 HS	144	if (!new) {
	145	printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
	146	return 1;
	147	}
	148
b6368467	149	flash = new;
fbb09918	150	#endif
b6368467	151
b6368467	152	return 0;
b6368467 HS	153	}
b6368467 HS	154
8d1af942 SG	155	/**
	156	* Write a block of data to SPI flash, first checking if it is different from
	157	* what is already there.
	158	*
	159	* If the data being written is the same, then *skipped is incremented by len.
	160	*
	161	* @param flash flash context pointer
	162	* @param offset flash offset to write
	163	* @param len number of bytes to write
	164	* @param buf buffer to write from
	165	* @param cmp_buf read buffer to use to compare data
	166	* @param skipped Count of skipped data (incremented by this function)
	167	* @return NULL if OK, else a string containing the stage which failed
	168	*/
	169	static const char spi_flash_update_block(struct spi_flash flash, u32 offset,
	170	size_t len, const char buf, char cmp_buf, size_t *skipped)
	171	{
ed62756d SR	172	char ptr = (char )buf;
ed62756d SR	173
a97f6efd	174	debug("offset=%#x, sector_size=%#x, len=%#zx\n",
402ba1e3	175	offset, flash->sector_size, len);
b95f958d GF	176	/* Read the entire sector so to allow for rewriting */
b95f958d GF	177	if (spi_flash_read(flash, offset, flash->sector_size, cmp_buf))
8d1af942	178	return "read";
b95f958d	179	/* Compare only what is meaningful (len) */
8d1af942	180	if (memcmp(cmp_buf, buf, len) == 0) {
a97f6efd	181	debug("Skip region %x size %zx: no change\n",
402ba1e3	182	offset, len);
8d1af942 SG	183	*skipped += len;
	184	return NULL;
	185	}
34888506 GF	186	/* Erase the entire sector */
34888506 GF	187	if (spi_flash_erase(flash, offset, flash->sector_size))
8d1af942	188	return "erase";
ed62756d	189	/* If it's a partial sector, copy the data into the temp-buffer */
b95f958d	190	if (len != flash->sector_size) {
ed62756d SR	191	memcpy(cmp_buf, buf, len);
ed62756d SR	192	ptr = cmp_buf;
b95f958d	193	}
ed62756d SR	194	/* Write one complete sector */
	195	if (spi_flash_write(flash, offset, flash->sector_size, ptr))
	196	return "write";
b95f958d	197
8d1af942 SG	198	return NULL;
	199	}
	200
	201	/**
	202	* Update an area of SPI flash by erasing and writing any blocks which need
	203	* to change. Existing blocks with the correct data are left unchanged.
	204	*
	205	* @param flash flash context pointer
	206	* @param offset flash offset to write
	207	* @param len number of bytes to write
	208	* @param buf buffer to write from
	209	* @return 0 if ok, 1 on error
	210	*/
	211	static int spi_flash_update(struct spi_flash *flash, u32 offset,
	212	size_t len, const char *buf)
	213	{
	214	const char *err_oper = NULL;
	215	char *cmp_buf;
	216	const char *end = buf + len;
	217	size_t todo; /* number of bytes to do in this pass */
8e8a4bc2	218	size_t skipped = 0; /* statistics */
a683c288 JM	219	const ulong start_time = get_timer(0);
	220	size_t scale = 1;
	221	const char *start_buf = buf;
	222	ulong delta;
8d1af942	223
a683c288 JM	224	if (end - buf >= 200)
a683c288 JM	225	scale = (end - buf) / 100;
156e96f0	226	cmp_buf = memalign(ARCH_DMA_MINALIGN, flash->sector_size);
8d1af942	227	if (cmp_buf) {
a683c288 JM	228	ulong last_update = get_timer(0);
a683c288 JM	229
8e8a4bc2	230	for (; buf < end && !err_oper; buf += todo, offset += todo) {
b4141195	231	todo = min_t(size_t, end - buf, flash->sector_size);
a683c288 JM	232	if (get_timer(last_update) > 100) {
a683c288 JM	233	printf(" \rUpdating, %zu%% %lu B/s",
402ba1e3	234	100 - (end - buf) / scale,
a683c288 JM	235	bytes_per_second(buf - start_buf,
	236	start_time));
	237	last_update = get_timer(0);
	238	}
8d1af942 SG	239	err_oper = spi_flash_update_block(flash, offset, todo,
	240	buf, cmp_buf, &skipped);
	241	}
	242	} else {
	243	err_oper = "malloc";
	244	}
	245	free(cmp_buf);
a683c288	246	putc('\r');
8d1af942 SG	247	if (err_oper) {
	248	printf("SPI flash failed in %s step\n", err_oper);
	249	return 1;
	250	}
a683c288 JM	251
	252	delta = get_timer(start_time);
	253	printf("%zu bytes written, %zu bytes skipped", len - skipped,
402ba1e3	254	skipped);
a683c288	255	printf(" in %ld.%lds, speed %ld B/s\n",
402ba1e3	256	delta / 1000, delta % 1000, bytes_per_second(len, start_time));
8e8a4bc2	257
8d1af942 SG	258	return 0;
	259	}
	260
54841ab5	261	static int do_spi_flash_read_write(int argc, char * const argv[])
b6368467 HS	262	{
b6368467 HS	263	unsigned long addr;
b6368467 HS	264	void *buf;
b6368467 HS	265	char *endp;
60b6614a	266	int ret = 1;
2ec1a405 HS	267	int dev = 0;
2ec1a405 HS	268	loff_t offset, len, maxsize;
b6368467	269
2ec1a405	270	if (argc < 3)
8a07de03	271	return -1;
b6368467 HS	272
	273	addr = simple_strtoul(argv[1], &endp, 16);
	274	if (argv[1] == 0 \|\| endp != 0)
8a07de03	275	return -1;
2ec1a405 HS	276
	277	if (mtd_arg_off_size(argc - 2, &argv[2], &dev, &offset, &len,
	278	&maxsize, MTD_DEV_TYPE_NOR, flash->size))
8a07de03	279	return -1;
b6368467	280
86493994 GF	281	/* Consistency checking */
	282	if (offset + len > flash->size) {
	283	printf("ERROR: attempting %s past flash size (%#x)\n",
402ba1e3	284	argv[0], flash->size);
86493994 GF	285	return 1;
	286	}
	287
b6368467	288	buf = map_physmem(addr, len, MAP_WRBACK);
10f087f7	289	if (!buf && addr) {
b6368467 HS	290	puts("Failed to map physical memory\n");
	291	return 1;
	292	}
	293
402ba1e3	294	if (strcmp(argv[0], "update") == 0) {
8d1af942	295	ret = spi_flash_update(flash, offset, len, buf);
402ba1e3	296	} else if (strncmp(argv[0], "read", 4) == 0 \|\|
60b6614a JT	297	strncmp(argv[0], "write", 5) == 0) {
	298	int read;
	299
	300	read = strncmp(argv[0], "read", 4) == 0;
	301	if (read)
	302	ret = spi_flash_read(flash, offset, len, buf);
	303	else
	304	ret = spi_flash_write(flash, offset, len, buf);
	305
a7d0711a SG	306	printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset,
	307	read ? "Read" : "Written");
	308	if (ret)
	309	printf("ERROR %d\n", ret);
	310	else
	311	printf("OK\n");
60b6614a	312	}
b6368467 HS	313
	314	unmap_physmem(buf, len);
	315
60b6614a	316	return ret == 0 ? 0 : 1;
b6368467 HS	317	}
b6368467 HS	318
54841ab5	319	static int do_spi_flash_erase(int argc, char * const argv[])
b6368467	320	{
b6368467	321	int ret;
2ec1a405 HS	322	int dev = 0;
	323	loff_t offset, len, maxsize;
	324	ulong size;
b6368467 HS	325
b6368467 HS	326	if (argc < 3)
8a07de03	327	return -1;
b6368467	328
2ec1a405 HS	329	if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize,
2ec1a405 HS	330	MTD_DEV_TYPE_NOR, flash->size))
8a07de03	331	return -1;
334eb4b0	332
2ec1a405	333	ret = sf_parse_len_arg(argv[2], &size);
334eb4b0	334	if (ret != 1)
8a07de03	335	return -1;
b6368467	336
86493994	337	/* Consistency checking */
2ec1a405	338	if (offset + size > flash->size) {
86493994	339	printf("ERROR: attempting %s past flash size (%#x)\n",
402ba1e3	340	argv[0], flash->size);
86493994 GF	341	return 1;
	342	}
	343
2ec1a405 HS	344	ret = spi_flash_erase(flash, offset, size);
2ec1a405 HS	345	printf("SF: %zu bytes @ %#x Erased: %s\n", (size_t)size, (u32)offset,
402ba1e3	346	ret ? "ERROR" : "OK");
b6368467	347
96bbf556	348	return ret == 0 ? 0 : 1;
b6368467 HS	349	}
b6368467 HS	350
c3c016cf FE	351	static int do_spi_protect(int argc, char * const argv[])
	352	{
	353	int ret = 0;
	354	loff_t start, len;
	355	bool prot = false;
	356
	357	if (argc != 4)
	358	return -1;
	359
	360	if (!str2off(argv[2], &start)) {
	361	puts("start sector is not a valid number\n");
	362	return 1;
	363	}
	364
	365	if (!str2off(argv[3], &len)) {
	366	puts("len is not a valid number\n");
	367	return 1;
	368	}
	369
	370	if (strcmp(argv[1], "lock") == 0)
	371	prot = true;
	372	else if (strcmp(argv[1], "unlock") == 0)
	373	prot = false;
	374	else
	375	return -1; /* Unknown parameter */
	376
	377	ret = spi_flash_protect(flash, start, len, prot);
	378
	379	return ret == 0 ? 0 : 1;
	380	}
	381
24007273 SG	382	#ifdef CONFIG_CMD_SF_TEST
	383	enum {
	384	STAGE_ERASE,
	385	STAGE_CHECK,
	386	STAGE_WRITE,
	387	STAGE_READ,
	388
	389	STAGE_COUNT,
	390	};
	391
	392	static char *stage_name[STAGE_COUNT] = {
	393	"erase",
	394	"check",
	395	"write",
	396	"read",
	397	};
	398
	399	struct test_info {
	400	int stage;
	401	int bytes;
	402	unsigned base_ms;
	403	unsigned time_ms[STAGE_COUNT];
	404	};
	405
	406	static void show_time(struct test_info *test, int stage)
	407	{
	408	uint64_t speed; /* KiB/s */
	409	int bps; /* Bits per second */
	410
	411	speed = (long long)test->bytes * 1000;
d1f22d4b SG	412	if (test->time_ms[stage])
d1f22d4b SG	413	do_div(speed, test->time_ms[stage] * 1024);
24007273 SG	414	bps = speed * 8;
24007273 SG	415
c6b2ea37	416	printf("%d %s: %u ticks, %d KiB/s %d.%03d Mbps\n", stage,
24007273 SG	417	stage_name[stage], test->time_ms[stage],
	418	(int)speed, bps / 1000, bps % 1000);
	419	}
	420
	421	static void spi_test_next_stage(struct test_info *test)
	422	{
	423	test->time_ms[test->stage] = get_timer(test->base_ms);
	424	show_time(test, test->stage);
	425	test->base_ms = get_timer(0);
	426	test->stage++;
	427	}
	428
	429	/**
	430	* Run a test on the SPI flash
	431	*
	432	* @param flash SPI flash to use
	433	* @param buf Source buffer for data to write
	434	* @param len Size of data to read/write
	435	* @param offset Offset within flash to check
	436	* @param vbuf Verification buffer
	437	* @return 0 if ok, -1 on error
	438	*/
1e7133e9 SG	439	static int spi_flash_test(struct spi_flash flash, uint8_t buf, ulong len,
1e7133e9 SG	440	ulong offset, uint8_t *vbuf)
24007273 SG	441	{
	442	struct test_info test;
	443	int i;
	444
	445	printf("SPI flash test:\n");
	446	memset(&test, '\0', sizeof(test));
	447	test.base_ms = get_timer(0);
	448	test.bytes = len;
	449	if (spi_flash_erase(flash, offset, len)) {
	450	printf("Erase failed\n");
	451	return -1;
	452	}
	453	spi_test_next_stage(&test);
	454
	455	if (spi_flash_read(flash, offset, len, vbuf)) {
	456	printf("Check read failed\n");
	457	return -1;
	458	}
	459	for (i = 0; i < len; i++) {
	460	if (vbuf[i] != 0xff) {
	461	printf("Check failed at %d\n", i);
b4141195 MY	462	print_buffer(i, vbuf + i, 1,
b4141195 MY	463	min_t(uint, len - i, 0x40), 0);
24007273 SG	464	return -1;
	465	}
	466	}
	467	spi_test_next_stage(&test);
	468
	469	if (spi_flash_write(flash, offset, len, buf)) {
	470	printf("Write failed\n");
	471	return -1;
	472	}
	473	memset(vbuf, '\0', len);
	474	spi_test_next_stage(&test);
	475
	476	if (spi_flash_read(flash, offset, len, vbuf)) {
	477	printf("Read failed\n");
	478	return -1;
	479	}
	480	spi_test_next_stage(&test);
	481
	482	for (i = 0; i < len; i++) {
	483	if (buf[i] != vbuf[i]) {
	484	printf("Verify failed at %d, good data:\n", i);
b4141195 MY	485	print_buffer(i, buf + i, 1,
b4141195 MY	486	min_t(uint, len - i, 0x40), 0);
24007273	487	printf("Bad data:\n");
b4141195 MY	488	print_buffer(i, vbuf + i, 1,
b4141195 MY	489	min_t(uint, len - i, 0x40), 0);
24007273 SG	490	return -1;
	491	}
	492	}
	493	printf("Test passed\n");
	494	for (i = 0; i < STAGE_COUNT; i++)
	495	show_time(&test, i);
	496
	497	return 0;
	498	}
	499
	500	static int do_spi_flash_test(int argc, char * const argv[])
	501	{
	502	unsigned long offset;
	503	unsigned long len;
d1f22d4b	504	uint8_t buf, from;
24007273	505	char *endp;
1e7133e9	506	uint8_t *vbuf;
24007273 SG	507	int ret;
24007273 SG	508
d1f22d4b SG	509	if (argc < 3)
d1f22d4b SG	510	return -1;
24007273 SG	511	offset = simple_strtoul(argv[1], &endp, 16);
	512	if (argv[1] == 0 \|\| endp != 0)
	513	return -1;
	514	len = simple_strtoul(argv[2], &endp, 16);
	515	if (argv[2] == 0 \|\| endp != 0)
	516	return -1;
	517
156e96f0	518	vbuf = memalign(ARCH_DMA_MINALIGN, len);
24007273	519	if (!vbuf) {
d1f22d4b	520	printf("Cannot allocate memory (%lu bytes)\n", len);
24007273 SG	521	return 1;
24007273 SG	522	}
156e96f0	523	buf = memalign(ARCH_DMA_MINALIGN, len);
24007273 SG	524	if (!buf) {
24007273 SG	525	free(vbuf);
d1f22d4b	526	printf("Cannot allocate memory (%lu bytes)\n", len);
24007273 SG	527	return 1;
	528	}
	529
d1f22d4b SG	530	from = map_sysmem(CONFIG_SYS_TEXT_BASE, 0);
d1f22d4b SG	531	memcpy(buf, from, len);
24007273 SG	532	ret = spi_flash_test(flash, buf, len, offset, vbuf);
	533	free(vbuf);
	534	free(buf);
	535	if (ret) {
	536	printf("Test failed\n");
	537	return 1;
	538	}
	539
	540	return 0;
	541	}
	542	#endif /* CONFIG_CMD_SF_TEST */
	543
402ba1e3 JT	544	static int do_spi_flash(cmd_tbl_t *cmdtp, int flag, int argc,
402ba1e3 JT	545	char * const argv[])
b6368467 HS	546	{
b6368467 HS	547	const char *cmd;
8a07de03	548	int ret;
b6368467 HS	549
	550	/* need at least two arguments */
	551	if (argc < 2)
	552	goto usage;
	553
	554	cmd = argv[1];
8a07de03 MF	555	--argc;
8a07de03 MF	556	++argv;
b6368467	557
8a07de03 MF	558	if (strcmp(cmd, "probe") == 0) {
	559	ret = do_spi_flash_probe(argc, argv);
	560	goto done;
	561	}
b6368467 HS	562
	563	/* The remaining commands require a selected device */
	564	if (!flash) {
	565	puts("No SPI flash selected. Please run `sf probe'\n");
	566	return 1;
	567	}
	568
8d1af942 SG	569	if (strcmp(cmd, "read") == 0 \|\| strcmp(cmd, "write") == 0 \|\|
8d1af942 SG	570	strcmp(cmd, "update") == 0)
8a07de03 MF	571	ret = do_spi_flash_read_write(argc, argv);
	572	else if (strcmp(cmd, "erase") == 0)
	573	ret = do_spi_flash_erase(argc, argv);
c3c016cf FE	574	else if (strcmp(cmd, "protect") == 0)
c3c016cf FE	575	ret = do_spi_protect(argc, argv);
24007273 SG	576	#ifdef CONFIG_CMD_SF_TEST
	577	else if (!strcmp(cmd, "test"))
	578	ret = do_spi_flash_test(argc, argv);
	579	#endif
8a07de03 MF	580	else
	581	ret = -1;
	582
	583	done:
	584	if (ret != -1)
	585	return ret;
b6368467 HS	586
b6368467 HS	587	usage:
4c12eeb8	588	return CMD_RET_USAGE;
b6368467 HS	589	}
b6368467 HS	590
24007273 SG	591	#ifdef CONFIG_CMD_SF_TEST
	592	#define SF_TEST_HELP "\nsf test offset len " \
	593	"- run a very basic destructive test"
	594	#else
	595	#define SF_TEST_HELP
	596	#endif
	597
b6368467 HS	598	U_BOOT_CMD(
b6368467 HS	599	sf, 5, 1, do_spi_flash,
2fb2604d	600	"SPI flash sub-system",
c1173bd0	601	"probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
b6368467	602	" and chip select\n"
2ec1a405 HS	603	"sf read addr offset\|partition len - read `len' bytes starting at\n"
	604	" `offset' or from start of mtd\n"
	605	" `partition'to memory at `addr'\n"
	606	"sf write addr offset\|partition len - write `len' bytes from memory\n"
	607	" at `addr' to flash at `offset'\n"
	608	" or to start of mtd `partition'\n"
	609	"sf erase offset\|partition [+]len - erase `len' bytes from `offset'\n"
	610	" or from start of mtd `partition'\n"
	611	" `+len' round up `len' to block size\n"
	612	"sf update addr offset\|partition len - erase and write `len' bytes from memory\n"
	613	" at `addr' to flash at `offset'\n"
	614	" or to start of mtd `partition'\n"
c3c016cf FE	615	"sf protect lock/unlock sector len - protect/unprotect 'len' bytes starting\n"
c3c016cf FE	616	" at address 'sector'\n"
24007273	617	SF_TEST_HELP
a89c33db	618	);