/*      $wasabi: ld_twa.c,v 1.9 2006/02/14 18:44:37 jordanr Exp $       */
/*      $NetBSD: ld_twa.c,v 1.21 2025/04/13 02:34:03 rin Exp $ */

/*-
* Copyright (c) 2000, 2001, 2002, 2003, 2004 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Andrew Doran, and by Jason R. Thorpe and Jordan Rhody of Wasabi
* Systems, Inc.
*
* 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.
*/

/*
* 3ware "Apache" RAID controller front-end for ld(4) driver.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: ld_twa.c,v 1.21 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/proc.h>
#include <sys/module.h>
#include <sys/bus.h>

#include <dev/ldvar.h>

#include <dev/scsipi/scsipi_all.h>
#include <dev/scsipi/scsipi_disk.h>
#include <dev/scsipi/scsipiconf.h>
#include <dev/scsipi/scsi_disk.h>


#include <dev/pci/pcireg.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/twareg.h>
#include <dev/pci/twavar.h>

#include "ioconf.h"

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

static void     ld_twa_attach(device_t, device_t, void *);
static int      ld_twa_detach(device_t, int);
static int      ld_twa_dobio(struct ld_twa_softc *, void *, size_t, daddr_t,
                            struct buf *);
static int      ld_twa_dump(struct ld_softc *, void *, daddr_t, int);
static int      ld_twa_flush(struct ld_softc *, bool);
static int      ld_twa_ioctl(struct ld_softc *, u_long, void *, int32_t, bool);
static void     ld_twa_handler(struct twa_request *);
static int      ld_twa_match(device_t, cfdata_t, void *);
static int      ld_twa_start(struct ld_softc *, struct buf *);

static void     ld_twa_adjqparam(device_t, int);

static int ld_twa_scsicmd(struct ld_twa_softc *,
       struct twa_request *, struct buf *);

CFATTACH_DECL_NEW(ld_twa, sizeof(struct ld_twa_softc),
   ld_twa_match, ld_twa_attach, ld_twa_detach, NULL);

static const struct twa_callbacks ld_twa_callbacks = {
       ld_twa_adjqparam,
};

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

       return (1);
}

static void
ld_twa_attach(device_t parent, device_t self, void *aux)
{
       struct twa_attach_args *twa_args = aux;
       struct ld_twa_softc *sc = device_private(self);
       struct ld_softc *ld = &sc->sc_ld;
       struct twa_softc *twa = device_private(parent);

       ld->sc_dv = self;

       twa_register_callbacks(twa, twa_args->twaa_unit, &ld_twa_callbacks);

       sc->sc_hwunit = twa_args->twaa_unit;
       ld->sc_maxxfer = twa_get_maxxfer(twa_get_maxsegs());
       ld->sc_secperunit = twa->sc_units[sc->sc_hwunit].td_size;
       ld->sc_flags = LDF_ENABLED;
       ld->sc_secsize = TWA_SECTOR_SIZE;
       ld->sc_maxqueuecnt = twa->sc_units[sc->sc_hwunit].td_openings;
       ld->sc_start = ld_twa_start;
       ld->sc_dump = ld_twa_dump;
       ld->sc_ioctl = ld_twa_ioctl;
       ldattach(ld, BUFQ_DISK_DEFAULT_STRAT);
}

static int
ld_twa_detach(device_t self, int flags)
{
       struct ld_twa_softc *sc = device_private(self);
       struct ld_softc *ld = &sc->sc_ld;
       int error;

       if ((error = ldbegindetach(ld, flags)) != 0)
               return (error);
       ldenddetach(ld);

       return (0);
}

static int
ld_twa_dobio(struct ld_twa_softc *sc, void *data, size_t datasize,
            daddr_t blkno, struct buf *bp)
{
       int rv;
       struct twa_request      *tr;
       struct twa_softc *twa;

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

       if ((tr = twa_get_request(twa, 0)) == NULL) {
               return (EAGAIN);
       }
       if (bp->b_flags & B_READ) {
               tr->tr_flags = TWA_CMD_DATA_OUT;
       } else {
               tr->tr_flags = TWA_CMD_DATA_IN;
       }

       tr->tr_data = data;
       tr->tr_length = datasize;
       tr->tr_cmd_pkt_type =
               (TWA_CMD_PKT_TYPE_9K | TWA_CMD_PKT_TYPE_EXTERNAL);

       tr->tr_command->cmd_hdr.header_desc.size_header = 128;

       tr->tr_command->command.cmd_pkt_9k.command.opcode =
               TWA_OP_EXECUTE_SCSI_COMMAND;
       tr->tr_command->command.cmd_pkt_9k.unit =
               sc->sc_hwunit;
       tr->tr_command->command.cmd_pkt_9k.request_id =
               tr->tr_request_id;
       tr->tr_command->command.cmd_pkt_9k.status = 0;
       tr->tr_command->command.cmd_pkt_9k.sgl_entries = 1;
       tr->tr_command->command.cmd_pkt_9k.sgl_offset = 16;

       /* offset from end of hdr = max cdb len */
       ld_twa_scsicmd(sc, tr, bp);

       tr->tr_callback = ld_twa_handler;
       tr->tr_ld_sc = sc;

       tr->bp = bp;

       rv = twa_map_request(tr);

       return (rv);
}

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

       return (ld_twa_dobio((struct ld_twa_softc *)ld, bp->b_data,
           bp->b_bcount, bp->b_rawblkno, bp));
}

