PERFORCE change 131610 for review
Maxim Zhuravlev
thioretic at FreeBSD.org
Tue Dec 25 12:01:42 PST 2007
http://perforce.freebsd.org/chv.cgi?CH=131610
Change 131610 by thioretic at thioretic on 2007/12/25 20:00:47
Add some connected device's state notification infrastructure.
Affected files ...
.. //depot/projects/soc2007/thioretic_gidl2/kern/device_if.m#2 edit
.. //depot/projects/soc2007/thioretic_gidl2/kern/subr_bus.c#10 edit
.. //depot/projects/soc2007/thioretic_gidl2/sys/bus.h#6 edit
Differences ...
==== //depot/projects/soc2007/thioretic_gidl2/kern/device_if.m#2 (text+ko) ====
@@ -62,9 +62,14 @@
{
return EOPNOTSUPP;
}
- static void* null_info (device_t dev)
+ static void* null_info (device_t dev, char *buf, size_t buflen)
+ {
+ return NULL;
+ }
+ static void null_receive_event (device_t dev, device_t provider,
+ enum relationship rel, enum dev_event ev)
{
- return EOPNOTSUPP;
+ return;
}
};
@@ -346,3 +351,30 @@
char *buf;
size_t buflen;
} DEFAULT null_info;
+
+/**
+ * @brief This is called when the some connected device has issued
+ * an event.
+ *
+ * To include this method in a device driver, use a line like this
+ * in the driver's method list:
+ *
+ * @code
+ * KOBJMETHOD(device_info, foo_info)
+ * @endcode
+ *
+ * @param dev the device being requested to receive an event
+ *
+ * @param provider the device that issued the event
+ *
+ * @param rel specifies how the provider does relate to the dev
+ *
+ * @param ev the event to process
+ *
+ */
+METHOD void receive_event {
+ device_t dev;
+ device_t provider;
+ enum relationship rel;
+ enum dev_event ev_type;
+} DEFAULT null_receive_event;
==== //depot/projects/soc2007/thioretic_gidl2/kern/subr_bus.c#10 (text+ko) ====
@@ -129,6 +129,13 @@
uint32_t flags;
};
+struct dev_event_entry {
+ enum dev_event ev_type;
+ TAILQ_ENTRY(dev_event_entry) link;
+};
+typedef struct dev_event_entry* dev_event_entry_t;
+typedef TAILQ_HEAD(dev_event_list, dev_event_entry) dev_event_list_t;
+
/**
* @brief Implementation of device.
*/
@@ -181,6 +188,8 @@
struct sysctl_ctx_list sysctl_ctx; /**< state for sysctl variables */
struct sysctl_oid *sysctl_tree; /**< state for sysctl variables */
+
+ dev_event_list_t evs;
};
typedef struct devicelink* devicelink_t;
@@ -188,7 +197,7 @@
device_t device_ptr;
#define DLF_ANCHOR 1
int flags;
- TAILQ(devicelink) link;
+ TAILQ_ENTRY(devicelink) link;
};
static MALLOC_DEFINE(M_BUS, "bus", "Bus data structures");
@@ -2059,6 +2068,45 @@
filter_probe_and_attach (dv->devices[i], filter);
}
}
+
+static void device_issue_event (device_t dev, enum dev_event ev_type){
+ dev_event_entry_t dee;
+ devicelink_t pd;
+
+ /*deliver to all children*/
+ if (!TAILQ_EMPTY(&dev->children)){
+ TAILQ_FOREACH (pd, &dev->children, link){
+ DEVICE_RECEIVE_EVENT (pd, dev, REL_CHILD, ev_type);
+ }
+ }
+
+ /*deliver to all parents*/
+ if (!TAILQ_EMPTY(&dev->parents)){
+ TAILQ_FOREACH (pd, &dev->parents, link){
+ DEVICE_RECEIVE_EVENT (pd, dev, REL_PARENT, ev_type);
+ }
+ }
+
+ /*enqueue*/
+ dee = malloc (sizeof(struct dev_event_entry), M_BUS, M_NOWAIT|M_ZERO);
+ if (dee == NULL)
+ return;
+
+ dee->ev_type = ev_type;
+ TAILQ_INSERT_TAIL (&dev->evs, dee, link);
+}
+
+static void device_deliver_events (device_t dev, device_t recipient, enum relationship rel){
+ dev_event_entry_t dee;
+
+ if (TAILQ_EMPTY(&dev->evs))
+ return;
+
+ TAILQ_FOREACH (dee, &dev->evs, link){
+ DEVICE_RECEIVE_EVENT (recipient, dev, rel, dee->ev_type);
+ }
+}
+
/**
* @internal
* @brief Make a new device and add it as a child of @p parent
@@ -2096,12 +2144,13 @@
dev = malloc(sizeof(struct device), M_BUS, M_NOWAIT|M_ZERO);
if (!dev)
return (NULL);
- TAILQ_INIT(&(dev->parents));
+ TAILQ_INIT(&dev->parents);
pd = malloc(sizeof(struct devicelink), M_BUS, M_NOWAIT|M_ZERO);
if (!pd){free(dev); return(NULL);}
pd->device_ptr = parent;
TAILQ_INSERT_TAIL(&dev->parents, pd, link);
TAILQ_INIT(&dev->children);
+ TAILQ_INIT(&dev->evs);
kobj_init((kobj_t) dev, &drv_compat_ctrl_driver)
for (level=DRL_LOWEST; level<=DRL_TOPMOST; level++)
TAILQ_INIT(&dev->drivers[level]);
==== //depot/projects/soc2007/thioretic_gidl2/sys/bus.h#6 (text+ko) ====
@@ -1,717 +1,734 @@
-/*-
- * Copyright (c) 1997,1998,2003 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: src/sys/sys/bus.h,v 1.70.2.4 2006/12/15 21:33:23 imp Exp $
- */
-
-#ifndef _SYS_BUS_H_
-#define _SYS_BUS_H_
-
-/**
- * @defgroup NEWBUS newbus - a generic framework for managing devices
- * @{
- */
-
-/**
- * @brief Interface information structure.
- */
-struct u_businfo {
- int ub_version; /**< @brief interface version */
-#define BUS_USER_VERSION 1
- int ub_generation; /**< @brief generation count */
-};
-
-/**
- * @brief State of the device.
- */
-typedef enum device_state {
- DS_RAW,
- DS_NOTPRESENT, /**< @brief not probed or probe failed */
- DS_ALIVE, /**< @brief probe succeeded */
- DS_ATTACHED, /**< @brief attach method called */
- DS_BUSY /**< @brief device is open */
-} device_state_t;
-
-/**
- * @brief Device information exported to userspace.
- */
-struct u_device {
- uintptr_t dv_handle;
- uintptr_t dv_parent;
-
- char dv_name[32]; /**< @brief Name of device in tree. */
- char dv_desc[32]; /**< @brief Driver description */
- char dv_drivername[32]; /**< @brief Driver name */
- char dv_pnpinfo[128]; /**< @brief Plug and play info */
- char dv_location[128]; /**< @brief Where is the device? */
- uint32_t dv_devflags; /**< @brief API Flags for device */
- uint16_t dv_flags; /**< @brief flags for dev date */
- device_state_t dv_state; /**< @brief State of attachment */
- /* XXX more driver info? */
-};
-
-#ifdef _KERNEL
-
-#include <sys/queue.h>
-#include <sys/kobj.h>
-
-/**
- * devctl hooks. Typically one should use the devctl_notify
- * hook to send the message. However, devctl_queue_data is also
- * included in case devctl_notify isn't sufficiently general.
- */
-void devctl_notify(const char *__system, const char *__subsystem,
- const char *__type, const char *__data);
-void devctl_queue_data(char *__data);
-
-/*
- * Forward declarations
- */
-typedef struct device *device_t;
-
-/**
- * @brief A device driver (included mainly for compatibility with
- * FreeBSD 4.x).
- */
-typedef struct kobj_class driver_t;
-
-/**
- * @brief A device class
- *
- * The devclass object has two main functions in the system. The first
- * is to manage the allocation of unit numbers for device instances
- * and the second is to hold the list of device drivers for a
- * particular bus type. Each devclass has a name and there cannot be
- * two devclasses with the same name. This ensures that unique unit
- * numbers are allocated to device instances.
- *
- * Drivers that support several different bus attachments (e.g. isa,
- * pci, pccard) should all use the same devclass to ensure that unit
- * numbers do not conflict.
- *
- * Each devclass may also have a parent devclass. This is used when
- * searching for device drivers to allow a form of inheritance. When
- * matching drivers with devices, first the driver list of the parent
- * device's devclass is searched. If no driver is found in that list,
- * the search continues in the parent devclass (if any).
- */
-typedef struct devclass *devclass_t;
-
-/**
- * @brief A device method (included mainly for compatibility with
- * FreeBSD 4.x).
- */
-#define device_method_t kobj_method_t
-
-/**
- * @brief A driver interrupt service routine
- */
-typedef void driver_intr_t(void*);
-
-/**
- * @brief Interrupt type bits.
- *
- * These flags are used both by newbus interrupt
- * registration (nexus.c) and also in struct intrec, which defines
- * interrupt properties.
- *
- * XXX We should probably revisit this and remove the vestiges of the
- * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
- * confuse things by renaming them (Grog, 18 July 2000).
- *
- * We define this in terms of bits because some devices may belong
- * to multiple classes (and therefore need to be included in
- * multiple interrupt masks, which is what this really serves to
- * indicate. Buses which do interrupt remapping will want to
- * change their type to reflect what sort of devices are underneath.
- */
-enum intr_type {
- INTR_TYPE_TTY = 1,
- INTR_TYPE_BIO = 2,
- INTR_TYPE_NET = 4,
- INTR_TYPE_CAM = 8,
- INTR_TYPE_MISC = 16,
- INTR_TYPE_CLK = 32,
- INTR_TYPE_AV = 64,
- INTR_FAST = 128,
- INTR_EXCL = 256, /* exclusive interrupt */
- INTR_MPSAFE = 512, /* this interrupt is SMP safe */
- INTR_ENTROPY = 1024 /* this interrupt provides entropy */
-};
-
-enum intr_trigger {
- INTR_TRIGGER_CONFORM = 0,
- INTR_TRIGGER_EDGE = 1,
- INTR_TRIGGER_LEVEL = 2
-};
-
-enum intr_polarity {
- INTR_POLARITY_CONFORM = 0,
- INTR_POLARITY_HIGH = 1,
- INTR_POLARITY_LOW = 2
-};
-
-typedef int (*devop_t)(void);
-
-/**
- * @brief This structure is deprecated.
- *
- * Use the kobj(9) macro DEFINE_CLASS to
- * declare classes which implement device drivers.
- */
-struct driver {
- KOBJ_CLASS_FIELDS;
-};
-
-/*
- * Definitions for drivers which need to keep simple lists of resources
- * for their child devices.
- */
-struct resource;
-
-/**
- * @brief An entry for a single resource in a resource list.
- */
-struct resource_list_entry {
- STAILQ_ENTRY(resource_list_entry) link;
- int type; /**< @brief type argument to alloc_resource */
- int rid; /**< @brief resource identifier */
- struct resource *res; /**< @brief the real resource when allocated */
- u_long start; /**< @brief start of resource range */
- u_long end; /**< @brief end of resource range */
- u_long count; /**< @brief count within range */
-};
-STAILQ_HEAD(resource_list, resource_list_entry);
-
-void resource_list_init(struct resource_list *rl);
-void resource_list_free(struct resource_list *rl);
-struct resource_list_entry *
- resource_list_add(struct resource_list *rl,
- int type, int rid,
- u_long start, u_long end, u_long count);
-int resource_list_add_next(struct resource_list *rl,
- int type,
- u_long start, u_long end, u_long count);
-struct resource_list_entry*
- resource_list_find(struct resource_list *rl,
- int type, int rid);
-void resource_list_delete(struct resource_list *rl,
- int type, int rid);
-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);
-int resource_list_release(struct resource_list *rl,
- device_t bus, device_t child,
- int type, int rid, struct resource *res);
-void resource_list_purge(struct resource_list *rl);
-int resource_list_print_type(struct resource_list *rl,
- const char *name, int type,
- const char *format);
-
-/*
- * The root bus, to which all top-level busses are attached.
- */
-extern device_t root_bus;
-extern devclass_t root_devclass;
-void root_bus_configure(void);
-
-/*
- * Useful functions for implementing busses.
- */
-
-int bus_generic_activate_resource(device_t dev, device_t child, int type,
- int rid, struct resource *r);
-device_t
- bus_generic_add_child(device_t dev, int order, const char *name,
- int unit);
-struct resource *
- bus_generic_alloc_resource(device_t bus, device_t child, int type,
- int *rid, u_long start, u_long end,
- u_long count, u_int flags);
-int bus_generic_attach(device_t dev);
-int bus_generic_child_present(device_t dev, device_t child);
-int bus_generic_config_intr(device_t, int, enum intr_trigger,
- enum intr_polarity);
-int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
- int rid, struct resource *r);
-int bus_generic_detach(device_t dev);
-void bus_generic_driver_added(device_t dev, driver_t *driver);
-struct resource_list *
- bus_generic_get_resource_list (device_t, device_t);
-int bus_print_child_header(device_t dev, device_t child);
-int bus_print_child_footer(device_t dev, device_t child);
-int bus_generic_print_child(device_t dev, device_t child);
-int bus_generic_probe(device_t dev);
-int bus_generic_read_ivar(device_t dev, device_t child, int which,
- uintptr_t *result);
-int bus_generic_release_resource(device_t bus, device_t child,
- int type, int rid, struct resource *r);
-int bus_generic_resume(device_t dev);
-int bus_generic_setup_intr(device_t dev, device_t child,
- struct resource *irq, int flags,
- driver_intr_t *intr, void *arg, void **cookiep);
-
-struct resource *
- bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
- u_long, u_long, u_long, u_int);
-void bus_generic_rl_delete_resource (device_t, device_t, int, int);
-int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
- u_long *);
-int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
- u_long);
-int bus_generic_rl_release_resource (device_t, device_t, int, int,
- struct resource *);
-
-int bus_generic_shutdown(device_t dev);
-int bus_generic_suspend(device_t dev);
-int bus_generic_teardown_intr(device_t dev, device_t child,
- struct resource *irq, void *cookie);
-int bus_generic_write_ivar(device_t dev, device_t child, int which,
- uintptr_t value);
-
-/*
- * Wrapper functions for the BUS_*_RESOURCE methods to make client code
- * a little simpler.
- */
-struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
- u_long start, u_long end, u_long count,
- u_int flags);
-int bus_activate_resource(device_t dev, int type, int rid,
- struct resource *r);
-int bus_deactivate_resource(device_t dev, int type, int rid,
- struct resource *r);
-int bus_release_resource(device_t dev, int type, int rid,
- struct resource *r);
-int bus_free_resource(device_t dev, int type, struct resource *r);
-int bus_setup_intr(device_t dev, struct resource *r, int flags,
- driver_intr_t handler, void *arg, void **cookiep);
-int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
-int bus_set_resource(device_t dev, int type, int rid,
- u_long start, u_long count);
-int bus_get_resource(device_t dev, int type, int rid,
- u_long *startp, u_long *countp);
-u_long bus_get_resource_start(device_t dev, int type, int rid);
-u_long bus_get_resource_count(device_t dev, int type, int rid);
-void bus_delete_resource(device_t dev, int type, int rid);
-int bus_child_present(device_t child);
-int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
-int bus_child_location_str(device_t child, char *buf, size_t buflen);
-void bus_enumerate_hinted_children(device_t bus);
-
-static __inline struct resource *
-bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
-{
- return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
-}
-
-/*
- * Forward compatibility define. bus_get_dma_tag is defined in current
- * to get the parent's dma tag. In RELENG_6 this is currently spelled NULL,
- * so provide a stop-gap compatibilty hook until this functionality is
- * merged from head (if ever)
- */
-#define bus_get_dma_tag(a) NULL
-
-/*
- * Access functions for device.
- */
-device_t device_add_child(device_t dev, const char *name, int unit);
-int device_add_existing_child (device_t dev, device_t child);
-int device_add_existing_parent (device_t dev, device_t parent);
-device_t device_add_child_ordered(device_t dev, int order,
- const char *name, int unit);
-void device_busy(device_t dev);
-int device_delete_child(device_t dev, device_t child);
-int device_delete_existing_child (device_t dev, device_t child);
-int device_delete_existing_parent (device_t dev, device_t parent);
-int device_attach(device_t dev);
-int device_detach(device_t dev);
-void device_disable(device_t dev);
-void device_enable(device_t dev);
-device_t device_find_child(device_t dev, const char *classname,
- int unit);
-device_t device_find_parent(device_t dev, const char* classname,
- int unit);
-const char *device_get_desc(device_t dev);
-devclass_t device_get_devclass(device_t dev);
-driver_t *device_get_driver(device_t dev);
-u_int32_t device_get_flags(device_t dev);
-device_t device_get_parent(device_t dev);
-int device_get_children(device_t dev, device_t **listp, int *countp);
-int device_get_all_parents(device_t dev, device_t **listp, int *countp);
-void *device_get_ivars(device_t dev);
-void *device_get_driver_ivars (device_t dev, driver_t *driver);
-void device_set_ivars(device_t dev, void *ivars);
-void device_set_driver_ivars (device_t dev, driver_t *driver,
- void* ivars);
-const char *device_get_name(device_t dev);
-const char *device_get_nameunit(device_t dev);
-void *device_get_softc(device_t dev);
-void *device_get_driver_softc(device_t dev, driver_t *driver);
-device_state_t device_get_state(device_t dev);
-int device_get_unit(device_t dev);
-struct sysctl_ctx_list *device_get_sysctl_ctx(device_t dev);
-struct sysctl_oid *device_get_sysctl_tree(device_t dev);
-int device_is_alive(device_t dev); /* did probe succeed? */
-int device_is_attached(device_t dev); /* did attach succeed? */
-int device_is_enabled(device_t dev);
-int device_is_quiet(device_t dev);
-int device_print_prettyname(device_t dev);
-int device_printf(device_t dev, const char *, ...) __printflike(2, 3);
-int device_probe_and_attach(device_t dev);
-int device_quiesce(device_t dev);
-void device_quiet(device_t dev);
-void device_set_desc(device_t dev, const char* desc);
-void device_set_desc_copy(device_t dev, const char* desc);
-int device_set_devclass(device_t dev, const char *classname);
-int device_set_driver(device_t dev, driver_t *driver);
-void device_set_flags(device_t dev, u_int32_t flags);
-void device_set_softc(device_t dev, void *softc);
-void device_set_driver_softc(device_t dev, driver_t *driver,
- void* softc);
-int device_set_unit(device_t dev, int unit); /* XXX DONT USE XXX */
-int device_shutdown(device_t dev);
-void device_unbusy(device_t dev);
-void device_verbose(device_t dev);
-
-/*
- * Access functions for devclass.
- */
-int devclass_add_driver(devclass_t dc, kobj_class_t driver);
-int devclass_delete_driver(devclass_t dc, kobj_class_t driver);
-devclass_t devclass_create(const char *classname);
-devclass_t devclass_find(const char *classname);
-kobj_class_t devclass_find_driver(devclass_t dc, const char *classname);
-const char *devclass_get_name(devclass_t dc);
-device_t devclass_get_device(devclass_t dc, int unit);
-void *devclass_get_softc(devclass_t dc, int unit);
-void *devclass_get_driver_softc (devclass_t dc, int unit, driver_t *driver);
-
-int devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
-int devclass_get_drivers(devclass_t dc, driver_t ***listp, int *countp);
-int devclass_get_count(devclass_t dc);
-int devclass_get_maxunit(devclass_t dc);
-int devclass_find_free_unit(devclass_t dc, int unit);
-void devclass_set_parent(devclass_t dc, devclass_t pdc);
-devclass_t devclass_get_parent(devclass_t dc);
-struct sysctl_ctx_list *devclass_get_sysctl_ctx(devclass_t dc);
-struct sysctl_oid *devclass_get_sysctl_tree(devclass_t dc);
-int devclass_quiesce_driver(devclass_t dc, kobj_class_t driver);
-
-/*
- * Access functions for device resources.
- */
-
-int resource_int_value(const char *name, int unit, const char *resname,
- int *result);
-int resource_long_value(const char *name, int unit, const char *resname,
- long *result);
-int resource_string_value(const char *name, int unit, const char *resname,
- const char **result);
-int resource_disabled(const char *name, int unit);
-int resource_find_match(int *anchor, const char **name, int *unit,
- const char *resname, const char *value);
-int resource_find_dev(int *anchor, const char *name, int *unit,
- const char *resname, const char *value);
-int resource_set_int(const char *name, int unit, const char *resname,
- int value);
-int resource_set_long(const char *name, int unit, const char *resname,
- long value);
-int resource_set_string(const char *name, int unit, const char *resname,
- const char *value);
-/*
- * Functions for maintaining and checking consistency of
- * bus information exported to userspace.
- */
-int bus_data_generation_check(int generation);
-void bus_data_generation_update(void);
-
-/**
- * Some convenience defines for probe routines to return. These are just
- * suggested values, and there's nothing magical about them.
- * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
- * possible other driver may exist (typically legacy drivers who don't fallow
- * all the rules, or special needs drivers). BUS_PROBE_VENDOR is the
- * suggested value that vendor supplied drivers use. This is for source or
- * binary drivers that are not yet integrated into the FreeBSD tree. Its use
- * in the base OS is prohibited. BUS_PROBE_DEFAULT is the normal return value
- * for drivers to use. It is intended that nearly all of the drivers in the
- * tree should return this value. BUS_PROBE_LOW_PRIORITY are for drivers that
- * have special requirements like when there are two drivers that support
- * overlapping series of hardware devices. In this case the one that supports
- * the older part of the line would return this value, while the one that
- * supports the newer ones would return BUS_PROBE_DEFAULT. BUS_PROBE_GENERIC
- * is for drivers that wish to have a generic form and a specialized form,
- * like is done with the pci bus and the acpi pci bus. BUS_PROBE_HOOVER is
- * for those busses that implement a generic device place-holder for devices on
- * the bus that have no more specific driver for them (aka ugen).
- */
-#define BUS_PROBE_SPECIFIC 0 /* Only I can use this device */
-#define BUS_PROBE_VENDOR (-10) /* Vendor supplied driver */
-#define BUS_PROBE_DEFAULT (-20) /* Base OS default driver */
-#define BUS_PROBE_LOW_PRIORITY (-40) /* Older, less desirable drivers */
-#define BUS_PROBE_GENERIC (-100) /* generic driver for dev */
-#define BUS_PROBE_HOOVER (-500) /* Generic dev for all devs on bus */
-
-/**
- * Shorthand for constructing method tables.
- */
-#define DEVMETHOD KOBJMETHOD
-
-/*
- * Some common device interfaces.
- */
-#include "device_if.h"
-#include "bus_if.h"
-#include <sys/types.h>
-
-struct module;
-
-int driver_module_handler(struct module *, int, void *);
-
-#define DRL_LEVELS 5
-#define DRL_LOWEST 0
-#define DRL_LOWER 1
-#define DRL_MIDDLE 2
-#define DRL_UPPER 3
-#define DRL_TOPMOST 4
-/**
- * Module support for automatically adding drivers to busses.
- */
-struct drv_internal {
- kobj_class_t devops;
+/*-
+ * Copyright (c) 1997,1998,2003 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: src/sys/sys/bus.h,v 1.70.2.4 2006/12/15 21:33:23 imp Exp $
+ */
+
+#ifndef _SYS_BUS_H_
+#define _SYS_BUS_H_
+
+/**
+ * @defgroup NEWBUS newbus - a generic framework for managing devices
+ * @{
+ */
+
+/**
+ * @brief Interface information structure.
+ */
+struct u_businfo {
+ int ub_version; /**< @brief interface version */
+#define BUS_USER_VERSION 1
+ int ub_generation; /**< @brief generation count */
+};
+
+/**
+ * @brief State of the device.
+ */
+typedef enum device_state {
+ DS_RAW,
+ DS_NOTPRESENT, /**< @brief not probed or probe failed */
+ DS_ALIVE, /**< @brief probe succeeded */
+ DS_ATTACHED, /**< @brief attach method called */
+ DS_BUSY /**< @brief device is open */
+} device_state_t;
+
+/**
+ * @brief Device information exported to userspace.
+ */
+struct u_device {
+ uintptr_t dv_handle;
+ uintptr_t dv_parent;
+
+ char dv_name[32]; /**< @brief Name of device in tree. */
+ char dv_desc[32]; /**< @brief Driver description */
+ char dv_drivername[32]; /**< @brief Driver name */
+ char dv_pnpinfo[128]; /**< @brief Plug and play info */
+ char dv_location[128]; /**< @brief Where is the device? */
+ uint32_t dv_devflags; /**< @brief API Flags for device */
+ uint16_t dv_flags; /**< @brief flags for dev date */
+ device_state_t dv_state; /**< @brief State of attachment */
+ /* XXX more driver info? */
+};
+
+#ifdef _KERNEL
+
+#include <sys/queue.h>
+#include <sys/kobj.h>
+
+/**
+ * devctl hooks. Typically one should use the devctl_notify
+ * hook to send the message. However, devctl_queue_data is also
+ * included in case devctl_notify isn't sufficiently general.
+ */
+void devctl_notify(const char *__system, const char *__subsystem,
+ const char *__type, const char *__data);
+void devctl_queue_data(char *__data);
+
+/*
+ * Forward declarations
+ */
+typedef struct device *device_t;
+
+/**
+ * @brief A device driver (included mainly for compatibility with
+ * FreeBSD 4.x).
+ */
+typedef struct kobj_class driver_t;
+
+/**
+ * @brief A device class
+ *
+ * The devclass object has two main functions in the system. The first
+ * is to manage the allocation of unit numbers for device instances
+ * and the second is to hold the list of device drivers for a
+ * particular bus type. Each devclass has a name and there cannot be
+ * two devclasses with the same name. This ensures that unique unit
+ * numbers are allocated to device instances.
+ *
+ * Drivers that support several different bus attachments (e.g. isa,
+ * pci, pccard) should all use the same devclass to ensure that unit
+ * numbers do not conflict.
+ *
+ * Each devclass may also have a parent devclass. This is used when
+ * searching for device drivers to allow a form of inheritance. When
+ * matching drivers with devices, first the driver list of the parent
+ * device's devclass is searched. If no driver is found in that list,
+ * the search continues in the parent devclass (if any).
+ */
+typedef struct devclass *devclass_t;
+
+/**
+ * @brief A device method (included mainly for compatibility with
+ * FreeBSD 4.x).
+ */
+#define device_method_t kobj_method_t
+
+/**
+ * @brief A driver interrupt service routine
+ */
+typedef void driver_intr_t(void*);
+
+/**
+ * @brief Interrupt type bits.
+ *
+ * These flags are used both by newbus interrupt
+ * registration (nexus.c) and also in struct intrec, which defines
+ * interrupt properties.
+ *
+ * XXX We should probably revisit this and remove the vestiges of the
+ * spls implicit in names like INTR_TYPE_TTY. In the meantime, don't
+ * confuse things by renaming them (Grog, 18 July 2000).
+ *
+ * We define this in terms of bits because some devices may belong
+ * to multiple classes (and therefore need to be included in
+ * multiple interrupt masks, which is what this really serves to
+ * indicate. Buses which do interrupt remapping will want to
+ * change their type to reflect what sort of devices are underneath.
+ */
+enum intr_type {
+ INTR_TYPE_TTY = 1,
+ INTR_TYPE_BIO = 2,
+ INTR_TYPE_NET = 4,
+ INTR_TYPE_CAM = 8,
+ INTR_TYPE_MISC = 16,
+ INTR_TYPE_CLK = 32,
+ INTR_TYPE_AV = 64,
+ INTR_FAST = 128,
+ INTR_EXCL = 256, /* exclusive interrupt */
+ INTR_MPSAFE = 512, /* this interrupt is SMP safe */
+ INTR_ENTROPY = 1024 /* this interrupt provides entropy */
+};
+
+enum intr_trigger {
+ INTR_TRIGGER_CONFORM = 0,
+ INTR_TRIGGER_EDGE = 1,
+ INTR_TRIGGER_LEVEL = 2
+};
+
+enum intr_polarity {
+ INTR_POLARITY_CONFORM = 0,
+ INTR_POLARITY_HIGH = 1,
+ INTR_POLARITY_LOW = 2
+};
+
+typedef int (*devop_t)(void);
+
+/**
+ * @brief This structure is deprecated.
+ *
+ * Use the kobj(9) macro DEFINE_CLASS to
+ * declare classes which implement device drivers.
+ */
+struct driver {
+ KOBJ_CLASS_FIELDS;
+};
+
+/*
+ * Definitions for drivers which need to keep simple lists of resources
+ * for their child devices.
+ */
+struct resource;
+
+/**
+ * @brief An entry for a single resource in a resource list.
+ */
+struct resource_list_entry {
+ STAILQ_ENTRY(resource_list_entry) link;
+ int type; /**< @brief type argument to alloc_resource */
+ int rid; /**< @brief resource identifier */
+ struct resource *res; /**< @brief the real resource when allocated */
+ u_long start; /**< @brief start of resource range */
+ u_long end; /**< @brief end of resource range */
+ u_long count; /**< @brief count within range */
+};
+STAILQ_HEAD(resource_list, resource_list_entry);
+
+void resource_list_init(struct resource_list *rl);
+void resource_list_free(struct resource_list *rl);
+struct resource_list_entry *
+ resource_list_add(struct resource_list *rl,
+ int type, int rid,
+ u_long start, u_long end, u_long count);
+int resource_list_add_next(struct resource_list *rl,
+ int type,
+ u_long start, u_long end, u_long count);
+struct resource_list_entry*
+ resource_list_find(struct resource_list *rl,
+ int type, int rid);
+void resource_list_delete(struct resource_list *rl,
+ int type, int rid);
+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);
+int resource_list_release(struct resource_list *rl,
+ device_t bus, device_t child,
+ int type, int rid, struct resource *res);
+void resource_list_purge(struct resource_list *rl);
+int resource_list_print_type(struct resource_list *rl,
+ const char *name, int type,
+ const char *format);
+
+/*
+ * The root bus, to which all top-level busses are attached.
+ */
+extern device_t root_bus;
+extern devclass_t root_devclass;
+void root_bus_configure(void);
+
+/*
+ * Useful functions for implementing busses.
+ */
+
+int bus_generic_activate_resource(device_t dev, device_t child, int type,
+ int rid, struct resource *r);
+device_t
+ bus_generic_add_child(device_t dev, int order, const char *name,
+ int unit);
+struct resource *
+ bus_generic_alloc_resource(device_t bus, device_t child, int type,
+ int *rid, u_long start, u_long end,
+ u_long count, u_int flags);
+int bus_generic_attach(device_t dev);
+int bus_generic_child_present(device_t dev, device_t child);
+int bus_generic_config_intr(device_t, int, enum intr_trigger,
+ enum intr_polarity);
+int bus_generic_deactivate_resource(device_t dev, device_t child, int type,
+ int rid, struct resource *r);
+int bus_generic_detach(device_t dev);
+void bus_generic_driver_added(device_t dev, driver_t *driver);
+struct resource_list *
+ bus_generic_get_resource_list (device_t, device_t);
+int bus_print_child_header(device_t dev, device_t child);
+int bus_print_child_footer(device_t dev, device_t child);
+int bus_generic_print_child(device_t dev, device_t child);
+int bus_generic_probe(device_t dev);
+int bus_generic_read_ivar(device_t dev, device_t child, int which,
+ uintptr_t *result);
+int bus_generic_release_resource(device_t bus, device_t child,
+ int type, int rid, struct resource *r);
+int bus_generic_resume(device_t dev);
+int bus_generic_setup_intr(device_t dev, device_t child,
+ struct resource *irq, int flags,
+ driver_intr_t *intr, void *arg, void **cookiep);
+
+struct resource *
+ bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
+ u_long, u_long, u_long, u_int);
+void bus_generic_rl_delete_resource (device_t, device_t, int, int);
+int bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
+ u_long *);
+int bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
+ u_long);
+int bus_generic_rl_release_resource (device_t, device_t, int, int,
+ struct resource *);
+
+int bus_generic_shutdown(device_t dev);
+int bus_generic_suspend(device_t dev);
+int bus_generic_teardown_intr(device_t dev, device_t child,
+ struct resource *irq, void *cookie);
+int bus_generic_write_ivar(device_t dev, device_t child, int which,
+ uintptr_t value);
+
+/*
+ * Wrapper functions for the BUS_*_RESOURCE methods to make client code
+ * a little simpler.
+ */
+struct resource *bus_alloc_resource(device_t dev, int type, int *rid,
+ u_long start, u_long end, u_long count,
+ u_int flags);
+int bus_activate_resource(device_t dev, int type, int rid,
+ struct resource *r);
+int bus_deactivate_resource(device_t dev, int type, int rid,
+ struct resource *r);
+int bus_release_resource(device_t dev, int type, int rid,
+ struct resource *r);
+int bus_free_resource(device_t dev, int type, struct resource *r);
+int bus_setup_intr(device_t dev, struct resource *r, int flags,
+ driver_intr_t handler, void *arg, void **cookiep);
+int bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
+int bus_set_resource(device_t dev, int type, int rid,
+ u_long start, u_long count);
+int bus_get_resource(device_t dev, int type, int rid,
+ u_long *startp, u_long *countp);
+u_long bus_get_resource_start(device_t dev, int type, int rid);
+u_long bus_get_resource_count(device_t dev, int type, int rid);
+void bus_delete_resource(device_t dev, int type, int rid);
+int bus_child_present(device_t child);
+int bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
+int bus_child_location_str(device_t child, char *buf, size_t buflen);
+void bus_enumerate_hinted_children(device_t bus);
+
+static __inline struct resource *
+bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
+{
+ return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
+}
+
+/*
>>> TRUNCATED FOR MAIL (1000 lines) <<<
More information about the p4-projects
mailing list