/*-
 * Copyright (c) 1997,1998 Doug Rabson
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 * $FreeBSD$
 */

#include "opt_bus.h"

#include <sys/param.h>
#include <sys/queue.h>
#include <sys/malloc.h>
#include <sys/kernel.h>
#include <sys/module.h>
#ifdef DEVICE_SYSCTLS
#include <sys/sysctl.h>
#endif
#include <sys/bus_private.h>
#include <sys/systm.h>
#include <machine/bus.h>
#include <sys/rman.h>
#include <machine/stdarg.h>	/* for device_printf() */

MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");

#ifdef BUS_DEBUG
#define PDEBUG(a)	(printf(__FUNCTION__ ":%d: ", __LINE__), printf a, printf("\n"))
#define DEVICENAME(d)	((d)? device_get_name(d): "no device")
#define DRIVERNAME(d)	((d)? d->name : "no driver")
#define DEVCLANAME(d)	((d)? d->name : "no devclass")

/* Produce the indenting, indent*2 spaces plus a '.' ahead of that to 
 * prevent syslog from deleting initial spaces
 */
#define indentprintf(p)	do { int iJ; printf("."); for (iJ=0; iJ<indent; iJ++) printf("  "); printf p ; } while(0)

static void print_method_list(device_method_t *m, int indent);
static void print_device_ops(device_ops_t ops, int indent);
static void print_device_short(device_t dev, int indent);
static void print_device(device_t dev, int indent);
void print_device_tree_short(device_t dev, int indent);
void print_device_tree(device_t dev, int indent);
static void print_driver_short(driver_t *driver, int indent);
static void print_driver(driver_t *driver, int indent);
static void print_driver_list(driver_list_t drivers, int indent);
static void print_devclass_short(devclass_t dc, int indent);
static void print_devclass(devclass_t dc, int indent);
void print_devclass_list_short(void);
void print_devclass_list(void);

#else
/* Make the compiler ignore the function calls */
#define PDEBUG(a)			/* nop */
#define DEVICENAME(d)			/* nop */
#define DRIVERNAME(d)			/* nop */
#define DEVCLANAME(d)			/* nop */

#define print_method_list(m,i)		/* nop */
#define print_device_ops(o,i)		/* nop */
#define print_device_short(d,i)		/* nop */
#define print_device(d,i)		/* nop */
#define print_device_tree_short(d,i)	/* nop */
#define print_device_tree(d,i)		/* nop */
#define print_driver_short(d,i)		/* nop */
#define print_driver(d,i)		/* nop */
#define print_driver_list(d,i)		/* nop */
#define print_devclass_short(d,i)	/* nop */
#define print_devclass(d,i)		/* nop */
#define print_devclass_list_short()	/* nop */
#define print_devclass_list()		/* nop */
#endif

#ifdef DEVICE_SYSCTLS
static void device_register_oids(device_t dev);
static void device_unregister_oids(device_t dev);
#endif

/*
 * Method table handling
 */
static int error_method(void);
static int next_method_offset = 1;

LIST_HEAD(methodlist, method) methods;
struct method {
    LIST_ENTRY(method) link;	/* linked list of methods */
    int offset;			/* offset in method table */
    int refs;			/* count of device_op_desc users */
    devop_t deflt;		/* default implementation */
    char* name;			/* unique name of method */
};

static void
register_method(struct device_op_desc *desc)
{
    struct method* m;

    if (desc->method) {
	desc->method->refs++;
	return;
    }

    /*
     * Make sure that desc->deflt is always valid to simplify dispatch.
     */
    if (!desc->deflt)
	desc->deflt = error_method;

    for (m = LIST_FIRST(&methods); m; m = LIST_NEXT(m, link)) {
	if (!strcmp(m->name, desc->name)) {
	    desc->offset = m->offset;
	    desc->method = m;
	    m->refs++;
	    PDEBUG(("method %p has the same name, %s, with offset %d",
		    (void *)m, desc->name, desc->offset));
	    return;
	}
    }

    m = (struct method *) malloc(sizeof(struct method)
				 + strlen(desc->name) + 1,
				 M_BUS, M_NOWAIT);
    if (!m)
	    panic("register_method: out of memory");
    bzero(m, sizeof(struct method) + strlen(desc->name) + 1);
    m->offset = next_method_offset++;
    m->refs = 1;
    m->deflt = desc->deflt;
    m->name = (char*) (m + 1);
    strcpy(m->name, desc->name);
    LIST_INSERT_HEAD(&methods, m, link);

    desc->offset = m->offset;
    desc->method = m;
}

static void
unregister_method(struct device_op_desc *desc)
{
    struct method *m = desc->method;
    m->refs--;
    if (m->refs == 0) {
	PDEBUG(("method %s, reached refcount 0", desc->name));
	LIST_REMOVE(m, link);
	free(m, M_BUS);
    	desc->method = 0;
    }
}

static int error_method(void)
{
    return ENXIO;
}

static struct device_ops null_ops = {
    1, 
    { error_method }
};

static void
compile_methods(driver_t *driver)
{
    device_ops_t ops;
    struct device_method *m;
    struct method *cm;
    int i;

    /*
     * First register any methods which need it.
     */
    for (i = 0, m = driver->methods; m->desc; i++, m++)
	register_method(m->desc);

    /*
     * Then allocate the compiled op table.
     */
    ops = malloc(sizeof(struct device_ops) + (next_method_offset-1) * sizeof(devop_t),
		 M_BUS, M_NOWAIT);
    if (!ops)
	panic("compile_methods: out of memory");
    bzero(ops, sizeof(struct device_ops) + (next_method_offset-1) * sizeof(devop_t));

    ops->maxoffset = next_method_offset;
    /* Fill in default methods and then overwrite with driver methods */
    for (i = 0; i < next_method_offset; i++)
	ops->methods[i] = error_method;
    for (cm = LIST_FIRST(&methods); cm; cm = LIST_NEXT(cm, link)) {
	if (cm->deflt)
	    ops->methods[cm->offset] = cm->deflt;
    }
    for (i = 0, m = driver->methods; m->desc; i++, m++)
	ops->methods[m->desc->offset] = m->func;
    PDEBUG(("%s has %d method%s, wasting %d bytes",
    		DRIVERNAME(driver), i, (i==1?"":"s"),
		(next_method_offset-i)*sizeof(devop_t)));

    driver->ops = ops;
}

static void
free_methods(driver_t *driver)
{
    int i;
    struct device_method *m;

    /*
     * Unregister any methods which are no longer used.
     */
    for (i = 0, m = driver->methods; m->desc; i++, m++)
	unregister_method(m->desc);

    /*
     * Free memory and clean up.
     */
    free(driver->ops, M_BUS);
    driver->ops = 0;
}

/*
 * Devclass implementation
 */

static devclass_list_t devclasses = TAILQ_HEAD_INITIALIZER(devclasses);

static devclass_t
devclass_find_internal(const char *classname, int create)
{
    devclass_t dc;

    PDEBUG(("looking for %s", classname));
    if (!classname)
	return NULL;

    for (dc = TAILQ_FIRST(&devclasses); dc; dc = TAILQ_NEXT(dc, link))
	if (!strcmp(dc->name, classname))
	    return dc;

    PDEBUG(("%s not found%s", classname, (create? ", creating": "")));
    if (create) {
	dc = malloc(sizeof(struct devclass) + strlen(classname) + 1,
		    M_BUS, M_NOWAIT);
	if (!dc)
	    return NULL;
	bzero(dc, sizeof(struct devclass) + strlen(classname) + 1);
	dc->name = (char*) (dc + 1);
	strcpy(dc->name, classname);
	dc->devices = NULL;
	dc->maxunit = 0;
	dc->nextunit = 0;
	TAILQ_INIT(&dc->drivers);
	TAILQ_INSERT_TAIL(&devclasses, dc, link);
    }

    return dc;
}

