/*
 * Flash mappings described by the OF (or flattened) device tree
 *
 * Copyright (C) 2006 MontaVista Software Inc.
 * Author: Vitaly Wool <vwool@ru.mvista.com>
 *
 * Revised to handle newer style flash binding by:
 *   Copyright (C) 2007 David Gibson, IBM Corporation.
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/map.h>
#include <linux/mtd/partitions.h>
#include <linux/mtd/concat.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_platform.h>
#include <linux/slab.h>

struct of_flash_list {
        struct mtd_info *mtd;
        struct map_info map;
        struct resource *res;
};

struct of_flash {
        struct mtd_info         *cmtd;
#ifdef CONFIG_MTD_PARTITIONS
        struct mtd_partition    *parts;
#endif
        int list_size; /* number of elements in of_flash_list */
        struct of_flash_list    list[0];
};

#ifdef CONFIG_MTD_PARTITIONS
#define OF_FLASH_PARTS(info)    ((info)->parts)

static int parse_obsolete_partitions(struct platform_device *dev,
                                     struct of_flash *info,
                                     struct device_node *dp)
{
        int i, plen, nr_parts;
        const struct {
                __be32 offset, len;
        } *part;
        const char *names;

        part = of_get_property(dp, "partitions", &plen);
        if (!part)
                return 0; /* No partitions found */

        dev_warn(&dev->dev, "Device tree uses obsolete partition map binding\n");

        nr_parts = plen / sizeof(part[0]);

        info->parts = kzalloc(nr_parts * sizeof(*info->parts), GFP_KERNEL);
        if (!info->parts)
                return -ENOMEM;

        names = of_get_property(dp, "partition-names", &plen);

        for (i = 0; i < nr_parts; i++) {
                info->parts[i].offset = be32_to_cpu(part->offset);
                info->parts[i].size   = be32_to_cpu(part->len) & ~1;
                if (be32_to_cpu(part->len) & 1) /* bit 0 set signifies read only partition */
                        info->parts[i].mask_flags = MTD_WRITEABLE;

                if (names && (plen > 0)) {
                        int len = strlen(names) + 1;

                        info->parts[i].name = (char *)names;
                        plen -= len;
                        names += len;
                } else {
                        info->parts[i].name = "unnamed";
                }

                part++;
        }

        return nr_parts;
}
#else /* MTD_PARTITIONS */
#define OF_FLASH_PARTS(info)            (0)
#define parse_partitions(info, dev)     (0)
#endif /* MTD_PARTITIONS */

static int of_flash_remove(struct platform_device *dev)
{
        struct of_flash *info;
        int i;

        info = dev_get_drvdata(&dev->dev);
        if (!info)
                return 0;
        dev_set_drvdata(&dev->dev, NULL);

#ifdef CONFIG_MTD_CONCAT
        if (info->cmtd != info->list[0].mtd) {
                del_mtd_device(info->cmtd);
                mtd_concat_destroy(info->cmtd);
        }
#endif

        if (info->cmtd) {
                if (OF_FLASH_PARTS(info)) {
                        del_mtd_partitions(info->cmtd);
                        kfree(OF_FLASH_PARTS(info));
                } else {
                        del_mtd_device(info->cmtd);
                }
        }

        for (i = 0; i < info->list_size; i++) {
                if (info->list[i].mtd)
                        map_destroy(info->list[i].mtd);

                if (info->list[i].map.virt)
                        iounmap(info->list[i].map.virt);

                if (info->list[i].res) {
                        release_resource(info->list[i].res);
                        kfree(info->list[i].res);
                }
        }

        kfree(info);

        return 0;
}

/* Helper function to handle probing of the obsolete "direct-mapped"
 * compatible binding, which has an extra "probe-type" property
 * describing the type of flash probe necessary. */
static struct mtd_info * __devinit obsolete_probe(struct platform_device *dev,
                                                  struct map_info *map)
{
        struct device_node *dp = dev->dev.of_node;
        const char *of_probe;
        struct mtd_info *mtd;
        static const char *rom_probe_types[]
                = { "cfi_probe", "jedec_probe", "map_rom"};
        int i;

        dev_warn(&dev->dev, "Device tree uses obsolete \"direct-mapped\" "
                 "flash binding\n");

