/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2001,2002,2003 Søren Schmidt <sos@FreeBSD.org>
 * 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,
 *    without modification, immediately at the beginning of the file.
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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/module.h>
#include <sys/bio.h>
#include <sys/bus.h>
#include <sys/conf.h>
#include <sys/eventhandler.h>
#include <sys/kernel.h>
#include <sys/lock.h>
#include <sys/malloc.h>
#include <sys/mutex.h>
#include <sys/proc.h>
#include <sys/rman.h>
#include <sys/stdarg.h>

#include <vm/vm.h>
#include <vm/pmap.h>

#include <machine/resource.h>
#include <machine/bus.h>

#include <dev/pci/pcivar.h>
#include <dev/pci/pcireg.h>
#include "dev/pst/pst-iop.h"

#include <geom/geom_disk.h>

struct pst_softc {
    struct iop_softc            *iop;
    struct i2o_lct_entry        *lct;
    struct i2o_bsa_device       *info;
    struct disk                 *disk;
    struct bio_queue_head       queue;
};

struct pst_request {
    struct pst_softc            *psc;           /* pointer to softc */
    u_int32_t                   mfa;            /* frame addreess */
    struct callout              timeout;        /* timeout timer */
    struct bio                  *bp;            /* associated bio ptr */
};

/* prototypes */
static disk_strategy_t pststrategy;
static int pst_probe(device_t);
static int pst_attach(device_t);
static void pst_shutdown_post_sync(device_t, int);
static void pst_start(struct pst_softc *);
static void pst_done(struct iop_softc *, u_int32_t, struct i2o_single_reply *);
static int pst_rw(struct pst_request *);
static void pst_timeout(void *);
static void bpack(int8_t *, int8_t *, int);

/* local vars */
static MALLOC_DEFINE(M_PSTRAID, "pst", "Promise SuperTrak RAID driver");

int
pst_add_raid(struct iop_softc *sc, struct i2o_lct_entry *lct)
{
    struct pst_softc *psc;
    device_t child = device_add_child(sc->dev, "pst", DEVICE_UNIT_ANY);

    if (!child)
        return ENOMEM;
    if (!(psc = malloc(sizeof(struct pst_softc), 
                       M_PSTRAID, M_NOWAIT | M_ZERO))) {
        device_delete_child(sc->dev, child);
        return ENOMEM;
    }
    psc->iop = sc;
    psc->lct = lct;
    device_set_softc(child, psc);
    return device_probe_and_attach(child);
}

static int
pst_probe(device_t dev)
{
    device_set_desc(dev, "Promise SuperTrak RAID");
    return 0;
}

static int
pst_attach(device_t dev)
{
    struct pst_softc *psc = device_get_softc(dev);
    struct i2o_get_param_reply *reply;
    struct i2o_device_identity *ident;
    int lun = device_get_unit(dev);
    int8_t name [32];

    if (!(reply = iop_get_util_params(psc->iop, psc->lct->local_tid,
                                      I2O_PARAMS_OPERATION_FIELD_GET,
                                      I2O_BSA_DEVICE_INFO_GROUP_NO)))
        return ENODEV;

    if (!(psc->info = (struct i2o_bsa_device *)
            malloc(sizeof(struct i2o_bsa_device), M_PSTRAID, M_NOWAIT))) {
        free(reply, M_PSTIOP);
        return ENOMEM;
    }
    bcopy(reply->result, psc->info, sizeof(struct i2o_bsa_device));
    free(reply, M_PSTIOP);

    if (!(reply = iop_get_util_params(psc->iop, psc->lct->local_tid,
                                      I2O_PARAMS_OPERATION_FIELD_GET,
                                      I2O_UTIL_DEVICE_IDENTITY_GROUP_NO)))
        return ENODEV;
    ident = (struct i2o_device_identity *)reply->result;
#ifdef PSTDEBUG    
    printf("pst: vendor=<%.16s> product=<%.16s>\n",
           ident->vendor, ident->product);
    printf("pst: description=<%.16s> revision=<%.8s>\n",
           ident->description, ident->revision);
    printf("pst: capacity=%lld blocksize=%d\n",
           psc->info->capacity, psc->info->block_size);
#endif
    bpack(ident->vendor, ident->vendor, 16);
    bpack(ident->product, ident->product, 16);
    sprintf(name, "%s %s", ident->vendor, ident->product);
    free(reply, M_PSTIOP);

    bioq_init(&psc->queue);

    psc->disk = disk_alloc();
    psc->disk->d_name = "pst";
    psc->disk->d_strategy = pststrategy;
    psc->disk->d_maxsize = 64 * 1024; /*I2O_SGL_MAX_SEGS * PAGE_SIZE;*/
    psc->disk->d_drv1 = psc;
    psc->disk->d_unit = lun;

    psc->disk->d_sectorsize = psc->info->block_size;
    psc->disk->d_mediasize = psc->info->capacity;
    psc->disk->d_fwsectors = 63;
    psc->disk->d_fwheads = 255;

    disk_create(psc->disk, DISK_VERSION);

    printf("pst%d: %lluMB <%.40s> [%lld/%d/%d] on %.16s\n", lun,
           (unsigned long long)psc->info->capacity / (1024 * 1024),
           name, psc->info->capacity/(512*255*63), 255, 63,
           device_get_nameunit(psc->iop->dev));

    EVENTHANDLER_REGISTER(shutdown_post_sync, pst_shutdown_post_sync,
                          dev, SHUTDOWN_PRI_FIRST);
    return 0;
}

