/* $NetBSD: mlx_eisa.c,v 1.30 2022/07/12 02:12:26 thorpej Exp $ */
/*-
* Copyright (c) 2001 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.
*/
/*
* EISA front-end for mlx(4) driver.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: mlx_eisa.c,v 1.30 2022/07/12 02:12:26 thorpej Exp $");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/module.h>
#include <sys/bus.h>
#include <sys/intr.h>
#include <dev/eisa/eisavar.h>
#include <dev/eisa/eisadevs.h>
#include <dev/ic/mlxreg.h>
#include <dev/ic/mlxio.h>
#include <dev/ic/mlxvar.h>
#include "ioconf.h"
#define MLX_EISA_SLOT_OFFSET 0x0c80
#define MLX_EISA_IOSIZE (0x0ce0 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG01 (0x0cc0 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG02 (0x0cc1 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG03 (0x0cc3 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG04 (0x0c8d - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG05 (0x0c90 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG06 (0x0c91 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG07 (0x0c92 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG08 (0x0c93 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG09 (0x0c94 - MLX_EISA_SLOT_OFFSET)
#define MLX_EISA_CFG10 (0x0c95 - MLX_EISA_SLOT_OFFSET)
static void mlx_eisa_attach(device_t, device_t, void *);
static int mlx_eisa_match(device_t, cfdata_t, void *);
static int mlx_eisa_rescan(device_t, const char *, const int *);
static int mlx_v1_submit(struct mlx_softc *, struct mlx_ccb *);
static int mlx_v1_findcomplete(struct mlx_softc *, u_int *, u_int *);
static void mlx_v1_intaction(struct mlx_softc *, int);
static int mlx_v1_fw_handshake(struct mlx_softc *, int *, int *, int *);
#ifdef MLX_RESET
static int mlx_v1_reset(struct mlx_softc *);
#endif
CFATTACH_DECL3_NEW(mlx_eisa, sizeof(struct mlx_softc),
mlx_eisa_match, mlx_eisa_attach, NULL, NULL, mlx_eisa_rescan, NULL, 0);
static const struct device_compatible_entry compat_data[] = {
/* nchan */
{ .compat = "MLX0070", .value = 1 },
{ .compat = "MLX0071", .value = 3 },
{ .compat = "MLX0072", .value = 3 },
{ .compat = "MLX0073", .value = 2 },
{ .compat = "MLX0074", .value = 1 },
{ .compat = "MLX0075", .value = 3 },
{ .compat = "MLX0076", .value = 2 },
{ .compat = "MLX0077", .value = 1 },
DEVICE_COMPAT_EOL
};
static int
mlx_eisa_match(device_t parent, cfdata_t match,
void *aux)
{
struct eisa_attach_args *ea = aux;
return (eisa_compatible_match(ea, compat_data));
}
static void
mlx_eisa_attach(device_t parent, device_t self, void *aux)
{
struct eisa_attach_args *ea = aux;
const struct device_compatible_entry *dce;
bus_space_handle_t ioh;
eisa_chipset_tag_t ec;
eisa_intr_handle_t ih;
struct mlx_softc *mlx;
bus_space_tag_t iot;
const char *intrstr;
int irq, ist, icfg;
char intrbuf[EISA_INTRSTR_LEN];
mlx = device_private(self);
iot = ea->ea_iot;
ec = ea->ea_ec;
dce = eisa_compatible_lookup(ea, compat_data);
KASSERT(dce != NULL);
mlx->mlx_ci.ci_nchan = (int)dce->value;
mlx->mlx_ci.ci_iftype = 1;
mlx->mlx_submit = mlx_v1_submit;
mlx->mlx_findcomplete = mlx_v1_findcomplete;
mlx->mlx_intaction = mlx_v1_intaction;
mlx->mlx_fw_handshake = mlx_v1_fw_handshake;
#ifdef MLX_RESET
mlx->mlx_reset = mlx_v1_reset;
#endif
aprint_normal(": Mylex RAID\n");
if (bus_space_map(iot, EISA_SLOT_ADDR(ea->ea_slot) +
MLX_EISA_SLOT_OFFSET, MLX_EISA_IOSIZE, 0, &ioh)) {
aprint_error_dev(self, "can't map i/o space\n");
return;
}
mlx->mlx_dv = self;
mlx->mlx_iot = iot;
mlx->mlx_ioh = ioh;
mlx->mlx_dmat = ea->ea_dmat;
/*
* Map and establish the interrupt.
*/
icfg = bus_space_read_1(iot, ioh, MLX_EISA_CFG03);
switch (icfg & 0xf0) {
case 0xa0:
irq = 11;
break;
case 0xc0:
irq = 12;
break;
case 0xe0:
irq = 14;
break;
case 0x80:
irq = 15;
break;
default:
aprint_error_dev(self,
"controller on invalid IRQ (icfg=0x%02x)\n", icfg);
return;
}
ist = (icfg & 0x08) != 0 ? IST_LEVEL : IST_EDGE;
if (eisa_intr_map(ec, irq, &ih)) {
aprint_error_dev(self, "can't map interrupt (%d)\n", irq);
return;
}
intrstr = eisa_intr_string(ec, ih, intrbuf, sizeof(intrbuf));
mlx->mlx_ih = eisa_intr_establish(ec, ih, ist, IPL_BIO, mlx_intr, mlx);
if (mlx->mlx_ih == NULL) {
aprint_error_dev(self, "can't establish interrupt");
if (intrstr != NULL)
aprint_error(" at %s", intrstr);
aprint_error("\n");
return;
}
if (intrstr != NULL) {
aprint_normal_dev(self, "interrupting at %s (%s trigger)\n",
ist == IST_EDGE ? "edge" : "level", intrstr);
}
mlx_init(mlx, intrstr);
}
static int
mlx_eisa_rescan(device_t self, const char *ifattr, const int *locs)
{
return mlx_configure(device_private(self), 1);
}
/*
* ================= V1 interface linkage =================
*/
/*
* Try to give (mc) to the controller. Returns 1 if successful, 0 on
* failure (the controller is not ready to take a command).
*
* Must be called at splbio or in a fashion that prevents reentry.
*/
static int
mlx_v1_submit(struct mlx_softc *mlx, struct mlx_ccb *mc)
{
/* Ready for our command? */
if ((mlx_inb(mlx, MLX_V1REG_IDB) & MLX_V1_IDB_FULL) == 0) {
/* Copy mailbox data to window. */
bus_space_write_region_1(mlx->mlx_iot, mlx->mlx_ioh,
MLX_V1REG_MAILBOX, mc->mc_mbox, 13);
/* Post command. */
mlx_outb(mlx, MLX_V1REG_IDB, MLX_V1_IDB_FULL);
return (1);
}
return (0);
}
/*
* See if a command has been completed, if so acknowledge its completion and
* recover the slot number and status code.
*
* Must be called at splbio or in a fashion that prevents reentry.
*/
static int
mlx_v1_findcomplete(struct mlx_softc *mlx, u_int *slot, u_int *status)
{
/* Status available? */
if ((mlx_inb(mlx, MLX_V1REG_ODB) & MLX_V1_ODB_SAVAIL) != 0) {
*slot = mlx_inb(mlx, MLX_V1REG_MAILBOX + 0x0d);
*status = mlx_inw(mlx, MLX_V1REG_MAILBOX + 0x0e);
/* Acknowledge completion. */
mlx_outb(mlx, MLX_V1REG_ODB, MLX_V1_ODB_SAVAIL);
mlx_outb(mlx, MLX_V1REG_IDB, MLX_V1_IDB_SACK);
return (1);
}
return (0);
}
/*
* Enable/disable interrupts as requested. (No acknowledge required)
*
* Must be called at splbio or in a fashion that prevents reentry.
*/
static void
mlx_v1_intaction(struct mlx_softc *mlx, int action)
{
mlx_outb(mlx, MLX_V1REG_IE, action ? 1 : 0);
}
/*
* Poll for firmware error codes during controller initialisation.
*
* Returns 0 if initialisation is complete, 1 if still in progress but no
* error has been fetched, 2 if an error has been retrieved.
*/
static int
mlx_v1_fw_handshake(struct mlx_softc *mlx, int *error, int *param1, int *param2)
{
u_int8_t fwerror;
/*
* First time around, enable the IDB interrupt and clear any
* hardware completion status.
*/
if ((mlx->mlx_flags & MLXF_FW_INITTED) == 0) {
mlx_outb(mlx, MLX_V1REG_ODB_EN, 1);
DELAY(1000);
mlx_outb(mlx, MLX_V1REG_ODB, 1);
DELAY(1000);
mlx_outb(mlx, MLX_V1REG_IDB, MLX_V1_IDB_SACK);
DELAY(1000);
mlx->mlx_flags |= MLXF_FW_INITTED;
}
/* Init in progress? */
if ((mlx_inb(mlx, MLX_V1REG_IDB) & MLX_V1_IDB_INIT_BUSY) == 0)
return (0);
/* Test error value. */
fwerror = mlx_inb(mlx, MLX_V1REG_ODB);
if ((fwerror & MLX_V1_FWERROR_PEND) == 0)
return (1);
/* XXX Fetch status. */
*error = fwerror & 0xf0;
*param1 = -1;
*param2 = -1;
/* Acknowledge. */
mlx_outb(mlx, MLX_V1REG_ODB, fwerror);
return (2);
}
#ifdef MLX_RESET
/*
* Reset the controller. Return non-zero on failure.
*/
static int
mlx_v1_reset(struct mlx_softc *mlx)
{
int i;
mlx_outb(mlx, MLX_V1REG_IDB, MLX_V1_IDB_SACK);
delay(1000000);
/* Wait up to 2 minutes for the bit to clear. */
for (i = 120; i != 0; i--) {
delay(1000000);
if ((mlx_inb(mlx, MLX_V1REG_IDB) & MLX_V1_IDB_SACK) == 0)
break;
}
if (i == 0)
return (-1);
mlx_outb(mlx, MLX_V1REG_ODB, MLX_V1_ODB_RESET);
mlx_outb(mlx, MLX_V1REG_IDB, MLX_V1_IDB_RESET);
/* Wait up to 5 seconds for the bit to clear... */
for (i = 5; i != 0; i--) {
delay(1000000);
if ((mlx_inb(mlx, MLX_V1REG_IDB) & MLX_V1_IDB_RESET) == 0)
break;
}
if (i == 0)
return (-1);
/* Wait up to 3 seconds for the other bit to clear... */
for (i = 5; i != 0; i--) {
delay(1000000);
if ((mlx_inb(mlx, MLX_V1REG_ODB) & MLX_V1_ODB_RESET) == 0)
break;
}
if (i == 0)
return (-1);
return (0);
}
#endif /* MLX_RESET */
MODULE(MODULE_CLASS_DRIVER, mlx_eisa, "mlx"); /* No eisa module yet! */
#ifdef _MODULE
/*
* XXX Don't allow ioconf.c to redefine the "struct cfdriver cac_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
mlx_eisa_modcmd(modcmd_t cmd, void *opaque)
{
int error = 0;
#ifdef _MODULE
switch (cmd) {
case MODULE_CMD_INIT:
/*
* We skip over the first entry in cfdriver[] array
* since the cfdriver is attached by the common
* (non-attachment-specific) code.
*/
error = config_init_component(&cfdriver_ioconf_mlx_eisa[1],
cfattach_ioconf_mlx_eisa, cfdata_ioconf_mlx_eisa);
break;
case MODULE_CMD_FINI:
error = config_fini_component(&cfdriver_ioconf_mlx_eisa[1],
cfattach_ioconf_mlx_eisa, cfdata_ioconf_mlx_eisa);
break;
default:
error = ENOTTY;
break;
}
#endif
return error;
}