// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 */

/*
 * FLASH support
 */
#include <common.h>
#include <command.h>
#include <log.h>
#include <uuid.h>

#if defined(CONFIG_CMD_MTDPARTS)
#include <jffs2/jffs2.h>

/* partition handling routines */
int mtdparts_init(void);
int mtd_id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
int find_dev_and_part(const char *id, struct mtd_device **dev,
                      u8 *part_num, struct part_info **part);
#endif

#ifdef CONFIG_MTD_NOR_FLASH
#include <flash.h>
#include <mtd/cfi_flash.h>
extern flash_info_t flash_info[];       /* info for FLASH chips */

/*
 * The user interface starts numbering for Flash banks with 1
 * for historical reasons.
 */

/*
 * this routine looks for an abbreviated flash range specification.
 * the syntax is B:SF[-SL], where B is the bank number, SF is the first
 * sector to erase, and SL is the last sector to erase (defaults to SF).
 * bank numbers start at 1 to be consistent with other specs, sector numbers
 * start at zero.
 *
 * returns:     1       - correct spec; *pinfo, *psf and *psl are
 *                        set appropriately
 *              0       - doesn't look like an abbreviated spec
 *              -1      - looks like an abbreviated spec, but got
 *                        a parsing error, a number out of range,
 *                        or an invalid flash bank.
 */
static int
abbrev_spec(char *str, flash_info_t **pinfo, int *psf, int *psl)
{
        flash_info_t *fp;
        int bank, first, last;
        char *p, *ep;

        p = strchr(str, ':');
        if (!p)
                return 0;
        *p++ = '\0';

        bank = dectoul(str, &ep);
        if (ep == str || *ep != '\0' ||
            bank < 1 || bank > CFI_FLASH_BANKS)
                return -1;

        fp = &flash_info[bank - 1];
        if (fp->flash_id == FLASH_UNKNOWN)
                return -1;

        str = p;
        p = strchr(str, '-');
        if (p)
                *p++ = '\0';

        first = dectoul(str, &ep);
        if (ep == str || *ep != '\0' || first >= fp->sector_count)
                return -1;

        if (p) {
                last = dectoul(p, &ep);
                if (ep == p || *ep != '\0' ||
                    last < first || last >= fp->sector_count)
                        return -1;
        } else {
                last = first;
        }

        *pinfo = fp;
        *psf = first;
        *psl = last;

        return 1;
}

/*
 * Take *addr in Flash and adjust it to fall on the end of its sector
 */
int flash_sect_roundb(ulong *addr)
{
        flash_info_t *info;
        ulong bank, sector_end_addr;
        char found;
        int i;

        /* find the end addr of the sector where the *addr is */
        found = 0;
        for (bank = 0; bank < CFI_FLASH_BANKS && !found; ++bank) {
                info = &flash_info[bank];
                for (i = 0; i < info->sector_count && !found; ++i) {
                        /* get the end address of the sector */
                        if (i == info->sector_count - 1) {
                                sector_end_addr = info->start[0] +
                                                                info->size - 1;
                        } else {
                                sector_end_addr = info->start[i + 1] - 1;
                        }

                        if (*addr <= sector_end_addr && *addr >= info->start[i]) {
                                found = 1;
                                /* adjust *addr if necessary */
                                if (*addr < sector_end_addr)
                                        *addr = sector_end_addr;
                        } /* sector */
                } /* bank */
        }
        if (!found) {
                /* error, address not in flash */
                printf("Error: end address (0x%08lx) not in flash!\n", *addr);
                return 1;
        }

        return 0;
}

/*
 * This function computes the start and end addresses for both
 * erase and protect commands. The range of the addresses on which
 * either of the commands is to operate can be given in two forms:
 * 1. <cmd> start end - operate on <'start',  'end')
 * 2. <cmd> start +length - operate on <'start', start + length)
 * If the second form is used and the end address 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:
 *    arg1, arg2: address specification (i.e. both command arguments)
 * Output:
 *    addr_first, addr_last: computed address range
 * Return:
 *    1: success
 *   -1: failure (bad format, bad address).
 */