devclass_t
devclass_create(const char *classname)
{
    return devclass_find_internal(classname, TRUE);
}

devclass_t
devclass_find(const char *classname)
{
    return devclass_find_internal(classname, FALSE);
}

int
devclass_add_driver(devclass_t dc, driver_t *driver)
{
    driverlink_t dl;
    int i;

    PDEBUG(("%s", DRIVERNAME(driver)));

    dl = malloc(sizeof *dl, M_BUS, M_NOWAIT);
    if (!dl)
	return ENOMEM;
    bzero(dl, sizeof *dl);

    /*
     * Compile the driver's methods.
     */
    if (!driver->ops)
	compile_methods(driver);

    /*
     * Make sure the devclass which the driver is implementing exists.
     */
    devclass_find_internal(driver->name, TRUE);

    dl->driver = driver;
    TAILQ_INSERT_TAIL(&dc->drivers, dl, link);
    driver->refs++;

    /*
     * Call BUS_DRIVER_ADDED for any existing busses in this class.
     */
    for (i = 0; i < dc->maxunit; i++)
	if (dc->devices[i])
	    BUS_DRIVER_ADDED(dc->devices[i], driver);

    return 0;
}

int
devclass_delete_driver(devclass_t busclass, driver_t *driver)
{
    devclass_t dc = devclass_find(driver->name);
    driverlink_t dl;
    device_t dev;
    int i;
    int error;

    PDEBUG(("%s from devclass %s", driver->name, DEVCLANAME(busclass)));

    if (!dc)
	return 0;

    /*
     * Find the link structure in the bus' list of drivers.
     */
    for (dl = TAILQ_FIRST(&busclass->drivers); dl;
	 dl = TAILQ_NEXT(dl, link)) {
	if (dl->driver == driver)
	    break;
    }

    if (!dl) {
	PDEBUG(("%s not found in %s list", driver->name, busclass->name));
	return ENOENT;
    }

    /*
     * Disassociate from any devices.  We iterate through all the
     * devices in the devclass of the driver and detach any which are
     * using the driver and which have a parent in the devclass which
     * we are deleting from.
     *
     * Note that since a driver can be in multiple devclasses, we
     * should not detach devices which are not children of devices in
     * the affected devclass.
     */
    for (i = 0; i < dc->maxunit; i++) {
	if (dc->devices[i]) {
	    dev = dc->devices[i];
	    if (dev->driver == driver
		&& dev->parent && dev->parent->devclass == busclass) {
		if ((error = device_detach(dev)) != 0)
		    return error;
		device_set_driver(dev, NULL);
	    }
	}
    }

    TAILQ_REMOVE(&busclass->drivers, dl, link);
    free(dl, M_BUS);

    driver->refs--;
    if (driver->refs == 0)
	free_methods(driver);

    return 0;
}

static driverlink_t
devclass_find_driver_internal(devclass_t dc, const char *classname)
{
    driverlink_t dl;

    PDEBUG(("%s in devclass %s", classname, DEVCLANAME(dc)));

    for (dl = TAILQ_FIRST(&dc->drivers); dl; dl = TAILQ_NEXT(dl, link)) {
	if (!strcmp(dl->driver->name, classname))
	    return dl;
    }

    PDEBUG(("not found"));
    return NULL;
}

driver_t *
devclass_find_driver(devclass_t dc, const char *classname)
{
    driverlink_t dl;

    dl = devclass_find_driver_internal(dc, classname);
    if (dl)
	return dl->driver;
    else
	return NULL;
}

const char *
devclass_get_name(devclass_t dc)
{
    return dc->name;
}

device_t
devclass_get_device(devclass_t dc, int unit)
{
    if (dc == NULL || unit < 0 || unit >= dc->maxunit)
	return NULL;
    return dc->devices[unit];
}

void *
devclass_get_softc(devclass_t dc, int unit)
{
    device_t dev;

    dev = devclass_get_device(dc, unit);
    if (!dev)
	return (NULL);

    return (device_get_softc(dev));
}

int
devclass_get_devices(devclass_t dc, device_t **devlistp, int *devcountp)
{
    int i;
    int count;
    device_t *list;
    
    count = 0;
    for (i = 0; i < dc->maxunit; i++)
	if (dc->devices[i])
	    count++;

    list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT);
    if (!list)
	return ENOMEM;
    bzero(list, count * sizeof(device_t));

    count = 0;
    for (i = 0; i < dc->maxunit; i++)
	if (dc->devices[i]) {
	    list[count] = dc->devices[i];
	    count++;
	}

    *devlistp = list;
    *devcountp = count;

    return 0;
}

int
devclass_get_maxunit(devclass_t dc)
{
    return dc->maxunit;
}

static int
devclass_alloc_unit(devclass_t dc, int *unitp)
{
    int unit = *unitp;

    PDEBUG(("unit %d in devclass %s", unit, DEVCLANAME(dc)));

    /*
     * If we have been given a wired unit number, check for existing
     * device.
     */
    if (unit != -1) {
	device_t dev;
	dev = devclass_get_device(dc, unit);
	if (dev) {
	    printf("devclass_alloc_unit: %s%d already exists, using next available unit number\n", dc->name, unit);
	    unit = -1;
	}
    }

    if (unit == -1) {
	unit = dc->nextunit;
	dc->nextunit++;
    } else if (dc->nextunit <= unit)
	dc->nextunit = unit + 1;

    if (unit >= dc->maxunit) {
	device_t *newlist;
	int newsize;

	newsize = (dc->maxunit ? 2 * dc->maxunit
		   : MINALLOCSIZE / sizeof(device_t));
	newlist = malloc(sizeof(device_t) * newsize, M_BUS, M_NOWAIT);
	if (!newlist)
	    return ENOMEM;
	bcopy(dc->devices, newlist, sizeof(device_t) * dc->maxunit);
	bzero(newlist + dc->maxunit,
	      sizeof(device_t) * (newsize - dc->maxunit));
	if (dc->devices)
	    free(dc->devices, M_BUS);
	dc->devices = newlist;
	dc->maxunit = newsize;
    }
    PDEBUG(("now: unit %d in devclass %s", unit, DEVCLANAME(dc)));

    *unitp = unit;
    return 0;
}

static int
devclass_add_device(devclass_t dc, device_t dev)
{
    int buflen, error;

    PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));

    buflen = strlen(dc->name) + 5;
    dev->nameunit = malloc(buflen, M_BUS, M_NOWAIT);
    if (!dev->nameunit)
	return ENOMEM;
    bzero(dev->nameunit, buflen);

    if ((error = devclass_alloc_unit(dc, &dev->unit)) != 0) {
	free(dev->nameunit, M_BUS);
	dev->nameunit = NULL;
	return error;
    }
    dc->devices[dev->unit] = dev;
    dev->devclass = dc;
    snprintf(dev->nameunit, buflen, "%s%d", dc->name, dev->unit);

#ifdef DEVICE_SYSCTLS
    device_register_oids(dev);
#endif

    return 0;
}

static int
devclass_delete_device(devclass_t dc, device_t dev)
{
    if (!dc || !dev)
	return 0;

    PDEBUG(("%s in devclass %s", DEVICENAME(dev), DEVCLANAME(dc)));

    if (dev->devclass != dc
	|| dc->devices[dev->unit] != dev)
	panic("devclass_delete_device: inconsistent device class");
    dc->devices[dev->unit] = NULL;
    if (dev->flags & DF_WILDCARD)
	dev->unit = -1;
    dev->devclass = NULL;
    free(dev->nameunit, M_BUS);
    dev->nameunit = NULL;
    while (dc->nextunit > 0 && dc->devices[dc->nextunit - 1] == NULL)
	dc->nextunit--;

#ifdef DEVICE_SYSCTLS
    device_unregister_oids(dev);
#endif

    return 0;
}

