[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 <command.h>
#include <div64.h>
#include <dm.h>
#include <flash.h>
#include <malloc.h>
#include <mapmem.h>
#include <spi.h>
#include <spi_flash.h>
#include <asm/cache.h>
#include <jffs2/jffs2.h>
#include <linux/mtd/mtd.h>

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

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