static int
addr_spec(char *arg1, char *arg2, ulong *addr_first, ulong *addr_last)
{
        char *ep;
        char len_used; /* indicates if the "start +length" form used */

        *addr_first = hextoul(arg1, &ep);
        if (ep == arg1 || *ep != '\0')
                return -1;

        len_used = 0;
        if (arg2 && *arg2 == '+') {
                len_used = 1;
                ++arg2;
        }

        *addr_last = hextoul(arg2, &ep);
        if (ep == arg2 || *ep != '\0')
                return -1;

        if (len_used) {
                /*
                 * *addr_last has the length, compute correct *addr_last
                 * XXX watch out for the integer overflow! Right now it is
                 * checked for in both the callers.
                 */
                *addr_last = *addr_first + *addr_last - 1;

                /*
                 * It may happen that *addr_last doesn't fall on the sector
                 * boundary. We want to round such an address to the next
                 * sector boundary, so that the commands don't fail later on.
                 */

                if (flash_sect_roundb(addr_last) > 0)
                        return -1;
        } /* "start +length" from used */

        return 1;
}

static int
flash_fill_sect_ranges(ulong addr_first, ulong addr_last,
                       int *s_first, int *s_last,
                       int *s_count)
{
        flash_info_t *info;
        ulong bank;
        int rcode = 0;

        *s_count = 0;

        for (bank = 0; bank < CFI_FLASH_BANKS; ++bank) {
                s_first[bank] = -1;     /* first sector to erase        */
                s_last[bank] = -1;      /* last  sector to erase        */
        }

        for (bank = 0, info = &flash_info[0];
             (bank < CFI_FLASH_BANKS) && (addr_first <= addr_last);
             ++bank, ++info) {
                ulong b_end;
                int sect;
                short s_end;

                if (info->flash_id == FLASH_UNKNOWN)
                        continue;

                b_end = info->start[0] + info->size - 1;        /* bank end addr */
                s_end = info->sector_count - 1;                 /* last sector   */

                for (sect = 0; sect < info->sector_count; ++sect) {
                        ulong end;      /* last address in current sect */

                        end = (sect == s_end) ? b_end : info->start[sect + 1] - 1;

                        if (addr_first > end)
                                continue;
                        if (addr_last < info->start[sect])
                                continue;

                        if (addr_first == info->start[sect])
                                s_first[bank] = sect;

                        if (addr_last  == end)
                                s_last[bank]  = sect;
                }
                if (s_first[bank] >= 0) {
                        if (s_last[bank] < 0) {
                                if (addr_last > b_end) {
                                        s_last[bank] = s_end;
                                } else {
                                        puts("Error: end address not on sector boundary\n");
                                        rcode = 1;
                                        break;
                                }
                        }
                        if (s_last[bank] < s_first[bank]) {
                                puts("Error: end sector precedes start sector\n");
                                rcode = 1;
                                break;
                        }
                        sect = s_last[bank];
                        addr_first = (sect == s_end) ? b_end + 1 : info->start[sect + 1];
                        (*s_count) += s_last[bank] - s_first[bank] + 1;
                } else if (addr_first >= info->start[0] && addr_first < b_end) {
                        puts("Error: start address not on sector boundary\n");
                        rcode = 1;
                        break;
                } else if (s_last[bank] >= 0) {
                        puts("Error: cannot span across banks when they are"
                             " mapped in reverse order\n");
                        rcode = 1;
                        break;
                }
        }

        return rcode;
}
#endif /* CONFIG_MTD_NOR_FLASH */

