sys/sys/bus.h

   1 /*-
   2  * Copyright (c) 1997,1998 Doug Rabson
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/sys/bus.h,v 1.30.2.5 2004/03/17 17:54:25 njl Exp $
  27  * $DragonFly: src/sys/sys/bus.h,v 1.14 2005/05/24 20:58:44 dillon Exp $
  28  */
  29
  30 #ifndef _SYS_BUS_H_
  31 #define _SYS_BUS_H_
  32
  33 #ifdef _KERNEL
  34
  35 #include <sys/queue.h>
  36 #include <sys/kobj.h>
  37 #include <sys/serialize.h>
  38
  39 /*
  40  * Forward declarations
  41  */
  42 typedef struct device           *device_t;
  43 typedef struct kobj_class       driver_t;
  44 typedef struct devclass         *devclass_t;
  45 #define device_method_t         kobj_method_t
  46
  47 typedef void driver_intr_t(void*);
  48
  49 /*
  50  * We define this in terms of bits because some devices may belong
  51  * to multiple classes (and therefore need to be included in
  52  * multiple interrupt masks, which is what this really serves to
  53  * indicate.  Buses which do interrupt remapping will want to
  54  * change their type to reflect what sort of devices are underneath.
  55  */
  56 enum intr_type {
  57     INTR_TYPE_TTY = 1,
  58     INTR_TYPE_BIO = 2,
  59     INTR_TYPE_NET = 4,
  60     INTR_TYPE_CAM = 8,
  61     INTR_TYPE_MISC = 16,
  62     INTR_TYPE_CLK = 32,
  63     INTR_TYPE_AV = 64,
  64     INTR_FAST = 128,
  65     INTR_EXCL = 256,
  66     INTR_MPSAFE = 512,
  67     INTR_ENTROPY = 1024
  68 };
  69
  70 #define INTR_TYPE_MASK  (INTR_TYPE_TTY|INTR_TYPE_BIO|INTR_TYPE_NET|\
  71                          INTR_TYPE_CAM|INTR_TYPE_MISC|INTR_TYPE_CLK|\
  72                          INTR_TYPE_AV)
  73
  74 enum intr_trigger {
  75     INTR_TRIGGER_CONFORM = 0,
  76     INTR_TRIGGER_EDGE = 1,
  77     INTR_TRIGGER_LEVEL = 2
  78 };
  79
  80 enum intr_polarity {
  81     INTR_POLARITY_CONFORM = 0,
  82     INTR_POLARITY_HIGH = 1,
  83     INTR_POLARITY_LOW = 2
  84 };
  85
  86 typedef int (*devop_t)(void);
  87
  88 typedef enum device_state {
  89     DS_NOTPRESENT,                      /* not probed or probe failed */
  90     DS_ALIVE,                           /* probe succeeded */
  91     DS_ATTACHED,                        /* attach method called */
  92     DS_BUSY                             /* device is open */
  93 } device_state_t;
  94
  95 /*
  96  * Definitions for drivers which need to keep simple lists of resources
  97  * for their child devices.
  98  */
  99 struct  resource;
 100
 101 struct resource_list_entry {
 102     SLIST_ENTRY(resource_list_entry) link;
 103     int                 type;           /* type argument to alloc_resource */
 104     int                 rid;            /* resource identifier */
 105     struct resource     *res;           /* the real resource when allocated */
 106     u_long              start;          /* start of resource range */
 107     u_long              end;            /* end of resource range */
 108     u_long              count;          /* count within range */
 109 };
 110 SLIST_HEAD(resource_list, resource_list_entry);
 111
 112 /*
 113  * Initialise a resource list.
 114  */
 115 void    resource_list_init(struct resource_list *rl);
 116
 117 /*
 118  * Reclaim memory used by a resource list.
 119  */
 120 void    resource_list_free(struct resource_list *rl);
 121
 122 /*
 123  * Add a resource entry or modify an existing entry if one exists with
 124  * the same type and rid.
 125  */
 126 void    resource_list_add(struct resource_list *rl,
 127                           int type, int rid,
 128                           u_long start, u_long end, u_long count);
 129
 130 /*
 131  * Find a resource entry by type and rid.
 132  */
 133 struct resource_list_entry*
 134         resource_list_find(struct resource_list *rl,
 135                            int type, int rid);
 136
 137 /*
 138  * Delete a resource entry.
 139  */
 140 void    resource_list_delete(struct resource_list *rl,
 141                              int type, int rid);
 142
 143 /*
 144  * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
 145  * and passing the allocation up to the parent of bus. This assumes
 146  * that the first entry of device_get_ivars(child) is a struct
 147  * resource_list. This also handles 'passthrough' allocations where a
 148  * child is a remote descendant of bus by passing the allocation up to
 149  * the parent of bus.
 150  */
 151 struct resource *
 152         resource_list_alloc(struct resource_list *rl,
 153                             device_t bus, device_t child,
 154                             int type, int *rid,
 155                             u_long start, u_long end,
 156                             u_long count, u_int flags);
 157
 158 /*
 159  * Implement BUS_RELEASE_RESOURCE.
 160  */
 161 int     resource_list_release(struct resource_list *rl,
 162                               device_t bus, device_t child,
 163                               int type, int rid, struct resource *res);
 164
 165 /*
 166  * Print all resources of a specified type, for use in bus_print_child.
 167  * The name is printed if at least one resource of the given type is available.
 168  * The format ist used to print resource start and end.
 169  */
 170 int     resource_list_print_type(struct resource_list *rl,
 171                                  const char *name, int type,
 172                                  const char *format);
 173
 174 /*
 175  * The root bus, to which all top-level busses are attached.
 176  */
 177 extern device_t root_bus;
 178 extern devclass_t root_devclass;
 179 void    root_bus_configure(void);
 180
 181 /*
 182  * Useful functions for implementing busses.
 183  */
 184
 185 int     bus_generic_activate_resource(device_t dev, device_t child, int type,
 186                                       int rid, struct resource *r);
 187 struct resource *
 188         bus_generic_alloc_resource(device_t bus, device_t child,
 189                                     int type, int *rid,
 190                                     u_long start, u_long end,
 191                                     u_long count, u_int flags);
 192 struct resource_list *
 193         bus_generic_get_resource_list (device_t, device_t);
 194
 195 int     bus_generic_config_intr(device_t, int, enum intr_trigger,
 196                                         enum intr_polarity);
 197 int     bus_generic_attach(device_t dev);
 198 int     bus_generic_child_present(device_t dev, device_t child);
 199 int     bus_generic_deactivate_resource(device_t dev, device_t child, int type,
 200                                         int rid, struct resource *r);
 201 int     bus_generic_detach(device_t dev);
 202 int     bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
 203 void    bus_generic_driver_added(device_t dev, driver_t *driver);
 204 void    bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
 205 int     bus_print_child_header(device_t dev, device_t child);
 206 int     bus_print_child_footer(device_t dev, device_t child);
 207 int     bus_generic_print_child(device_t dev, device_t child);
 208 int     bus_generic_probe(device_t dev);
 209 int     bus_generic_read_ivar(device_t dev, device_t child, int which,
 210                               uintptr_t *result);
 211 int     bus_generic_release_resource(device_t bus, device_t child,
 212                                      int type, int rid, struct resource *r);
 213 int     bus_generic_resume(device_t dev);
 214 int     bus_generic_setup_intr(device_t dev, device_t child,
 215                                struct resource *irq, int flags,
 216                                driver_intr_t *intr, void *arg,
 217                                void **cookiep, lwkt_serialize_t serializer);
 218 int     bus_generic_shutdown(device_t dev);
 219 int     bus_generic_suspend(device_t dev);
 220 int     bus_generic_teardown_intr(device_t dev, device_t child,
 221                                   struct resource *irq, void *cookie);
 222 int     bus_generic_write_ivar(device_t dev, device_t child, int which,
 223                                uintptr_t value);
 224
 225 struct resource *
 226         bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
 227                                     u_long, u_long, u_long, u_int);
 228 void    bus_generic_rl_delete_resource (device_t, device_t, int, int);
 229 int     bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
 230                                     u_long *);
 231 int     bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
 232                                     u_long);
 233 int     bus_generic_rl_release_resource (device_t, device_t, int, int,
 234                                     struct resource *);
 235
 236 /*
 237  * Wrapper functions for the BUS_*_RESOURCE methods to make client code
 238  * a little simpler.
 239  */
 240 struct  resource *bus_alloc_resource(device_t dev, int type, int *rid,
 241                                      u_long start, u_long end, u_long count,
 242                                      u_int flags);
 243 int     bus_activate_resource(device_t dev, int type, int rid,
 244                               struct resource *r);
 245 int     bus_deactivate_resource(device_t dev, int type, int rid,
 246                                 struct resource *r);
 247 int     bus_disable_intr(device_t dev, void *cookie);
 248 void    bus_enable_intr(device_t dev, void *cookie);
 249 int     bus_release_resource(device_t dev, int type, int rid,
 250                              struct resource *r);
 251 int     bus_setup_intr(device_t dev, struct resource *r, int flags,
 252                        driver_intr_t handler, void *arg,
 253                        void **cookiep, lwkt_serialize_t serializer);
 254 int     bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
 255 int     bus_set_resource(device_t dev, int type, int rid,
 256                          u_long start, u_long count);
 257 int     bus_get_resource(device_t dev, int type, int rid,
 258                          u_long *startp, u_long *countp);
 259 u_long  bus_get_resource_start(device_t dev, int type, int rid);
 260 u_long  bus_get_resource_count(device_t dev, int type, int rid);
 261 void    bus_delete_resource(device_t dev, int type, int rid);
 262 int     bus_child_present(device_t child);
 263 int     bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
 264 int     bus_child_location_str(device_t child, char *buf, size_t buflen);
 265
 266 static __inline struct resource *
 267 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
 268 {
 269         return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
 270 }
 271
 272 /*
 273  * Access functions for device.
 274  */
 275 device_t        device_add_child(device_t dev, const char *name, int unit);
 276 device_t        device_add_child_ordered(device_t dev, int order,
 277                                          const char *name, int unit);
 278 void    device_busy(device_t dev);
 279 int     device_delete_child(device_t dev, device_t child);
 280 int     device_detach(device_t dev);
 281 void    device_disable(device_t dev);
 282 void    device_enable(device_t dev);
 283 device_t        device_find_child(device_t dev, const char *classname,
 284                                   int unit);
 285 const char      *device_get_desc(device_t dev);
 286 devclass_t      device_get_devclass(device_t dev);
 287 driver_t        *device_get_driver(device_t dev);
 288 u_int32_t       device_get_flags(device_t dev);
 289 device_t        device_get_parent(device_t dev);
 290 int     device_get_children(device_t dev, device_t **listp, int *countp);
 291 void    *device_get_ivars(device_t dev);
 292 void    device_set_ivars(device_t dev, void *ivars);
 293 const   char *device_get_name(device_t dev);
 294 const   char *device_get_nameunit(device_t dev);
 295 void    *device_get_softc(device_t dev);
 296 device_state_t  device_get_state(device_t dev);
 297 int     device_get_unit(device_t dev);
 298 int     device_is_alive(device_t dev); /* did probe succeed? */
 299 int     device_is_attached(device_t dev);       /* did attach succeed? */
 300 int     device_is_enabled(device_t dev);
 301 int     device_is_quiet(device_t dev);
 302 int     device_print_prettyname(device_t dev);
 303 int     device_printf(device_t dev, const char *, ...) __printflike(2, 3);
 304 int     device_probe_and_attach(device_t dev);
 305 void    device_quiet(device_t dev);
 306 void    device_set_desc(device_t dev, const char* desc);
 307 void    device_set_desc_copy(device_t dev, const char* desc);
 308 int     device_set_devclass(device_t dev, const char *classname);
 309 int     device_set_driver(device_t dev, driver_t *driver);
 310 void    device_set_flags(device_t dev, u_int32_t flags);
 311 void    device_set_softc(device_t dev, void *softc);
 312 int     device_set_unit(device_t dev, int unit);        /* XXX DONT USE XXX */
 313 int     device_shutdown(device_t dev);
 314 void    device_unbusy(device_t dev);
 315 void    device_verbose(device_t dev);
 316
 317 /*
 318  * Access functions for devclass.
 319  */
 320 int     devclass_add_driver(devclass_t dc, kobj_class_t driver);
 321 int     devclass_delete_driver(devclass_t dc, kobj_class_t driver);
 322 devclass_t      devclass_create(const char *classname);
 323 devclass_t      devclass_find(const char *classname);
 324 kobj_class_t    devclass_find_driver(devclass_t dc, const char *classname);
 325 const char      *devclass_get_name(devclass_t dc);
 326 device_t        devclass_get_device(devclass_t dc, int unit);
 327 void    *devclass_get_softc(devclass_t dc, int unit);
 328 int     devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
 329 int     devclass_get_maxunit(devclass_t dc);
 330 void    devclass_set_parent(devclass_t dc, devclass_t pdc);
 331 devclass_t      devclass_get_parent(devclass_t dc);
 332
 333 /*
 334  * Access functions for device resources.
 335  */
 336
 337 int     resource_int_value(const char *name, int unit, const char *resname,
 338                            int *result);
 339 int     resource_long_value(const char *name, int unit, const char *resname,
 340                             long *result);
 341 int     resource_string_value(const char *name, int unit, const char *resname,
 342                               char **result);
 343 int     resource_disabled(const char *name, int unit);
 344 int     resource_query_string(int i, const char *resname, const char *value);
 345 char    *resource_query_name(int i);
 346 int     resource_query_unit(int i);
 347 int     resource_locate(int i, const char *resname);
 348 int     resource_set_int(const char *name, int unit, const char *resname,
 349                          int value);
 350 int     resource_set_long(const char *name, int unit, const char *resname,
 351                           long value);
 352 int     resource_set_string(const char *name, int unit, const char *resname,
 353                             const char *value);
 354 int     resource_count(void);
 355
 356 /*
 357  * Shorthand for constructing method tables.
 358  */
 359 #define DEVMETHOD       KOBJMETHOD
 360
 361 /*
 362  * Some common device interfaces.
 363  */
 364 #include "device_if.h"
 365 #include "bus_if.h"
 366
 367 struct  module;
 368
 369 int     driver_module_handler(struct module *, int, void *);
 370
 371 /*
 372  * Module support for automatically adding drivers to busses.
 373  */
 374 struct driver_module_data {
 375         int             (*dmd_chainevh)(struct module *, int, void *);
 376         void            *dmd_chainarg;
 377         const char      *dmd_busname;
 378         kobj_class_t    dmd_driver;
 379         devclass_t      *dmd_devclass;
 380 };
 381
 382 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg)        \
 383                                                                         \
 384 static struct driver_module_data name##_##busname##_driver_mod = {      \
 385         evh, arg,                                                       \
 386         #busname,                                                       \
 387         (kobj_class_t) &driver,                                         \
 388         &devclass                                                       \
 389 };                                                                      \
 390                                                                         \
 391 static moduledata_t name##_##busname##_mod = {                          \
 392         #busname "/" #name,                                             \
 393         driver_module_handler,                                          \
 394         &name##_##busname##_driver_mod                                  \
 395 };                                                                      \
 396 DECLARE_MODULE(name##_##busname, name##_##busname##_mod,                \
 397                SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 398
 399 #endif /* _KERNEL */
 400
 401 #endif /* !_SYS_BUS_H_ */