[people/ms/u-boot.git] / common / cmd_sf.c

/*
 * Command for accessing SPI flash.
 *
 * Copyright (C) 2008 Atmel Corporation
 * Licensed under the GPL-2 or later.
 */

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

#include <asm/io.h>

#ifndef CONFIG_SF_DEFAULT_SPEED
# define CONFIG_SF_DEFAULT_SPEED	1000000
#endif
#ifndef CONFIG_SF_DEFAULT_MODE
# define CONFIG_SF_DEFAULT_MODE		SPI_MODE_3
#endif
#ifndef CONFIG_SF_DEFAULT_CS
# define CONFIG_SF_DEFAULT_CS		0
#endif
#ifndef CONFIG_SF_DEFAULT_BUS
# define CONFIG_SF_DEFAULT_BUS		0
#endif

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

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);
	if (spi_flash_read(flash, offset, len, cmp_buf))
		return "read";
	if (memcmp(cmp_buf, buf, len) == 0) {
		debug("Skip region %x size %zx: no change\n",
			offset, len);
		*skipped += len;
		return NULL;
	}
	if (spi_flash_erase(flash, offset, len))
		return "erase";
	if (spi_flash_write(flash, offset, len, buf))
		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 */

	cmp_buf = malloc(flash->sector_size);
	if (cmp_buf) {
		for (; buf < end && !err_oper; buf += todo, offset += todo) {
			todo = min(end - buf, flash->sector_size);
			err_oper = spi_flash_update_block(flash, offset, todo,
					buf, cmp_buf, &skipped);
		}
	} else {
		err_oper = "malloc";
	}
	free(cmp_buf);
	if (err_oper) {
		printf("SPI flash failed in %s step\n", err_oper);
		return 1;
	}
	printf("%zu bytes written, %zu bytes skipped\n", len - skipped,
	       skipped);

	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;

	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;

	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 (strcmp(argv[0], "read") == 0)
		ret = spi_flash_read(flash, offset, len, buf);
	else
		ret = spi_flash_write(flash, offset, len, buf);

	unmap_physmem(buf, len);

	if (ret) {
		printf("SPI flash %s failed\n", argv[0]);
		return 1;
	}

	return 0;
}

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;

	ret = spi_flash_erase(flash, offset, len);
	if (ret) {
		printf("SPI flash %s failed\n", argv[0]);
		return 1;
	}

	return 0;
}

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
		ret = -1;

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

usage:
	return CMD_RET_USAGE;
}

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'"
);
Commit	Line	Data
b6368467 HS	1	/*
	2	* Command for accessing SPI flash.
	3	*
	4	* Copyright (C) 2008 Atmel Corporation
4166ee58	5	* Licensed under the GPL-2 or later.
b6368467	6	*/
4166ee58	7
b6368467	8	#include <common.h>
8d1af942	9	#include <malloc.h>
b6368467 HS	10	#include <spi_flash.h>
	11
	12	#include <asm/io.h>
	13
	14	#ifndef CONFIG_SF_DEFAULT_SPEED
	15	# define CONFIG_SF_DEFAULT_SPEED 1000000
	16	#endif
	17	#ifndef CONFIG_SF_DEFAULT_MODE
	18	# define CONFIG_SF_DEFAULT_MODE SPI_MODE_3
	19	#endif
c1173bd0 EN	20	#ifndef CONFIG_SF_DEFAULT_CS
	21	# define CONFIG_SF_DEFAULT_CS 0
	22	#endif
	23	#ifndef CONFIG_SF_DEFAULT_BUS
	24	# define CONFIG_SF_DEFAULT_BUS 0
	25	#endif
b6368467 HS	26
	27	static struct spi_flash *flash;
	28
334eb4b0 RR	29
	30	/*
	31	* This function computes the length argument for the erase command.
	32	* The length on which the command is to operate can be given in two forms:
	33	* 1. <cmd> offset len - operate on <'offset', 'len')
	34	* 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
	35	* If the second form is used and the length doesn't fall on the
	36	* sector boundary, than it will be adjusted to the next sector boundary.
	37	* If it isn't in the flash, the function will fail (return -1).
	38	* Input:
	39	* arg: length specification (i.e. both command arguments)
	40	* Output:
	41	* len: computed length for operation
	42	* Return:
	43	* 1: success
	44	* -1: failure (bad format, bad address).
	45	*/
	46	static int sf_parse_len_arg(char arg, ulong len)
	47	{
	48	char *ep;
	49	char round_up_len; /* indicates if the "+length" form used */
	50	ulong len_arg;
	51
	52	round_up_len = 0;
	53	if (*arg == '+') {
	54	round_up_len = 1;
	55	++arg;
	56	}
	57
	58	len_arg = simple_strtoul(arg, &ep, 16);
	59	if (ep == arg \|\| *ep != '\0')
	60	return -1;
	61
	62	if (round_up_len && flash->sector_size > 0)
155cfb5e	63	*len = ROUND(len_arg, flash->sector_size);
334eb4b0 RR	64	else
	65	*len = len_arg;
	66
	67	return 1;
	68	}
	69
