sys/dev/pccbb/pccbb_isa.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2002-2004 M. Warner Losh.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 /*
  30  * Driver for ISA to PCMCIA bridges compliant with the Intel ExCA
  31  * specification.
  32  */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 #include <sys/param.h>
  38 #include <sys/systm.h>
  39 #include <sys/proc.h>
  40 #include <sys/condvar.h>
  41 #include <sys/errno.h>
  42 #include <sys/kernel.h>
  43 #include <sys/lock.h>
  44 #include <sys/malloc.h>
  45 #include <sys/module.h>
  46 #include <sys/mutex.h>
  47 #include <sys/sysctl.h>
  48 #include <sys/kthread.h>
  49 #include <sys/bus.h>
  50 #include <machine/bus.h>
  51 #include <sys/rman.h>
  52 #include <machine/resource.h>
  53
  54 #include <isa/isavar.h>
  55
  56 #include <dev/pci/pcivar.h>
  57 #include <dev/pci/pcib_private.h>
  58
  59 #include <dev/pccard/pccardreg.h>
  60 #include <dev/pccard/pccardvar.h>
  61
  62 #include <dev/exca/excareg.h>
  63 #include <dev/exca/excavar.h>
  64
  65 #include <dev/pccbb/pccbbreg.h>
  66 #include <dev/pccbb/pccbbvar.h>
  67
  68 #include "power_if.h"
  69 #include "card_if.h"
  70
  71 /*****************************************************************************
  72  * Configurable parameters.
  73  *****************************************************************************/
  74
  75 /* sysctl vars */
  76 static SYSCTL_NODE(_hw, OID_AUTO, pcic, CTLFLAG_RD, 0, "PCIC parameters");
  77
  78 static int isa_intr_mask = EXCA_INT_MASK_ALLOWED;
  79 SYSCTL_INT(_hw_pcic, OID_AUTO, intr_mask, CTLFLAG_RDTUN, &isa_intr_mask, 0,
  80     "Mask of allowable interrupts for this laptop.  The default is generally"
  81     " correct, but some laptops do not route all the IRQ pins to the bridge to"
  82     " save wires.  Sometimes you need a more restrictive mask because some of"
  83     " the hardware in your laptop may not have a driver so its IRQ might not be"
  84     " allocated.");
  85
  86 /*
  87  * CL-PD6722's VSENSE method
  88  *     0: NO VSENSE (assume a 5.0V card always)
  89  *     1: 6710's method (default)
  90  *     2: 6729's method
  91  */
  92 int pcic_pd6722_vsense = 1;
  93 SYSCTL_INT(_hw_pcic, OID_AUTO, pd6722_vsense, CTLFLAG_RDTUN,
  94     &pcic_pd6722_vsense, 1,
  95     "Select CL-PD6722's VSENSE method.  VSENSE is used to determine the"
  96     " voltage of inserted cards.  The CL-PD6722 has two methods to determine"
  97     " the voltage of the card.  0 means assume a 5.0V card and do not check.  1"
  98     " means use the same method that the CL-PD6710 uses (default).  2 means use"
  99     " the same method as the CL-PD6729.  2 is documented in the datasheet as"
 100     " being the correct way, but 1 seems to give better results on more"
 101     " laptops.");
 102 /*****************************************************************************
 103  * End of configurable parameters.
 104  *****************************************************************************/
 105
 106 #define DPRINTF(x) do { if (cbb_debug) printf x; } while (0)
 107 #define DEVPRINTF(x) do { if (cbb_debug) device_printf x; } while (0)
 108
 109 /* XXX Not sure that PNP0E03 should be claimed, except maybe on pc98 */
 110 static struct isa_pnp_id pcic_ids[] = {
 111         {EXCA_PNP_ACTIONTEC,            NULL},          /* AEI0218 */
 112         {EXCA_PNP_IBM3765,              NULL},          /* IBM3765 */
 113         {EXCA_PNP_82365,                NULL},          /* PNP0E00 */
 114         {EXCA_PNP_CL_PD6720,            NULL},          /* PNP0E01 */
 115         {EXCA_PNP_VLSI_82C146,          NULL},          /* PNP0E02 */
 116         {EXCA_PNP_82365_CARDBUS,        NULL},          /* PNP0E03 */
 117         {EXCA_PNP_SCM_SWAPBOX,          NULL},          /* SCM0469 */
 118         {0}
 119 };
 120
 121 /************************************************************************/
 122 /* Probe/Attach                                                         */
 123 /************************************************************************/
 124
 125 static int
 126 cbb_isa_activate(device_t dev)
 127 {
 128         struct cbb_softc *sc = device_get_softc(dev);
 129         struct resource *res;
 130         int rid;
 131         int i;
 132
 133         /* A little bogus, but go ahead and get the irq for CSC events */
 134         rid = 0;
 135         res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 136         if (res == NULL) {
 137                 /*
 138                  * No IRQ specified, find one.  This can be due to the PnP
 139                  * data not specifying any IRQ, or the default kernel not
 140                  * assinging an IRQ.
 141                  */
 142                 for (i = 0; i < 16 && res == NULL; i++) {
 143                         if (((1 << i) & isa_intr_mask) == 0)
 144                                 continue;
 145                         res = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, i, i,
 146                             1, RF_ACTIVE);
 147                 }
 148         }
 149         if (res == NULL)
 150                 return (ENXIO);
 151         sc->irq_res = res;
 152         rid = 0;
 153         res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
 154         if (res == NULL) {
 155                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
 156                 sc->irq_res = NULL;
 157                 device_printf(dev, "Cannot allocate I/O\n");
 158                 return (ENOMEM);
 159         }
 160         sc->bst = rman_get_bustag(res);
 161         sc->bsh = rman_get_bushandle(res);
 162         sc->base_res = res;
 163         return (0);
 164 }
 165
 166 static void
 167 cbb_isa_deactivate(device_t dev)
 168 {
 169         struct cbb_softc *sc = device_get_softc(dev);
 170
 171         if (sc->irq_res)
 172                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
 173         sc->irq_res = NULL;
 174         if (sc->base_res)
 175                 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->base_res);
 176         sc->base_res = NULL;
 177 }
 178
 179 static int
 180 cbb_isa_probe(device_t dev)
 181 {
 182         int error;
 183         struct cbb_softc *sc = device_get_softc(dev);
 184
 185         /* Check isapnp ids */
 186         error = ISA_PNP_PROBE(device_get_parent(dev), dev, pcic_ids);
 187         if (error != 0 && error != ENOENT)
 188                 return (error);
 189
 190         error = cbb_isa_activate(dev);
 191         if (error != 0)
 192                 return (error);
 193
 194         /* Check to make sure that we have actual hardware */
 195         error = exca_probe_slots(dev, &sc->exca[0], sc->bst, sc->bsh);
 196         cbb_isa_deactivate(dev);
 197         return (error);
 198 }
 199
 200 static int
 201 cbb_isa_attach(device_t dev)
 202 {
 203         return (ENOMEM);
 204 }
 205
 206 static int
 207 cbb_isa_suspend(device_t dev)
 208 {
 209         return (0);
 210 }
 211
 212 static int
 213 cbb_isa_resume(device_t dev)
 214 {
 215         return (0);
 216 }
 217
 218 static device_method_t cbb_methods[] = {
 219         /* Device interface */
 220         DEVMETHOD(device_probe,                 cbb_isa_probe),
 221         DEVMETHOD(device_attach,                cbb_isa_attach),
 222         DEVMETHOD(device_detach,                cbb_detach),
 223         DEVMETHOD(device_suspend,               cbb_isa_suspend),
 224         DEVMETHOD(device_resume,                cbb_isa_resume),
 225
 226         /* bus methods */
 227         DEVMETHOD(bus_read_ivar,                cbb_read_ivar),
 228         DEVMETHOD(bus_write_ivar,               cbb_write_ivar),
 229         DEVMETHOD(bus_alloc_resource,           cbb_alloc_resource),
 230         DEVMETHOD(bus_release_resource,         cbb_release_resource),
 231         DEVMETHOD(bus_activate_resource,        cbb_activate_resource),
 232         DEVMETHOD(bus_deactivate_resource,      cbb_deactivate_resource),
 233         DEVMETHOD(bus_driver_added,             cbb_driver_added),
 234         DEVMETHOD(bus_child_detached,           cbb_child_detached),
 235         DEVMETHOD(bus_setup_intr,               cbb_setup_intr),
 236         DEVMETHOD(bus_teardown_intr,            cbb_teardown_intr),
 237         DEVMETHOD(bus_child_present,            cbb_child_present),
 238
 239         /* 16-bit card interface */
 240         DEVMETHOD(card_set_res_flags,           cbb_pcic_set_res_flags),
 241         DEVMETHOD(card_set_memory_offset,       cbb_pcic_set_memory_offset),
 242
 243         /* power interface */
 244         DEVMETHOD(power_enable_socket,          cbb_power_enable_socket),
 245         DEVMETHOD(power_disable_socket,         cbb_power_disable_socket),
 246
 247         DEVMETHOD_END
 248 };
 249
 250 static driver_t cbb_isa_driver = {
 251         "cbb",
 252         cbb_methods,
 253         sizeof(struct cbb_softc)
 254 };
 255
 256 DRIVER_MODULE(cbb, isa, cbb_isa_driver, cbb_devclass, 0, 0);
 257 MODULE_DEPEND(cbb, exca, 1, 1, 1);