static int do_flinfo(struct cmd_tbl *cmdtp, int flag, int argc,
                     char *const argv[])
{
#ifdef CONFIG_MTD_NOR_FLASH
        ulong bank;
#endif

#ifdef CONFIG_MTD_NOR_FLASH
        if (argc == 1) {        /* print info for all FLASH banks */
                for (bank = 0; bank < CFI_FLASH_BANKS; ++bank) {
                        printf("\nBank # %ld: ", bank + 1);

                        flash_print_info(&flash_info[bank]);
                }
                return 0;
        }

        bank = hextoul(argv[1], NULL);
        if (bank < 1 || bank > CFI_FLASH_BANKS) {
                printf("Only FLASH Banks # 1 ... # %d supported\n",
                       CFI_FLASH_BANKS);
                return 1;
        }
        printf("\nBank # %ld: ", bank);
        flash_print_info(&flash_info[bank - 1]);
#endif /* CONFIG_MTD_NOR_FLASH */
        return 0;
}

static int do_flerase(struct cmd_tbl *cmdtp, int flag, int argc,
                      char *const argv[])
{
#ifdef CONFIG_MTD_NOR_FLASH
        flash_info_t *info = NULL;
        ulong bank, addr_first, addr_last;
        int n, sect_first = 0, sect_last = 0;
#if defined(CONFIG_CMD_MTDPARTS)
        struct mtd_device *dev;
        struct part_info *part;
        u8 dev_type, dev_num, pnum;
#endif
        int rcode = 0;

        if (argc < 2)
                return CMD_RET_USAGE;

        if (strcmp(argv[1], "all") == 0) {
                for (bank = 1; bank <= CFI_FLASH_BANKS; ++bank) {
                        printf("Erase Flash Bank # %ld ", bank);
                        info = &flash_info[bank - 1];
                        rcode = flash_erase(info, 0, info->sector_count - 1);
                }
                return rcode;
        }

        n = abbrev_spec(argv[1], &info, &sect_first, &sect_last);
        if (n) {
                if (n < 0) {
                        puts("Bad sector specification\n");
                        return 1;
                }
                printf("Erase Flash Sectors %d-%d in Bank # %zu ",
                       sect_first, sect_last, (info - flash_info) + 1);
                rcode = flash_erase(info, sect_first, sect_last);
                return rcode;
        }

#if defined(CONFIG_CMD_MTDPARTS)
        /* erase <part-id> - erase partition */
        if (argc == 2 && mtd_id_parse(argv[1], NULL, &dev_type, &dev_num) == 0) {
                mtdparts_init();
                if (find_dev_and_part(argv[1], &dev, &pnum, &part) == 0) {
                        if (dev->id->type == MTD_DEV_TYPE_NOR) {
                                bank = dev->id->num;
                                info = &flash_info[bank];
                                addr_first = part->offset + info->start[0];
                                addr_last = addr_first + part->size - 1;

                                printf("Erase Flash Partition %s, bank %ld, 0x%08lx - 0x%08lx ",
                                       argv[1], bank, addr_first,
                                       addr_last);

                                rcode = flash_sect_erase(addr_first, addr_last);
                                return rcode;
                        }

                        printf("cannot erase, not a NOR device\n");
                        return 1;
                }
        }
#endif

        if (argc != 3)
                return CMD_RET_USAGE;

        if (strcmp(argv[1], "bank") == 0) {
                bank = hextoul(argv[2], NULL);
                if (bank < 1 || bank > CFI_FLASH_BANKS) {
                        printf("Only FLASH Banks # 1 ... # %d supported\n",
                               CFI_FLASH_BANKS);
                        return 1;
                }
                printf("Erase Flash Bank # %ld ", bank);
                info = &flash_info[bank - 1];
                rcode = flash_erase(info, 0, info->sector_count - 1);
                return rcode;
        }

        if (addr_spec(argv[1], argv[2], &addr_first, &addr_last) < 0) {
                printf("Bad address format\n");
                return 1;
        }

        if (addr_first >= addr_last)
                return CMD_RET_USAGE;

        rcode = flash_sect_erase(addr_first, addr_last);
        return rcode;
#else
        return 0;
#endif /* CONFIG_MTD_NOR_FLASH */
}