54841ab5	70	static int do_spi_flash_probe(int argc, char * const argv[])
b6368467	71	{
c1173bd0 EN	72	unsigned int bus = CONFIG_SF_DEFAULT_BUS;
c1173bd0 EN	73	unsigned int cs = CONFIG_SF_DEFAULT_CS;
b6368467 HS	74	unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
	75	unsigned int mode = CONFIG_SF_DEFAULT_MODE;
	76	char *endp;
	77	struct spi_flash *new;
	78
c1173bd0 EN	79	if (argc >= 2) {
	80	cs = simple_strtoul(argv[1], &endp, 0);
	81	if (argv[1] == 0 \|\| (endp != 0 && *endp != ':'))
8a07de03	82	return -1;
c1173bd0 EN	83	if (*endp == ':') {
	84	if (endp[1] == 0)
	85	return -1;
	86
	87	bus = cs;
	88	cs = simple_strtoul(endp + 1, &endp, 0);
	89	if (*endp != 0)
	90	return -1;
	91	}
b6368467 HS	92	}
	93
	94	if (argc >= 3) {
	95	speed = simple_strtoul(argv[2], &endp, 0);
	96	if (argv[2] == 0 \|\| endp != 0)
8a07de03	97	return -1;
b6368467 HS	98	}
b6368467 HS	99	if (argc >= 4) {
6e8d58d3	100	mode = simple_strtoul(argv[3], &endp, 16);
b6368467	101	if (argv[3] == 0 \|\| endp != 0)
8a07de03	102	return -1;
b6368467 HS	103	}
	104
	105	new = spi_flash_probe(bus, cs, speed, mode);
	106	if (!new) {
	107	printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
	108	return 1;
	109	}
	110
	111	if (flash)
	112	spi_flash_free(flash);
	113	flash = new;
	114
b6368467	115	return 0;
b6368467 HS	116	}
b6368467 HS	117
8d1af942 SG	118	/**
	119	* Write a block of data to SPI flash, first checking if it is different from
	120	* what is already there.
	121	*
	122	* If the data being written is the same, then *skipped is incremented by len.
	123	*
	124	* @param flash flash context pointer
	125	* @param offset flash offset to write
	126	* @param len number of bytes to write
	127	* @param buf buffer to write from
	128	* @param cmp_buf read buffer to use to compare data
	129	* @param skipped Count of skipped data (incremented by this function)
	130	* @return NULL if OK, else a string containing the stage which failed
	131	*/
	132	static const char spi_flash_update_block(struct spi_flash flash, u32 offset,
	133	size_t len, const char buf, char cmp_buf, size_t *skipped)
	134	{
a97f6efd	135	debug("offset=%#x, sector_size=%#x, len=%#zx\n",
8d1af942 SG	136	offset, flash->sector_size, len);
	137	if (spi_flash_read(flash, offset, len, cmp_buf))
	138	return "read";
	139	if (memcmp(cmp_buf, buf, len) == 0) {
a97f6efd	140	debug("Skip region %x size %zx: no change\n",
8d1af942 SG	141	offset, len);
	142	*skipped += len;
	143	return NULL;
	144	}
	145	if (spi_flash_erase(flash, offset, len))
	146	return "erase";
	147	if (spi_flash_write(flash, offset, len, buf))
	148	return "write";
	149	return NULL;
	150	}
	151
	152	/**
	153	* Update an area of SPI flash by erasing and writing any blocks which need
	154	* to change. Existing blocks with the correct data are left unchanged.
	155	*
	156	* @param flash flash context pointer
	157	* @param offset flash offset to write
	158	* @param len number of bytes to write
	159	* @param buf buffer to write from
	160	* @return 0 if ok, 1 on error
	161	*/
	162	static int spi_flash_update(struct spi_flash *flash, u32 offset,
	163	size_t len, const char *buf)
	164	{
	165	const char *err_oper = NULL;
	166	char *cmp_buf;
	167	const char *end = buf + len;
	168	size_t todo; /* number of bytes to do in this pass */
8e8a4bc2	169	size_t skipped = 0; /* statistics */
8d1af942 SG	170
	171	cmp_buf = malloc(flash->sector_size);
	172	if (cmp_buf) {
8e8a4bc2	173	for (; buf < end && !err_oper; buf += todo, offset += todo) {
8d1af942 SG	174	todo = min(end - buf, flash->sector_size);
	175	err_oper = spi_flash_update_block(flash, offset, todo,
	176	buf, cmp_buf, &skipped);
	177	}
	178	} else {
	179	err_oper = "malloc";
	180	}
	181	free(cmp_buf);
	182	if (err_oper) {
	183	printf("SPI flash failed in %s step\n", err_oper);
	184	return 1;
	185	}
	186	printf("%zu bytes written, %zu bytes skipped\n", len - skipped,
	187	skipped);
8e8a4bc2	188
8d1af942 SG	189	return 0;
	190	}
	191
