/*      $NetBSD: com_mca.c,v 1.23 2018/12/08 17:46:14 thorpej Exp $     */

/*-
* Copyright (c) 2001 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Charles M. Hannum.
*
* 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.
*/

/*-
* Copyright (c) 1991 The Regents of the University of California.
* 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.
* 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. Neither the name of the University nor the names of its contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
*
*      @(#)com.c       7.5 (Berkeley) 5/16/91
*/

/*
* This driver attaches serial port boards and internal modems.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: com_mca.c,v 1.23 2018/12/08 17:46:14 thorpej Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/ioctl.h>
#include <sys/select.h>
#include <sys/tty.h>
#include <sys/proc.h>
#include <sys/file.h>
#include <sys/uio.h>
#include <sys/kernel.h>
#include <sys/syslog.h>
#include <sys/device.h>

#include <sys/intr.h>
#include <sys/bus.h>

#include <dev/ic/comreg.h>
#include <dev/ic/comvar.h>

#include <dev/mca/mcavar.h>
#include <dev/mca/mcadevs.h>

struct com_mca_softc {
       struct  com_softc sc_com;       /* real "com" softc */

       /* MCA-specific goo. */
       void    *sc_ih;                 /* interrupt handler */
};

int com_mca_probe(device_t, cfdata_t , void *);
void com_mca_attach(device_t, device_t, void *);

static int ibm_modem_getcfg(struct mca_attach_args *, int *, int *);
static int neocom1_getcfg(struct mca_attach_args *, int *, int *);
static int ibm_mpcom_getcfg(struct mca_attach_args *, int *, int *);

CFATTACH_DECL_NEW(com_mca, sizeof(struct com_mca_softc),
   com_mca_probe, com_mca_attach, NULL, NULL);

static const struct com_mca_product {
       u_int32_t       cp_prodid;      /* MCA product ID */
       const char      *cp_name;       /* device name */
       int (*cp_getcfg)(struct mca_attach_args *, int *iobase, int *irq);
                                       /* get device i/o base and irq */
} com_mca_products[] = {
       { MCA_PRODUCT_IBM_MOD,  "IBM Internal Modem",   ibm_modem_getcfg },
       { MCA_PRODUCT_NEOCOM1,  "NeoTecH Single RS-232 Async. Adapter, SM110",
               neocom1_getcfg },
       { MCA_PRODUCT_IBM_MPCOM,"IBM Multi-Protocol Communications Adapter",
               ibm_mpcom_getcfg },
       { 0,                    NULL,                   NULL },
};

static const struct com_mca_product *com_mca_lookup(int);

static const struct com_mca_product *
com_mca_lookup(int ma_id)
{
       const struct com_mca_product *cpp;

       for (cpp = com_mca_products; cpp->cp_name != NULL; cpp++)
               if (cpp->cp_prodid == ma_id)
                       return (cpp);

       return (NULL);
}

int
com_mca_probe(device_t parent, cfdata_t match, void *aux)
{
       struct mca_attach_args *ma = aux;

       if (com_mca_lookup(ma->ma_id))
               return (1);

       return (0);
}

void
com_mca_attach(device_t parent, device_t self, void *aux)
{
       struct com_mca_softc *isc = device_private(self);
       struct com_softc *sc = &isc->sc_com;
       int iobase, irq;
       struct mca_attach_args *ma = aux;
       const struct com_mca_product *cpp;
       bus_space_handle_t ioh;

       sc->sc_dev = self;
       cpp = com_mca_lookup(ma->ma_id);

       /* get iobase and irq */
       if ((*cpp->cp_getcfg)(ma, &iobase, &irq))
               return;

       if (bus_space_map(ma->ma_iot, iobase, COM_NPORTS, 0, &ioh)) {
               aprint_error(": can't map i/o space\n");
               return;
       }

       com_init_regs(&sc->sc_regs, ma->ma_iot, ioh, iobase);
       sc->sc_frequency = COM_FREQ;

       aprint_normal(" slot %d i/o %#x-%#x irq %d", ma->ma_slot + 1,
               iobase, iobase + COM_NPORTS - 1, irq);

       com_attach_subr(sc);

       aprint_normal_dev(self, "%s\n", cpp->cp_name);

       isc->sc_ih = mca_intr_establish(ma->ma_mc, irq, IPL_SERIAL,
                       comintr, sc);
       if (isc->sc_ih == NULL) {
               aprint_error_dev(self,
                   "couldn't establish interrupt handler\n");
               return;
       }

       /*
        * com_cleanup: shutdown hook for buggy BIOSs that don't
        * recognize the UART without a disabled FIFO.
        * XXX is this necessary on MCA ? --- jdolecek
        */
       if (!pmf_device_register1(self, com_suspend, com_resume, com_cleanup))
               aprint_error_dev(self, "could not establish shutdown hook\n");
}