static device_t
make_device(device_t parent, const char *name, int unit)
{
    device_t dev;
    devclass_t dc;

    PDEBUG(("%s at %s as unit %d", name, DEVICENAME(parent), unit));

    if (name) {
	dc = devclass_find_internal(name, TRUE);
	if (!dc) {
	    printf("make_device: can't find device class %s\n", name);
	    return NULL;
	}
    } else
	dc = NULL;

    dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT);
    if (!dev)
	return 0;
    bzero(dev, sizeof(struct device));

    dev->parent = parent;
    TAILQ_INIT(&dev->children);
    dev->ops = &null_ops;
    dev->driver = NULL;
    dev->devclass = NULL;
    dev->unit = unit;
    dev->nameunit = NULL;
    dev->desc = NULL;
    dev->busy = 0;
    dev->devflags = 0;
    dev->flags = DF_ENABLED;
    dev->order = 0;
    if (unit == -1)
	dev->flags |= DF_WILDCARD;
    if (name) {
	dev->flags |= DF_FIXEDCLASS;
	devclass_add_device(dc, dev);
    }
    dev->ivars = NULL;
    dev->softc = NULL;

    dev->state = DS_NOTPRESENT;

    return dev;
}

static int
device_print_child(device_t dev, device_t child)
{
    int retval = 0;

    if (device_is_alive(child)) {
	retval += BUS_PRINT_CHILD(dev, child);
    } else
	retval += device_printf(child, " not found\n");

    return (retval);
}

device_t
device_add_child(device_t dev, const char *name, int unit)
{
    return device_add_child_ordered(dev, 0, name, unit);
}

device_t
device_add_child_ordered(device_t dev, int order, const char *name, int unit)
{
    device_t child;
    device_t place;

    PDEBUG(("%s at %s with order %d as unit %d",
	    name, DEVICENAME(dev), order, unit));

    child = make_device(dev, name, unit);
    if (child == NULL)
	return child;
    child->order = order;

    TAILQ_FOREACH(place, &dev->children, link)
	if (place->order > order)
	    break;

    if (place) {
	/*
	 * The device 'place' is the first device whose order is
	 * greater than the new child.
	 */
	TAILQ_INSERT_BEFORE(place, child, link);
    } else {
	/*
	 * The new child's order is greater or equal to the order of
	 * any existing device. Add the child to the tail of the list.
	 */
	TAILQ_INSERT_TAIL(&dev->children, child, link);
    }

    return child;
}

int
device_delete_child(device_t dev, device_t child)
{
    int error;
    device_t grandchild;

    PDEBUG(("%s from %s", DEVICENAME(child), DEVICENAME(dev)));

    /* remove children first */
    while ( (grandchild = TAILQ_FIRST(&child->children)) ) {
        error = device_delete_child(child, grandchild);
	if (error)
	    return error;
    }

    if ((error = device_detach(child)) != 0)
	return error;
    if (child->devclass)
	devclass_delete_device(child->devclass, child);
    TAILQ_REMOVE(&dev->children, child, link);
    device_set_desc(child, NULL);
    free(child, M_BUS);

    return 0;
}

/*
 * Find only devices attached to this bus.
 */
device_t
device_find_child(device_t dev, const char *classname, int unit)
{
    devclass_t dc;
    device_t child;

    dc = devclass_find(classname);
    if (!dc)
	return NULL;

    child = devclass_get_device(dc, unit);
    if (child && child->parent == dev)
	return child;
    return NULL;
}

static driverlink_t
first_matching_driver(devclass_t dc, device_t dev)
{
    if (dev->devclass)
	return devclass_find_driver_internal(dc, dev->devclass->name);
    else
	return TAILQ_FIRST(&dc->drivers);
}

static driverlink_t
next_matching_driver(devclass_t dc, device_t dev, driverlink_t last)
{
    if (dev->devclass) {
	driverlink_t dl;
	for (dl = TAILQ_NEXT(last, link); dl; dl = TAILQ_NEXT(dl, link))
	    if (!strcmp(dev->devclass->name, dl->driver->name))
		return dl;
	return NULL;
    } else
	return TAILQ_NEXT(last, link);
}

static int
device_probe_child(device_t dev, device_t child)
{
    devclass_t dc;
    driverlink_t best = 0;
    driverlink_t dl;
    int result, pri = 0;

    dc = dev->devclass;
    if (dc == NULL)
	panic("device_probe_child: parent device has no devclass");

    if (child->state == DS_ALIVE)
	return 0;

    for (dl = first_matching_driver(dc, child);
	 dl;
	 dl = next_matching_driver(dc, child, dl)) {
	PDEBUG(("Trying %s", DRIVERNAME(dl->driver)));
	device_set_driver(child, dl->driver);
	result = DEVICE_PROBE(child);

	/*
	 * If the driver returns SUCCESS, there can be no higher match
	 * for this device.
	 */
	if (result == 0) {
	    best = dl;
	    pri = 0;
	    break;
	}

	/*
	 * The driver returned an error so it certainly doesn't match.
	 */
	if (result > 0)
	    continue;

	/*
	 * A priority lower than SUCCESS, remember the best matching
	 * driver. Initialise the value of pri for the first match.
	 */
	if (best == 0 || result > pri) {
	    best = dl;
	    pri = result;
	    continue;
	}
    }

    /*
     * If we found a driver, change state and initialise the devclass.
     */
    if (best) {
	if (!child->devclass)
	    device_set_devclass(child, best->driver->name);
	device_set_driver(child, best->driver);
	if (pri < 0) {
	    /*
	     * A bit bogus. Call the probe method again to make sure
	     * that we have the right description.
	     */
	    DEVICE_PROBE(child);
	}
	child->state = DS_ALIVE;
	return 0;
    }

    return ENXIO;
}

device_t
device_get_parent(device_t dev)
{
    return dev->parent;
}

int
device_get_children(device_t dev, device_t **devlistp, int *devcountp)
{
    int count;
    device_t child;
    device_t *list;
    
    count = 0;
    for (child = TAILQ_FIRST(&dev->children); child;
	 child = TAILQ_NEXT(child, link))
	count++;

    list = malloc(count * sizeof(device_t), M_TEMP, M_NOWAIT);
    if (!list)
	return ENOMEM;
    bzero(list, count * sizeof(device_t));

    count = 0;
    for (child = TAILQ_FIRST(&dev->children); child;
	 child = TAILQ_NEXT(child, link)) {
	list[count] = child;
	count++;
    }

    *devlistp = list;
    *devcountp = count;

    return 0;
}

driver_t *
device_get_driver(device_t dev)
{
    return dev->driver;
}

devclass_t
device_get_devclass(device_t dev)
{
    return dev->devclass;
}

const char *
device_get_name(device_t dev)
{
    if (dev->devclass)
	return devclass_get_name(dev->devclass);
    return NULL;
}

const char *
device_get_nameunit(device_t dev)
{
    return dev->nameunit;
}

int
device_get_unit(device_t dev)
{
    return dev->unit;
}

const char *
device_get_desc(device_t dev)
{
    return dev->desc;
}

u_int32_t
device_get_flags(device_t dev)
{
    return dev->devflags;
}

int
device_print_prettyname(device_t dev)
{
    const char *name = device_get_name(dev);

    if (name == 0)
	return printf("unknown: ");
    else
	return printf("%s%d: ", name, device_get_unit(dev));
}

int
device_printf(device_t dev, const char * fmt, ...)
{
    va_list ap;
    int retval;

    retval = device_print_prettyname(dev);
    va_start(ap, fmt);
    retval += vprintf(fmt, ap);
    va_end(ap);
    return retval;
}