#ifdef CONFIG_MTD_NOR_FLASH
int flash_sect_erase(ulong addr_first, ulong addr_last)
{
        flash_info_t *info;
        ulong bank;
        int s_first[CFI_FLASH_BANKS], s_last[CFI_FLASH_BANKS];
        int erased = 0;
        int planned;
        int rcode = 0;

        rcode = flash_fill_sect_ranges(addr_first, addr_last, s_first, s_last, &planned);

        if (planned && rcode == 0) {
                for (bank = 0, info = &flash_info[0];
                     bank < CFI_FLASH_BANKS && rcode == 0;
                     ++bank, ++info) {
                        if (s_first[bank] >= 0) {
                                erased += s_last[bank] - s_first[bank] + 1;
                                debug("Erase Flash from 0x%08lx to 0x%08lx in Bank # %ld ",
                                      info->start[s_first[bank]],
                                      (s_last[bank] == info->sector_count) ?
                                      info->start[0] + info->size - 1 :
                                      info->start[s_last[bank] + 1] - 1,
                                      bank + 1);
                                rcode = flash_erase(info, s_first[bank],
                                                    s_last[bank]);
                        }
                }
                if (rcode == 0)
                        printf("Erased %d sectors\n", erased);
        } else if (rcode == 0) {
                puts("Error: start and/or end address not on sector boundary\n");
                rcode = 1;
        }
        return rcode;
}
#endif /* CONFIG_MTD_NOR_FLASH */