        of_probe = of_get_property(dp, "probe-type", NULL);
        if (!of_probe) {
                for (i = 0; i < ARRAY_SIZE(rom_probe_types); i++) {
                        mtd = do_map_probe(rom_probe_types[i], map);
                        if (mtd)
                                return mtd;
                }
                return NULL;
        } else if (strcmp(of_probe, "CFI") == 0) {
                return do_map_probe("cfi_probe", map);
        } else if (strcmp(of_probe, "JEDEC") == 0) {
                return do_map_probe("jedec_probe", map);
        } else {
                if (strcmp(of_probe, "ROM") != 0)
                        dev_warn(&dev->dev, "obsolete_probe: don't know probe "
                                 "type '%s', mapping as rom\n", of_probe);
                return do_map_probe("mtd_rom", map);
        }
}

#ifdef CONFIG_MTD_PARTITIONS
/* When partitions are set we look for a linux,part-probe property which
   specifies the list of partition probers to use. If none is given then the
   default is use. These take precedence over other device tree
   information. */
static const char *part_probe_types_def[] = { "cmdlinepart", "RedBoot", NULL };
static const char ** __devinit of_get_probes(struct device_node *dp)
{
        const char *cp;
        int cplen;
        unsigned int l;
        unsigned int count;
        const char **res;

        cp = of_get_property(dp, "linux,part-probe", &cplen);
        if (cp == NULL)
                return part_probe_types_def;

        count = 0;
        for (l = 0; l != cplen; l++)
                if (cp[l] == 0)
                        count++;

        res = kzalloc((count + 1)*sizeof(*res), GFP_KERNEL);
        count = 0;
        while (cplen > 0) {
                res[count] = cp;
                l = strlen(cp) + 1;
                cp += l;
                cplen -= l;
                count++;
        }
        return res;
}

static void __devinit of_free_probes(const char **probes)
{
        if (probes != part_probe_types_def)
                kfree(probes);
}
#endif