static void
device_set_desc_internal(device_t dev, const char* desc, int copy)
{
    if (dev->desc && (dev->flags & DF_DESCMALLOCED)) {
	free(dev->desc, M_BUS);
	dev->flags &= ~DF_DESCMALLOCED;
	dev->desc = NULL;
    }

    if (copy && desc) {
	dev->desc = malloc(strlen(desc) + 1, M_BUS, M_NOWAIT);
	if (dev->desc) {
	    strcpy(dev->desc, desc);
	    dev->flags |= DF_DESCMALLOCED;
	}
    } else
	/* Avoid a -Wcast-qual warning */
	dev->desc = (char *)(uintptr_t) desc;

#ifdef DEVICE_SYSCTLS
    {
	struct sysctl_oid *oid = &dev->oid[1];
	oid->oid_arg1 = dev->desc ? dev->desc : "";
	oid->oid_arg2 = dev->desc ? strlen(dev->desc) : 0;
    }
#endif
}

void
device_set_desc(device_t dev, const char* desc)
{
    device_set_desc_internal(dev, desc, FALSE);
}

void
device_set_desc_copy(device_t dev, const char* desc)
{
    device_set_desc_internal(dev, desc, TRUE);
}

void
device_set_flags(device_t dev, u_int32_t flags)
{
    dev->devflags = flags;
}

void *
device_get_softc(device_t dev)
{
    return dev->softc;
}

void *
device_get_ivars(device_t dev)
{
    return dev->ivars;
}

void
device_set_ivars(device_t dev, void * ivars)
{
    if (!dev)
	return;

    dev->ivars = ivars;

    return;
}

device_state_t
device_get_state(device_t dev)
{
    return dev->state;
}

void
device_enable(device_t dev)
{
    dev->flags |= DF_ENABLED;
}

void
device_disable(device_t dev)
{
    dev->flags &= ~DF_ENABLED;
}

void
device_busy(device_t dev)
{
    if (dev->state < DS_ATTACHED)
	panic("device_busy: called for unattached device");
    if (dev->busy == 0 && dev->parent)
	device_busy(dev->parent);
    dev->busy++;
    dev->state = DS_BUSY;
}

void
device_unbusy(device_t dev)
{
    if (dev->state != DS_BUSY)
	panic("device_unbusy: called for non-busy device");
    dev->busy--;
    if (dev->busy == 0) {
	if (dev->parent)
	    device_unbusy(dev->parent);
	dev->state = DS_ATTACHED;
    }
}

void
device_quiet(device_t dev)
{
    dev->flags |= DF_QUIET;
}

void
device_verbose(device_t dev)
{
    dev->flags &= ~DF_QUIET;
}

int
device_is_quiet(device_t dev)
{
    return (dev->flags & DF_QUIET) != 0;
}

int
device_is_enabled(device_t dev)
{
    return (dev->flags & DF_ENABLED) != 0;
}

int
device_is_alive(device_t dev)
{
    return dev->state >= DS_ALIVE;
}

int
device_set_devclass(device_t dev, const char *classname)
{
    devclass_t dc;

    if (dev->devclass) {
	printf("device_set_devclass: device class already set\n");
	return EINVAL;
    }

    dc = devclass_find_internal(classname, TRUE);
    if (!dc)
	return ENOMEM;

    return devclass_add_device(dc, dev);
}

int
device_set_driver(device_t dev, driver_t *driver)
{
    if (dev->state >= DS_ATTACHED)
	return EBUSY;

    if (dev->driver == driver)
	return 0;

    if (dev->softc) {
	free(dev->softc, M_BUS);
	dev->softc = NULL;
    }
    dev->ops = &null_ops;
    dev->driver = driver;
    if (driver) {
	dev->ops = driver->ops;
	dev->softc = malloc(driver->softc, M_BUS, M_NOWAIT);
	if (!dev->softc) {
	    dev->ops = &null_ops;
	    dev->driver = NULL;
	    return ENOMEM;
	}
	bzero(dev->softc, driver->softc);
    }
    return 0;
}

int
device_probe_and_attach(device_t dev)
{
    device_t bus = dev->parent;
    int error = 0;

    if (dev->state >= DS_ALIVE)
	return 0;

    if (dev->flags & DF_ENABLED) {
	error = device_probe_child(bus, dev);
	if (!error) {
	    if (!device_is_quiet(dev))
		device_print_child(bus, dev);
	    error = DEVICE_ATTACH(dev);
	    if (!error)
		dev->state = DS_ATTACHED;
	    else {
		printf("device_probe_and_attach: %s%d attach returned %d\n",
		       dev->driver->name, dev->unit, error);
		device_set_driver(dev, NULL);
		dev->state = DS_NOTPRESENT;
	    }
	} else {
		BUS_PROBE_NOMATCH(bus, dev);
	}
    } else {
	    device_print_prettyname(dev);
	    printf("not probed (disabled)\n");
    }

    return error;
}

int
device_detach(device_t dev)
{
    int error;

    PDEBUG(("%s", DEVICENAME(dev)));
    if (dev->state == DS_BUSY)
	return EBUSY;
    if (dev->state != DS_ATTACHED)
	return 0;

    if ((error = DEVICE_DETACH(dev)) != 0)
	return error;
    if (dev->parent)
	BUS_CHILD_DETACHED(dev->parent, dev);

    if (!(dev->flags & DF_FIXEDCLASS))
	devclass_delete_device(dev->devclass, dev);

    dev->state = DS_NOTPRESENT;
    device_set_driver(dev, NULL);

    return 0;
}

int
device_shutdown(device_t dev)
{
    if (dev->state < DS_ATTACHED)
	return 0;
    return DEVICE_SHUTDOWN(dev);
}

#ifdef DEVICE_SYSCTLS

/*
 * Sysctl nodes for devices.
 */

SYSCTL_NODE(_hw, OID_AUTO, devices, CTLFLAG_RW, 0, "A list of all devices");

static int
sysctl_handle_children SYSCTL_HANDLER_ARGS
{
    device_t dev = arg1;
    device_t child;
    int first = 1, error = 0;

    for (child = TAILQ_FIRST(&dev->children); child;
	 child = TAILQ_NEXT(child, link)) {
	if (child->nameunit) {
	    if (!first) {
		error = SYSCTL_OUT(req, ",", 1);
		if (error) return error;
	    } else {
		first = 0;
	    }
	    error = SYSCTL_OUT(req, child->nameunit, strlen(child->nameunit));
	    if (error) return error;
	}
    }

    error = SYSCTL_OUT(req, "", 1);

    return error;
}

static int
sysctl_handle_state SYSCTL_HANDLER_ARGS
{
    device_t dev = arg1;

    switch (dev->state) {
    case DS_NOTPRESENT:
	return SYSCTL_OUT(req, "notpresent", sizeof("notpresent"));
    case DS_ALIVE:
	return SYSCTL_OUT(req, "alive", sizeof("alive"));
    case DS_ATTACHED:
	return SYSCTL_OUT(req, "attached", sizeof("attached"));
    case DS_BUSY:
	return SYSCTL_OUT(req, "busy", sizeof("busy"));
    }

    return 0;
}

