/*      $NetBSD: ld_icp.c,v 1.33 2025/04/13 02:34:03 rin Exp $  */

/*-
* Copyright (c) 2002 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Andrew Doran.
*
* 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
*/

/*
* ICP-Vortex "GDT" front-end for ld(4) driver.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ld_icp.c,v 1.33 2025/04/13 02:34:03 rin Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/device.h>
#include <sys/buf.h>
#include <sys/bufq.h>
#include <sys/endian.h>
#include <sys/dkio.h>
#include <sys/disk.h>
#include <sys/module.h>
#include <sys/bus.h>

#include <dev/ldvar.h>

#include <dev/ic/icpreg.h>
#include <dev/ic/icpvar.h>

#include "ioconf.h"

struct ld_icp_softc {
       struct  ld_softc sc_ld;
       int     sc_hwunit;
};

static void     ld_icp_attach(device_t, device_t, void *);
static int      ld_icp_detach(device_t, int);
static int      ld_icp_dobio(struct ld_icp_softc *, void *, int, int, int,
                    struct buf *);
static int      ld_icp_dump(struct ld_softc *, void *, daddr_t, int);
static int      ld_icp_flush(struct ld_softc *, bool);
static int      ld_icp_ioctl(struct ld_softc *, u_long, void *, int32_t, bool);
static void     ld_icp_intr(struct icp_ccb *);
static int      ld_icp_match(device_t, cfdata_t, void *);
static int      ld_icp_start(struct ld_softc *, struct buf *);

static void     ld_icp_adjqparam(device_t, int);

CFATTACH_DECL_NEW(ld_icp, sizeof(struct ld_icp_softc),
   ld_icp_match, ld_icp_attach, ld_icp_detach, NULL);

static const struct icp_servicecb ld_icp_servicecb = {
       ld_icp_adjqparam,
};

static int
ld_icp_match(device_t parent, cfdata_t match, void *aux)
{
       struct icp_attach_args *icpa;

       icpa = aux;

       return (icpa->icpa_unit < ICPA_UNIT_SCSI);
}

static void
ld_icp_attach(device_t parent, device_t self, void *aux)
{
       struct icp_attach_args *icpa = aux;
       struct ld_icp_softc *sc = device_private(self);
       struct ld_softc *ld = &sc->sc_ld;
       struct icp_softc *icp = device_private(parent);
       struct icp_cachedrv *cd = &icp->icp_cdr[icpa->icpa_unit];
       struct icp_cdevinfo *cdi;
       const char *str;
       int t;

       ld->sc_dv = self;

       icp_register_servicecb(icp, icpa->icpa_unit, &ld_icp_servicecb);

       sc->sc_hwunit = icpa->icpa_unit;
       ld->sc_maxxfer = ICP_MAX_XFER;
       ld->sc_secsize = ICP_SECTOR_SIZE;
       ld->sc_start = ld_icp_start;
       ld->sc_dump = ld_icp_dump;
       ld->sc_ioctl = ld_icp_ioctl;
       ld->sc_secperunit = cd->cd_size;
       ld->sc_flags = LDF_ENABLED;
       ld->sc_maxqueuecnt = icp->icp_openings;

       if (!icp_cmd(icp, ICP_CACHESERVICE, ICP_IOCTL, ICP_CACHE_DRV_INFO,
           sc->sc_hwunit, sizeof(struct icp_cdevinfo))) {
               aprint_error(": unable to retrieve device info\n");
               ld->sc_flags = LDF_ENABLED;
               goto out;
       }
       cdi = (struct icp_cdevinfo *)icp->icp_scr;

       aprint_normal(": <%.8s>, ", cdi->ld_name);
       t = le32toh(cdi->ld_dtype) >> 16;

       /*
        * Print device type.
        */
       if (le32toh(cdi->ld_dcnt) > 1 || le32toh(cdi->ld_slave) != -1)
               str = "RAID-1";
       else if (t == 0)
               str = "JBOD";
       else if (t == 1)
               str = "RAID-0";
       else if (t == 2)
               str = "Chain";
       else
               str = "unknown type";

       aprint_normal("type: %s, ", str);

       /*
        * Print device status.
        */
       if (t > 2)
               str = "missing";
       else if ((cdi->ld_error & 1) != 0) {
               str = "fault";
               ld->sc_flags = LDF_ENABLED;
       } else if ((cdi->ld_error & 2) != 0)
               str = "invalid";
       else {
               str = "optimal";
               ld->sc_flags = LDF_ENABLED;
       }

       aprint_normal("status: %s\n", str);