static int do_protect(struct cmd_tbl *cmdtp, int flag, int argc,
                      char *const argv[])
{
        int rcode = 0;
#ifdef CONFIG_MTD_NOR_FLASH
        flash_info_t *info = NULL;
        ulong bank;
        int i, n, sect_first = 0, sect_last = 0;
#if defined(CONFIG_CMD_MTDPARTS)
        struct mtd_device *dev;
        struct part_info *part;
        u8 dev_type, dev_num, pnum;
#endif
#endif /* CONFIG_MTD_NOR_FLASH */
#if defined(CONFIG_MTD_NOR_FLASH)
        int p;
        ulong addr_first, addr_last;
#endif

        if (argc < 3)
                return CMD_RET_USAGE;

#if defined(CONFIG_MTD_NOR_FLASH)
        if (strcmp(argv[1], "off") == 0)
                p = 0;
        else if (strcmp(argv[1], "on") == 0)
                p = 1;
        else
                return CMD_RET_USAGE;
#endif

#ifdef CONFIG_MTD_NOR_FLASH
        if (strcmp(argv[2], "all") == 0) {
                for (bank = 1; bank <= CFI_FLASH_BANKS; ++bank) {
                        info = &flash_info[bank - 1];
                        if (info->flash_id == FLASH_UNKNOWN)
                                continue;

                        printf("%sProtect Flash Bank # %ld\n",
                               p ? "" : "Un-", bank);

                        for (i = 0; i < info->sector_count; ++i) {
#if defined(CONFIG_SYS_FLASH_PROTECTION)
                                if (flash_real_protect(info, i, p))
                                        rcode = 1;
                                putc('.');
#else
                                info->protect[i] = p;
#endif  /* CONFIG_SYS_FLASH_PROTECTION */
                        }
#if defined(CONFIG_SYS_FLASH_PROTECTION)
                        if (!rcode)
                                puts(" done\n");
#endif  /* CONFIG_SYS_FLASH_PROTECTION */
                }
                return rcode;
        }
        n = abbrev_spec(argv[2], &info, &sect_first, &sect_last);
        if (n) {
                if (n < 0) {
                        puts("Bad sector specification\n");
                        return 1;
                }
                printf("%sProtect Flash Sectors %d-%d in Bank # %zu\n",
                       p ? "" : "Un-", sect_first, sect_last,
                       (info - flash_info) + 1);
                for (i = sect_first; i <= sect_last; i++) {
#if defined(CONFIG_SYS_FLASH_PROTECTION)
                        if (flash_real_protect(info, i, p))
                                rcode =  1;
                        putc('.');
#else
                        info->protect[i] = p;
#endif  /* CONFIG_SYS_FLASH_PROTECTION */
                }

#if defined(CONFIG_SYS_FLASH_PROTECTION)
                if (!rcode)
                        puts(" done\n");
#endif  /* CONFIG_SYS_FLASH_PROTECTION */

                return rcode;
        }

#if defined(CONFIG_CMD_MTDPARTS)
        /* protect on/off <part-id> */
        if (argc == 3 && mtd_id_parse(argv[2], NULL, &dev_type, &dev_num) == 0) {
                mtdparts_init();
                if (find_dev_and_part(argv[2], &dev, &pnum, &part) == 0) {
                        if (dev->id->type == MTD_DEV_TYPE_NOR) {
                                bank = dev->id->num;
                                info = &flash_info[bank];
                                addr_first = part->offset + info->start[0];
                                addr_last = addr_first + part->size - 1;

                                printf("%sProtect Flash Partition %s, "
                                       "bank %ld, 0x%08lx - 0x%08lx\n",
                                       p ? "" : "Un", argv[1],
                                       bank, addr_first, addr_last);

                                rcode = flash_sect_protect(p, addr_first,
                                                           addr_last);
                                return rcode;
                        }

                        printf("cannot %sprotect, not a NOR device\n",
                               p ? "" : "un");
                        return 1;
                }
        }
#endif

        if (argc != 4)
                return CMD_RET_USAGE;

        if (strcmp(argv[2], "bank") == 0) {
                bank = hextoul(argv[3], NULL);
                if (bank < 1 || bank > CFI_FLASH_BANKS) {
                        printf("Only FLASH Banks # 1 ... # %d supported\n",
                               CFI_FLASH_BANKS);
                        return 1;
                }
                printf("%sProtect Flash Bank # %ld\n",
                       p ? "" : "Un-", bank);
                info = &flash_info[bank - 1];

                if (info->flash_id == FLASH_UNKNOWN) {
                        puts("missing or unknown FLASH type\n");
                        return 1;
                }
                for (i = 0; i < info->sector_count; ++i) {
#if defined(CONFIG_SYS_FLASH_PROTECTION)
                        if (flash_real_protect(info, i, p))
                                rcode =  1;
                        putc('.');
#else
                        info->protect[i] = p;
#endif  /* CONFIG_SYS_FLASH_PROTECTION */
                }

#if defined(CONFIG_SYS_FLASH_PROTECTION)
                if (!rcode)
                        puts(" done\n");
#endif  /* CONFIG_SYS_FLASH_PROTECTION */

                return rcode;
        }

        if (addr_spec(argv[2], argv[3], &addr_first, &addr_last) < 0) {
                printf("Bad address format\n");
                return 1;
        }

        if (addr_first >= addr_last)
                return CMD_RET_USAGE;

        rcode = flash_sect_protect(p, addr_first, addr_last);
#endif /* CONFIG_MTD_NOR_FLASH */
        return rcode;
}