static void
device_register_oids(device_t dev)
{
    struct sysctl_oid* oid;

    oid = &dev->oid[0];
    bzero(oid, sizeof(*oid));
    oid->oid_parent = &sysctl__hw_devices_children;
    oid->oid_number = OID_AUTO;
    oid->oid_kind = CTLTYPE_NODE | CTLFLAG_RW;
    oid->oid_arg1 = &dev->oidlist[0];
    oid->oid_arg2 = 0;
    oid->oid_name = dev->nameunit;
    oid->oid_handler = 0;
    oid->oid_fmt = "N";
    SLIST_INIT(&dev->oidlist[0]);
    sysctl_register_oid(oid);

    oid = &dev->oid[1];
    bzero(oid, sizeof(*oid));
    oid->oid_parent = &dev->oidlist[0];
    oid->oid_number = OID_AUTO;
    oid->oid_kind = CTLTYPE_STRING | CTLFLAG_RD;
    oid->oid_arg1 = dev->desc ? dev->desc : "";
    oid->oid_arg2 = dev->desc ? strlen(dev->desc) : 0;
    oid->oid_name = "desc";
    oid->oid_handler = sysctl_handle_string;
    oid->oid_fmt = "A";
    sysctl_register_oid(oid);

    oid = &dev->oid[2];
    bzero(oid, sizeof(*oid));
    oid->oid_parent = &dev->oidlist[0];
    oid->oid_number = OID_AUTO;
    oid->oid_kind = CTLTYPE_INT | CTLFLAG_RD;
    oid->oid_arg1 = dev;
    oid->oid_arg2 = 0;
    oid->oid_name = "children";
    oid->oid_handler = sysctl_handle_children;
    oid->oid_fmt = "A";
    sysctl_register_oid(oid);

    oid = &dev->oid[3];
    bzero(oid, sizeof(*oid));
    oid->oid_parent = &dev->oidlist[0];
    oid->oid_number = OID_AUTO;
    oid->oid_kind = CTLTYPE_INT | CTLFLAG_RD;
    oid->oid_arg1 = dev;
    oid->oid_arg2 = 0;
    oid->oid_name = "state";
    oid->oid_handler = sysctl_handle_state;
    oid->oid_fmt = "A";
    sysctl_register_oid(oid);
}

static void
device_unregister_oids(device_t dev)
{
    sysctl_unregister_oid(&dev->oid[0]);
    sysctl_unregister_oid(&dev->oid[1]);
    sysctl_unregister_oid(&dev->oid[2]);
}

#endif

/*======================================*/
/*
 * Access functions for device resources.
 */

/* Supplied by config(8) in ioconf.c */
extern struct config_device config_devtab[];
extern int devtab_count;

/* Runtime version */
struct config_device *devtab = config_devtab;

static int
resource_new_name(const char *name, int unit)
{
	struct config_device *new;

	new = malloc((devtab_count + 1) * sizeof(*new), M_TEMP, M_NOWAIT);
	if (new == NULL)
		return -1;
	if (devtab && devtab_count > 0)
		bcopy(devtab, new, devtab_count * sizeof(*new));
	bzero(&new[devtab_count], sizeof(*new));
	new[devtab_count].name = malloc(strlen(name) + 1, M_TEMP, M_NOWAIT);
	if (new[devtab_count].name == NULL) {
		free(new, M_TEMP);
		return -1;
	}
	strcpy(new[devtab_count].name, name);
	new[devtab_count].unit = unit;
	new[devtab_count].resource_count = 0;
	new[devtab_count].resources = NULL;
	devtab = new;
	return devtab_count++;
}

static int
resource_new_resname(int j, const char *resname, resource_type type)
{
	struct config_resource *new;
	int i;

	i = devtab[j].resource_count;
	new = malloc((i + 1) * sizeof(*new), M_TEMP, M_NOWAIT);
	if (new == NULL)
		return -1;
	if (devtab[j].resources && i > 0)
		bcopy(devtab[j].resources, new, i * sizeof(*new));
	bzero(&new[i], sizeof(*new));
	new[i].name = malloc(strlen(resname) + 1, M_TEMP, M_NOWAIT);
	if (new[i].name == NULL) {
		free(new, M_TEMP);
		return -1;
	}
	strcpy(new[i].name, resname);
	new[i].type = type;
	if (devtab[j].resources)
		free(devtab[j].resources, M_TEMP);
	devtab[j].resources = new;
	devtab[j].resource_count = i + 1;
	return i;
}

static int
resource_match_string(int i, const char *resname, const char *value)
{
	int j;
	struct config_resource *res;

	for (j = 0, res = devtab[i].resources;
	     j < devtab[i].resource_count; j++, res++)
		if (!strcmp(res->name, resname)
		    && res->type == RES_STRING
		    && !strcmp(res->u.stringval, value))
			return j;
	return -1;
}

static int
resource_find(const char *name, int unit, const char *resname, 
	      struct config_resource **result)
{
	int i, j;
	struct config_resource *res;

	/*
	 * First check specific instances, then generic.
	 */
	for (i = 0; i < devtab_count; i++) {
		if (devtab[i].unit < 0)
			continue;
		if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
			res = devtab[i].resources;
			for (j = 0; j < devtab[i].resource_count; j++, res++)
				if (!strcmp(res->name, resname)) {
					*result = res;
					return 0;
				}
		}
	}
	for (i = 0; i < devtab_count; i++) {
		if (devtab[i].unit >= 0)
			continue;
		/* XXX should this `&& devtab[i].unit == unit' be here? */
		/* XXX if so, then the generic match does nothing */
		if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
			res = devtab[i].resources;
			for (j = 0; j < devtab[i].resource_count; j++, res++)
				if (!strcmp(res->name, resname)) {
					*result = res;
					return 0;
				}
		}
	}
	return ENOENT;
}

int
resource_int_value(const char *name, int unit, const char *resname, int *result)
{
	int error;
	struct config_resource *res;

	if ((error = resource_find(name, unit, resname, &res)) != 0)
		return error;
	if (res->type != RES_INT)
		return EFTYPE;
	*result = res->u.intval;
	return 0;
}

int
resource_long_value(const char *name, int unit, const char *resname,
		    long *result)
{
	int error;
	struct config_resource *res;

	if ((error = resource_find(name, unit, resname, &res)) != 0)
		return error;
	if (res->type != RES_LONG)
		return EFTYPE;
	*result = res->u.longval;
	return 0;
}

int
resource_string_value(const char *name, int unit, const char *resname,
		      char **result)
{
	int error;
	struct config_resource *res;

	if ((error = resource_find(name, unit, resname, &res)) != 0)
		return error;
	if (res->type != RES_STRING)
		return EFTYPE;
	*result = res->u.stringval;
	return 0;
}

int
resource_query_string(int i, const char *resname, const char *value)
{
	if (i < 0)
		i = 0;
	else
		i = i + 1;
	for (; i < devtab_count; i++)
		if (resource_match_string(i, resname, value) >= 0)
			return i;
	return -1;
}

int
resource_locate(int i, const char *resname)
{
	if (i < 0)
		i = 0;
	else
		i = i + 1;
	for (; i < devtab_count; i++)
		if (!strcmp(devtab[i].name, resname))
			return i;
	return -1;
}

int
resource_count(void)
{
	return devtab_count;
}

char *
resource_query_name(int i)
{
	return devtab[i].name;
}

int
resource_query_unit(int i)
{
	return devtab[i].unit;
}

static int
resource_create(const char *name, int unit, const char *resname,
		resource_type type, struct config_resource **result)
{
	int i, j;
	struct config_resource *res = NULL;

	for (i = 0; i < devtab_count; i++) {
		if (!strcmp(devtab[i].name, name) && devtab[i].unit == unit) {
			res = devtab[i].resources;
			break;
		}
	}
	if (res == NULL) {
		i = resource_new_name(name, unit);
		if (i < 0)
			return ENOMEM;
		res = devtab[i].resources;
	}
	for (j = 0; j < devtab[i].resource_count; j++, res++) {
		if (!strcmp(res->name, resname)) {
			*result = res;
			return 0;
		}
	}
	j = resource_new_resname(i, resname, type);
	if (j < 0)
		return ENOMEM;
	res = &devtab[i].resources[j];
	*result = res;
	return 0;
}