out:
       ldattach(ld, BUFQ_DISK_DEFAULT_STRAT);
}

static int
ld_icp_detach(device_t dv, int flags)
{
       struct ld_softc *ldsc = device_private(dv);
       int rv;

       if ((rv = ldbegindetach(ldsc, flags)) != 0)
               return (rv);
       ldenddetach(ldsc);

       return (0);
}

static int
ld_icp_dobio(struct ld_icp_softc *sc, void *data, int datasize, int blkno,
            int dowrite, struct buf *bp)
{
       struct icp_cachecmd *cc;
       struct icp_ccb *ic;
       struct icp_softc *icp;
       int s, rv;

       icp = device_private(device_parent(sc->sc_ld.sc_dv));

       /*
        * Allocate a command control block.
        */
       if (__predict_false((ic = icp_ccb_alloc(icp)) == NULL))
               return (EAGAIN);

       /*
        * Map the data transfer.
        */
       cc = &ic->ic_cmd.cmd_packet.cc;
       ic->ic_sg = cc->cc_sg;
       ic->ic_service = ICP_CACHESERVICE;

       rv = icp_ccb_map(icp, ic, data, datasize,
           dowrite ? IC_XFER_OUT : IC_XFER_IN);
       if (rv != 0) {
               icp_ccb_free(icp, ic);
               return (rv);
       }

       /*
        * Build the command.
        */
       ic->ic_cmd.cmd_opcode = htole16((dowrite ? ICP_WRITE : ICP_READ));
       cc->cc_deviceno = htole16(sc->sc_hwunit);
       cc->cc_blockno = htole32(blkno);
       cc->cc_blockcnt = htole32(datasize / ICP_SECTOR_SIZE);
       cc->cc_addr = ~0;       /* scatter gather */
       cc->cc_nsgent = htole32(ic->ic_nsgent);

       ic->ic_cmdlen = (u_long)ic->ic_sg - (u_long)&ic->ic_cmd +
           ic->ic_nsgent * sizeof(*ic->ic_sg);

       /*
        * Fire it off to the controller.
        */
       if (bp == NULL) {
               s = splbio();
               rv = icp_ccb_poll(icp, ic, 10000);
               icp_ccb_unmap(icp, ic);
               icp_ccb_free(icp, ic);
               splx(s);
       } else {
               ic->ic_intr = ld_icp_intr;
               ic->ic_context = bp;
               ic->ic_dv = sc->sc_ld.sc_dv;
               icp_ccb_enqueue(icp, ic);
       }

       return (rv);
}

static int
ld_icp_start(struct ld_softc *ld, struct buf *bp)
{

       return (ld_icp_dobio((struct ld_icp_softc *)ld, bp->b_data,
           bp->b_bcount, bp->b_rawblkno, (bp->b_flags & B_READ) == 0, bp));
}

static int
ld_icp_dump(struct ld_softc *ld, void *data, daddr_t blkno, int blkcnt)
{

       /* ld_icp_dobio() takes only an 'int' as a disk address */
       if (blkno + blkcnt - 1 > INT_MAX)
               return (EIO);

       return (ld_icp_dobio((struct ld_icp_softc *)ld, data,
           blkcnt * ld->sc_secsize, blkno, 1, NULL));
}