/* map serial_X to iobase and irq */
static const struct {
       int iobase;
       int irq;
} MCA_SERIAL[] = {
       { 0x03f8,       4 },    /* SERIAL_1 */
       { 0x02f8,       3 },    /* SERIAL_2 */
       { 0x3220,       3 },    /* SERIAL_3 */
       { 0x3228,       3 },    /* SERIAL_4 */
       { 0x4220,       3 },    /* SERIAL_5 */
       { 0x4228,       3 },    /* SERIAL_6 */
       { 0x5220,       3 },    /* SERIAL_7 */
       { 0x5228,       3 },    /* SERIAL_8 */
};

/*
* Get config for IBM Internal Modem (ID 0xEDFF). This beast doesn't
* seem to support even AT commands, it's good as example for adding
* other stuff though.
*/
static int
ibm_modem_getcfg(struct mca_attach_args *ma, int *iobasep, int *irqp)
{
       int pos2;
       int snum;

       pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);

       /*
        * POS register 2: (adf pos0)
        * 7 6 5 4 3 2 1 0
        *         \__/  \__ enable: 0=adapter disabled, 1=adapter enabled
        *            \_____ Serial Configuration: XX=SERIAL_XX
        */

       snum = (pos2 & 0x0e) >> 1;

       *iobasep = MCA_SERIAL[snum].iobase;
       *irqp = MCA_SERIAL[snum].irq;

       return (0);
}

/*
* Get configuration for NeoTecH Single RS-232 Async. Adapter, SM110.
*/
static int
neocom1_getcfg(struct mca_attach_args *ma, int *iobasep, int *irqp)
{
       int pos2, pos3, pos4;
       static const int neotech_irq[] = { 12, 9, 4, 3 };

       pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);
       pos3 = mca_conf_read(ma->ma_mc, ma->ma_slot, 3);
       pos4 = mca_conf_read(ma->ma_mc, ma->ma_slot, 4);

       /*
        * POS register 2: (adf pos0)
        * 7 6 5 4 3 2 1 0
        *     1     \_/ \__ enable: 0=adapter disabled, 1=adapter enabled
        *             \____ IRQ: 11=3 10=4 01=9 00=12
        *
        * POS register 3: (adf pos1)
        * 7 6 5 4 3 2 1 0
        * \______/
        *        \_________ I/O Address: bits 7-3
        *
        * POS register 4: (adf pos2)
        * 7 6 5 4 3 2 1 0
        * \_____________/
        *               \__ I/O Address: bits 15-8
        */

       *iobasep = (pos4 << 8) | (pos3 & 0xf8);
       *irqp = neotech_irq[(pos2 & 0x06) >> 1];

       return (0);
}

/*
* Get configuration for IBM Multi-Protocol Communications Adapter.
* We only support SERIAL mode, bail out if set to SDLC or BISYNC.
*/
static int
ibm_mpcom_getcfg(struct mca_attach_args *ma, int *iobasep, int *irqp)
{
       int snum, pos2;

       pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);

       /*
        * For SERIAL mode, bit 4 has to be 0.
        *
        * POS register 2: (adf pos0)
        * 7 6 5 4 3 2 1 0
        *       0 \__/  \__ enable: 0=adapter disabled, 1=adapter enabled
        *            \_____ Serial Configuration: XX=SERIAL_XX
        */

       if (pos2 & 0x10) {
               aprint_error(": not set to SERIAL mode, ignored\n");
               return (1);
       }

       snum = (pos2 & 0x0e) >> 1;

       *iobasep = MCA_SERIAL[snum].iobase;
       *irqp = MCA_SERIAL[snum].irq;

       return (0);
}