[J-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 <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

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 - 1, flash->sector_size);
	else
		*len = len_arg;

	return 1;
}

static int do_spi_flash_probe(int argc, char * const argv[])
{
	unsigned int bus = 0;
	unsigned int cs;
	unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
	unsigned int mode = CONFIG_SF_DEFAULT_MODE;
	char *endp;
	struct spi_flash *new;

	if (argc < 2)
		goto usage;

	cs = simple_strtoul(argv[1], &endp, 0);
	if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
		goto usage;
	if (*endp == ':') {
		if (endp[1] == 0)
			goto usage;

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

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

	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;

usage:
	puts("Usage: sf probe [bus:]cs [hz] [mode]\n");
	return 1;
}

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

	addr = simple_strtoul(argv[1], &endp, 16);
	if (*argv[1] == 0 || *endp != 0)
		goto usage;
	offset = simple_strtoul(argv[2], &endp, 16);
	if (*argv[2] == 0 || *endp != 0)
		goto usage;
	len = simple_strtoul(argv[3], &endp, 16);
	if (*argv[3] == 0 || *endp != 0)
		goto usage;

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

	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;

usage:
	printf("Usage: sf %s addr offset len\n", argv[0]);
	return 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)
		goto usage;

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

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

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

	return 0;

usage:
	puts("Usage: sf erase offset [+]len\n");
	return 1;
}

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

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

	cmd = argv[1];

	if (strcmp(cmd, "probe") == 0)
		return do_spi_flash_probe(argc - 1, argv + 1);

	/* 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)
		return do_spi_flash_read_write(argc - 1, argv + 1);
	if (strcmp(cmd, "erase") == 0)
		return do_spi_flash_erase(argc - 1, argv + 1);

usage:
	return cmd_usage(cmdtp);
}

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"
);
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 HS	8	#include <common.h>
	9	#include <spi_flash.h>
	10
	11	#include <asm/io.h>
	12
	13	#ifndef CONFIG_SF_DEFAULT_SPEED
	14	# define CONFIG_SF_DEFAULT_SPEED 1000000
	15	#endif
	16	#ifndef CONFIG_SF_DEFAULT_MODE
	17	# define CONFIG_SF_DEFAULT_MODE SPI_MODE_3
	18	#endif
	19
	20	static struct spi_flash *flash;
	21
334eb4b0 RR	22
	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)
	56	*len = ROUND(len_arg - 1, flash->sector_size);
	57	else
	58	*len = len_arg;
	59
	60	return 1;
	61	}
	62
54841ab5	63	static int do_spi_flash_probe(int argc, char * const argv[])
b6368467 HS	64	{
	65	unsigned int bus = 0;
	66	unsigned int cs;
	67	unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
	68	unsigned int mode = CONFIG_SF_DEFAULT_MODE;
	69	char *endp;
	70	struct spi_flash *new;
	71
	72	if (argc < 2)
	73	goto usage;
	74
	75	cs = simple_strtoul(argv[1], &endp, 0);
	76	if (argv[1] == 0 \|\| (endp != 0 && *endp != ':'))
	77	goto usage;
	78	if (*endp == ':') {
	79	if (endp[1] == 0)
	80	goto usage;
	81
	82	bus = cs;
	83	cs = simple_strtoul(endp + 1, &endp, 0);
	84	if (*endp != 0)
	85	goto usage;
	86	}
	87
	88	if (argc >= 3) {
	89	speed = simple_strtoul(argv[2], &endp, 0);
	90	if (argv[2] == 0 \|\| endp != 0)
	91	goto usage;
	92	}
	93	if (argc >= 4) {
6e8d58d3	94	mode = simple_strtoul(argv[3], &endp, 16);
b6368467 HS	95	if (argv[3] == 0 \|\| endp != 0)
	96	goto usage;
	97	}
	98
	99	new = spi_flash_probe(bus, cs, speed, mode);
	100	if (!new) {
	101	printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
	102	return 1;
	103	}
	104
	105	if (flash)
	106	spi_flash_free(flash);
	107	flash = new;
	108
b6368467 HS	109	return 0;
	110
	111	usage:
	112	puts("Usage: sf probe [bus:]cs [hz] [mode]\n");
	113	return 1;
	114	}
	115
54841ab5	116	static int do_spi_flash_read_write(int argc, char * const argv[])
b6368467 HS	117	{
	118	unsigned long addr;
	119	unsigned long offset;
	120	unsigned long len;
	121	void *buf;
	122	char *endp;
	123	int ret;
	124
	125	if (argc < 4)
	126	goto usage;
	127
	128	addr = simple_strtoul(argv[1], &endp, 16);
	129	if (argv[1] == 0 \|\| endp != 0)
	130	goto usage;
	131	offset = simple_strtoul(argv[2], &endp, 16);
	132	if (argv[2] == 0 \|\| endp != 0)
	133	goto usage;
	134	len = simple_strtoul(argv[3], &endp, 16);
	135	if (argv[3] == 0 \|\| endp != 0)
	136	goto usage;
	137
	138	buf = map_physmem(addr, len, MAP_WRBACK);
	139	if (!buf) {
	140	puts("Failed to map physical memory\n");
	141	return 1;
	142	}
	143
	144	if (strcmp(argv[0], "read") == 0)
	145	ret = spi_flash_read(flash, offset, len, buf);
	146	else
	147	ret = spi_flash_write(flash, offset, len, buf);
	148
	149	unmap_physmem(buf, len);
	150
	151	if (ret) {
	152	printf("SPI flash %s failed\n", argv[0]);
	153	return 1;
	154	}
	155
	156	return 0;
	157
	158	usage:
	159	printf("Usage: sf %s addr offset len\n", argv[0]);
	160	return 1;
	161	}
	162
54841ab5	163	static int do_spi_flash_erase(int argc, char * const argv[])
b6368467 HS	164	{
	165	unsigned long offset;
	166	unsigned long len;
	167	char *endp;
	168	int ret;
	169
	170	if (argc < 3)
	171	goto usage;
	172
	173	offset = simple_strtoul(argv[1], &endp, 16);
	174	if (argv[1] == 0 \|\| endp != 0)
	175	goto usage;
334eb4b0 RR	176
	177	ret = sf_parse_len_arg(argv[2], &len);
	178	if (ret != 1)
b6368467 HS	179	goto usage;
	180
	181	ret = spi_flash_erase(flash, offset, len);
	182	if (ret) {
	183	printf("SPI flash %s failed\n", argv[0]);
	184	return 1;
	185	}
	186
	187	return 0;
	188
	189	usage:
334eb4b0	190	puts("Usage: sf erase offset [+]len\n");
b6368467 HS	191	return 1;
	192	}
	193
54841ab5	194	static int do_spi_flash(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
b6368467 HS	195	{
	196	const char *cmd;
	197
	198	/* need at least two arguments */
	199	if (argc < 2)
	200	goto usage;
	201
	202	cmd = argv[1];
	203
	204	if (strcmp(cmd, "probe") == 0)
	205	return do_spi_flash_probe(argc - 1, argv + 1);
	206
	207	/* The remaining commands require a selected device */
	208	if (!flash) {
	209	puts("No SPI flash selected. Please run `sf probe'\n");
	210	return 1;
	211	}
	212
	213	if (strcmp(cmd, "read") == 0 \|\| strcmp(cmd, "write") == 0)
	214	return do_spi_flash_read_write(argc - 1, argv + 1);
	215	if (strcmp(cmd, "erase") == 0)
	216	return do_spi_flash_erase(argc - 1, argv + 1);
	217
	218	usage:
47e26b1b	219	return cmd_usage(cmdtp);
b6368467 HS	220	}
	221
	222	U_BOOT_CMD(
	223	sf, 5, 1, do_spi_flash,
2fb2604d	224	"SPI flash sub-system",
b6368467 HS	225	"probe [bus:]cs [hz] [mode] - init flash device on given SPI bus\n"
	226	" and chip select\n"
	227	"sf read addr offset len - read `len' bytes starting at\n"
	228	" `offset' to memory at `addr'\n"
	229	"sf write addr offset len - write `len' bytes from memory\n"
	230	" at `addr' to flash at `offset'\n"
334eb4b0 RR	231	"sf erase offset [+]len - erase `len' bytes from `offset'\n"
334eb4b0 RR	232	" `+len' round up `len' to block size"
a89c33db	233	);