/* ARGSUSED */
static int
ld_icp_flush(struct ld_softc *ld, bool poll)
{
       struct ld_icp_softc *sc;
       struct icp_softc *icp;
       struct icp_cachecmd *cc;
       struct icp_ccb *ic;
       int rv;

       sc = (struct ld_icp_softc *)ld;
       icp = device_private(device_parent(ld->sc_dv));

       ic = icp_ccb_alloc_wait(icp);
       ic->ic_cmd.cmd_opcode = htole16(ICP_FLUSH);

       cc = &ic->ic_cmd.cmd_packet.cc;
       cc->cc_deviceno = htole16(sc->sc_hwunit);
       cc->cc_blockno = htole32(1);
       cc->cc_blockcnt = 0;
       cc->cc_addr = 0;
       cc->cc_nsgent = 0;

       ic->ic_cmdlen = (u_long)&cc->cc_sg - (u_long)&ic->ic_cmd;
       ic->ic_service = ICP_CACHESERVICE;

       rv = icp_ccb_wait(icp, ic, 30000);
       icp_ccb_free(icp, ic);

       return (rv);
}

static int
ld_icp_ioctl(struct ld_softc *ld, u_long cmd, void *addr, int32_t flag, bool poll)
{
       int error;

       switch (cmd) {
       case DIOCCACHESYNC:
               error = ld_icp_flush(ld, poll);
               break;

       default:
               error = EPASSTHROUGH;
               break;
       }

       return error;
}

static void
ld_icp_intr(struct icp_ccb *ic)
{
       struct buf *bp;
       struct ld_icp_softc *sc;
       struct icp_softc *icp;

       bp = ic->ic_context;
       sc = device_private(ic->ic_dv);
       icp = device_private(device_parent(sc->sc_ld.sc_dv));

       if (ic->ic_status != ICP_S_OK) {
               aprint_error_dev(ic->ic_dv, "request failed; status=0x%04x\n",
                   ic->ic_status);
               bp->b_error = EIO;
               bp->b_resid = bp->b_bcount;

               icp->icp_evt.size = sizeof(icp->icp_evt.eu.sync);
               icp->icp_evt.eu.sync.ionode = device_unit(icp->icp_dv);
               icp->icp_evt.eu.sync.service = icp->icp_service;
               icp->icp_evt.eu.sync.status = icp->icp_status;
               icp->icp_evt.eu.sync.info = icp->icp_info;
               icp->icp_evt.eu.sync.hostdrive = sc->sc_hwunit;
               if (icp->icp_status >= 0x8000)
                       icp_store_event(icp, GDT_ES_SYNC, 0, &icp->icp_evt);
               else
                       icp_store_event(icp, GDT_ES_SYNC, icp->icp_service,
                           &icp->icp_evt);
       } else
               bp->b_resid = 0;

       icp_ccb_unmap(icp, ic);
       icp_ccb_free(icp, ic);
       lddone(&sc->sc_ld, bp);
}

static void
ld_icp_adjqparam(device_t dv, int openings)
{

       ldadjqparam(device_private(dv), openings);
}

MODULE(MODULE_CLASS_DRIVER, ld_icp, "ld");      /* no icp module yet */

#ifdef _MODULE
/*
* XXX Don't allow ioconf.c to redefine the "struct cfdriver ld_cd"
* XXX it will be defined in the common-code module
*/
#undef  CFDRIVER_DECL
#define CFDRIVER_DECL(name, class, attr)
#include "ioconf.c"
#endif

static int
ld_icp_modcmd(modcmd_t cmd, void *opaque)
{
#ifdef _MODULE
       /*
        * We ignore the cfdriver_vec[] that ioconf provides, since
        * the cfdrivers are attached already.
        */
       static struct cfdriver * const no_cfdriver_vec[] = { NULL };
#endif
       int error = 0;

#ifdef _MODULE
       switch (cmd) {
       case MODULE_CMD_INIT:
               error = config_init_component(no_cfdriver_vec,
                   cfattach_ioconf_ld_icp, cfdata_ioconf_ld_icp);
               break;
       case MODULE_CMD_FINI:
               error = config_fini_component(no_cfdriver_vec,
                   cfattach_ioconf_ld_icp, cfdata_ioconf_ld_icp);
               break;
       default:
               error = ENOTTY;
               break;
       }
#endif

       return error;
}