#ifdef CONFIG_MTD_NOR_FLASH
int flash_sect_protect(int p, ulong addr_first, ulong addr_last)
{
        flash_info_t *info;
        ulong bank;
        int s_first[CFI_FLASH_BANKS], s_last[CFI_FLASH_BANKS];
        int protected, i;
        int planned;
        int rcode;

        rcode = flash_fill_sect_ranges(addr_first, addr_last, s_first, s_last, &planned);

        protected = 0;

        if (planned && rcode == 0) {
                for (bank = 0, info = &flash_info[0];
                     bank < CFI_FLASH_BANKS; ++bank, ++info) {
                        if (info->flash_id == FLASH_UNKNOWN)
                                continue;

                        if (s_first[bank] >= 0 && s_first[bank] <= s_last[bank]) {
                                debug("%sProtecting sectors %d..%d in bank %ld\n",
                                      p ? "" : "Un-", s_first[bank],
                                      s_last[bank], bank + 1);
                                protected += s_last[bank] - s_first[bank] + 1;
                                for (i = s_first[bank]; i <= s_last[bank]; ++i) {
#if defined(CONFIG_SYS_FLASH_PROTECTION)
                                        if (flash_real_protect(info, i, p))
                                                rcode = 1;
                                        putc('.');
#else
                                        info->protect[i] = p;
#endif  /* CONFIG_SYS_FLASH_PROTECTION */
                                }
                        }
                }
#if defined(CONFIG_SYS_FLASH_PROTECTION)
                puts(" done\n");
#endif  /* CONFIG_SYS_FLASH_PROTECTION */

                printf("%sProtected %d sectors\n",
                       p ? "" : "Un-", protected);
        } else if (rcode == 0) {
                puts("Error: start and/or end address not on sector boundary\n");
                rcode = 1;
        }
        return rcode;
}
#endif /* CONFIG_MTD_NOR_FLASH */

/**************************************************/
#if defined(CONFIG_CMD_MTDPARTS)
# define TMP_ERASE      "erase <part-id>\n    - erase partition\n"
# define TMP_PROT_ON    "protect on <part-id>\n    - protect partition\n"
# define TMP_PROT_OFF   "protect off <part-id>\n    - make partition writable\n"
#else
# define TMP_ERASE      /* empty */
# define TMP_PROT_ON    /* empty */
# define TMP_PROT_OFF   /* empty */
#endif

U_BOOT_CMD(
        flinfo,    2,    1,    do_flinfo,
        "print FLASH memory information",
        "\n    - print information for all FLASH memory banks\n"
        "flinfo N\n    - print information for FLASH memory bank # N"
);

U_BOOT_CMD(
        erase,   3,   0,  do_flerase,
        "erase FLASH memory",
        "start end\n"
        "    - erase FLASH from addr 'start' to addr 'end'\n"
        "erase start +len\n"
        "    - erase FLASH from addr 'start' to the end of sect w/addr 'start'+'len'-1\n"
        "erase N:SF[-SL]\n    - erase sectors SF-SL in FLASH bank # N\n"
        "erase bank N\n    - erase FLASH bank # N\n"
        TMP_ERASE
        "erase all\n    - erase all FLASH banks"
);

U_BOOT_CMD(
        protect,  4,  0,   do_protect,
        "enable or disable FLASH write protection",
        "on  start end\n"
        "    - protect FLASH from addr 'start' to addr 'end'\n"
        "protect on start +len\n"
        "    - protect FLASH from addr 'start' to end of sect w/addr 'start'+'len'-1\n"
        "protect on  N:SF[-SL]\n"
        "    - protect sectors SF-SL in FLASH bank # N\n"
        "protect on  bank N\n    - protect FLASH bank # N\n"
        TMP_PROT_ON
        "protect on  all\n    - protect all FLASH banks\n"
        "protect off start end\n"
        "    - make FLASH from addr 'start' to addr 'end' writable\n"
        "protect off start +len\n"
        "    - make FLASH from addr 'start' to end of sect w/addr 'start'+'len'-1 wrtable\n"
        "protect off N:SF[-SL]\n"
        "    - make sectors SF-SL writable in FLASH bank # N\n"
        "protect off bank N\n    - make FLASH bank # N writable\n"
        TMP_PROT_OFF
        "protect off all\n    - make all FLASH banks writable"
);

#undef  TMP_ERASE
#undef  TMP_PROT_ON
#undef  TMP_PROT_OFF