sys/dev/ofw/ofwbus.c

   1 /*-
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>.
   4  * Copyright 2006 by Marius Strobl <marius@FreeBSD.org>.
   5  * All rights reserved.
   6  *
   7  * Permission to use, copy, modify, and distribute this software and
   8  * its documentation for any purpose and without fee is hereby
   9  * granted, provided that both the above copyright notice and this
  10  * permission notice appear in all copies, that both the above
  11  * copyright notice and this permission notice appear in all
  12  * supporting documentation, and that the name of M.I.T. not be used
  13  * in advertising or publicity pertaining to distribution of the
  14  * software without specific, written prior permission.  M.I.T. makes
  15  * no representations about the suitability of this software for any
  16  * purpose.  It is provided "as is" without express or implied
  17  * warranty.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  20  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  21  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  23  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/bus.h>
  41 #include <sys/kernel.h>
  42 #include <sys/malloc.h>
  43 #include <sys/module.h>
  44 #include <sys/pcpu.h>
  45 #include <sys/rman.h>
  46 #ifdef INTRNG
  47 #include <sys/intr.h>
  48 #endif
  49
  50 #include <vm/vm.h>
  51 #include <vm/pmap.h>
  52
  53 #include <dev/ofw/ofw_bus.h>
  54 #include <dev/ofw/ofw_bus_subr.h>
  55 #include <dev/ofw/openfirm.h>
  56 #include <dev/fdt/simplebus.h>
  57
  58 #include <machine/bus.h>
  59 #include <machine/resource.h>
  60
  61 /*
  62  * The ofwbus (which is a pseudo-bus actually) iterates over the nodes that
  63  * hang from the Open Firmware root node and adds them as devices to this bus
  64  * (except some special nodes which are excluded) so that drivers can be
  65  * attached to them. There should be only one ofwbus in the system, added
  66  * directly as a child of nexus0.
  67  */
  68
  69 static device_probe_t ofwbus_probe;
  70 static device_attach_t ofwbus_attach;
  71 static bus_alloc_resource_t ofwbus_alloc_resource;
  72 static bus_release_resource_t ofwbus_release_resource;
  73
  74 static device_method_t ofwbus_methods[] = {
  75         /* Device interface */
  76         DEVMETHOD(device_probe,         ofwbus_probe),
  77         DEVMETHOD(device_attach,        ofwbus_attach),
  78
  79         /* Bus interface */
  80         DEVMETHOD(bus_alloc_resource,   ofwbus_alloc_resource),
  81         DEVMETHOD(bus_adjust_resource,  bus_generic_adjust_resource),
  82         DEVMETHOD(bus_release_resource, ofwbus_release_resource),
  83
  84         DEVMETHOD_END
  85 };
  86
  87 DEFINE_CLASS_1(ofwbus, ofwbus_driver, ofwbus_methods,
  88     sizeof(struct simplebus_softc), simplebus_driver);
  89 static devclass_t ofwbus_devclass;
  90 EARLY_DRIVER_MODULE(ofwbus, nexus, ofwbus_driver, ofwbus_devclass, 0, 0,
  91     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
  92 MODULE_VERSION(ofwbus, 1);
  93
  94 static int
  95 ofwbus_probe(device_t dev)
  96 {
  97
  98         if (OF_peer(0) == 0)
  99                 return (ENXIO);
 100
 101         /* Only one instance of ofwbus. */
 102         if (device_get_unit(dev) != 0)
 103                 panic("ofwbus added with non-zero unit number: %d\n",
 104                     device_get_unit(dev));
 105
 106         device_set_desc(dev, "Open Firmware Device Tree");
 107         return (BUS_PROBE_NOWILDCARD);
 108 }
 109
 110 static int
 111 ofwbus_attach(device_t dev)
 112 {
 113         phandle_t node;
 114         struct ofw_bus_devinfo obd;
 115
 116         node = OF_peer(0);
 117
 118         /*
 119          * If no Open Firmware, bail early
 120          */
 121         if (node == -1)
 122                 return (ENXIO);
 123
 124         /*
 125          * ofwbus bus starts on unamed node in FDT, so we cannot make
 126          * ofw_bus_devinfo from it. Pass node to simplebus_init directly.
 127          */
 128         simplebus_init(dev, node);
 129
 130         /*
 131          * Allow devices to identify.
 132          */
 133         bus_generic_probe(dev);
 134
 135         /*
 136          * Now walk the OFW tree and attach top-level devices.
 137          */
 138         for (node = OF_child(node); node > 0; node = OF_peer(node)) {
 139                 if (ofw_bus_gen_setup_devinfo(&obd, node) != 0)
 140                         continue;
 141                 simplebus_add_device(dev, node, 0, NULL, -1, NULL);
 142                 ofw_bus_gen_destroy_devinfo(&obd);
 143         }
 144         return (bus_generic_attach(dev));
 145 }
 146
 147 static struct resource *
 148 ofwbus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 149     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 150 {
 151         struct resource *rv;
 152         struct resource_list_entry *rle;
 153         bool isdefault, passthrough;
 154
 155         isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
 156         passthrough = (device_get_parent(child) != bus);
 157         rle = NULL;
 158         if (!passthrough && isdefault) {
 159                 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
 160                     type, *rid);
 161                 if (rle == NULL) {
 162                         if (bootverbose)
 163                                 device_printf(bus, "no default resources for "
 164                                     "rid = %d, type = %d\n", *rid, type);
 165                         return (NULL);
 166                 }
 167                 start = rle->start;
 168                 count = ummax(count, rle->count);
 169                 end = ummax(rle->end, start + count - 1);
 170         }
 171
 172         /* Let nexus handle the allocation. */
 173         rv = bus_generic_alloc_resource(bus, child, type, rid, start, end,
 174             count, flags);
 175         if (rv == NULL)
 176                 return (NULL);
 177
 178         if (!passthrough && rle != NULL) {
 179                 rle->res = rv;
 180                 rle->start = rman_get_start(rv);
 181                 rle->end = rman_get_end(rv);
 182                 rle->count = rle->end - rle->start + 1;
 183         }
 184
 185         return (rv);
 186 }
 187
 188 static int
 189 ofwbus_release_resource(device_t bus, device_t child, int type,
 190     int rid, struct resource *r)
 191 {
 192         struct resource_list_entry *rle;
 193         bool passthrough;
 194
 195         passthrough = (device_get_parent(child) != bus);
 196         if (!passthrough) {
 197                 /* Clean resource list entry */
 198                 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
 199                     type, rid);
 200                 if (rle != NULL)
 201                         rle->res = NULL;
 202         }
 203
 204         /* Let nexus handle the release. */
 205         return (bus_generic_release_resource(bus, child, type, rid, r));
 206 }