sys/dev/pcf/envctrl.c

   1 /*-
   2  * Copyright (c) 2004 Joerg Wunsch
   3  *
   4  * derived from sys/i386/isa/pcf.c which is:
   5  *
   6  * Copyright (c) 1998 Nicolas Souchu, Marc Bouget
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 /*
  34  * Device specific driver for the SUNW,envctrl device found on some
  35  * UltraSPARC Sun systems.  This device is a Philips PCF8584 sitting
  36  * on the Ebus2.
  37  */
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/bus.h>
  42 #include <sys/conf.h>
  43 #include <sys/kernel.h>
  44 #include <sys/malloc.h>
  45 #include <sys/module.h>
  46 #include <sys/resource.h>
  47 #include <sys/uio.h>
  48
  49 #include <dev/ofw/ofw_bus.h>
  50
  51 #include <machine/bus.h>
  52 #include <machine/resource.h>
  53
  54 #include <sys/rman.h>
  55
  56 #include <dev/iicbus/iiconf.h>
  57 #include <dev/pcf/pcfvar.h>
  58 #include "iicbus_if.h"
  59
  60 #undef PCF_DEFAULT_ADDR
  61 #define PCF_DEFAULT_ADDR        0x55 /* SUNW,pcf default */
  62
  63 static int envctrl_probe(device_t);
  64 static int envctrl_attach(device_t);
  65 static int envctrl_detach(device_t);
  66
  67 static device_method_t envctrl_methods[] = {
  68         /* device interface */
  69         DEVMETHOD(device_probe,         envctrl_probe),
  70         DEVMETHOD(device_attach,        envctrl_attach),
  71         DEVMETHOD(device_detach,        envctrl_detach),
  72
  73         /* iicbus interface */
  74         DEVMETHOD(iicbus_callback,      iicbus_null_callback),
  75         DEVMETHOD(iicbus_repeated_start, pcf_repeated_start),
  76         DEVMETHOD(iicbus_start,         pcf_start),
  77         DEVMETHOD(iicbus_stop,          pcf_stop),
  78         DEVMETHOD(iicbus_write,         pcf_write),
  79         DEVMETHOD(iicbus_read,          pcf_read),
  80         DEVMETHOD(iicbus_reset,         pcf_rst_card),
  81         { 0, 0 }
  82 };
  83
  84 static devclass_t envctrl_devclass;
  85
  86 static driver_t envctrl_driver = {
  87         "envctrl",
  88         envctrl_methods,
  89         sizeof(struct pcf_softc),
  90 };
  91
  92 static int
  93 envctrl_probe(device_t dev)
  94 {
  95
  96         if (strcmp("SUNW,envctrl", ofw_bus_get_name(dev)) == 0) {
  97                 device_set_desc(dev, "EBus SUNW,envctrl");
  98                 return (0);
  99         }
 100         return (ENXIO);
 101 }
 102
 103 static int
 104 envctrl_attach(device_t dev)
 105 {
 106         struct pcf_softc *sc;
 107         int rv = ENXIO;
 108
 109         sc = DEVTOSOFTC(dev);
 110         bzero(sc, sizeof(struct pcf_softc));
 111
 112         /* IO port is mandatory */
 113         sc->res_ioport = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
 114                                                 &sc->rid_ioport, RF_ACTIVE);
 115         if (sc->res_ioport == 0) {
 116                 device_printf(dev, "cannot reserve I/O port range\n");
 117                 goto error;
 118         }
 119         sc->bt_ioport = rman_get_bustag(sc->res_ioport);
 120         sc->bh_ioport = rman_get_bushandle(sc->res_ioport);
 121
 122         sc->pcf_flags = device_get_flags(dev);
 123
 124         if (!(sc->pcf_flags & IIC_POLLED)) {
 125                 sc->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->rid_irq,
 126                                                      RF_ACTIVE);
 127                 if (sc->res_irq == 0) {
 128                         device_printf(dev, "can't reserve irq, polled mode.\n");
 129                         sc->pcf_flags |= IIC_POLLED;
 130                 }
 131         }
 132
 133         /* reset the chip */
 134         pcf_rst_card(dev, IIC_FASTEST, PCF_DEFAULT_ADDR, NULL);
 135
 136         rv = bus_setup_intr(dev, sc->res_irq,
 137                             INTR_TYPE_NET /* | INTR_ENTROPY */,
 138                             NULL, pcf_intr, sc, &sc->intr_cookie);
 139         if (rv) {
 140                 device_printf(dev, "could not setup IRQ\n");
 141                 goto error;
 142         }
 143
 144         if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL)
 145                 device_printf(dev, "could not allocate iicbus instance\n");
 146
 147         /* probe and attach the iicbus */
 148         bus_generic_attach(dev);
 149
 150         return (0);
 151
 152 error:
 153         if (sc->res_irq != 0) {
 154                 bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq,
 155                                      sc->res_irq);
 156         }
 157         if (sc->res_ioport != 0) {
 158                 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ioport,
 159                                      sc->res_ioport);
 160         }
 161         return (rv);
 162 }
 163
 164 static int
 165 envctrl_detach(device_t dev)
 166 {
 167         struct pcf_softc *sc;
 168         int rv;
 169
 170         sc = DEVTOSOFTC(dev);
 171
 172         if ((rv = bus_generic_detach(dev)) != 0)
 173                 return (rv);
 174
 175         if ((rv = device_delete_child(dev, sc->iicbus)) != 0)
 176                 return (rv);
 177
 178         if (sc->res_irq != 0) {
 179                 bus_teardown_intr(dev, sc->res_irq, sc->intr_cookie);
 180                 bus_release_resource(dev, SYS_RES_IRQ, sc->rid_irq, sc->res_irq);
 181         }
 182
 183         bus_release_resource(dev, SYS_RES_MEMORY, sc->rid_ioport, sc->res_ioport);
 184
 185         return (0);
 186 }
 187
 188 DRIVER_MODULE(envctrl, ebus, envctrl_driver, envctrl_devclass, 0, 0);
 189 MODULE_DEPEND(envctrl, iicbus, PCF_MINVER, PCF_PREFVER, PCF_MAXVER);
 190 MODULE_VERSION(envctrl, PCF_MODVER);