static void
pst_shutdown_post_sync(device_t dev, int howto __unused)
{
    struct pst_softc *psc = device_get_softc(dev);
    struct i2o_bsa_cache_flush_message *msg;
    int mfa;

    if (SCHEDULER_STOPPED()) {
        /* Request polled shutdown. */
        psc->iop->reg->oqueue_intr_mask = 0xffffffff;
    }

    mfa = iop_get_mfa(psc->iop);
    msg = (struct i2o_bsa_cache_flush_message *)(psc->iop->ibase + mfa);
    bzero(msg, sizeof(struct i2o_bsa_cache_flush_message));
    msg->version_offset = 0x01;
    msg->message_flags = 0x0;
    msg->message_size = sizeof(struct i2o_bsa_cache_flush_message) >> 2;
    msg->target_address = psc->lct->local_tid;
    msg->initiator_address = I2O_TID_HOST;
    msg->function = I2O_BSA_CACHE_FLUSH;
    msg->control_flags = 0x0; /* 0x80 = post progress reports */
    if (iop_queue_wait_msg(psc->iop, mfa, (struct i2o_basic_message *)msg))
        printf("pst: shutdown failed!\n");
}

static void
pststrategy(struct bio *bp)
{
    struct pst_softc *psc = bp->bio_disk->d_drv1;
    
    mtx_lock(&psc->iop->mtx);
    bioq_disksort(&psc->queue, bp);
    pst_start(psc);
    mtx_unlock(&psc->iop->mtx);
}

static void
pst_start(struct pst_softc *psc)
{
    struct pst_request *request;
    struct bio *bp;
    u_int32_t mfa;
    int error;

    if (psc->iop->outstanding < (I2O_IOP_OUTBOUND_FRAME_COUNT - 1) &&
        (bp = bioq_first(&psc->queue))) {
        if ((mfa = iop_get_mfa(psc->iop)) != 0xffffffff) {
            bioq_remove(&psc->queue, bp);
            if (!(request = malloc(sizeof(struct pst_request),
                                   M_PSTRAID, M_NOWAIT | M_ZERO))) {
                printf("pst: out of memory in start\n");
                biofinish(request->bp, NULL, ENOMEM);
                iop_free_mfa(psc->iop, mfa);
                return;
            }
            callout_init_mtx(&request->timeout, &psc->iop->mtx, 0);
            psc->iop->outstanding++;
            request->psc = psc;
            request->mfa = mfa;
            request->bp = bp;
            if ((error = pst_rw(request)) != 0) {
                biofinish(request->bp, NULL, error);
                iop_free_mfa(request->psc->iop, request->mfa);
                psc->iop->outstanding--;
                free(request, M_PSTRAID);
            }
        }
    }
}

static void
pst_done(struct iop_softc *sc, u_int32_t mfa, struct i2o_single_reply *reply)
{
    struct pst_request *request =
        (struct pst_request *)reply->transaction_context;
    struct pst_softc *psc = request->psc;

    callout_stop(&request->timeout);
    request->bp->bio_resid = request->bp->bio_bcount - reply->donecount;
    biofinish(request->bp, NULL, reply->status ? EIO : 0);
    free(request, M_PSTRAID);
    psc->iop->reg->oqueue = mfa;
    psc->iop->outstanding--;
    pst_start(psc);
}

