3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
14 #if defined(CONFIG_CMD_MTDPARTS)
15 #include <jffs2/jffs2.h>
17 /* partition handling routines */
18 int mtdparts_init(void);
19 int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
20 int find_dev_and_part(const char *id, struct mtd_device **dev,
21 u8 *part_num, struct part_info **part);
24 #ifdef CONFIG_MTD_NOR_FLASH
26 #include <mtd/cfi_flash.h>
27 extern flash_info_t flash_info[]; /* info for FLASH chips */
30 * The user interface starts numbering for Flash banks with 1
31 * for historical reasons.
35 * this routine looks for an abbreviated flash range specification.
36 * the syntax is B:SF[-SL], where B is the bank number, SF is the first
37 * sector to erase, and SL is the last sector to erase (defaults to SF).
38 * bank numbers start at 1 to be consistent with other specs, sector numbers
41 * returns: 1 - correct spec; *pinfo, *psf and *psl are
43 * 0 - doesn't look like an abbreviated spec
44 * -1 - looks like an abbreviated spec, but got
45 * a parsing error, a number out of range,
46 * or an invalid flash bank.
49 abbrev_spec (char *str, flash_info_t ** pinfo, int *psf, int *psl)
52 int bank, first, last;
55 if ((p = strchr (str, ':')) == NULL)
59 bank = simple_strtoul (str, &ep, 10);
60 if (ep == str || *ep != '\0' ||
61 bank < 1 || bank > CONFIG_SYS_MAX_FLASH_BANKS ||
62 (fp = &flash_info[bank - 1])->flash_id == FLASH_UNKNOWN)
66 if ((p = strchr (str, '-')) != NULL)
69 first = simple_strtoul (str, &ep, 10);
70 if (ep == str || *ep != '\0' || first >= fp->sector_count)
74 last = simple_strtoul (p, &ep, 10);
75 if (ep == p || *ep != '\0' ||
76 last < first || last >= fp->sector_count)
90 * Take *addr in Flash and adjust it to fall on the end of its sector
92 int flash_sect_roundb (ulong *addr)
95 ulong bank, sector_end_addr;
99 /* find the end addr of the sector where the *addr is */
101 for (bank = 0; bank < CONFIG_SYS_MAX_FLASH_BANKS && !found; ++bank) {
102 info = &flash_info[bank];
103 for (i = 0; i < info->sector_count && !found; ++i) {
104 /* get the end address of the sector */
105 if (i == info->sector_count - 1) {
106 sector_end_addr = info->start[0] +
109 sector_end_addr = info->start[i+1] - 1;
112 if (*addr <= sector_end_addr &&
113 *addr >= info->start[i]) {
115 /* adjust *addr if necessary */
116 if (*addr < sector_end_addr)
117 *addr = sector_end_addr;
122 /* error, address not in flash */
123 printf("Error: end address (0x%08lx) not in flash!\n", *addr);
131 * This function computes the start and end addresses for both
132 * erase and protect commands. The range of the addresses on which
133 * either of the commands is to operate can be given in two forms:
134 * 1. <cmd> start end - operate on <'start', 'end')
135 * 2. <cmd> start +length - operate on <'start', start + length)
136 * If the second form is used and the end address doesn't fall on the
137 * sector boundary, than it will be adjusted to the next sector boundary.
138 * If it isn't in the flash, the function will fail (return -1).
140 * arg1, arg2: address specification (i.e. both command arguments)
142 * addr_first, addr_last: computed address range
145 * -1: failure (bad format, bad address).
148 addr_spec(char *arg1, char *arg2, ulong *addr_first, ulong *addr_last)
151 char len_used; /* indicates if the "start +length" form used */
153 *addr_first = simple_strtoul(arg1, &ep, 16);
154 if (ep == arg1 || *ep != '\0')
158 if (arg2 && *arg2 == '+'){
163 *addr_last = simple_strtoul(arg2, &ep, 16);
164 if (ep == arg2 || *ep != '\0')
169 * *addr_last has the length, compute correct *addr_last
170 * XXX watch out for the integer overflow! Right now it is
171 * checked for in both the callers.
173 *addr_last = *addr_first + *addr_last - 1;
176 * It may happen that *addr_last doesn't fall on the sector
177 * boundary. We want to round such an address to the next
178 * sector boundary, so that the commands don't fail later on.
181 if (flash_sect_roundb(addr_last) > 0)
183 } /* "start +length" from used */
189 flash_fill_sect_ranges (ulong addr_first, ulong addr_last,
190 int *s_first, int *s_last,
199 for (bank=0; bank < CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
200 s_first[bank] = -1; /* first sector to erase */
201 s_last [bank] = -1; /* last sector to erase */
204 for (bank=0,info = &flash_info[0];
205 (bank < CONFIG_SYS_MAX_FLASH_BANKS) && (addr_first <= addr_last);
211 if (info->flash_id == FLASH_UNKNOWN) {
215 b_end = info->start[0] + info->size - 1; /* bank end addr */
216 s_end = info->sector_count - 1; /* last sector */
219 for (sect=0; sect < info->sector_count; ++sect) {
220 ulong end; /* last address in current sect */
222 end = (sect == s_end) ? b_end : info->start[sect + 1] - 1;
224 if (addr_first > end)
226 if (addr_last < info->start[sect])
229 if (addr_first == info->start[sect]) {
230 s_first[bank] = sect;
232 if (addr_last == end) {
236 if (s_first[bank] >= 0) {
237 if (s_last[bank] < 0) {
238 if (addr_last > b_end) {
239 s_last[bank] = s_end;
241 puts ("Error: end address"
242 " not on sector boundary\n");
247 if (s_last[bank] < s_first[bank]) {
248 puts ("Error: end sector"
249 " precedes start sector\n");
254 addr_first = (sect == s_end) ? b_end + 1: info->start[sect + 1];
255 (*s_count) += s_last[bank] - s_first[bank] + 1;
256 } else if (addr_first >= info->start[0] && addr_first < b_end) {
257 puts ("Error: start address not on sector boundary\n");
260 } else if (s_last[bank] >= 0) {
261 puts ("Error: cannot span across banks when they are"
262 " mapped in reverse order\n");
270 #endif /* CONFIG_MTD_NOR_FLASH */
272 static int do_flinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
274 #ifdef CONFIG_MTD_NOR_FLASH
278 #ifdef CONFIG_MTD_NOR_FLASH
279 if (argc == 1) { /* print info for all FLASH banks */
280 for (bank=0; bank <CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
281 printf ("\nBank # %ld: ", bank+1);
283 flash_print_info (&flash_info[bank]);
288 bank = simple_strtoul(argv[1], NULL, 16);
289 if ((bank < 1) || (bank > CONFIG_SYS_MAX_FLASH_BANKS)) {
290 printf ("Only FLASH Banks # 1 ... # %d supported\n",
291 CONFIG_SYS_MAX_FLASH_BANKS);
294 printf ("\nBank # %ld: ", bank);
295 flash_print_info (&flash_info[bank-1]);
296 #endif /* CONFIG_MTD_NOR_FLASH */
300 static int do_flerase(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
302 #ifdef CONFIG_MTD_NOR_FLASH
303 flash_info_t *info = NULL;
304 ulong bank, addr_first, addr_last;
305 int n, sect_first = 0, sect_last = 0;
306 #if defined(CONFIG_CMD_MTDPARTS)
307 struct mtd_device *dev;
308 struct part_info *part;
309 u8 dev_type, dev_num, pnum;
314 return CMD_RET_USAGE;
316 if (strcmp(argv[1], "all") == 0) {
317 for (bank=1; bank<=CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
318 printf ("Erase Flash Bank # %ld ", bank);
319 info = &flash_info[bank-1];
320 rcode = flash_erase (info, 0, info->sector_count-1);
325 if ((n = abbrev_spec(argv[1], &info, §_first, §_last)) != 0) {
327 puts ("Bad sector specification\n");
330 printf ("Erase Flash Sectors %d-%d in Bank # %zu ",
331 sect_first, sect_last, (info-flash_info)+1);
332 rcode = flash_erase(info, sect_first, sect_last);
336 #if defined(CONFIG_CMD_MTDPARTS)
337 /* erase <part-id> - erase partition */
338 if ((argc == 2) && (mtd_id_parse(argv[1], NULL, &dev_type, &dev_num) == 0)) {
340 if (find_dev_and_part(argv[1], &dev, &pnum, &part) == 0) {
341 if (dev->id->type == MTD_DEV_TYPE_NOR) {
343 info = &flash_info[bank];
344 addr_first = part->offset + info->start[0];
345 addr_last = addr_first + part->size - 1;
347 printf ("Erase Flash Partition %s, "
348 "bank %ld, 0x%08lx - 0x%08lx ",
349 argv[1], bank, addr_first,
352 rcode = flash_sect_erase(addr_first, addr_last);
356 printf("cannot erase, not a NOR device\n");
363 return CMD_RET_USAGE;
365 if (strcmp(argv[1], "bank") == 0) {
366 bank = simple_strtoul(argv[2], NULL, 16);
367 if ((bank < 1) || (bank > CONFIG_SYS_MAX_FLASH_BANKS)) {
368 printf ("Only FLASH Banks # 1 ... # %d supported\n",
369 CONFIG_SYS_MAX_FLASH_BANKS);
372 printf ("Erase Flash Bank # %ld ", bank);
373 info = &flash_info[bank-1];
374 rcode = flash_erase (info, 0, info->sector_count-1);
378 if (addr_spec(argv[1], argv[2], &addr_first, &addr_last) < 0){
379 printf ("Bad address format\n");
383 if (addr_first >= addr_last)
384 return CMD_RET_USAGE;
386 rcode = flash_sect_erase(addr_first, addr_last);
390 #endif /* CONFIG_MTD_NOR_FLASH */
393 #ifdef CONFIG_MTD_NOR_FLASH
394 int flash_sect_erase (ulong addr_first, ulong addr_last)
398 int s_first[CONFIG_SYS_MAX_FLASH_BANKS], s_last[CONFIG_SYS_MAX_FLASH_BANKS];
403 rcode = flash_fill_sect_ranges (addr_first, addr_last,
404 s_first, s_last, &planned );
406 if (planned && (rcode == 0)) {
407 for (bank=0,info = &flash_info[0];
408 (bank < CONFIG_SYS_MAX_FLASH_BANKS) && (rcode == 0);
410 if (s_first[bank]>=0) {
411 erased += s_last[bank] - s_first[bank] + 1;
412 debug ("Erase Flash from 0x%08lx to 0x%08lx "
414 info->start[s_first[bank]],
415 (s_last[bank] == info->sector_count) ?
416 info->start[0] + info->size - 1:
417 info->start[s_last[bank]+1] - 1,
419 rcode = flash_erase (info, s_first[bank], s_last[bank]);
423 printf("Erased %d sectors\n", erased);
424 } else if (rcode == 0) {
425 puts ("Error: start and/or end address"
426 " not on sector boundary\n");
431 #endif /* CONFIG_MTD_NOR_FLASH */
433 static int do_protect(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
436 #ifdef CONFIG_MTD_NOR_FLASH
437 flash_info_t *info = NULL;
439 int i, n, sect_first = 0, sect_last = 0;
440 #if defined(CONFIG_CMD_MTDPARTS)
441 struct mtd_device *dev;
442 struct part_info *part;
443 u8 dev_type, dev_num, pnum;
445 #endif /* CONFIG_MTD_NOR_FLASH */
446 #if defined(CONFIG_MTD_NOR_FLASH)
448 ulong addr_first, addr_last;
452 return CMD_RET_USAGE;
454 #if defined(CONFIG_MTD_NOR_FLASH)
455 if (strcmp(argv[1], "off") == 0)
457 else if (strcmp(argv[1], "on") == 0)
460 return CMD_RET_USAGE;
463 #ifdef CONFIG_MTD_NOR_FLASH
464 if (strcmp(argv[2], "all") == 0) {
465 for (bank=1; bank<=CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
466 info = &flash_info[bank-1];
467 if (info->flash_id == FLASH_UNKNOWN) {
470 printf ("%sProtect Flash Bank # %ld\n",
471 p ? "" : "Un-", bank);
473 for (i=0; i<info->sector_count; ++i) {
474 #if defined(CONFIG_SYS_FLASH_PROTECTION)
475 if (flash_real_protect(info, i, p))
479 info->protect[i] = p;
480 #endif /* CONFIG_SYS_FLASH_PROTECTION */
482 #if defined(CONFIG_SYS_FLASH_PROTECTION)
483 if (!rcode) puts (" done\n");
484 #endif /* CONFIG_SYS_FLASH_PROTECTION */
489 if ((n = abbrev_spec(argv[2], &info, §_first, §_last)) != 0) {
491 puts ("Bad sector specification\n");
494 printf("%sProtect Flash Sectors %d-%d in Bank # %zu\n",
495 p ? "" : "Un-", sect_first, sect_last,
496 (info-flash_info)+1);
497 for (i = sect_first; i <= sect_last; i++) {
498 #if defined(CONFIG_SYS_FLASH_PROTECTION)
499 if (flash_real_protect(info, i, p))
503 info->protect[i] = p;
504 #endif /* CONFIG_SYS_FLASH_PROTECTION */
507 #if defined(CONFIG_SYS_FLASH_PROTECTION)
508 if (!rcode) puts (" done\n");
509 #endif /* CONFIG_SYS_FLASH_PROTECTION */
514 #if defined(CONFIG_CMD_MTDPARTS)
515 /* protect on/off <part-id> */
516 if ((argc == 3) && (mtd_id_parse(argv[2], NULL, &dev_type, &dev_num) == 0)) {
518 if (find_dev_and_part(argv[2], &dev, &pnum, &part) == 0) {
519 if (dev->id->type == MTD_DEV_TYPE_NOR) {
521 info = &flash_info[bank];
522 addr_first = part->offset + info->start[0];
523 addr_last = addr_first + part->size - 1;
525 printf ("%sProtect Flash Partition %s, "
526 "bank %ld, 0x%08lx - 0x%08lx\n",
527 p ? "" : "Un", argv[1],
528 bank, addr_first, addr_last);
530 rcode = flash_sect_protect (p, addr_first, addr_last);
534 printf("cannot %sprotect, not a NOR device\n",
542 return CMD_RET_USAGE;
544 if (strcmp(argv[2], "bank") == 0) {
545 bank = simple_strtoul(argv[3], NULL, 16);
546 if ((bank < 1) || (bank > CONFIG_SYS_MAX_FLASH_BANKS)) {
547 printf ("Only FLASH Banks # 1 ... # %d supported\n",
548 CONFIG_SYS_MAX_FLASH_BANKS);
551 printf ("%sProtect Flash Bank # %ld\n",
552 p ? "" : "Un-", bank);
553 info = &flash_info[bank-1];
555 if (info->flash_id == FLASH_UNKNOWN) {
556 puts ("missing or unknown FLASH type\n");
559 for (i=0; i<info->sector_count; ++i) {
560 #if defined(CONFIG_SYS_FLASH_PROTECTION)
561 if (flash_real_protect(info, i, p))
565 info->protect[i] = p;
566 #endif /* CONFIG_SYS_FLASH_PROTECTION */
569 #if defined(CONFIG_SYS_FLASH_PROTECTION)
570 if (!rcode) puts (" done\n");
571 #endif /* CONFIG_SYS_FLASH_PROTECTION */
576 if (addr_spec(argv[2], argv[3], &addr_first, &addr_last) < 0){
577 printf("Bad address format\n");
581 if (addr_first >= addr_last)
582 return CMD_RET_USAGE;
584 rcode = flash_sect_protect (p, addr_first, addr_last);
585 #endif /* CONFIG_MTD_NOR_FLASH */
589 #ifdef CONFIG_MTD_NOR_FLASH
590 int flash_sect_protect (int p, ulong addr_first, ulong addr_last)
594 int s_first[CONFIG_SYS_MAX_FLASH_BANKS], s_last[CONFIG_SYS_MAX_FLASH_BANKS];
599 rcode = flash_fill_sect_ranges( addr_first, addr_last, s_first, s_last, &planned );
603 if (planned && (rcode == 0)) {
604 for (bank=0,info = &flash_info[0]; bank < CONFIG_SYS_MAX_FLASH_BANKS; ++bank, ++info) {
605 if (info->flash_id == FLASH_UNKNOWN) {
609 if (s_first[bank]>=0 && s_first[bank]<=s_last[bank]) {
610 debug ("%sProtecting sectors %d..%d in bank %ld\n",
612 s_first[bank], s_last[bank], bank+1);
613 protected += s_last[bank] - s_first[bank] + 1;
614 for (i=s_first[bank]; i<=s_last[bank]; ++i) {
615 #if defined(CONFIG_SYS_FLASH_PROTECTION)
616 if (flash_real_protect(info, i, p))
620 info->protect[i] = p;
621 #endif /* CONFIG_SYS_FLASH_PROTECTION */
625 #if defined(CONFIG_SYS_FLASH_PROTECTION)
627 #endif /* CONFIG_SYS_FLASH_PROTECTION */
629 printf ("%sProtected %d sectors\n",
630 p ? "" : "Un-", protected);
631 } else if (rcode == 0) {
632 puts ("Error: start and/or end address"
633 " not on sector boundary\n");
638 #endif /* CONFIG_MTD_NOR_FLASH */
641 /**************************************************/
642 #if defined(CONFIG_CMD_MTDPARTS)
643 # define TMP_ERASE "erase <part-id>\n - erase partition\n"
644 # define TMP_PROT_ON "protect on <part-id>\n - protect partition\n"
645 # define TMP_PROT_OFF "protect off <part-id>\n - make partition writable\n"
647 # define TMP_ERASE /* empty */
648 # define TMP_PROT_ON /* empty */
649 # define TMP_PROT_OFF /* empty */
653 flinfo, 2, 1, do_flinfo,
654 "print FLASH memory information",
655 "\n - print information for all FLASH memory banks\n"
656 "flinfo N\n - print information for FLASH memory bank # N"
660 erase, 3, 0, do_flerase,
661 "erase FLASH memory",
663 " - erase FLASH from addr 'start' to addr 'end'\n"
665 " - erase FLASH from addr 'start' to the end of sect "
666 "w/addr 'start'+'len'-1\n"
667 "erase N:SF[-SL]\n - erase sectors SF-SL in FLASH bank # N\n"
668 "erase bank N\n - erase FLASH bank # N\n"
670 "erase all\n - erase all FLASH banks"
674 protect, 4, 0, do_protect,
675 "enable or disable FLASH write protection",
677 " - protect FLASH from addr 'start' to addr 'end'\n"
678 "protect on start +len\n"
679 " - protect FLASH from addr 'start' to end of sect "
680 "w/addr 'start'+'len'-1\n"
681 "protect on N:SF[-SL]\n"
682 " - protect sectors SF-SL in FLASH bank # N\n"
683 "protect on bank N\n - protect FLASH bank # N\n"
685 "protect on all\n - protect all FLASH banks\n"
686 "protect off start end\n"
687 " - make FLASH from addr 'start' to addr 'end' writable\n"
688 "protect off start +len\n"
689 " - make FLASH from addr 'start' to end of sect "
690 "w/addr 'start'+'len'-1 wrtable\n"
691 "protect off N:SF[-SL]\n"
692 " - make sectors SF-SL writable in FLASH bank # N\n"
693 "protect off bank N\n - make FLASH bank # N writable\n"
695 "protect off all\n - make all FLASH banks writable"