static void
ld_twa_handler(struct twa_request *tr)
{
       uint8_t status;
       struct buf *bp;
       struct ld_twa_softc *sc;

       bp = tr->bp;
       sc = (struct ld_twa_softc *)tr->tr_ld_sc;

       status = tr->tr_command->command.cmd_pkt_9k.status;

       if (status != 0) {
               bp->b_error = EIO;
               bp->b_resid = bp->b_bcount;
       } else {
               bp->b_resid = 0;
               bp->b_error = 0;
       }
       twa_release_request(tr);

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

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

#if 0
       /* XXX Unsafe right now. */
       return (ld_twa_dobio((struct ld_twa_softc *)ld, data,
           blkcnt * ld->sc_secsize, blkno, NULL));
#else
       return EIO;
#endif

}


static int
ld_twa_flush(struct ld_softc *ld, bool poll)
{
       int s, rv = 0;
       struct twa_request *tr;
       struct twa_softc *twa = device_private(device_parent(ld->sc_dv));
       struct ld_twa_softc *sc = (void *)ld;
       struct twa_command_generic *generic_cmd;

       /* Get a request packet. */
       tr = twa_get_request_wait(twa, 0);
       KASSERT(tr != NULL);

       tr->tr_cmd_pkt_type =
               (TWA_CMD_PKT_TYPE_9K | TWA_CMD_PKT_TYPE_EXTERNAL);

       tr->tr_callback = twa_request_wait_handler;
       tr->tr_ld_sc = sc;

       tr->tr_command->cmd_hdr.header_desc.size_header = 128;

       generic_cmd = &(tr->tr_command->command.cmd_pkt_7k.generic);
       generic_cmd->opcode = TWA_OP_FLUSH;
       generic_cmd->size = 2;
       generic_cmd->unit = sc->sc_hwunit;
       generic_cmd->request_id = tr->tr_request_id;
       generic_cmd->sgl_offset = 0;
       generic_cmd->host_id = 0;
       generic_cmd->status = 0;
       generic_cmd->flags = 0;
       generic_cmd->count = 0;
       rv = twa_map_request(tr);
       s = splbio();
       while (tr->tr_status != TWA_CMD_COMPLETE)
               if ((rv = tsleep(tr, PRIBIO, "twaflush", 60 * hz)) != 0)
                       break;
       twa_release_request(tr);
       splx(s);

       return (rv);
}

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

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

       default:
               error = EPASSTHROUGH;
               break;
       }

       return error;
}

static void
ld_twa_adjqparam(device_t self, int openings)
{
       struct ld_twa_softc *sc = device_private(self);
       struct ld_softc *ld = &sc->sc_ld;

       ldadjqparam(ld, openings);
}


static int
ld_twa_scsicmd(struct ld_twa_softc *sc,
       struct twa_request *tr, struct buf *bp)
{
       if (tr->tr_flags == TWA_CMD_DATA_IN) {
               tr->tr_command->command.cmd_pkt_9k.cdb[0] = WRITE_16;
       } else {
               tr->tr_command->command.cmd_pkt_9k.cdb[0] = READ_16;
       }
       tr->tr_command->command.cmd_pkt_9k.cdb[1] =
               (sc->sc_hwunit << 5);                   /* lun for CDB */

       _lto8b(htole64(bp->b_rawblkno),
               &tr->tr_command->command.cmd_pkt_9k.cdb[2]);
       _lto4b(htole32((bp->b_bcount / TWA_SECTOR_SIZE)),
               &tr->tr_command->command.cmd_pkt_9k.cdb[10]);

       tr->tr_command->command.cmd_pkt_9k.cdb[14] = 0;
       tr->tr_command->command.cmd_pkt_9k.cdb[15] = 0;

       return (0);
}

MODULE(MODULE_CLASS_DRIVER, ld_twa, "ld,twa");

#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_twa_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_twa, cfdata_ioconf_ld_twa);
               break;
       case MODULE_CMD_FINI:
               error = config_fini_component(no_cfdriver_vec,
                   cfattach_ioconf_ld_twa, cfdata_ioconf_ld_twa);
               break;
       default:
               error = ENOTTY;
               break;
       }
#endif

       return error;
}