int
resource_set_int(const char *name, int unit, const char *resname, int value)
{
	int error;
	struct config_resource *res;

	error = resource_create(name, unit, resname, RES_INT, &res);
	if (error)
		return error;
	if (res->type != RES_INT)
		return EFTYPE;
	res->u.intval = value;
	return 0;
}

int
resource_set_long(const char *name, int unit, const char *resname, long value)
{
	int error;
	struct config_resource *res;

	error = resource_create(name, unit, resname, RES_LONG, &res);
	if (error)
		return error;
	if (res->type != RES_LONG)
		return EFTYPE;
	res->u.longval = value;
	return 0;
}

int
resource_set_string(const char *name, int unit, const char *resname,
		    const char *value)
{
	int error;
	struct config_resource *res;

	error = resource_create(name, unit, resname, RES_STRING, &res);
	if (error)
		return error;
	if (res->type != RES_STRING)
		return EFTYPE;
	if (res->u.stringval)
		free(res->u.stringval, M_TEMP);
	res->u.stringval = malloc(strlen(value) + 1, M_TEMP, M_NOWAIT);
	if (res->u.stringval == NULL)
		return ENOMEM;
	strcpy(res->u.stringval, value);
	return 0;
}


static void
resource_cfgload(void *dummy __unused)
{
	struct config_resource *res, *cfgres;
	int i, j;
	int error;
	char *name, *resname;
	int unit;
	resource_type type;
	char *stringval;
	int config_devtab_count;

	config_devtab_count = devtab_count;
	devtab = NULL;
	devtab_count = 0;

	for (i = 0; i < config_devtab_count; i++) {
		name = config_devtab[i].name;
		unit = config_devtab[i].unit;

		for (j = 0; j < config_devtab[i].resource_count; j++) {
			cfgres = config_devtab[i].resources;
			resname = cfgres[j].name;
			type = cfgres[j].type;
			error = resource_create(name, unit, resname, type,
						&res);
			if (error) {
				printf("create resource %s%d: error %d\n",
					name, unit, error);
				continue;
			}
			if (res->type != type) {
				printf("type mismatch %s%d: %d != %d\n",
					name, unit, res->type, type);
				continue;
			}
			switch (type) {
			case RES_INT:
				res->u.intval = cfgres[j].u.intval;
				break;
			case RES_LONG:
				res->u.longval = cfgres[j].u.longval;
				break;
			case RES_STRING:
				if (res->u.stringval)
					free(res->u.stringval, M_TEMP);
				stringval = cfgres[j].u.stringval;
				res->u.stringval = malloc(strlen(stringval) + 1,
							  M_TEMP, M_NOWAIT);
				if (res->u.stringval == NULL)
					break;
				strcpy(res->u.stringval, stringval);
				break;
			default:
				panic("unknown resource type %d\n", type);
			}
		}
	}
}
SYSINIT(cfgload, SI_SUB_KMEM, SI_ORDER_ANY + 50, resource_cfgload, 0)


/*======================================*/
/*
 * Some useful method implementations to make life easier for bus drivers.
 */

void
resource_list_init(struct resource_list *rl)
{
	SLIST_INIT(rl);
}

void
resource_list_free(struct resource_list *rl)
{
    struct resource_list_entry *rle;

    while ((rle = SLIST_FIRST(rl)) != NULL) {
	if (rle->res)
	    panic("resource_list_free: resource entry is busy");
	SLIST_REMOVE_HEAD(rl, link);
	free(rle, M_BUS);
    }
}

void
resource_list_add(struct resource_list *rl,
		  int type, int rid,
		  u_long start, u_long end, u_long count)
{
    struct resource_list_entry *rle;

    rle = resource_list_find(rl, type, rid);
    if (!rle) {
	rle = malloc(sizeof(struct resource_list_entry), M_BUS, M_NOWAIT);
	if (!rle)
	    panic("resource_list_add: can't record entry");
	SLIST_INSERT_HEAD(rl, rle, link);
	rle->type = type;
	rle->rid = rid;
	rle->res = NULL;
    }

    if (rle->res)
	panic("resource_list_add: resource entry is busy");

    rle->start = start;
    rle->end = end;
    rle->count = count;
}

struct resource_list_entry*
resource_list_find(struct resource_list *rl,
		   int type, int rid)
{
    struct resource_list_entry *rle;

    SLIST_FOREACH(rle, rl, link)
	if (rle->type == type && rle->rid == rid)
	    return rle;
    return NULL;
}

void
resource_list_delete(struct resource_list *rl,
		     int type, int rid)
{
    struct resource_list_entry *rle = resource_list_find(rl, type, rid);

    if (rle) {
	SLIST_REMOVE(rl, rle, resource_list_entry, link);
	free(rle, M_BUS);
    }
}

struct resource *
resource_list_alloc(struct resource_list *rl,
		    device_t bus, device_t child,
		    int type, int *rid,
		    u_long start, u_long end,
		    u_long count, u_int flags)
{
    struct resource_list_entry *rle = 0;
    int passthrough = (device_get_parent(child) != bus);
    int isdefault = (start == 0UL && end == ~0UL);

    if (passthrough) {
	return BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
				  type, rid,
				  start, end, count, flags);
    }

    rle = resource_list_find(rl, type, *rid);

    if (!rle)
	return 0;		/* no resource of that type/rid */
    if (rle->res)
	panic("resource_list_alloc: resource entry is busy");

    if (isdefault) {
	start = rle->start;
	count = max(count, rle->count);
	end = max(rle->end, start + count - 1);
    }

    rle->res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child,
				  type, rid, start, end, count, flags);

    /*
     * Record the new range.
     */
    if (rle->res) {
	    rle->start = rman_get_start(rle->res);
	    rle->end = rman_get_end(rle->res);
	    rle->count = count;
    }

    return rle->res;
}

int
resource_list_release(struct resource_list *rl,
		      device_t bus, device_t child,
		      int type, int rid, struct resource *res)
{
    struct resource_list_entry *rle = 0;
    int passthrough = (device_get_parent(child) != bus);
    int error;

    if (passthrough) {
	return BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
				    type, rid, res);
    }

    rle = resource_list_find(rl, type, rid);

    if (!rle)
	panic("resource_list_release: can't find resource");
    if (!rle->res)
	panic("resource_list_release: resource entry is not busy");

    error = BUS_RELEASE_RESOURCE(device_get_parent(bus), child,
				 type, rid, res);
    if (error)
	return error;

    rle->res = NULL;
    return 0;
}

/*
 * Call DEVICE_IDENTIFY for each driver.
 */
int
bus_generic_probe(device_t dev)
{
    devclass_t dc = dev->devclass;
    driverlink_t dl;

    for (dl = TAILQ_FIRST(&dc->drivers); dl; dl = TAILQ_NEXT(dl, link))
	DEVICE_IDENTIFY(dl->driver, dev);

    return 0;
}

int
bus_generic_attach(device_t dev)
{
    device_t child;

    for (child = TAILQ_FIRST(&dev->children);
	 child; child = TAILQ_NEXT(child, link))
	device_probe_and_attach(child);

    return 0;
}

int
bus_generic_detach(device_t dev)
{
    device_t child;
    int error;

    if (dev->state != DS_ATTACHED)
	return EBUSY;

    for (child = TAILQ_FIRST(&dev->children);
	 child; child = TAILQ_NEXT(child, link))
	if ((error = device_detach(child)) != 0)
	    return error;

    return 0;
}

int
bus_generic_shutdown(device_t dev)
{
    device_t child;

    for (child = TAILQ_FIRST(&dev->children);
	 child; child = TAILQ_NEXT(child, link))
	device_shutdown(child);

    return 0;
}