int
pst_rw(struct pst_request *request)
{
    struct i2o_bsa_rw_block_message *msg;
    int sgl_flag;

    msg = (struct i2o_bsa_rw_block_message *)
          (request->psc->iop->ibase + request->mfa);
    bzero(msg, sizeof(struct i2o_bsa_rw_block_message));
    msg->version_offset = 0x81;
    msg->message_flags = 0x0;
    msg->message_size = sizeof(struct i2o_bsa_rw_block_message) >> 2;
    msg->target_address = request->psc->lct->local_tid;
    msg->initiator_address = I2O_TID_HOST;
    switch (request->bp->bio_cmd) {
    case BIO_READ:
        msg->function = I2O_BSA_BLOCK_READ;
        msg->control_flags = 0x0; /* 0x0c = read cache + readahead */
        msg->fetch_ahead = 0x0; /* 8 Kb */
        sgl_flag = 0;
        break;
    case BIO_WRITE:
        msg->function = I2O_BSA_BLOCK_WRITE;
        msg->control_flags = 0x0; /* 0x10 = write behind cache */
        msg->fetch_ahead = 0x0;
        sgl_flag = I2O_SGL_DIR;
        break;
    default:
        printf("pst: unknown command type 0x%02x\n", request->bp->bio_cmd);
        return EOPNOTSUPP;
    }
    msg->initiator_context = (u_int32_t)pst_done;
    msg->transaction_context = (u_int32_t)request;
    msg->time_multiplier = 1;
    msg->bytecount = request->bp->bio_bcount;
    msg->lba = ((u_int64_t)request->bp->bio_pblkno) * (DEV_BSIZE * 1LL);

    if (!iop_create_sgl((struct i2o_basic_message *)msg, request->bp->bio_data,
                        request->bp->bio_bcount, sgl_flag))
        return EIO;

    request->psc->iop->reg->iqueue = request->mfa;

    if (!dumping)
        callout_reset(&request->timeout, 10 * hz, pst_timeout, request);
    return 0;
}

static void
pst_timeout(void *arg)
{
    struct pst_request *request;
    int error;

    request = arg;
    printf("pst: timeout mfa=0x%08x cmd=0x%02x\n",
           request->mfa, request->bp->bio_cmd);
    mtx_assert(&request->psc->iop->mtx, MA_OWNED);
    iop_free_mfa(request->psc->iop, request->mfa);
    if ((request->mfa = iop_get_mfa(request->psc->iop)) == 0xffffffff) {
        printf("pst: timeout no mfa possible\n");
        biofinish(request->bp, NULL, EIO);
        request->psc->iop->outstanding--;
        return;
    }
    if ((error = pst_rw(request)) != 0) {
        iop_free_mfa(request->psc->iop, request->mfa);
        biofinish(request->bp, NULL, error);
        request->psc->iop->outstanding--;
    }
}

static void
bpack(int8_t *src, int8_t *dst, int len)
{
    int i, j, blank;
    int8_t *ptr, *buf = dst;

    for (i = j = blank = 0 ; i < len; i++) {
        if (blank && src[i] == ' ')
            continue;
        if (blank && src[i] != ' ') {
            dst[j++] = src[i];
            blank = 0;
            continue;
        }
        if (src[i] == ' ') {
            blank = 1;
            if (i == 0)
                continue;
        }
        dst[j++] = src[i];
    }
    if (j < len) 
        dst[j] = 0x00;
    for (ptr = buf; ptr < buf+len; ++ptr)
        if (!*ptr)
            *ptr = ' ';
    for (ptr = buf + len - 1; ptr >= buf && *ptr == ' '; --ptr)
        *ptr = 0;
}

static device_method_t pst_methods[] = {
    DEVMETHOD(device_probe,     pst_probe),
    DEVMETHOD(device_attach,    pst_attach),
    DEVMETHOD_END
};

static driver_t pst_driver = {
    "pst",
    pst_methods,
    sizeof(struct pst_softc),
};

DRIVER_MODULE(pst, pstpci, pst_driver, 0, 0);