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

/*-
 * Copyright (c) 2000, 2006 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.
 */

/*
 * Compaq array controller front-end for ld(4) driver.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ld_cac.c,v 1.32 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/cacreg.h>
#include <dev/ic/cacvar.h>

#include "ioconf.h"

struct ld_cac_softc {
        struct  ld_softc sc_ld;
        kmutex_t *sc_mutex;
        int     sc_hwunit;
        int     sc_serrcnt;
        struct  timeval sc_serrtm;
};

void    ld_cac_attach(device_t, device_t, void *);
void    ld_cac_done(device_t, void *, int);
int     ld_cac_dump(struct ld_softc *, void *, daddr_t, int);
int     ld_cac_match(device_t, cfdata_t, void *);
int     ld_cac_start(struct ld_softc *, struct buf *);

static const struct     timeval ld_cac_serrintvl = { 60, 0 };

CFATTACH_DECL_NEW(ld_cac, sizeof(struct ld_cac_softc),
    ld_cac_match, ld_cac_attach, NULL, NULL);

int
ld_cac_match(device_t parent, cfdata_t match, void *aux)
{

        return (1);
}

void
ld_cac_attach(device_t parent, device_t self, void *aux)
{
        struct cac_drive_info dinfo;
        struct cac_attach_args *caca;
        struct ld_cac_softc *sc = device_private(self);
        struct cac_softc *cac = device_private(parent);
        struct ld_softc *ld = &sc->sc_ld;
        const char *type;

        caca = aux;
        ld->sc_dv = self;
        sc->sc_mutex = &cac->sc_mutex;
        sc->sc_hwunit = caca->caca_unit;

        if (cac_cmd(cac, CAC_CMD_GET_LOG_DRV_INFO, &dinfo, sizeof(dinfo),
            sc->sc_hwunit, 0, CAC_CCB_DATA_IN, NULL)) {
                aprint_error(": CMD_GET_LOG_DRV_INFO failed\n");
                return;
        }

        ld->sc_secsize = CAC_GET2(dinfo.secsize);
        ld->sc_maxxfer = CAC_MAX_XFER;
        ld->sc_maxqueuecnt = (CAC_MAX_CCBS - 1) / cac->sc_nunits;
        ld->sc_secperunit = CAC_GET2(dinfo.ncylinders) *
            CAC_GET1(dinfo.nheads) * CAC_GET1(dinfo.nsectors);
        ld->sc_start = ld_cac_start;
        ld->sc_dump = ld_cac_dump;

        switch (CAC_GET1(dinfo.mirror)) {
        case 0:
                type = "standalone disk or RAID0";
                break;
        case 1:
                type = "RAID4";
                break;
        case 2:
                type = "RAID1";
                break;
        case 3:
                type = "RAID5";
                break;
        default:
                type = "unknown type of";
                break;
        }

        aprint_normal(": %s array\n", type);

        /* XXX We should verify this... */
        ld->sc_flags = LDF_ENABLED | LDF_MPSAFE;
        ldattach(ld, BUFQ_DISK_DEFAULT_STRAT);
}

int
ld_cac_start(struct ld_softc *ld, struct buf *bp)
{
        int flags, cmd;
        struct cac_softc *cac;
        struct ld_cac_softc *sc;
        struct cac_context cc;

        sc = (struct ld_cac_softc *)ld;
        cac = device_private(device_parent(ld->sc_dv));

        cc.cc_handler = ld_cac_done;
        cc.cc_context = bp;
        cc.cc_dv = ld->sc_dv;

        if ((bp->b_flags & B_READ) == 0) {
                cmd = CAC_CMD_WRITE;
                flags = CAC_CCB_DATA_OUT;
        } else {
                cmd = CAC_CMD_READ;
                flags = CAC_CCB_DATA_IN;
        }

        return (cac_cmd(cac, cmd, bp->b_data, bp->b_bcount, sc->sc_hwunit,
            bp->b_rawblkno, flags, &cc));
}

int
ld_cac_dump(struct ld_softc *ld, void *data, daddr_t blkno, int blkcnt)
{
        struct ld_cac_softc *sc;

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

        sc = (struct ld_cac_softc *)ld;

        return (cac_cmd(device_private(device_parent(ld->sc_dv)),
            CAC_CMD_WRITE_MEDIA, data, blkcnt * ld->sc_secsize,
            sc->sc_hwunit, blkno, CAC_CCB_DATA_OUT, NULL));
}

void
ld_cac_done(device_t dv, void *context, int error)
{
        struct buf *bp;
        struct ld_cac_softc *sc;
        int rv;

        bp = context;
        rv = 0;
        sc = device_private(dv);

        if ((error & CAC_RET_CMD_REJECTED) == CAC_RET_CMD_REJECTED) {
                aprint_error_dev(dv, "command rejected\n");
                rv = EIO;
        }
        if (rv == 0 && (error & CAC_RET_INVAL_BLOCK) != 0) {
                aprint_error_dev(dv, "invalid request block\n");
                rv = EIO;
        }
        if (rv == 0 && (error & CAC_RET_HARD_ERROR) != 0) {
                aprint_error_dev(dv, "hard error\n");
                rv = EIO;
        }
        if (rv == 0 && (error & CAC_RET_SOFT_ERROR) != 0) {
                sc->sc_serrcnt++;
                if (ratecheck(&sc->sc_serrtm, &ld_cac_serrintvl)) {
                        sc->sc_serrcnt = 0;
                        aprint_error_dev(dv,
                            "%d soft errors; array may be degraded\n",
                            sc->sc_serrcnt);
                }
        }

        if (rv) {
                bp->b_error = rv;
                bp->b_resid = bp->b_bcount;
        } else
                bp->b_resid = 0;

        mutex_exit(sc->sc_mutex);
        lddone(&sc->sc_ld, bp);
        mutex_enter(sc->sc_mutex);
}

MODULE(MODULE_CLASS_DRIVER, ld_cac, "ld,cac");

#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_cac_modcmd(modcmd_t cmd, void *opaque)
{               
        int error = 0;
#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

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

        return error;
}