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