int
bus_generic_suspend(device_t dev)
{
	int		error;
	device_t	child, child2;

	for (child = TAILQ_FIRST(&dev->children);
	     child; child = TAILQ_NEXT(child, link)) {
		error = DEVICE_SUSPEND(child);
		if (error) {
			for (child2 = TAILQ_FIRST(&dev->children);
			     child2 && child2 != child; 
			     child2 = TAILQ_NEXT(child2, link))
				DEVICE_RESUME(child2);
			return (error);
		}
	}
	return 0;
}

int
bus_generic_resume(device_t dev)
{
	device_t	child;

	for (child = TAILQ_FIRST(&dev->children);
	     child; child = TAILQ_NEXT(child, link)) {
		DEVICE_RESUME(child);
		/* if resume fails, there's nothing we can usefully do... */
	}
	return 0;
}

int
bus_print_child_header (device_t dev, device_t child)
{
	int	retval = 0;

	if (device_get_desc(child)) { 
		retval += device_printf(child, "<%s>",
				       device_get_desc(child));      
	} else {
		retval += printf("%s", device_get_nameunit(child));
	}

	return (retval);
}

int
bus_print_child_footer (device_t dev, device_t child)
{
	return(printf(" on %s\n", device_get_nameunit(dev)));
}

int
bus_generic_print_child(device_t dev, device_t child)
{
	int	retval = 0;

	retval += bus_print_child_header(dev, child);
	retval += bus_print_child_footer(dev, child);

	return (retval);
}

int
bus_generic_read_ivar(device_t dev, device_t child, int index, 
		      uintptr_t * result)
{
    return ENOENT;
}

int
bus_generic_write_ivar(device_t dev, device_t child, int index, 
		       uintptr_t value)
{
    return ENOENT;
}

void
bus_generic_driver_added(device_t dev, driver_t *driver)
{
    device_t child;

    DEVICE_IDENTIFY(driver, dev);
    for (child = TAILQ_FIRST(&dev->children);
	 child; child = TAILQ_NEXT(child, link))
	if (child->state == DS_NOTPRESENT)
	    device_probe_and_attach(child);
}

int
bus_generic_setup_intr(device_t dev, device_t child, struct resource *irq, 
		       int flags, driver_intr_t *intr, void *arg,
		       void **cookiep)
{
	/* Propagate up the bus hierarchy until someone handles it. */
	if (dev->parent)
		return (BUS_SETUP_INTR(dev->parent, child, irq, flags,
				       intr, arg, cookiep));
	else
		return (EINVAL);
}

int
bus_generic_teardown_intr(device_t dev, device_t child, struct resource *irq,
			  void *cookie)
{
	/* Propagate up the bus hierarchy until someone handles it. */
	if (dev->parent)
		return (BUS_TEARDOWN_INTR(dev->parent, child, irq, cookie));
	else
		return (EINVAL);
}

struct resource *
bus_generic_alloc_resource(device_t dev, device_t child, int type, int *rid,
			   u_long start, u_long end, u_long count, u_int flags)
{
	/* Propagate up the bus hierarchy until someone handles it. */
	if (dev->parent)
		return (BUS_ALLOC_RESOURCE(dev->parent, child, type, rid, 
					   start, end, count, flags));
	else
		return (NULL);
}

int
bus_generic_release_resource(device_t dev, device_t child, int type, int rid,
			     struct resource *r)
{
	/* Propagate up the bus hierarchy until someone handles it. */
	if (dev->parent)
		return (BUS_RELEASE_RESOURCE(dev->parent, child, type, rid, 
					     r));
	else
		return (EINVAL);
}

int
bus_generic_activate_resource(device_t dev, device_t child, int type, int rid,
			      struct resource *r)
{
	/* Propagate up the bus hierarchy until someone handles it. */
	if (dev->parent)
		return (BUS_ACTIVATE_RESOURCE(dev->parent, child, type, rid, 
					      r));
	else
		return (EINVAL);
}

int
bus_generic_deactivate_resource(device_t dev, device_t child, int type,
				int rid, struct resource *r)
{
	/* Propagate up the bus hierarchy until someone handles it. */
	if (dev->parent)
		return (BUS_DEACTIVATE_RESOURCE(dev->parent, child, type, rid,
						r));
	else
		return (EINVAL);
}

/*
 * Some convenience functions to make it easier for drivers to use the
 * resource-management functions.  All these really do is hide the
 * indirection through the parent's method table, making for slightly
 * less-wordy code.  In the future, it might make sense for this code
 * to maintain some sort of a list of resources allocated by each device.
 */
struct resource *
bus_alloc_resource(device_t dev, int type, int *rid, u_long start, u_long end,
		   u_long count, u_int flags)
{
	if (dev->parent == 0)
		return (0);
	return (BUS_ALLOC_RESOURCE(dev->parent, dev, type, rid, start, end,
				   count, flags));
}

int
bus_activate_resource(device_t dev, int type, int rid, struct resource *r)
{
	if (dev->parent == 0)
		return (EINVAL);
	return (BUS_ACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
}

int
bus_deactivate_resource(device_t dev, int type, int rid, struct resource *r)
{
	if (dev->parent == 0)
		return (EINVAL);
	return (BUS_DEACTIVATE_RESOURCE(dev->parent, dev, type, rid, r));
}

int
bus_release_resource(device_t dev, int type, int rid, struct resource *r)
{
	if (dev->parent == 0)
		return (EINVAL);
	return (BUS_RELEASE_RESOURCE(dev->parent, dev,
				     type, rid, r));
}

int
bus_setup_intr(device_t dev, struct resource *r, int flags,
	       driver_intr_t handler, void *arg, void **cookiep)
{
	if (dev->parent == 0)
		return (EINVAL);
	return (BUS_SETUP_INTR(dev->parent, dev, r, flags,
			       handler, arg, cookiep));
}

int
bus_teardown_intr(device_t dev, struct resource *r, void *cookie)
{
	if (dev->parent == 0)
		return (EINVAL);
	return (BUS_TEARDOWN_INTR(dev->parent, dev, r, cookie));
}

int
bus_set_resource(device_t dev, int type, int rid,
		 u_long start, u_long count)
{
	return BUS_SET_RESOURCE(device_get_parent(dev), dev, type, rid,
				start, count);
}

int
bus_get_resource(device_t dev, int type, int rid,
		 u_long *startp, u_long *countp)
{
	return BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
				startp, countp);
}

u_long
bus_get_resource_start(device_t dev, int type, int rid)
{
	u_long start, count;
	int error;

	error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
				 &start, &count);
	if (error)
		return 0;
	return start;
}

u_long
bus_get_resource_count(device_t dev, int type, int rid)
{
	u_long start, count;
	int error;

	error = BUS_GET_RESOURCE(device_get_parent(dev), dev, type, rid,
				 &start, &count);
	if (error)
		return 0;
	return count;
}

void
bus_delete_resource(device_t dev, int type, int rid)
{
	BUS_DELETE_RESOURCE(device_get_parent(dev), dev, type, rid);
}

static int
root_print_child(device_t dev, device_t child)
{
	return (0);
}

static int
root_setup_intr(device_t dev, device_t child, driver_intr_t *intr, void *arg,
		void **cookiep)
{
	/*
	 * If an interrupt mapping gets to here something bad has happened.
	 */
	panic("root_setup_intr");
}

static device_method_t root_methods[] = {
	/* Device interface */
	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
	DEVMETHOD(device_suspend,	bus_generic_suspend),
	DEVMETHOD(device_resume,	bus_generic_resume),

	/* Bus interface */
	DEVMETHOD(bus_print_child,	root_print_child),
	DEVMETHOD(bus_read_ivar,	bus_generic_read_ivar),
	DEVMETHOD(bus_write_ivar,	bus_generic_write_ivar),
	DEVMETHOD(bus_setup_intr,	root_setup_intr),

	{ 0, 0 }
};

static driver_t root_driver = {
	"root",
	root_methods,
	1,			/* no softc */
};

