/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2012 Semihalf
 * Copyright (c) 2009 Jakub Klama <jakub.klama@uj.edu.pl>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/slicer.h>

#include <geom/geom.h>
#include <geom/geom_disk.h>
#include <geom/geom_flashmap.h>
#include <geom/geom_slice.h>

struct g_flashmap_slice {
        off_t           sl_start;
        off_t           sl_end;
        const char      *sl_name;

        STAILQ_ENTRY(g_flashmap_slice) sl_link;
};

STAILQ_HEAD(g_flashmap_head, g_flashmap_slice);

static struct {
        const char      *type;
        flash_slicer_t  slicer;
} g_flashmap_slicers[] = {
        { "NAND::device",       NULL },
        { "CFI::device",        NULL },
        { "SPI::device",        NULL },
        { "MMC::device",        NULL }
};

static g_taste_t g_flashmap_taste;

static int g_flashmap_load(device_t dev, struct g_provider *pp,
    flash_slicer_t slicer, struct g_flashmap_head *head);
static int g_flashmap_modify(struct g_flashmap *gfp, struct g_geom *gp,
    const char *devname, int secsize, struct g_flashmap_head *slices);
static void g_flashmap_print(struct g_flashmap_slice *slice);

MALLOC_DECLARE(M_FLASHMAP);
MALLOC_DEFINE(M_FLASHMAP, "geom_flashmap", "GEOM flash memory slicer class");

static void
g_flashmap_print(struct g_flashmap_slice *slice)
{

        printf("%08jx-%08jx: %s (%juKB)\n", (uintmax_t)slice->sl_start,
            (uintmax_t)slice->sl_end, slice->sl_name,
            (uintmax_t)(slice->sl_end - slice->sl_start) / 1024);
}

static int
g_flashmap_modify(struct g_flashmap *gfp, struct g_geom *gp,
    const char *devname, int secsize, struct g_flashmap_head *slices)
{
        struct g_flashmap_slice *slice;
        int i, error;

        g_topology_assert();

        i = 0;
        STAILQ_FOREACH(slice, slices, sl_link) {
                if (bootverbose) {
                        printf("%s: slice ", devname);
                        g_flashmap_print(slice);
                }

                error = g_slice_config(gp, i++, G_SLICE_CONFIG_CHECK,
                    slice->sl_start,
                    slice->sl_end - slice->sl_start + 1,
                    secsize, FLASH_SLICES_FMT, gp->name, slice->sl_name);

                if (error)
                        return (error);
        }

        i = 0;
        STAILQ_FOREACH(slice, slices, sl_link) {
                free(__DECONST(void *, gfp->labels[i]), M_FLASHMAP);
                gfp->labels[i] = strdup(slice->sl_name, M_FLASHMAP);
                error = g_slice_config(gp, i++, G_SLICE_CONFIG_SET,
                    slice->sl_start,
                    slice->sl_end - slice->sl_start + 1,
                    secsize, "%ss.%s", gp->name, slice->sl_name);

                if (error)
                        return (error);
        }

        return (0);
}

static struct g_geom *
g_flashmap_taste(struct g_class *mp, struct g_provider *pp, int flags)
{
        struct g_geom *gp;
        struct g_consumer *cp;
        struct g_flashmap_head head;
        struct g_flashmap_slice *slice, *slice_temp;
        struct g_flashmap *gfp;
        flash_slicer_t slicer;
        device_t dev;
        int i, size;

        g_trace(G_T_TOPOLOGY, "flashmap_taste(%s,%s)", mp->name, pp->name);
        g_topology_assert();

        if (flags == G_TF_NORMAL &&
            strcmp(pp->geom->class->name, G_DISK_CLASS_NAME) != 0)
                return (NULL);

        gp = g_slice_new(mp, FLASH_SLICES_MAX_NUM, pp, &cp, (void**)&gfp,
            sizeof(struct g_flashmap), NULL);
        if (gp == NULL)
                return (NULL);

        STAILQ_INIT(&head);

        do {
                slicer = NULL;
                for (i = 0; i < nitems(g_flashmap_slicers); i++) {
                        size = sizeof(device_t);
                        if (g_io_getattr(g_flashmap_slicers[i].type, cp,
                            &size, &dev) == 0) {
                                slicer = g_flashmap_slicers[i].slicer;
                                break;
                        }
                }
                if (slicer == NULL)
                        break;

                if (g_flashmap_load(dev, pp, slicer, &head) == 0)
                        break;

                g_flashmap_modify(gfp, gp, cp->provider->name,
                    cp->provider->sectorsize, &head);
        } while (0);

        g_access(cp, -1, 0, 0);

        STAILQ_FOREACH_SAFE(slice, &head, sl_link, slice_temp)
                free(slice, M_FLASHMAP);

        if (LIST_EMPTY(&gp->provider)) {
                g_slice_spoiled(cp);
                return (NULL);
        }
        return (gp);
}

static int
g_flashmap_load(device_t dev, struct g_provider *pp, flash_slicer_t slicer,
    struct g_flashmap_head *head)
{
        struct flash_slice *slices;
        struct g_flashmap_slice *slice;
        int i, nslices = 0;

        slices = malloc(sizeof(struct flash_slice) * FLASH_SLICES_MAX_NUM,
            M_FLASHMAP, M_WAITOK | M_ZERO);
        if (slicer(dev, pp->name, slices, &nslices) == 0) {
                for (i = 0; i < nslices; i++) {
                        slice = malloc(sizeof(struct g_flashmap_slice),
                            M_FLASHMAP, M_WAITOK);

                        slice->sl_name = slices[i].label;
                        slice->sl_start = slices[i].base;
                        slice->sl_end = slices[i].base + slices[i].size - 1;

                        STAILQ_INSERT_TAIL(head, slice, sl_link);
                }
        }

        free(slices, M_FLASHMAP);
        return (nslices);
}

void flash_register_slicer(flash_slicer_t slicer, u_int type, bool force)
{

        g_topology_lock();
        if (g_flashmap_slicers[type].slicer == NULL || force == TRUE)
                g_flashmap_slicers[type].slicer = slicer;
        g_topology_unlock();
}

static struct g_class g_flashmap_class = {
        .name = FLASHMAP_CLASS_NAME,
        .version = G_VERSION,
        .taste = g_flashmap_taste,
};

DECLARE_GEOM_CLASS(g_flashmap_class, g_flashmap);
MODULE_VERSION(geom_flashmap, 0);