blob: 55bef2f7699d90764152d2f49a7deaf9dc973c98 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Haavard Skinnemoenb6368462008-05-16 11:10:34 +02002/*
3 * Command for accessing SPI flash.
4 *
5 * Copyright (C) 2008 Atmel Corporation
6 */
Mike Frysinger4166ee52009-10-09 17:12:44 -04007
Haavard Skinnemoenb6368462008-05-16 11:10:34 +02008#include <common.h>
Simon Glass09140112020-05-10 11:40:03 -06009#include <command.h>
Simon Glass4e4bf942022-07-31 12:28:48 -060010#include <display_options.h>
Mingkai Hu381c6e22013-04-07 22:13:32 +000011#include <div64.h>
Simon Glassfbb09912014-10-13 23:42:07 -060012#include <dm.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060013#include <log.h>
Simon Glass8d1af942011-08-22 16:03:46 -070014#include <malloc.h>
Joe Hershberger0eb25b62015-03-22 17:08:59 -050015#include <mapmem.h>
Simon Glassff0960f2014-10-13 23:42:04 -060016#include <spi.h>
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020017#include <spi_flash.h>
Simon Glass90526e92020-05-10 11:39:56 -060018#include <asm/cache.h>
Heiko Schocher2ec1a402015-04-27 07:42:06 +020019#include <jffs2/jffs2.h>
20#include <linux/mtd/mtd.h>
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020021
22#include <asm/io.h>
Simon Glassfbb09912014-10-13 23:42:07 -060023#include <dm/device-internal.h>
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020024
Miquel Raynaleb446ef2019-10-25 19:39:29 +020025#include "legacy-mtd-utils.h"
26
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020027static struct spi_flash *flash;
28
Richard Retanubun334eb4b2011-02-16 16:39:44 -050029/*
30 * This function computes the length argument for the erase command.
31 * The length on which the command is to operate can be given in two forms:
32 * 1. <cmd> offset len - operate on <'offset', 'len')
33 * 2. <cmd> offset +len - operate on <'offset', 'round_up(len)')
34 * If the second form is used and the length doesn't fall on the
35 * sector boundary, than it will be adjusted to the next sector boundary.
36 * If it isn't in the flash, the function will fail (return -1).
37 * Input:
38 * arg: length specification (i.e. both command arguments)
39 * Output:
40 * len: computed length for operation
41 * Return:
42 * 1: success
43 * -1: failure (bad format, bad address).
44 */
45static int sf_parse_len_arg(char *arg, ulong *len)
46{
47 char *ep;
48 char round_up_len; /* indicates if the "+length" form used */
49 ulong len_arg;
50
51 round_up_len = 0;
52 if (*arg == '+') {
53 round_up_len = 1;
54 ++arg;
55 }
56
Simon Glass7e5f4602021-07-24 09:03:29 -060057 len_arg = hextoul(arg, &ep);
Richard Retanubun334eb4b2011-02-16 16:39:44 -050058 if (ep == arg || *ep != '\0')
59 return -1;
60
61 if (round_up_len && flash->sector_size > 0)
Anton Staaf155cfb52011-09-02 13:45:28 +000062 *len = ROUND(len_arg, flash->sector_size);
Richard Retanubun334eb4b2011-02-16 16:39:44 -050063 else
64 *len = len_arg;
65
66 return 1;
67}
68
James Millera683c282012-09-28 14:28:00 +000069/**
70 * This function takes a byte length and a delta unit of time to compute the
71 * approximate bytes per second
72 *
73 * @param len amount of bytes currently processed
74 * @param start_ms start time of processing in ms
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010075 * Return: bytes per second if OK, 0 on error
James Millera683c282012-09-28 14:28:00 +000076 */
77static ulong bytes_per_second(unsigned int len, ulong start_ms)
78{
79 /* less accurate but avoids overflow */
80 if (len >= ((unsigned int) -1) / 1024)
Masahiro Yamadab4141192014-11-07 03:03:31 +090081 return len / (max(get_timer(start_ms) / 1024, 1UL));
James Millera683c282012-09-28 14:28:00 +000082 else
Masahiro Yamadab4141192014-11-07 03:03:31 +090083 return 1024 * len / max(get_timer(start_ms), 1UL);
James Millera683c282012-09-28 14:28:00 +000084}
85
Simon Glass09140112020-05-10 11:40:03 -060086static int do_spi_flash_probe(int argc, char *const argv[])
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020087{
Eric Nelsonc1173bd2012-01-31 10:52:07 -070088 unsigned int bus = CONFIG_SF_DEFAULT_BUS;
89 unsigned int cs = CONFIG_SF_DEFAULT_CS;
Patrick Delaunayb0cc1b82019-02-27 15:36:44 +010090 /* In DM mode, defaults speed and mode will be taken from DT */
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020091 unsigned int speed = CONFIG_SF_DEFAULT_SPEED;
92 unsigned int mode = CONFIG_SF_DEFAULT_MODE;
93 char *endp;
Patrice Chotard3feea0b2022-03-30 09:33:14 +020094 bool use_dt = true;
Lukasz Majewski56c40462020-06-04 23:11:53 +080095#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
Simon Glassfbb09912014-10-13 23:42:07 -060096 struct udevice *new, *bus_dev;
97 int ret;
98#else
Haavard Skinnemoenb6368462008-05-16 11:10:34 +020099 struct spi_flash *new;
Simon Glassfbb09912014-10-13 23:42:07 -0600100#endif
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200101
Eric Nelsonc1173bd2012-01-31 10:52:07 -0700102 if (argc >= 2) {
103 cs = simple_strtoul(argv[1], &endp, 0);
104 if (*argv[1] == 0 || (*endp != 0 && *endp != ':'))
Mike Frysinger8a07de02011-04-12 02:21:31 -0400105 return -1;
Eric Nelsonc1173bd2012-01-31 10:52:07 -0700106 if (*endp == ':') {
107 if (endp[1] == 0)
108 return -1;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200109
Eric Nelsonc1173bd2012-01-31 10:52:07 -0700110 bus = cs;
111 cs = simple_strtoul(endp + 1, &endp, 0);
112 if (*endp != 0)
113 return -1;
114 }
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200115 }
116
117 if (argc >= 3) {
118 speed = simple_strtoul(argv[2], &endp, 0);
119 if (*argv[2] == 0 || *endp != 0)
Mike Frysinger8a07de02011-04-12 02:21:31 -0400120 return -1;
Patrice Chotard3feea0b2022-03-30 09:33:14 +0200121 use_dt = false;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200122 }
123 if (argc >= 4) {
Simon Glass7e5f4602021-07-24 09:03:29 -0600124 mode = hextoul(argv[3], &endp);
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200125 if (*argv[3] == 0 || *endp != 0)
Mike Frysinger8a07de02011-04-12 02:21:31 -0400126 return -1;
Patrice Chotard3feea0b2022-03-30 09:33:14 +0200127 use_dt = false;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200128 }
129
Lukasz Majewski56c40462020-06-04 23:11:53 +0800130#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
Simon Glassfbb09912014-10-13 23:42:07 -0600131 /* Remove the old device, otherwise probe will just be a nop */
132 ret = spi_find_bus_and_cs(bus, cs, &bus_dev, &new);
133 if (!ret) {
Stefan Roese706865a2017-03-20 12:51:48 +0100134 device_remove(new, DM_REMOVE_NORMAL);
Simon Glassfbb09912014-10-13 23:42:07 -0600135 }
136 flash = NULL;
Patrice Chotard3feea0b2022-03-30 09:33:14 +0200137 if (use_dt) {
138 spi_flash_probe_bus_cs(bus, cs, &new);
139 flash = dev_get_uclass_priv(new);
140 } else {
141 flash = spi_flash_probe(bus, cs, speed, mode);
142 }
143
144 if (!flash) {
Simon Glassfbb09912014-10-13 23:42:07 -0600145 printf("Failed to initialize SPI flash at %u:%u (error %d)\n",
146 bus, cs, ret);
147 return 1;
148 }
Simon Glassfbb09912014-10-13 23:42:07 -0600149#else
Heiko Schocher8ee81b72015-04-27 07:42:07 +0200150 if (flash)
151 spi_flash_free(flash);
152
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200153 new = spi_flash_probe(bus, cs, speed, mode);
Heiko Schocher8ee81b72015-04-27 07:42:07 +0200154 flash = new;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200155 if (!new) {
156 printf("Failed to initialize SPI flash at %u:%u\n", bus, cs);
157 return 1;
158 }
Simon Glassfbb09912014-10-13 23:42:07 -0600159#endif
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200160
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200161 return 0;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200162}
163
Simon Glass8d1af942011-08-22 16:03:46 -0700164/**
165 * Write a block of data to SPI flash, first checking if it is different from
166 * what is already there.
167 *
168 * If the data being written is the same, then *skipped is incremented by len.
169 *
170 * @param flash flash context pointer
171 * @param offset flash offset to write
172 * @param len number of bytes to write
173 * @param buf buffer to write from
174 * @param cmp_buf read buffer to use to compare data
175 * @param skipped Count of skipped data (incremented by this function)
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100176 * Return: NULL if OK, else a string containing the stage which failed
Simon Glass8d1af942011-08-22 16:03:46 -0700177 */
178static const char *spi_flash_update_block(struct spi_flash *flash, u32 offset,
179 size_t len, const char *buf, char *cmp_buf, size_t *skipped)
180{
Stefan Roeseed627562015-01-09 14:39:22 +0100181 char *ptr = (char *)buf;
Marek Vasut622b5d32022-09-28 18:45:04 +0200182 u32 start_offset = offset % flash->sector_size;
183 u32 read_offset = offset - start_offset;
Stefan Roeseed627562015-01-09 14:39:22 +0100184
Marek Vasut622b5d32022-09-28 18:45:04 +0200185 debug("offset=%#x+%#x, sector_size=%#x, len=%#zx\n",
186 read_offset, start_offset, flash->sector_size, len);
Gerlando Falautob95f9582013-08-27 19:13:57 +0530187 /* Read the entire sector so to allow for rewriting */
Marek Vasut622b5d32022-09-28 18:45:04 +0200188 if (spi_flash_read(flash, read_offset, flash->sector_size, cmp_buf))
Simon Glass8d1af942011-08-22 16:03:46 -0700189 return "read";
Gerlando Falautob95f9582013-08-27 19:13:57 +0530190 /* Compare only what is meaningful (len) */
Marek Vasut622b5d32022-09-28 18:45:04 +0200191 if (memcmp(cmp_buf + start_offset, buf, len) == 0) {
192 debug("Skip region %x+%x size %zx: no change\n",
193 start_offset, read_offset, len);
Simon Glass8d1af942011-08-22 16:03:46 -0700194 *skipped += len;
195 return NULL;
196 }
Gerlando Falauto34888502013-07-03 20:33:57 +0200197 /* Erase the entire sector */
198 if (spi_flash_erase(flash, offset, flash->sector_size))
Simon Glass8d1af942011-08-22 16:03:46 -0700199 return "erase";
Stefan Roeseed627562015-01-09 14:39:22 +0100200 /* If it's a partial sector, copy the data into the temp-buffer */
Gerlando Falautob95f9582013-08-27 19:13:57 +0530201 if (len != flash->sector_size) {
Marek Vasut622b5d32022-09-28 18:45:04 +0200202 memcpy(cmp_buf + start_offset, buf, len);
Stefan Roeseed627562015-01-09 14:39:22 +0100203 ptr = cmp_buf;
Gerlando Falautob95f9582013-08-27 19:13:57 +0530204 }
Stefan Roeseed627562015-01-09 14:39:22 +0100205 /* Write one complete sector */
206 if (spi_flash_write(flash, offset, flash->sector_size, ptr))
207 return "write";
Gerlando Falautob95f9582013-08-27 19:13:57 +0530208
Simon Glass8d1af942011-08-22 16:03:46 -0700209 return NULL;
210}
211
212/**
213 * Update an area of SPI flash by erasing and writing any blocks which need
214 * to change. Existing blocks with the correct data are left unchanged.
215 *
216 * @param flash flash context pointer
217 * @param offset flash offset to write
218 * @param len number of bytes to write
219 * @param buf buffer to write from
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100220 * Return: 0 if ok, 1 on error
Simon Glass8d1af942011-08-22 16:03:46 -0700221 */
222static int spi_flash_update(struct spi_flash *flash, u32 offset,
223 size_t len, const char *buf)
224{
225 const char *err_oper = NULL;
226 char *cmp_buf;
227 const char *end = buf + len;
228 size_t todo; /* number of bytes to do in this pass */
Kumar Gala8e8a4bc2011-10-03 04:35:47 +0000229 size_t skipped = 0; /* statistics */
James Millera683c282012-09-28 14:28:00 +0000230 const ulong start_time = get_timer(0);
231 size_t scale = 1;
232 const char *start_buf = buf;
233 ulong delta;
Simon Glass8d1af942011-08-22 16:03:46 -0700234
James Millera683c282012-09-28 14:28:00 +0000235 if (end - buf >= 200)
236 scale = (end - buf) / 100;
Ravi Babu156e96f2015-08-17 13:29:48 +0530237 cmp_buf = memalign(ARCH_DMA_MINALIGN, flash->sector_size);
Simon Glass8d1af942011-08-22 16:03:46 -0700238 if (cmp_buf) {
James Millera683c282012-09-28 14:28:00 +0000239 ulong last_update = get_timer(0);
240
Kumar Gala8e8a4bc2011-10-03 04:35:47 +0000241 for (; buf < end && !err_oper; buf += todo, offset += todo) {
Masahiro Yamadab4141192014-11-07 03:03:31 +0900242 todo = min_t(size_t, end - buf, flash->sector_size);
Marek Vasut622b5d32022-09-28 18:45:04 +0200243 todo = min_t(size_t, end - buf,
244 flash->sector_size - (offset % flash->sector_size));
James Millera683c282012-09-28 14:28:00 +0000245 if (get_timer(last_update) > 100) {
246 printf(" \rUpdating, %zu%% %lu B/s",
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530247 100 - (end - buf) / scale,
James Millera683c282012-09-28 14:28:00 +0000248 bytes_per_second(buf - start_buf,
249 start_time));
250 last_update = get_timer(0);
251 }
Simon Glass8d1af942011-08-22 16:03:46 -0700252 err_oper = spi_flash_update_block(flash, offset, todo,
253 buf, cmp_buf, &skipped);
254 }
255 } else {
256 err_oper = "malloc";
257 }
258 free(cmp_buf);
James Millera683c282012-09-28 14:28:00 +0000259 putc('\r');
Simon Glass8d1af942011-08-22 16:03:46 -0700260 if (err_oper) {
261 printf("SPI flash failed in %s step\n", err_oper);
262 return 1;
263 }
James Millera683c282012-09-28 14:28:00 +0000264
265 delta = get_timer(start_time);
266 printf("%zu bytes written, %zu bytes skipped", len - skipped,
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530267 skipped);
James Millera683c282012-09-28 14:28:00 +0000268 printf(" in %ld.%lds, speed %ld B/s\n",
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530269 delta / 1000, delta % 1000, bytes_per_second(len, start_time));
Kumar Gala8e8a4bc2011-10-03 04:35:47 +0000270
Simon Glass8d1af942011-08-22 16:03:46 -0700271 return 0;
272}
273
Simon Glass09140112020-05-10 11:40:03 -0600274static int do_spi_flash_read_write(int argc, char *const argv[])
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200275{
276 unsigned long addr;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200277 void *buf;
278 char *endp;
Jagannadha Sutradharudu Teki60b66142013-05-26 14:52:52 +0530279 int ret = 1;
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200280 int dev = 0;
281 loff_t offset, len, maxsize;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200282
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200283 if (argc < 3)
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100284 return CMD_RET_USAGE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200285
Simon Glass7e5f4602021-07-24 09:03:29 -0600286 addr = hextoul(argv[1], &endp);
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200287 if (*argv[1] == 0 || *endp != 0)
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100288 return CMD_RET_USAGE;
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200289
290 if (mtd_arg_off_size(argc - 2, &argv[2], &dev, &offset, &len,
291 &maxsize, MTD_DEV_TYPE_NOR, flash->size))
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100292 return CMD_RET_FAILURE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200293
Gerlando Falauto86493992012-04-03 04:34:13 +0000294 /* Consistency checking */
295 if (offset + len > flash->size) {
296 printf("ERROR: attempting %s past flash size (%#x)\n",
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530297 argv[0], flash->size);
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100298 return CMD_RET_FAILURE;
Gerlando Falauto86493992012-04-03 04:34:13 +0000299 }
300
Jan Kiszkaf3a56dd2022-03-02 15:01:56 +0100301 if (strncmp(argv[0], "read", 4) != 0 && flash->flash_is_unlocked &&
302 !flash->flash_is_unlocked(flash, offset, len)) {
303 printf("ERROR: flash area is locked\n");
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100304 return CMD_RET_FAILURE;
Jan Kiszkaf3a56dd2022-03-02 15:01:56 +0100305 }
306
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200307 buf = map_physmem(addr, len, MAP_WRBACK);
Liam Beguin10f087f2018-03-14 19:15:11 -0400308 if (!buf && addr) {
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200309 puts("Failed to map physical memory\n");
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100310 return CMD_RET_FAILURE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200311 }
312
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530313 if (strcmp(argv[0], "update") == 0) {
Simon Glass8d1af942011-08-22 16:03:46 -0700314 ret = spi_flash_update(flash, offset, len, buf);
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530315 } else if (strncmp(argv[0], "read", 4) == 0 ||
Jagannadha Sutradharudu Teki60b66142013-05-26 14:52:52 +0530316 strncmp(argv[0], "write", 5) == 0) {
317 int read;
318
319 read = strncmp(argv[0], "read", 4) == 0;
320 if (read)
321 ret = spi_flash_read(flash, offset, len, buf);
322 else
323 ret = spi_flash_write(flash, offset, len, buf);
324
Simon Glassa7d0711a2015-06-07 08:50:32 -0600325 printf("SF: %zu bytes @ %#x %s: ", (size_t)len, (u32)offset,
326 read ? "Read" : "Written");
327 if (ret)
328 printf("ERROR %d\n", ret);
329 else
330 printf("OK\n");
Jagannadha Sutradharudu Teki60b66142013-05-26 14:52:52 +0530331 }
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200332
333 unmap_physmem(buf, len);
334
Heinrich Schuchardtfa3b38d2023-01-02 18:21:14 +0100335 return ret ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200336}
337
Simon Glass09140112020-05-10 11:40:03 -0600338static int do_spi_flash_erase(int argc, char *const argv[])
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200339{
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200340 int ret;
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200341 int dev = 0;
342 loff_t offset, len, maxsize;
343 ulong size;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200344
345 if (argc < 3)
Heinrich Schuchardtee0b0be2023-01-02 18:21:16 +0100346 return CMD_RET_USAGE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200347
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200348 if (mtd_arg_off(argv[1], &dev, &offset, &len, &maxsize,
349 MTD_DEV_TYPE_NOR, flash->size))
Heinrich Schuchardtee0b0be2023-01-02 18:21:16 +0100350 return CMD_RET_FAILURE;
Richard Retanubun334eb4b2011-02-16 16:39:44 -0500351
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200352 ret = sf_parse_len_arg(argv[2], &size);
Richard Retanubun334eb4b2011-02-16 16:39:44 -0500353 if (ret != 1)
Heinrich Schuchardtee0b0be2023-01-02 18:21:16 +0100354 return CMD_RET_USAGE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200355
Ashok Reddy Soma899fb5a2023-05-16 05:52:36 -0600356 if (size == 0) {
357 debug("ERROR: Invalid size 0\n");
358 return CMD_RET_FAILURE;
359 }
360
Gerlando Falauto86493992012-04-03 04:34:13 +0000361 /* Consistency checking */
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200362 if (offset + size > flash->size) {
Gerlando Falauto86493992012-04-03 04:34:13 +0000363 printf("ERROR: attempting %s past flash size (%#x)\n",
Jagannadha Sutradharudu Teki402ba1e2013-07-29 22:12:52 +0530364 argv[0], flash->size);
Heinrich Schuchardtee0b0be2023-01-02 18:21:16 +0100365 return CMD_RET_FAILURE;
Gerlando Falauto86493992012-04-03 04:34:13 +0000366 }
367
Jan Kiszkaf3a56dd2022-03-02 15:01:56 +0100368 if (flash->flash_is_unlocked &&
369 !flash->flash_is_unlocked(flash, offset, len)) {
370 printf("ERROR: flash area is locked\n");
Heinrich Schuchardtee0b0be2023-01-02 18:21:16 +0100371 return CMD_RET_FAILURE;
Jan Kiszkaf3a56dd2022-03-02 15:01:56 +0100372 }
373
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200374 ret = spi_flash_erase(flash, offset, size);
Sean Anderson1bb8ca32021-02-04 23:11:06 -0500375 printf("SF: %zu bytes @ %#x Erased: ", (size_t)size, (u32)offset);
376 if (ret)
377 printf("ERROR %d\n", ret);
378 else
379 printf("OK\n");
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200380
Heinrich Schuchardtee0b0be2023-01-02 18:21:16 +0100381 return ret ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200382}
383
Simon Glass09140112020-05-10 11:40:03 -0600384static int do_spi_protect(int argc, char *const argv[])
Fabio Estevamc3c016c2015-11-05 12:43:42 -0200385{
386 int ret = 0;
387 loff_t start, len;
388 bool prot = false;
389
390 if (argc != 4)
391 return -1;
392
393 if (!str2off(argv[2], &start)) {
394 puts("start sector is not a valid number\n");
395 return 1;
396 }
397
398 if (!str2off(argv[3], &len)) {
399 puts("len is not a valid number\n");
400 return 1;
401 }
402
403 if (strcmp(argv[1], "lock") == 0)
404 prot = true;
405 else if (strcmp(argv[1], "unlock") == 0)
406 prot = false;
407 else
408 return -1; /* Unknown parameter */
409
410 ret = spi_flash_protect(flash, start, len, prot);
411
412 return ret == 0 ? 0 : 1;
413}
414
Simon Glass24007272012-10-08 13:16:02 +0000415enum {
416 STAGE_ERASE,
417 STAGE_CHECK,
418 STAGE_WRITE,
419 STAGE_READ,
420
421 STAGE_COUNT,
422};
423
Simon Glassad4e0102021-09-19 15:49:33 -0600424static const char *stage_name[STAGE_COUNT] = {
Simon Glass24007272012-10-08 13:16:02 +0000425 "erase",
426 "check",
427 "write",
428 "read",
429};
430
431struct test_info {
432 int stage;
433 int bytes;
434 unsigned base_ms;
435 unsigned time_ms[STAGE_COUNT];
436};
437
438static void show_time(struct test_info *test, int stage)
439{
440 uint64_t speed; /* KiB/s */
441 int bps; /* Bits per second */
442
443 speed = (long long)test->bytes * 1000;
Simon Glassd1f22d42013-11-10 10:26:51 -0700444 if (test->time_ms[stage])
445 do_div(speed, test->time_ms[stage] * 1024);
Simon Glass24007272012-10-08 13:16:02 +0000446 bps = speed * 8;
447
Heinrich Schuchardtc6b2ea32019-01-06 12:03:37 +0100448 printf("%d %s: %u ticks, %d KiB/s %d.%03d Mbps\n", stage,
Simon Glass24007272012-10-08 13:16:02 +0000449 stage_name[stage], test->time_ms[stage],
450 (int)speed, bps / 1000, bps % 1000);
451}
452
453static void spi_test_next_stage(struct test_info *test)
454{
455 test->time_ms[test->stage] = get_timer(test->base_ms);
456 show_time(test, test->stage);
457 test->base_ms = get_timer(0);
458 test->stage++;
459}
460
461/**
462 * Run a test on the SPI flash
463 *
464 * @param flash SPI flash to use
465 * @param buf Source buffer for data to write
466 * @param len Size of data to read/write
467 * @param offset Offset within flash to check
468 * @param vbuf Verification buffer
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100469 * Return: 0 if ok, -1 on error
Simon Glass24007272012-10-08 13:16:02 +0000470 */
Simon Glass1e7133e2013-03-11 06:08:13 +0000471static int spi_flash_test(struct spi_flash *flash, uint8_t *buf, ulong len,
472 ulong offset, uint8_t *vbuf)
Simon Glass24007272012-10-08 13:16:02 +0000473{
474 struct test_info test;
Sean Anderson9bc77282021-02-04 23:11:07 -0500475 int err, i;
Simon Glass24007272012-10-08 13:16:02 +0000476
477 printf("SPI flash test:\n");
478 memset(&test, '\0', sizeof(test));
479 test.base_ms = get_timer(0);
480 test.bytes = len;
Sean Anderson9bc77282021-02-04 23:11:07 -0500481 err = spi_flash_erase(flash, offset, len);
482 if (err) {
483 printf("Erase failed (err = %d)\n", err);
Simon Glass24007272012-10-08 13:16:02 +0000484 return -1;
485 }
486 spi_test_next_stage(&test);
487
Sean Anderson9bc77282021-02-04 23:11:07 -0500488 err = spi_flash_read(flash, offset, len, vbuf);
489 if (err) {
490 printf("Check read failed (err = %d)\n", err);
Simon Glass24007272012-10-08 13:16:02 +0000491 return -1;
492 }
493 for (i = 0; i < len; i++) {
494 if (vbuf[i] != 0xff) {
495 printf("Check failed at %d\n", i);
Masahiro Yamadab4141192014-11-07 03:03:31 +0900496 print_buffer(i, vbuf + i, 1,
497 min_t(uint, len - i, 0x40), 0);
Simon Glass24007272012-10-08 13:16:02 +0000498 return -1;
499 }
500 }
501 spi_test_next_stage(&test);
502
Sean Anderson9bc77282021-02-04 23:11:07 -0500503 err = spi_flash_write(flash, offset, len, buf);
504 if (err) {
505 printf("Write failed (err = %d)\n", err);
Simon Glass24007272012-10-08 13:16:02 +0000506 return -1;
507 }
508 memset(vbuf, '\0', len);
509 spi_test_next_stage(&test);
510
Sean Anderson9bc77282021-02-04 23:11:07 -0500511 err = spi_flash_read(flash, offset, len, vbuf);
512 if (err) {
513 printf("Read failed (ret = %d)\n", err);
Simon Glass24007272012-10-08 13:16:02 +0000514 return -1;
515 }
516 spi_test_next_stage(&test);
517
518 for (i = 0; i < len; i++) {
519 if (buf[i] != vbuf[i]) {
520 printf("Verify failed at %d, good data:\n", i);
Masahiro Yamadab4141192014-11-07 03:03:31 +0900521 print_buffer(i, buf + i, 1,
522 min_t(uint, len - i, 0x40), 0);
Simon Glass24007272012-10-08 13:16:02 +0000523 printf("Bad data:\n");
Masahiro Yamadab4141192014-11-07 03:03:31 +0900524 print_buffer(i, vbuf + i, 1,
525 min_t(uint, len - i, 0x40), 0);
Simon Glass24007272012-10-08 13:16:02 +0000526 return -1;
527 }
528 }
529 printf("Test passed\n");
530 for (i = 0; i < STAGE_COUNT; i++)
531 show_time(&test, i);
532
533 return 0;
534}
535
Simon Glass09140112020-05-10 11:40:03 -0600536static int do_spi_flash_test(int argc, char *const argv[])
Simon Glass24007272012-10-08 13:16:02 +0000537{
538 unsigned long offset;
539 unsigned long len;
Simon Glassd1f22d42013-11-10 10:26:51 -0700540 uint8_t *buf, *from;
Simon Glass24007272012-10-08 13:16:02 +0000541 char *endp;
Simon Glass1e7133e2013-03-11 06:08:13 +0000542 uint8_t *vbuf;
Simon Glass24007272012-10-08 13:16:02 +0000543 int ret;
544
Simon Glassd1f22d42013-11-10 10:26:51 -0700545 if (argc < 3)
546 return -1;
Simon Glass7e5f4602021-07-24 09:03:29 -0600547 offset = hextoul(argv[1], &endp);
Simon Glass24007272012-10-08 13:16:02 +0000548 if (*argv[1] == 0 || *endp != 0)
549 return -1;
Simon Glass7e5f4602021-07-24 09:03:29 -0600550 len = hextoul(argv[2], &endp);
Simon Glass24007272012-10-08 13:16:02 +0000551 if (*argv[2] == 0 || *endp != 0)
552 return -1;
553
Ravi Babu156e96f2015-08-17 13:29:48 +0530554 vbuf = memalign(ARCH_DMA_MINALIGN, len);
Simon Glass24007272012-10-08 13:16:02 +0000555 if (!vbuf) {
Simon Glassd1f22d42013-11-10 10:26:51 -0700556 printf("Cannot allocate memory (%lu bytes)\n", len);
Simon Glass24007272012-10-08 13:16:02 +0000557 return 1;
558 }
Ravi Babu156e96f2015-08-17 13:29:48 +0530559 buf = memalign(ARCH_DMA_MINALIGN, len);
Simon Glass24007272012-10-08 13:16:02 +0000560 if (!buf) {
561 free(vbuf);
Simon Glassd1f22d42013-11-10 10:26:51 -0700562 printf("Cannot allocate memory (%lu bytes)\n", len);
Simon Glass24007272012-10-08 13:16:02 +0000563 return 1;
564 }
565
Simon Glass98463902022-10-20 18:22:39 -0600566 from = map_sysmem(CONFIG_TEXT_BASE, 0);
Simon Glassd1f22d42013-11-10 10:26:51 -0700567 memcpy(buf, from, len);
Simon Glass24007272012-10-08 13:16:02 +0000568 ret = spi_flash_test(flash, buf, len, offset, vbuf);
569 free(vbuf);
570 free(buf);
571 if (ret) {
572 printf("Test failed\n");
573 return 1;
574 }
575
576 return 0;
577}
Simon Glass24007272012-10-08 13:16:02 +0000578
Simon Glass09140112020-05-10 11:40:03 -0600579static int do_spi_flash(struct cmd_tbl *cmdtp, int flag, int argc,
580 char *const argv[])
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200581{
582 const char *cmd;
Mike Frysinger8a07de02011-04-12 02:21:31 -0400583 int ret;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200584
585 /* need at least two arguments */
586 if (argc < 2)
Heinrich Schuchardt8c8df672023-01-02 18:21:15 +0100587 return CMD_RET_USAGE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200588
589 cmd = argv[1];
Mike Frysinger8a07de02011-04-12 02:21:31 -0400590 --argc;
591 ++argv;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200592
Heinrich Schuchardt8c8df672023-01-02 18:21:15 +0100593 if (strcmp(cmd, "probe") == 0)
594 return do_spi_flash_probe(argc, argv);
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200595
596 /* The remaining commands require a selected device */
597 if (!flash) {
598 puts("No SPI flash selected. Please run `sf probe'\n");
Heinrich Schuchardt8c8df672023-01-02 18:21:15 +0100599 return CMD_RET_FAILURE;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200600 }
601
Simon Glass8d1af942011-08-22 16:03:46 -0700602 if (strcmp(cmd, "read") == 0 || strcmp(cmd, "write") == 0 ||
603 strcmp(cmd, "update") == 0)
Mike Frysinger8a07de02011-04-12 02:21:31 -0400604 ret = do_spi_flash_read_write(argc, argv);
605 else if (strcmp(cmd, "erase") == 0)
606 ret = do_spi_flash_erase(argc, argv);
Fabio Estevamc3c016c2015-11-05 12:43:42 -0200607 else if (strcmp(cmd, "protect") == 0)
608 ret = do_spi_protect(argc, argv);
Simon Glass3512e152021-09-19 15:49:34 -0600609 else if (IS_ENABLED(CONFIG_CMD_SF_TEST) && !strcmp(cmd, "test"))
Simon Glass24007272012-10-08 13:16:02 +0000610 ret = do_spi_flash_test(argc, argv);
Mike Frysinger8a07de02011-04-12 02:21:31 -0400611 else
Heinrich Schuchardt8c8df672023-01-02 18:21:15 +0100612 ret = CMD_RET_USAGE;
Mike Frysinger8a07de02011-04-12 02:21:31 -0400613
Heinrich Schuchardt8c8df672023-01-02 18:21:15 +0100614 return ret;
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200615}
616
Simon Glass3512e152021-09-19 15:49:34 -0600617#ifdef CONFIG_SYS_LONGHELP
618static const char long_help[] =
Eric Nelsonc1173bd2012-01-31 10:52:07 -0700619 "probe [[bus:]cs] [hz] [mode] - init flash device on given SPI bus\n"
Haavard Skinnemoenb6368462008-05-16 11:10:34 +0200620 " and chip select\n"
Heiko Schocher2ec1a402015-04-27 07:42:06 +0200621 "sf read addr offset|partition len - read `len' bytes starting at\n"
622 " `offset' or from start of mtd\n"
623 " `partition'to memory at `addr'\n"
624 "sf write addr offset|partition len - write `len' bytes from memory\n"
625 " at `addr' to flash at `offset'\n"
626 " or to start of mtd `partition'\n"
627 "sf erase offset|partition [+]len - erase `len' bytes from `offset'\n"
628 " or from start of mtd `partition'\n"
629 " `+len' round up `len' to block size\n"
630 "sf update addr offset|partition len - erase and write `len' bytes from memory\n"
631 " at `addr' to flash at `offset'\n"
632 " or to start of mtd `partition'\n"
Fabio Estevamc3c016c2015-11-05 12:43:42 -0200633 "sf protect lock/unlock sector len - protect/unprotect 'len' bytes starting\n"
Simon Glass3512e152021-09-19 15:49:34 -0600634 " at address 'sector'"
635#ifdef CONFIG_CMD_SF_TEST
636 "\nsf test offset len - run a very basic destructive test"
637#endif
638#endif /* CONFIG_SYS_LONGHELP */
639 ;
640
641U_BOOT_CMD(
642 sf, 5, 1, do_spi_flash,
643 "SPI flash sub-system", long_help
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200644);