3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
31 #ifdef CONFIG_HAS_DATAFLASH
32 #include <dataflash.h>
35 #if (CONFIG_COMMANDS & CFG_CMD_FLASH)
37 extern flash_info_t flash_info[]; /* info for FLASH chips */
40 * The user interface starts numbering for Flash banks with 1
41 * for historical reasons.
45 * this routine looks for an abbreviated flash range specification.
46 * the syntax is B:SF[-SL], where B is the bank number, SF is the first
47 * sector to erase, and SL is the last sector to erase (defaults to SF).
48 * bank numbers start at 1 to be consistent with other specs, sector numbers
51 * returns: 1 - correct spec; *pinfo, *psf and *psl are
53 * 0 - doesn't look like an abbreviated spec
54 * -1 - looks like an abbreviated spec, but got
55 * a parsing error, a number out of range,
56 * or an invalid flash bank.
59 abbrev_spec (char *str, flash_info_t ** pinfo, int *psf, int *psl)
62 int bank, first, last;
65 if ((p = strchr (str, ':')) == NULL)
69 bank = simple_strtoul (str, &ep, 10);
70 if (ep == str || *ep != '\0' ||
71 bank < 1 || bank > CFG_MAX_FLASH_BANKS ||
72 (fp = &flash_info[bank - 1])->flash_id == FLASH_UNKNOWN)
76 if ((p = strchr (str, '-')) != NULL)
79 first = simple_strtoul (str, &ep, 10);
80 if (ep == str || *ep != '\0' || first >= fp->sector_count)
84 last = simple_strtoul (p, &ep, 10);
85 if (ep == p || *ep != '\0' ||
86 last < first || last >= fp->sector_count)
100 * This function computes the start and end addresses for both
101 * erase and protect commands. The range of the addresses on which
102 * either of the commands is to operate can be given in two forms:
103 * 1. <cmd> start end - operate on <'start', 'end')
104 * 2. <cmd> start +length - operate on <'start', start + length)
105 * If the second form is used and the end address doesn't fall on the
106 * sector boundary, than it will be adjusted to the next sector boundary.
107 * If it isn't in the flash, the function will fail (return -1).
109 * arg1, arg2: address specification (i.e. both command arguments)
111 * addr_first, addr_last: computed address range
114 * -1: failure (bad format, bad address).
117 addr_spec(char *arg1, char *arg2, ulong *addr_first, ulong *addr_last)
120 *addr_first = simple_strtoul(arg1, &ep, 16);
121 if (ep == arg1 || *ep != '\0')
124 char len_used = 0; /* indicates if the "start +length" form used */
125 if (arg2 && *arg2 == '+'){
130 *addr_last = simple_strtoul(arg2, &ep, 16);
131 if (ep == arg2 || *ep != '\0')
136 * *addr_last has the length, compute correct *addr_last
137 * XXX watch out for the integer overflow! Right now it is
138 * checked for in both the callers.
140 *addr_last = *addr_first + *addr_last - 1;
143 * It may happen that *addr_last doesn't fall on the sector
144 * boundary. We want to round such an address to the next
145 * sector boundary, so that the commands don't fail later on.
148 /* find the end addr of the sector where the *addr_last is */
151 for (bank = 0; bank < CFG_MAX_FLASH_BANKS && !found; ++bank){
153 flash_info_t *info = &flash_info[bank];
154 for (i = 0; i < info->sector_count && !found; ++i){
155 /* get the end address of the sector */
156 ulong sector_end_addr;
157 if (i == info->sector_count - 1){
159 info->start[0] + info->size - 1;
162 info->start[i+1] - 1;
164 if (*addr_last <= sector_end_addr &&
165 *addr_last >= info->start[i]){
168 /* adjust *addr_last if necessary */
169 if (*addr_last < sector_end_addr){
170 *addr_last = sector_end_addr;
176 /* error, addres not in flash */
177 printf("Error: end address (0x%08lx) not in flash!\n",
181 } /* "start +length" from used */
187 flash_fill_sect_ranges (ulong addr_first, ulong addr_last,
188 int *s_first, int *s_last,
197 for (bank=0; bank < CFG_MAX_FLASH_BANKS; ++bank) {
198 s_first[bank] = -1; /* first sector to erase */
199 s_last [bank] = -1; /* last sector to erase */
202 for (bank=0,info=&flash_info[0];
203 (bank < CFG_MAX_FLASH_BANKS) && (addr_first <= addr_last);
209 if (info->flash_id == FLASH_UNKNOWN) {
213 b_end = info->start[0] + info->size - 1; /* bank end addr */
214 s_end = info->sector_count - 1; /* last sector */
217 for (sect=0; sect < info->sector_count; ++sect) {
218 ulong end; /* last address in current sect */
220 end = (sect == s_end) ? b_end : info->start[sect + 1] - 1;
222 if (addr_first > end)
224 if (addr_last < info->start[sect])
227 if (addr_first == info->start[sect]) {
228 s_first[bank] = sect;
230 if (addr_last == end) {
234 if (s_first[bank] >= 0) {
235 if (s_last[bank] < 0) {
236 if (addr_last > b_end) {
237 s_last[bank] = s_end;
239 puts ("Error: end address"
240 " not on sector boundary\n");
245 if (s_last[bank] < s_first[bank]) {
246 puts ("Error: end sector"
247 " precedes start sector\n");
252 addr_first = (sect == s_end) ? b_end + 1: info->start[sect + 1];
253 (*s_count) += s_last[bank] - s_first[bank] + 1;
254 } else if (addr_first >= info->start[0] && addr_first < b_end) {
255 puts ("Error: start address not on sector boundary\n");
258 } else if (s_last[bank] >= 0) {
259 puts ("Error: cannot span across banks when they are"
260 " mapped in reverse order\n");
269 int do_flinfo ( cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
273 #ifdef CONFIG_HAS_DATAFLASH
274 dataflash_print_info();
277 if (argc == 1) { /* print info for all FLASH banks */
278 for (bank=0; bank <CFG_MAX_FLASH_BANKS; ++bank) {
279 printf ("\nBank # %ld: ", bank+1);
281 flash_print_info (&flash_info[bank]);
286 bank = simple_strtoul(argv[1], NULL, 16);
287 if ((bank < 1) || (bank > CFG_MAX_FLASH_BANKS)) {
288 printf ("Only FLASH Banks # 1 ... # %d supported\n",
289 CFG_MAX_FLASH_BANKS);
292 printf ("\nBank # %ld: ", bank);
293 flash_print_info (&flash_info[bank-1]);
296 int do_flerase (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
299 ulong bank, addr_first, addr_last;
300 int n, sect_first, sect_last;
304 printf ("Usage:\n%s\n", cmdtp->usage);
308 if (strcmp(argv[1], "all") == 0) {
309 for (bank=1; bank<=CFG_MAX_FLASH_BANKS; ++bank) {
310 printf ("Erase Flash Bank # %ld ", bank);
311 info = &flash_info[bank-1];
312 rcode = flash_erase (info, 0, info->sector_count-1);
317 if ((n = abbrev_spec(argv[1], &info, §_first, §_last)) != 0) {
319 puts ("Bad sector specification\n");
322 printf ("Erase Flash Sectors %d-%d in Bank # %d ",
323 sect_first, sect_last, (info-flash_info)+1);
324 rcode = flash_erase(info, sect_first, sect_last);
329 printf ("Usage:\n%s\n", cmdtp->usage);
333 if (strcmp(argv[1], "bank") == 0) {
334 bank = simple_strtoul(argv[2], NULL, 16);
335 if ((bank < 1) || (bank > CFG_MAX_FLASH_BANKS)) {
336 printf ("Only FLASH Banks # 1 ... # %d supported\n",
337 CFG_MAX_FLASH_BANKS);
340 printf ("Erase Flash Bank # %ld ", bank);
341 info = &flash_info[bank-1];
342 rcode = flash_erase (info, 0, info->sector_count-1);
346 if (addr_spec(argv[1], argv[2], &addr_first, &addr_last) < 0){
347 printf ("Bad address format\n");
351 if (addr_first >= addr_last) {
352 printf ("Usage:\n%s\n", cmdtp->usage);
356 rcode = flash_sect_erase(addr_first, addr_last);
360 int flash_sect_erase (ulong addr_first, ulong addr_last)
364 int s_first[CFG_MAX_FLASH_BANKS], s_last[CFG_MAX_FLASH_BANKS];
369 rcode = flash_fill_sect_ranges (addr_first, addr_last,
370 s_first, s_last, &planned );
372 if (planned && (rcode == 0)) {
373 for (bank=0,info=&flash_info[0];
374 (bank < CFG_MAX_FLASH_BANKS) && (rcode == 0);
376 if (s_first[bank]>=0) {
377 erased += s_last[bank] - s_first[bank] + 1;
378 debug ("Erase Flash from 0x%08lx to 0x%08lx "
380 info->start[s_first[bank]],
381 (s_last[bank] == info->sector_count) ?
382 info->start[0] + info->size - 1:
383 info->start[s_last[bank]+1] - 1,
385 rcode = flash_erase (info, s_first[bank], s_last[bank]);
388 printf ("Erased %d sectors\n", erased);
389 } else if (rcode == 0) {
390 puts ("Error: start and/or end address"
391 " not on sector boundary\n");
397 int do_protect (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
400 ulong bank, addr_first, addr_last;
401 int i, p, n, sect_first, sect_last;
403 #ifdef CONFIG_HAS_DATAFLASH
407 printf ("Usage:\n%s\n", cmdtp->usage);
411 if (strcmp(argv[1], "off") == 0) {
413 } else if (strcmp(argv[1], "on") == 0) {
416 printf ("Usage:\n%s\n", cmdtp->usage);
420 #ifdef CONFIG_HAS_DATAFLASH
421 if ((strcmp(argv[2], "all") != 0) && (strcmp(argv[2], "bank") != 0)) {
422 addr_first = simple_strtoul(argv[2], NULL, 16);
423 addr_last = simple_strtoul(argv[3], NULL, 16);
425 if (addr_dataflash(addr_first) && addr_dataflash(addr_last)) {
426 status = dataflash_real_protect(p,addr_first,addr_last);
428 puts ("Bad DataFlash sector specification\n");
431 printf("%sProtect %d DataFlash Sectors\n",
432 p ? "" : "Un-", status);
438 if (strcmp(argv[2], "all") == 0) {
439 for (bank=1; bank<=CFG_MAX_FLASH_BANKS; ++bank) {
440 info = &flash_info[bank-1];
441 if (info->flash_id == FLASH_UNKNOWN) {
444 printf ("%sProtect Flash Bank # %ld\n",
445 p ? "" : "Un-", bank);
447 for (i=0; i<info->sector_count; ++i) {
448 #if defined(CFG_FLASH_PROTECTION)
449 if (flash_real_protect(info, i, p))
453 info->protect[i] = p;
454 #endif /* CFG_FLASH_PROTECTION */
458 #if defined(CFG_FLASH_PROTECTION)
459 if (!rcode) puts (" done\n");
460 #endif /* CFG_FLASH_PROTECTION */
465 if ((n = abbrev_spec(argv[2], &info, §_first, §_last)) != 0) {
467 puts ("Bad sector specification\n");
470 printf("%sProtect Flash Sectors %d-%d in Bank # %d\n",
471 p ? "" : "Un-", sect_first, sect_last,
472 (info-flash_info)+1);
473 for (i = sect_first; i <= sect_last; i++) {
474 #if defined(CFG_FLASH_PROTECTION)
475 if (flash_real_protect(info, i, p))
479 info->protect[i] = p;
480 #endif /* CFG_FLASH_PROTECTION */
483 #if defined(CFG_FLASH_PROTECTION)
484 if (!rcode) puts (" done\n");
485 #endif /* CFG_FLASH_PROTECTION */
491 printf ("Usage:\n%s\n", cmdtp->usage);
495 if (strcmp(argv[2], "bank") == 0) {
496 bank = simple_strtoul(argv[3], NULL, 16);
497 if ((bank < 1) || (bank > CFG_MAX_FLASH_BANKS)) {
498 printf ("Only FLASH Banks # 1 ... # %d supported\n",
499 CFG_MAX_FLASH_BANKS);
502 printf ("%sProtect Flash Bank # %ld\n",
503 p ? "" : "Un-", bank);
504 info = &flash_info[bank-1];
506 if (info->flash_id == FLASH_UNKNOWN) {
507 puts ("missing or unknown FLASH type\n");
510 for (i=0; i<info->sector_count; ++i) {
511 #if defined(CFG_FLASH_PROTECTION)
512 if (flash_real_protect(info, i, p))
516 info->protect[i] = p;
517 #endif /* CFG_FLASH_PROTECTION */
520 #if defined(CFG_FLASH_PROTECTION)
521 if (!rcode) puts (" done\n");
522 #endif /* CFG_FLASH_PROTECTION */
527 if (addr_spec(argv[2], argv[3], &addr_first, &addr_last) < 0){
528 printf("Bad address format\n");
532 if (addr_first >= addr_last) {
533 printf ("Usage:\n%s\n", cmdtp->usage);
536 rcode = flash_sect_protect (p, addr_first, addr_last);
541 int flash_sect_protect (int p, ulong addr_first, ulong addr_last)
545 int s_first[CFG_MAX_FLASH_BANKS], s_last[CFG_MAX_FLASH_BANKS];
550 rcode = flash_fill_sect_ranges( addr_first, addr_last, s_first, s_last, &planned );
554 if (planned && (rcode == 0)) {
555 for (bank=0,info=&flash_info[0]; bank < CFG_MAX_FLASH_BANKS; ++bank, ++info) {
556 if (info->flash_id == FLASH_UNKNOWN) {
560 if (s_first[bank]>=0 && s_first[bank]<=s_last[bank]) {
561 debug ("%sProtecting sectors %d..%d in bank %ld\n",
563 s_first[bank], s_last[bank], bank+1);
564 protected += s_last[bank] - s_first[bank] + 1;
565 for (i=s_first[bank]; i<=s_last[bank]; ++i) {
566 #if defined(CFG_FLASH_PROTECTION)
567 if (flash_real_protect(info, i, p))
571 info->protect[i] = p;
572 #endif /* CFG_FLASH_PROTECTION */
575 #if defined(CFG_FLASH_PROTECTION)
576 if (!rcode) putc ('\n');
577 #endif /* CFG_FLASH_PROTECTION */
580 printf ("%sProtected %d sectors\n",
581 p ? "" : "Un-", protected);
582 } else if (rcode == 0) {
583 puts ("Error: start and/or end address"
584 " not on sector boundary\n");
591 /**************************************************/
594 flinfo, 2, 1, do_flinfo,
595 "flinfo - print FLASH memory information\n",
596 "\n - print information for all FLASH memory banks\n"
597 "flinfo N\n - print information for FLASH memory bank # N\n"
601 erase, 3, 1, do_flerase,
602 "erase - erase FLASH memory\n",
604 " - erase FLASH from addr 'start' to addr 'end'\n"
606 " - erase FLASH from addr 'start' to the end of sect "
607 "w/addr 'start'+'len'-1\n"
608 "erase N:SF[-SL]\n - erase sectors SF-SL in FLASH bank # N\n"
609 "erase bank N\n - erase FLASH bank # N\n"
610 "erase all\n - erase all FLASH banks\n"
614 protect, 4, 1, do_protect,
615 "protect - enable or disable FLASH write protection\n",
617 " - protect FLASH from addr 'start' to addr 'end'\n"
618 "protect on start +len\n"
619 " - protect FLASH from addr 'start' to end of sect "
620 "w/addr 'start'+'len'-1\n"
621 "protect on N:SF[-SL]\n"
622 " - protect sectors SF-SL in FLASH bank # N\n"
623 "protect on bank N\n - protect FLASH bank # N\n"
624 "protect on all\n - protect all FLASH banks\n"
625 "protect off start end\n"
626 " - make FLASH from addr 'start' to addr 'end' writable\n"
627 "protect off start +len\n"
628 " - make FLASH from addr 'start' to end of sect "
629 "w/addr 'start'+'len'-1 wrtable\n"
630 "protect off N:SF[-SL]\n"
631 " - make sectors SF-SL writable in FLASH bank # N\n"
632 "protect off bank N\n - make FLASH bank # N writable\n"
633 "protect off all\n - make all FLASH banks writable\n"
636 #endif /* CFG_CMD_FLASH */