[J-u-boot.git] / common / cmd_sf.c

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

#include <common.h>
#include <div64.h>
#include <malloc.h>
#include <spi_flash.h>

#include <asm/io.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, 1));
	else
		return 1024 * len / max(get_timer(start_ms), 1);
}

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;
	struct spi_flash *new;

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

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

	if (flash)
		spi_flash_free(flash);
	flash = new;

	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)
{
	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";
	/* Write the initial part of the block from the source */
	if (spi_flash_write(flash, offset, len, buf))
		return "write";
	/* If it's a partial sector, rewrite the existing part */
	if (len != flash->sector_size) {
		/* Rewrite the original data to the end of the sector */
		if (spi_flash_write(flash, offset + len,
				    flash->sector_size - len, &cmp_buf[len]))
			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 = malloc(flash->sector_size);
	if (cmp_buf) {
		ulong last_update = get_timer(0);

		for (; buf < end && !err_oper; buf += todo, offset += todo) {
			todo = min(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;
	unsigned long offset;
	unsigned long len;
	void *buf;
	char *endp;
	int ret = 1;

	if (argc < 4)
		return -1;

	addr = simple_strtoul(argv[1], &endp, 16);
	if (*argv[1] == 0 || *endp != 0)
		return -1;
	offset = simple_strtoul(argv[2], &endp, 16);
	if (*argv[2] == 0 || *endp != 0)
		return -1;
	len = simple_strtoul(argv[3], &endp, 16);
	if (*argv[3] == 0 || *endp != 0)
		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) {
		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: %s\n", (size_t)len, (u32)offset,
		       read ? "Read" : "Written", ret ? "ERROR" : "OK");
	}

	unmap_physmem(buf, len);

	return ret == 0 ? 0 : 1;
}

static int do_spi_flash_erase(int argc, char * const argv[])
{
	unsigned long offset;
	unsigned long len;
	char *endp;
	int ret;

	if (argc < 3)
		return -1;

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

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

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

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

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