54841ab5	192	static int do_spi_flash_read_write(int argc, char * const argv[])
b6368467 HS	193	{
	194	unsigned long addr;
	195	unsigned long offset;
	196	unsigned long len;
	197	void *buf;
	198	char *endp;
	199	int ret;
	200
	201	if (argc < 4)
8a07de03	202	return -1;
b6368467 HS	203
	204	addr = simple_strtoul(argv[1], &endp, 16);
	205	if (argv[1] == 0 \|\| endp != 0)
8a07de03	206	return -1;
b6368467 HS	207	offset = simple_strtoul(argv[2], &endp, 16);
b6368467 HS	208	if (argv[2] == 0 \|\| endp != 0)
8a07de03	209	return -1;
b6368467 HS	210	len = simple_strtoul(argv[3], &endp, 16);
b6368467 HS	211	if (argv[3] == 0 \|\| endp != 0)
8a07de03	212	return -1;
b6368467 HS	213
	214	buf = map_physmem(addr, len, MAP_WRBACK);
	215	if (!buf) {
	216	puts("Failed to map physical memory\n");
	217	return 1;
	218	}
	219
8d1af942 SG	220	if (strcmp(argv[0], "update") == 0)
	221	ret = spi_flash_update(flash, offset, len, buf);
	222	else if (strcmp(argv[0], "read") == 0)
b6368467 HS	223	ret = spi_flash_read(flash, offset, len, buf);
	224	else
	225	ret = spi_flash_write(flash, offset, len, buf);
	226
	227	unmap_physmem(buf, len);
	228
	229	if (ret) {
	230	printf("SPI flash %s failed\n", argv[0]);
	231	return 1;
	232	}
	233
	234	return 0;
b6368467 HS	235	}
b6368467 HS	236
54841ab5	237	static int do_spi_flash_erase(int argc, char * const argv[])
b6368467 HS	238	{
	239	unsigned long offset;
	240	unsigned long len;
	241	char *endp;
	242	int ret;
	243
	244	if (argc < 3)
8a07de03	245	return -1;
b6368467 HS	246
	247	offset = simple_strtoul(argv[1], &endp, 16);
	248	if (argv[1] == 0 \|\| endp != 0)
8a07de03	249	return -1;
334eb4b0 RR	250
	251	ret = sf_parse_len_arg(argv[2], &len);
	252	if (ret != 1)
8a07de03	253	return -1;
b6368467 HS	254
	255	ret = spi_flash_erase(flash, offset, len);
	256	if (ret) {
	257	printf("SPI flash %s failed\n", argv[0]);
	258	return 1;
	259	}
	260
	261	return 0;
b6368467 HS	262	}
b6368467 HS	263
54841ab5	264	static int do_spi_flash(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
b6368467 HS	265	{
b6368467 HS	266	const char *cmd;
8a07de03	267	int ret;
b6368467 HS	268
	269	/* need at least two arguments */
	270	if (argc < 2)
	271	goto usage;
	272
	273	cmd = argv[1];
8a07de03 MF	274	--argc;
8a07de03 MF	275	++argv;
b6368467	276
8a07de03 MF	277	if (strcmp(cmd, "probe") == 0) {
	278	ret = do_spi_flash_probe(argc, argv);
	279	goto done;
	280	}
b6368467 HS	281
	282	/* The remaining commands require a selected device */
	283	if (!flash) {
	284	puts("No SPI flash selected. Please run `sf probe'\n");
	285	return 1;
	286	}
	287
8d1af942 SG	288	if (strcmp(cmd, "read") == 0 \|\| strcmp(cmd, "write") == 0 \|\|
8d1af942 SG	289	strcmp(cmd, "update") == 0)
8a07de03 MF	290	ret = do_spi_flash_read_write(argc, argv);
	291	else if (strcmp(cmd, "erase") == 0)
	292	ret = do_spi_flash_erase(argc, argv);
	293	else
	294	ret = -1;
	295
	296	done:
	297	if (ret != -1)
	298	return ret;
b6368467 HS	299
b6368467 HS	300	usage:
4c12eeb8	301	return CMD_RET_USAGE;
b6368467 HS	302	}
	303
	304	U_BOOT_CMD(
	305	sf, 5, 1, do_spi_flash,
2fb2604d	306	"SPI flash sub-system",
c1173bd0	307	"probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
b6368467 HS	308	" and chip select\n"
	309	"sf read addr offset len - read `len' bytes starting at\n"
	310	" `offset' to memory at `addr'\n"
	311	"sf write addr offset len - write `len' bytes from memory\n"
	312	" at `addr' to flash at `offset'\n"
334eb4b0	313	"sf erase offset [+]len - erase `len' bytes from `offset'\n"
8d1af942 SG	314	" `+len' round up `len' to block size\n"
	315	"sf update addr offset len - erase and write `len' bytes from memory\n"
	316	" at `addr' to flash at `offset'"
a89c33db	317	);