The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/powerpc/aim/nexus.c

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright 1998 Massachusetts Institute of Technology
    3  *
    4  * Permission to use, copy, modify, and distribute this software and
    5  * its documentation for any purpose and without fee is hereby
    6  * granted, provided that both the above copyright notice and this
    7  * permission notice appear in all copies, that both the above
    8  * copyright notice and this permission notice appear in all
    9  * supporting documentation, and that the name of M.I.T. not be used
   10  * in advertising or publicity pertaining to distribution of the
   11  * software without specific, written prior permission.  M.I.T. makes
   12  * no representations about the suitability of this software for any
   13  * purpose.  It is provided "as is" without express or implied
   14  * warranty.
   15  *
   16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
   17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
   18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
   20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  */
   29 /*-
   30  * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>.  All rights reserved.
   31  *
   32  * Redistribution and use in source and binary forms, with or without
   33  * modification, are permitted provided that the following conditions
   34  * are met:
   35  * 1. Redistributions of source code must retain the above copyright
   36  *    notice, this list of conditions and the following disclaimer.
   37  * 2. Redistributions in binary form must reproduce the above copyright
   38  *    notice, this list of conditions and the following disclaimer in the
   39  *    documentation and/or other materials provided with the distribution.
   40  *
   41  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   51  * SUCH DAMAGE.
   52  *
   53  *      from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09
   54  */
   55 
   56 #include <sys/cdefs.h>
   57 __FBSDID("$FreeBSD$");
   58 
   59 #include <sys/param.h>
   60 #include <sys/systm.h>
   61 #include <sys/module.h>
   62 #include <sys/bus.h>
   63 #include <sys/cons.h>
   64 #include <sys/kernel.h>
   65 #include <sys/malloc.h>
   66 
   67 #include <dev/ofw/ofw_bus_subr.h>
   68 #include <dev/ofw/openfirm.h>
   69 
   70 #include <machine/bus.h>
   71 #include <machine/frame.h>
   72 #include <machine/intr_machdep.h>
   73 #include <machine/resource.h>
   74 
   75 #include <sys/rman.h>
   76 
   77 #include "ofw_bus_if.h"
   78 #include "pic_if.h"
   79 
   80 /*
   81  * The nexus (which is a pseudo-bus actually) iterates over the nodes that
   82  * exist in Open Firmware and adds them as devices to this bus so that drivers
   83  * can be attached to them.
   84  *
   85  * Maybe this code should get into dev/ofw to some extent, as some of it should
   86  * work for all Open Firmware based machines...
   87  */
   88 
   89 static MALLOC_DEFINE(M_NEXUS, "nexus", "nexus device information");
   90 
   91 enum nexus_ivars {
   92         NEXUS_IVAR_NODE,
   93         NEXUS_IVAR_NAME,
   94         NEXUS_IVAR_DEVICE_TYPE,
   95         NEXUS_IVAR_COMPATIBLE,
   96 };
   97 
   98 struct nexus_devinfo {
   99         phandle_t       ndi_node;
  100         /* Some common properties. */
  101         const char      *ndi_name;
  102         const char      *ndi_device_type;
  103         const char      *ndi_compatible;
  104 };
  105 
  106 struct nexus_softc {
  107         struct rman     sc_rman;
  108 };
  109 
  110 /*
  111  * Device interface
  112  */
  113 static int      nexus_probe(device_t);
  114 static int      nexus_attach(device_t);
  115 
  116 /*
  117  * Bus interface
  118  */
  119 static device_t nexus_add_child(device_t, u_int, const char *, int);
  120 static void     nexus_probe_nomatch(device_t, device_t);
  121 static int      nexus_read_ivar(device_t, device_t, int, uintptr_t *);
  122 static int      nexus_write_ivar(device_t, device_t, int, uintptr_t);
  123 #ifdef SMP
  124 static int      nexus_bind_intr(device_t dev, device_t child,
  125                     struct resource *irq, int cpu);
  126 #endif
  127 static int      nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
  128                     enum intr_polarity pol);
  129 static int      nexus_setup_intr(device_t, device_t, struct resource *, int,
  130                     driver_filter_t *, driver_intr_t *, void *, void **);
  131 static int      nexus_teardown_intr(device_t, device_t, struct resource *,
  132                     void *);
  133 static struct   resource *nexus_alloc_resource(device_t, device_t, int, int *,
  134                     u_long, u_long, u_long, u_int);
  135 static int      nexus_activate_resource(device_t, device_t, int, int,
  136                     struct resource *);
  137 static int      nexus_deactivate_resource(device_t, device_t, int, int,
  138                     struct resource *);
  139 static int      nexus_release_resource(device_t, device_t, int, int,
  140                     struct resource *);
  141 
  142 /*
  143  * OFW bus interface.
  144  */
  145 static phandle_t         nexus_ofw_get_node(device_t, device_t);
  146 static const char       *nexus_ofw_get_name(device_t, device_t);
  147 static const char       *nexus_ofw_get_type(device_t, device_t);
  148 static const char       *nexus_ofw_get_compat(device_t, device_t);
  149 
  150 /*
  151  * Local routines
  152  */
  153 static device_t nexus_device_from_node(device_t, phandle_t);
  154 
  155 static device_method_t nexus_methods[] = {
  156         /* Device interface */
  157         DEVMETHOD(device_probe,         nexus_probe),
  158         DEVMETHOD(device_attach,        nexus_attach),
  159         DEVMETHOD(device_detach,        bus_generic_detach),
  160         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  161         DEVMETHOD(device_suspend,       bus_generic_suspend),
  162         DEVMETHOD(device_resume,        bus_generic_resume),
  163 
  164         /* Bus interface. Resource management is business of the children... */
  165         DEVMETHOD(bus_add_child,        nexus_add_child),
  166         DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
  167         DEVMETHOD(bus_probe_nomatch,    nexus_probe_nomatch),
  168         DEVMETHOD(bus_read_ivar,        nexus_read_ivar),
  169         DEVMETHOD(bus_write_ivar,       nexus_write_ivar),
  170         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
  171         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
  172 #ifdef SMP
  173         DEVMETHOD(bus_bind_intr,        nexus_bind_intr),
  174 #endif
  175         DEVMETHOD(bus_config_intr,      nexus_config_intr),
  176         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
  177         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
  178         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
  179         DEVMETHOD(bus_release_resource, nexus_release_resource),
  180 
  181         /* OFW bus interface */
  182         DEVMETHOD(ofw_bus_get_node, nexus_ofw_get_node),
  183         DEVMETHOD(ofw_bus_get_name, nexus_ofw_get_name),
  184         DEVMETHOD(ofw_bus_get_type, nexus_ofw_get_type),
  185         DEVMETHOD(ofw_bus_get_compat, nexus_ofw_get_compat),
  186 
  187         DEVMETHOD_END
  188 };
  189 
  190 static driver_t nexus_driver = {
  191         "nexus",
  192         nexus_methods,
  193         sizeof(struct nexus_softc),
  194 };
  195 
  196 static devclass_t nexus_devclass;
  197 
  198 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
  199 
  200 static int
  201 nexus_probe(device_t dev)
  202 {
  203         bus_generic_probe(dev);
  204         device_set_desc(dev, "Open Firmware Nexus device");
  205         return (0);
  206 }
  207 
  208 static int
  209 nexus_attach(device_t dev)
  210 {
  211         phandle_t       root;
  212         phandle_t       child;
  213         struct          nexus_softc *sc;
  214         u_long          start, end;
  215 
  216         sc = device_get_softc(dev);
  217 
  218         start = 0;
  219         end = MAX_PICS*INTR_VECTORS - 1;
  220 
  221         sc->sc_rman.rm_start = start;
  222         sc->sc_rman.rm_end = end;
  223         sc->sc_rman.rm_type = RMAN_ARRAY;
  224         sc->sc_rman.rm_descr = "Interrupt request lines";
  225         if (rman_init(&sc->sc_rman) ||
  226             rman_manage_region(&sc->sc_rman, start, end))
  227                 panic("nexus_probe IRQ rman");
  228 
  229         if ((root = OF_peer(0)) == 0)
  230                 return (bus_generic_attach(dev));
  231                 
  232         /*
  233          * Now walk the OFW tree to locate top-level devices
  234          */
  235         for (child = OF_child(root); child != 0; child = OF_peer(child)) {
  236                 if (child == -1)
  237                         panic("nexus_probe(): OF_child failed.");
  238                 (void)nexus_device_from_node(dev, child);
  239 
  240         }
  241 
  242         return (bus_generic_attach(dev));
  243 }
  244 
  245 static void
  246 nexus_probe_nomatch(device_t dev, device_t child)
  247 {
  248         char    *name, *type;
  249 
  250         if (BUS_READ_IVAR(dev, child, NEXUS_IVAR_NAME,
  251             (uintptr_t *)&name) != 0 ||
  252             BUS_READ_IVAR(dev, child, NEXUS_IVAR_DEVICE_TYPE,
  253             (uintptr_t *)&type) != 0)
  254                 return;
  255 
  256         if (type == NULL)
  257                 type = "(unknown)";
  258 
  259         if (bootverbose)
  260                 device_printf(dev, "<%s>, type %s (no driver attached)\n",
  261                     name, type);
  262 }
  263 
  264 static device_t
  265 nexus_add_child(device_t dev, u_int order, const char *name, int unit)
  266 {
  267         device_t child;
  268         struct nexus_devinfo *dinfo;
  269 
  270         child = device_add_child_ordered(dev, order, name, unit);
  271         if (child == NULL)
  272                 return (NULL);
  273 
  274         dinfo = malloc(sizeof(struct nexus_devinfo), M_NEXUS, M_NOWAIT|M_ZERO);
  275         if (dinfo == NULL)
  276                 return (NULL);
  277 
  278         dinfo->ndi_node = -1;
  279         dinfo->ndi_name = name;
  280         device_set_ivars(child, dinfo);
  281 
  282         return (child);
  283 }
  284 
  285 
  286 static int
  287 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
  288 {
  289         struct nexus_devinfo *dinfo;
  290 
  291         if ((dinfo = device_get_ivars(child)) == 0)
  292                 return (ENOENT);
  293         switch (which) {
  294         case NEXUS_IVAR_NODE:
  295                 *result = dinfo->ndi_node;
  296                 break;
  297         case NEXUS_IVAR_NAME:
  298                 *result = (uintptr_t)dinfo->ndi_name;
  299                 break;
  300         case NEXUS_IVAR_DEVICE_TYPE:
  301                 *result = (uintptr_t)dinfo->ndi_device_type;
  302                 break;
  303         case NEXUS_IVAR_COMPATIBLE:
  304                 *result = (uintptr_t)dinfo->ndi_compatible;
  305                 break;
  306         default:
  307                 return (ENOENT);
  308         }
  309         return 0;
  310 }
  311 
  312 static int
  313 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
  314 {
  315         struct nexus_devinfo *dinfo;
  316 
  317         if ((dinfo = device_get_ivars(child)) == 0)
  318                 return (ENOENT);
  319 
  320         switch (which) {
  321         case NEXUS_IVAR_NAME:
  322                 return (EINVAL);
  323 
  324         /* Identified devices may want to set these */
  325         case NEXUS_IVAR_NODE:
  326                 dinfo->ndi_node = (phandle_t)value;
  327                 break;
  328 
  329         case NEXUS_IVAR_DEVICE_TYPE:
  330                 dinfo->ndi_device_type = (char *)value;
  331                 break;
  332 
  333         default:
  334                 return (ENOENT);
  335         }
  336         return 0;
  337 }
  338 
  339 static int
  340 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
  341     driver_filter_t *filter, driver_intr_t *ihand, void *arg, void **cookiep)
  342 {
  343         int             error;
  344 
  345         /* somebody tried to setup an irq that failed to allocate! */
  346         if (res == NULL)
  347                 panic("nexus_setup_intr: NULL irq resource!");
  348 
  349         *cookiep = 0;
  350         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
  351                 flags |= INTR_EXCL;
  352 
  353         /*
  354          * We depend here on rman_activate_resource() being idempotent.
  355          */
  356         error = rman_activate_resource(res);
  357         if (error)
  358                 return (error);
  359 
  360         error = powerpc_setup_intr(device_get_nameunit(child),
  361             rman_get_start(res), filter, ihand, arg, flags, cookiep);
  362 
  363         return (error);
  364 }
  365 
  366 static int
  367 nexus_teardown_intr(device_t dev, device_t child, struct resource *res,
  368     void *cookie)
  369 {
  370 
  371         return (powerpc_teardown_intr(cookie));
  372 }
  373 
  374 #ifdef SMP
  375 static int
  376 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
  377 {
  378 
  379         return (powerpc_bind_intr(rman_get_start(irq), cpu));
  380 }
  381 #endif
  382         
  383 static int
  384 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
  385     enum intr_polarity pol)
  386 {
  387 
  388         return (powerpc_config_intr(irq, trig, pol));
  389 }
  390 
  391 /*
  392  * Allocate resources at the behest of a child.  This only handles interrupts,
  393  * since I/O resources are handled by child busses.
  394  */
  395 static struct resource *
  396 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
  397     u_long start, u_long end, u_long count, u_int flags)
  398 {
  399         struct nexus_softc *sc;
  400         struct resource *rv;
  401 
  402         if (type != SYS_RES_IRQ) {
  403                 device_printf(bus, "unknown resource request from %s\n",
  404                     device_get_nameunit(child));
  405                 return (NULL);
  406         }
  407 
  408         if (count == 0 || start + count - 1 != end) {
  409                 device_printf(bus, "invalid IRQ allocation from %s\n",
  410                     device_get_nameunit(child));
  411                 return (NULL);
  412         }
  413 
  414         sc = device_get_softc(bus);
  415 
  416         rv = rman_reserve_resource(&sc->sc_rman, start, end, count,
  417             flags, child);
  418         if (rv == NULL) {
  419                 device_printf(bus, "IRQ allocation failed for %s\n",
  420                     device_get_nameunit(child));
  421         } else
  422                 rman_set_rid(rv, *rid);
  423 
  424         return (rv);
  425 }
  426 
  427 static int
  428 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
  429     struct resource *res)
  430 {
  431 
  432         /* Not much to be done yet... */
  433         return (rman_activate_resource(res));
  434 }
  435 
  436 static int
  437 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
  438     struct resource *res)
  439 {
  440 
  441         /* Not much to be done yet... */
  442         return (rman_deactivate_resource(res));
  443 }
  444 
  445 static int
  446 nexus_release_resource(device_t bus, device_t child, int type, int rid,
  447     struct resource *res)
  448 {
  449 
  450         if (type != SYS_RES_IRQ) {
  451                 device_printf(bus, "unknown resource request from %s\n",
  452                     device_get_nameunit(child));
  453                 return (EINVAL);
  454         }
  455 
  456         return (rman_release_resource(res));
  457 }
  458 
  459 static device_t
  460 nexus_device_from_node(device_t parent, phandle_t node)
  461 {
  462         device_t        cdev;
  463         struct          nexus_devinfo *dinfo;
  464         char            *name, *type, *compatible;
  465 
  466         OF_getprop_alloc(node, "name", 1, (void **)&name);
  467         OF_getprop_alloc(node, "device_type", 1, (void **)&type);
  468         OF_getprop_alloc(node, "compatible", 1, (void **)&compatible);
  469         cdev = device_add_child(parent, NULL, -1);
  470         if (cdev != NULL) {
  471                 dinfo = malloc(sizeof(*dinfo), M_NEXUS, M_WAITOK);
  472                 dinfo->ndi_node = node;
  473                 dinfo->ndi_name = name;
  474                 dinfo->ndi_device_type = type;
  475                 dinfo->ndi_compatible = compatible;
  476                 device_set_ivars(cdev, dinfo);
  477         } else
  478                 free(name, M_OFWPROP);
  479 
  480         return (cdev);
  481 }
  482 
  483 static const char *
  484 nexus_ofw_get_name(device_t bus, device_t dev)
  485 {
  486         struct nexus_devinfo *dinfo;
  487 
  488         if ((dinfo = device_get_ivars(dev)) == NULL)
  489                 return (NULL);
  490         
  491         return (dinfo->ndi_name);
  492 }
  493 
  494 static phandle_t
  495 nexus_ofw_get_node(device_t bus, device_t dev)
  496 {
  497         struct nexus_devinfo *dinfo;
  498 
  499         if ((dinfo = device_get_ivars(dev)) == NULL)
  500                 return (0);
  501         
  502         return (dinfo->ndi_node);
  503 }
  504 
  505 static const char *
  506 nexus_ofw_get_type(device_t bus, device_t dev)
  507 {
  508         struct nexus_devinfo *dinfo;
  509 
  510         if ((dinfo = device_get_ivars(dev)) == NULL)
  511                 return (NULL);
  512         
  513         return (dinfo->ndi_device_type);
  514 }
  515 
  516 static const char *
  517 nexus_ofw_get_compat(device_t bus, device_t dev)
  518 {
  519         struct nexus_devinfo *dinfo;
  520 
  521         if ((dinfo = device_get_ivars(dev)) == NULL)
  522                 return (NULL);
  523         
  524         return (dinfo->ndi_compatible);
  525 }
  526 

Cache object: 5446de3f54972ce95998e460f064256a


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.