device_t	root_bus;
devclass_t	root_devclass;

static int
root_bus_module_handler(module_t mod, int what, void* arg)
{
    switch (what) {
    case MOD_LOAD:
	compile_methods(&root_driver);
	root_bus = make_device(NULL, "root", 0, NULL);
	root_bus->desc = "System root bus";
	root_bus->ops = root_driver.ops;
	root_bus->driver = &root_driver;
	root_bus->state = DS_ATTACHED;
	root_devclass = devclass_find_internal("root", FALSE);
	return 0;

    case MOD_SHUTDOWN:
	device_shutdown(root_bus);
	return 0;
    }

    return 0;
}

static moduledata_t root_bus_mod = {
	"rootbus",
	root_bus_module_handler,
	0
};
DECLARE_MODULE(rootbus, root_bus_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);

void
root_bus_configure(void)
{
    device_t dev;

    PDEBUG(("."));

    for (dev = TAILQ_FIRST(&root_bus->children); dev;
	 dev = TAILQ_NEXT(dev, link)) {
	device_probe_and_attach(dev);
    }
}

int
driver_module_handler(module_t mod, int what, void *arg)
{
	int error, i;
	struct driver_module_data *dmd;
	devclass_t bus_devclass;

	dmd = (struct driver_module_data *)arg;
	bus_devclass = devclass_find_internal(dmd->dmd_busname, TRUE);
	error = 0;

	switch (what) {
	case MOD_LOAD:
		if (dmd->dmd_chainevh)
			error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);

		for (i = 0; !error && i < dmd->dmd_ndrivers; i++) {
			PDEBUG(("Loading module: driver %s on bus %s",
				DRIVERNAME(dmd->dmd_drivers[i]), 
				dmd->dmd_busname));
			error = devclass_add_driver(bus_devclass,
						    dmd->dmd_drivers[i]);
		}
		if (error)
			break;

		/*
		 * The drivers loaded in this way are assumed to all
		 * implement the same devclass.
		 */
		*dmd->dmd_devclass =
			devclass_find_internal(dmd->dmd_drivers[0]->name,
					       TRUE);
		break;

	case MOD_UNLOAD:
		for (i = 0; !error && i < dmd->dmd_ndrivers; i++) {
			PDEBUG(("Unloading module: driver %s from bus %s",
				DRIVERNAME(dmd->dmd_drivers[i]), 
				dmd->dmd_busname));
			error = devclass_delete_driver(bus_devclass,
						       dmd->dmd_drivers[i]);
		}

		if (!error && dmd->dmd_chainevh)
			error = dmd->dmd_chainevh(mod,what,dmd->dmd_chainarg);
		break;
	}

	return (error);
}

#ifdef BUS_DEBUG

/* the _short versions avoid iteration by not calling anything that prints
 * more than oneliners. I love oneliners.
 */

static void
print_method_list(device_method_t *m, int indent)
{
	int i;

	if (!m)
		return;

	for (i = 0; m->desc; i++, m++)
		indentprintf(("method %d: %s, offset=%d\n",
			i, m->desc->name, m->desc->offset));
}

static void
print_device_ops(device_ops_t ops, int indent)
{
	int i;
	int count = 0;

	if (!ops)
		return;

	/* we present a list of the methods that are pointing to the
	 * error_method, but ignore the 0'th elements; it is always
	 * error_method.
	 */
	for (i = 1; i < ops->maxoffset; i++) {
		if (ops->methods[i] == error_method) {
			if (count == 0)
				indentprintf(("error_method:"));
			printf(" %d", i);
			count++;
		}
	}
	if (count)
		printf("\n");

	indentprintf(("(%d method%s, %d valid, %d error_method%s)\n",
		ops->maxoffset-1, (ops->maxoffset-1 == 1? "":"s"),
		ops->maxoffset-1-count,
		count, (count == 1? "":"'s")));
}

static void
print_device_short(device_t dev, int indent)
{
	if (!dev)
		return;

	indentprintf(("device %d: <%s> %sparent,%schildren,%s%s%s%s,%sivars,%ssoftc,busy=%d\n",
		dev->unit, dev->desc,
		(dev->parent? "":"no "),
		(TAILQ_EMPTY(&dev->children)? "no ":""),
		(dev->flags&DF_ENABLED? "enabled,":"disabled,"),
		(dev->flags&DF_FIXEDCLASS? "fixed,":""),
		(dev->flags&DF_WILDCARD? "wildcard,":""),
		(dev->flags&DF_DESCMALLOCED? "descmalloced,":""),
		(dev->ivars? "":"no "),
		(dev->softc? "":"no "),
		dev->busy));
}

static void
print_device(device_t dev, int indent)
{
	if (!dev)
		return;

	print_device_short(dev, indent);

	indentprintf(("Parent:\n"));
	print_device_short(dev->parent, indent+1);
	indentprintf(("Methods:\n"));
	print_device_ops(dev->ops, indent+1);
	indentprintf(("Driver:\n"));
	print_driver_short(dev->driver, indent+1);
	indentprintf(("Devclass:\n"));
	print_devclass_short(dev->devclass, indent+1);
}

void
print_device_tree_short(device_t dev, int indent)
/* print the device and all its children (indented) */
{
	device_t child;

	if (!dev)
		return;

	print_device_short(dev, indent);

	for (child = TAILQ_FIRST(&dev->children); child;
		 child = TAILQ_NEXT(child, link))
		print_device_tree_short(child, indent+1);
}

void
print_device_tree(device_t dev, int indent)
/* print the device and all its children (indented) */
{
	device_t child;

	if (!dev)
		return;

	print_device(dev, indent);

	for (child = TAILQ_FIRST(&dev->children); child;
		 child = TAILQ_NEXT(child, link))
		print_device_tree(child, indent+1);
}

static void
print_driver_short(driver_t *driver, int indent)
{
	if (!driver)
		return;

	indentprintf(("driver %s: softc size = %d\n",
		driver->name, driver->softc));
}

static void
print_driver(driver_t *driver, int indent)
{
	if (!driver)
		return;

	print_driver_short(driver, indent);
	indentprintf(("Methods:\n"));
	print_method_list(driver->methods, indent+1);
	indentprintf(("Operations:\n"));
	print_device_ops(driver->ops, indent+1);
}


static void
print_driver_list(driver_list_t drivers, int indent)
{
	driverlink_t driver;

	for (driver = TAILQ_FIRST(&drivers); driver;
	     driver = TAILQ_NEXT(driver, link))
		print_driver(driver->driver, indent);
}

static void
print_devclass_short(devclass_t dc, int indent)
{
	if ( !dc )
		return;

	indentprintf(("devclass %s: max units = %d, next unit = %d\n",
		dc->name, dc->maxunit, dc->nextunit));
}

static void
print_devclass(devclass_t dc, int indent)
{
	int i;

	if ( !dc )
		return;

	print_devclass_short(dc, indent);
	indentprintf(("Drivers:\n"));
	print_driver_list(dc->drivers, indent+1);

	indentprintf(("Devices:\n"));
	for (i = 0; i < dc->maxunit; i++)
		if (dc->devices[i])
			print_device(dc->devices[i], indent+1);
}

void
print_devclass_list_short(void)
{
	devclass_t dc;

	printf("Short listing of devclasses, drivers & devices:\n");
	for (dc = TAILQ_FIRST(&devclasses); dc; dc = TAILQ_NEXT(dc, link))
		print_devclass_short(dc, 0);
}

void
print_devclass_list(void)
{
	devclass_t dc;

	printf("Full listing of devclasses, drivers & devices:\n");
	for (dc = TAILQ_FIRST(&devclasses); dc; dc = TAILQ_NEXT(dc, link))
		print_devclass(dc, 0);
}

#endif