static int __devinit of_flash_probe(struct platform_device *dev,
                                    const struct of_device_id *match)
{
#ifdef CONFIG_MTD_PARTITIONS
        const char **part_probe_types;
#endif
        struct device_node *dp = dev->dev.of_node;
        struct resource res;
        struct of_flash *info;
        const char *probe_type = match->data;
        const __be32 *width;
        int err;
        int i;
        int count;
        const __be32 *p;
        int reg_tuple_size;
        struct mtd_info **mtd_list = NULL;
        resource_size_t res_size;

        reg_tuple_size = (of_n_addr_cells(dp) + of_n_size_cells(dp)) * sizeof(u32);

        /*
         * Get number of "reg" tuples. Scan for MTD devices on area's
         * described by each "reg" region. This makes it possible (including
         * the concat support) to support the Intel P30 48F4400 chips which
         * consists internally of 2 non-identical NOR chips on one die.
         */
        p = of_get_property(dp, "reg", &count);
        if (count % reg_tuple_size != 0) {
                dev_err(&dev->dev, "Malformed reg property on %s\n",
                                dev->dev.of_node->full_name);
                err = -EINVAL;
                goto err_flash_remove;
        }
        count /= reg_tuple_size;

        err = -ENOMEM;
        info = kzalloc(sizeof(struct of_flash) +
                       sizeof(struct of_flash_list) * count, GFP_KERNEL);
        if (!info)
                goto err_flash_remove;

        dev_set_drvdata(&dev->dev, info);

        mtd_list = kzalloc(sizeof(*mtd_list) * count, GFP_KERNEL);
        if (!mtd_list)
                goto err_flash_remove;

        for (i = 0; i < count; i++) {
                err = -ENXIO;
                if (of_address_to_resource(dp, i, &res)) {
                        /*
                         * Continue with next register tuple if this
                         * one is not mappable
                         */
                        continue;
                }

                dev_dbg(&dev->dev, "of_flash device: %pR\n", &res);

                err = -EBUSY;
                res_size = resource_size(&res);
                info->list[i].res = request_mem_region(res.start, res_size,
                                                       dev_name(&dev->dev));
                if (!info->list[i].res)
                        goto err_out;

                err = -ENXIO;
                width = of_get_property(dp, "bank-width", NULL);
                if (!width) {
                        dev_err(&dev->dev, "Can't get bank width from device"
                                " tree\n");
                        goto err_out;
                }

                info->list[i].map.name = dev_name(&dev->dev);
                info->list[i].map.phys = res.start;
                info->list[i].map.size = res_size;
                info->list[i].map.bankwidth = be32_to_cpup(width);

                err = -ENOMEM;
                info->list[i].map.virt = ioremap(info->list[i].map.phys,
                                                 info->list[i].map.size);
                if (!info->list[i].map.virt) {
                        dev_err(&dev->dev, "Failed to ioremap() flash"
                                " region\n");
                        goto err_out;
                }

                simple_map_init(&info->list[i].map);

                if (probe_type) {
                        info->list[i].mtd = do_map_probe(probe_type,
                                                         &info->list[i].map);
                } else {
                        info->list[i].mtd = obsolete_probe(dev,
                                                           &info->list[i].map);
                }
                mtd_list[i] = info->list[i].mtd;

                err = -ENXIO;
                if (!info->list[i].mtd) {
                        dev_err(&dev->dev, "do_map_probe() failed\n");
                        goto err_out;
                } else {
                        info->list_size++;
                }
                info->list[i].mtd->owner = THIS_MODULE;
                info->list[i].mtd->dev.parent = &dev->dev;
        }

        err = 0;
        if (info->list_size == 1) {
                info->cmtd = info->list[0].mtd;
        } else if (info->list_size > 1) {
                /*
                 * We detected multiple devices. Concatenate them together.
                 */
#ifdef CONFIG_MTD_CONCAT
                info->cmtd = mtd_concat_create(mtd_list, info->list_size,
                                               dev_name(&dev->dev));
                if (info->cmtd == NULL)
                        err = -ENXIO;
#else
                printk(KERN_ERR "physmap_of: multiple devices "
                       "found but MTD concat support disabled.\n");
                err = -ENXIO;
#endif
        }
        if (err)
                goto err_out;

#ifdef CONFIG_MTD_PARTITIONS
        part_probe_types = of_get_probes(dp);
        err = parse_mtd_partitions(info->cmtd, part_probe_types,
                                   &info->parts, 0);
        if (err < 0) {
                of_free_probes(part_probe_types);
                goto err_out;
        }
        of_free_probes(part_probe_types);

#ifdef CONFIG_MTD_OF_PARTS
        if (err == 0) {
                err = of_mtd_parse_partitions(&dev->dev, dp, &info->parts);
                if (err < 0)
                        goto err_out;
        }
#endif

        if (err == 0) {
                err = parse_obsolete_partitions(dev, info, dp);
                if (err < 0)
                        goto err_out;
        }

        if (err > 0)
                add_mtd_partitions(info->cmtd, info->parts, err);
        else
#endif
                add_mtd_device(info->cmtd);

        kfree(mtd_list);

        return 0;

err_out:
        kfree(mtd_list);
err_flash_remove:
        of_flash_remove(dev);

        return err;
}

static struct of_device_id of_flash_match[] = {
        {
                .compatible     = "cfi-flash",
                .data           = (void *)"cfi_probe",
        },
        {
                /* FIXME: JEDEC chips can't be safely and reliably
                 * probed, although the mtd code gets it right in
                 * practice most of the time.  We should use the
                 * vendor and device ids specified by the binding to
                 * bypass the heuristic probe code, but the mtd layer
                 * provides, at present, no interface for doing so
                 * :(. */
                .compatible     = "jedec-flash",
                .data           = (void *)"jedec_probe",
        },
        {
                .compatible     = "mtd-ram",
                .data           = (void *)"map_ram",
        },
        {
                .type           = "rom",
                .compatible     = "direct-mapped"
        },
        { },
};
MODULE_DEVICE_TABLE(of, of_flash_match);

static struct of_platform_driver of_flash_driver = {
        .driver = {
                .name = "of-flash",
                .owner = THIS_MODULE,
                .of_match_table = of_flash_match,
        },
        .probe          = of_flash_probe,
        .remove         = of_flash_remove,
};

static int __init of_flash_init(void)
{
        return of_register_platform_driver(&of_flash_driver);
}

static void __exit of_flash_exit(void)
{
        of_unregister_platform_driver(&of_flash_driver);
}

module_init(of_flash_init);
module_exit(of_flash_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Vitaly Wool <vwool@ru.mvista.com>");
MODULE_DESCRIPTION("Device tree based MTD map driver");