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.27 2008/08/17 04:32:32 sephe Exp $
  28  */
  29
  30 #ifndef _SYS_BUS_H_
  31 #define _SYS_BUS_H_
  32
  33 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  34
  35 #ifndef _SYS_TYPES_H_
  36 #include <sys/types.h>
  37 #endif
  38 #ifndef _SYS_QUEUE_H_
  39 #include <sys/queue.h>
  40 #endif
  41 #ifndef _SYS_KOBJ_H_
  42 #include <sys/kobj.h>
  43 #endif
  44 #ifdef _KERNEL
  45 #include <sys/serialize.h>
  46 #endif
  47 #ifndef _SYS_BUS_DMA_H_
  48 #include <sys/bus_dma.h>
  49 #endif
  50 #ifndef _SYS_BUS_RESOURCE_H_
  51 #include <sys/bus_resource.h>
  52 #endif
  53
  54 /*
  55  * Forward declarations
  56  */
  57 typedef struct device           *device_t;
  58 typedef struct kobj_class       driver_t;
  59 typedef struct devclass         *devclass_t;
  60 #define device_method_t         kobj_method_t
  61
  62 typedef void driver_intr_t(void*);
  63
  64 /*
  65  * Interrupt features mask.  Note that DragonFly no longer implements
  66  * INTR_TYPE_* flags.
  67  */
  68 #define INTR_FAST       0x0080
  69 #define INTR_EXCL       0x0100
  70 #define INTR_MPSAFE     0x0200
  71 #define INTR_NOENTROPY  0x0400
  72 #define INTR_NOPOLL     0x0800  /* interrupt cannot be polled (e.g. ata) */
  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_INPROGRESS,                      /* attach in progress */
  92     DS_ATTACHED,                        /* attach method called */
  93     DS_BUSY                             /* device is open */
  94 } device_state_t;
  95
  96 /*
  97  * Definitions for drivers which need to keep simple lists of resources
  98  * for their child devices.
  99  */
 100 struct  resource;
 101
 102 struct resource_list_entry {
 103     SLIST_ENTRY(resource_list_entry) link;
 104     int                 type;           /* type argument to alloc_resource */
 105     int                 rid;            /* resource identifier */
 106     struct resource     *res;           /* the real resource when allocated */
 107     u_long              start;          /* start of resource range */
 108     u_long              end;            /* end of resource range */
 109     u_long              count;          /* count within range */
 110 };
 111 SLIST_HEAD(resource_list, resource_list_entry);
 112
 113 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
 114 #ifdef _KERNEL
 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 void    root_bus_configure(void);
 183
 184 /*
 185  * Useful functions for implementing busses.
 186  */
 187
 188 int     bus_generic_activate_resource(device_t dev, device_t child, int type,
 189                                       int rid, struct resource *r);
 190 struct resource *
 191         bus_generic_alloc_resource(device_t bus, device_t child,
 192                                     int type, int *rid,
 193                                     u_long start, u_long end,
 194                                     u_long count, u_int flags);
 195 struct resource_list *
 196         bus_generic_get_resource_list (device_t, device_t);
 197
 198 int     bus_generic_config_intr(device_t, int, enum intr_trigger,
 199                                         enum intr_polarity);
 200 int     bus_generic_attach(device_t dev);
 201 int     bus_generic_child_present(device_t dev, device_t child);
 202 int     bus_generic_deactivate_resource(device_t dev, device_t child, int type,
 203                                         int rid, struct resource *r);
 204 int     bus_generic_detach(device_t dev);
 205 int     bus_generic_disable_intr(device_t dev, device_t child, void *cookie);
 206 void    bus_generic_driver_added(device_t dev, driver_t *driver);
 207 void    bus_generic_enable_intr(device_t dev, device_t child, void *cookie);
 208 int     bus_print_child_header(device_t dev, device_t child);
 209 int     bus_print_child_footer(device_t dev, device_t child);
 210 int     bus_generic_print_child(device_t dev, device_t child);
 211 int     bus_generic_identify(driver_t *driver, device_t parent);
 212 int     bus_generic_identify_sameunit(driver_t *driver, device_t parent);
 213 int     bus_generic_probe(device_t dev);
 214 int     bus_generic_probe_hack(device_t dev);
 215 device_t bus_generic_add_child(device_t, device_t, int, const char *, int);
 216 int     bus_generic_read_ivar(device_t dev, device_t child, int which,
 217                               uintptr_t *result);
 218 int     bus_generic_release_resource(device_t bus, device_t child,
 219                                      int type, int rid, struct resource *r);
 220 int     bus_generic_get_resource(device_t dev, device_t child, int type,
 221                                      int rid, u_long *startp, u_long *countp);
 222 int     bus_generic_set_resource(device_t dev, device_t child, int type,
 223                                      int rid, u_long start, u_long count);
 224 void    bus_generic_delete_resource(device_t dev, device_t child,
 225                                      int type, int rid);
 226 int     bus_generic_resume(device_t dev);
 227 int     bus_generic_setup_intr(device_t dev, device_t child,
 228                                struct resource *irq, int flags,
 229                                driver_intr_t *intr, void *arg,
 230                                void **cookiep, lwkt_serialize_t serializer);
 231 int     bus_generic_shutdown(device_t dev);
 232 int     bus_generic_suspend(device_t dev);
 233 int     bus_generic_teardown_intr(device_t dev, device_t child,
 234                                   struct resource *irq, void *cookie);
 235 int     bus_generic_write_ivar(device_t dev, device_t child, int which,
 236                                uintptr_t value);
 237
 238 struct resource *
 239         bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
 240                                     u_long, u_long, u_long, u_int);
 241 void    bus_generic_rl_delete_resource (device_t, device_t, int, int);
 242 int     bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
 243                                     u_long *);
 244 int     bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
 245                                     u_long);
 246 int     bus_generic_rl_release_resource (device_t, device_t, int, int,
 247                                     struct resource *);
 248
 249 /*
 250  * Wrapper functions for the BUS_*_RESOURCE methods to make client code
 251  * a little simpler.
 252  */
 253 struct resource_spec {
 254         int     type;
 255         int     rid;
 256         int     flags;
 257 };
 258
 259 int bus_alloc_resources(device_t dev, struct resource_spec *rs,
 260                         struct resource **res);
 261 void bus_release_resources(device_t dev, const struct resource_spec *rs,
 262                            struct resource **res);
 263
 264 struct  resource *bus_alloc_resource(device_t dev, int type, int *rid,
 265                                      u_long start, u_long end, u_long count,
 266                                      u_int flags);
 267 int     bus_activate_resource(device_t dev, int type, int rid,
 268                               struct resource *r);
 269 int     bus_deactivate_resource(device_t dev, int type, int rid,
 270                                 struct resource *r);
 271 int     bus_disable_intr(device_t dev, void *cookie);
 272 void    bus_enable_intr(device_t dev, void *cookie);
 273 int     bus_release_resource(device_t dev, int type, int rid,
 274                              struct resource *r);
 275 int     bus_setup_intr(device_t dev, struct resource *r, int flags,
 276                        driver_intr_t handler, void *arg,
 277                        void **cookiep, lwkt_serialize_t serializer);
 278 int     bus_teardown_intr(device_t dev, struct resource *r, void *cookie);
 279 int     bus_set_resource(device_t dev, int type, int rid,
 280                          u_long start, u_long count);
 281 int     bus_get_resource(device_t dev, int type, int rid,
 282                          u_long *startp, u_long *countp);
 283 u_long  bus_get_resource_start(device_t dev, int type, int rid);
 284 u_long  bus_get_resource_count(device_t dev, int type, int rid);
 285 void    bus_delete_resource(device_t dev, int type, int rid);
 286 int     bus_child_present(device_t child);
 287 int     bus_child_pnpinfo_str(device_t child, char *buf, size_t buflen);
 288 int     bus_child_location_str(device_t child, char *buf, size_t buflen);
 289
 290 static __inline struct resource *
 291 bus_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
 292 {
 293         return (bus_alloc_resource(dev, type, rid, 0ul, ~0ul, 1, flags));
 294 }
 295
 296 /*
 297  * Access functions for device.
 298  */
 299 device_t        device_add_child(device_t dev, const char *name, int unit);
 300 device_t        device_add_child_ordered(device_t dev, int order,
 301                                          const char *name, int unit);
 302 void    device_busy(device_t dev);
 303 int     device_delete_child(device_t dev, device_t child);
 304 int     device_detach(device_t dev);
 305 void    device_disable(device_t dev);
 306 void    device_enable(device_t dev);
 307 device_t        device_find_child(device_t dev, const char *classname,
 308                                   int unit);
 309 const char      *device_get_desc(device_t dev);
 310 devclass_t      device_get_devclass(device_t dev);
 311 driver_t        *device_get_driver(device_t dev);
 312 u_int32_t       device_get_flags(device_t dev);
 313 device_t        device_get_parent(device_t dev);
 314 int     device_get_children(device_t dev, device_t **listp, int *countp);
 315 void    *device_get_ivars(device_t dev);
 316 void    device_set_ivars(device_t dev, void *ivars);
 317 const   char *device_get_name(device_t dev);
 318 const   char *device_get_nameunit(device_t dev);
 319 void    *device_get_softc(device_t dev);
 320 device_state_t  device_get_state(device_t dev);
 321 int     device_get_unit(device_t dev);
 322 int     device_is_alive(device_t dev); /* did probe succeed? */
 323 int     device_is_attached(device_t dev);       /* did attach succeed? */
 324 int     device_is_enabled(device_t dev);
 325 int     device_is_quiet(device_t dev);
 326 int     device_print_prettyname(device_t dev);
 327 int     device_printf(device_t dev, const char *, ...) __printflike(2, 3);
 328 int     device_probe_and_attach(device_t dev);
 329 void    device_quiet(device_t dev);
 330 void    device_set_desc(device_t dev, const char* desc);
 331 void    device_set_desc_copy(device_t dev, const char* desc);
 332 int     device_set_devclass(device_t dev, const char *classname);
 333 int     device_set_driver(device_t dev, driver_t *driver);
 334 void    device_set_flags(device_t dev, u_int32_t flags);
 335 void    device_set_softc(device_t dev, void *softc);
 336 void    device_set_async_attach(device_t dev, int enable);
 337 int     device_set_unit(device_t dev, int unit);        /* XXX DONT USE XXX */
 338 int     device_shutdown(device_t dev);
 339 void    device_unbusy(device_t dev);
 340 void    device_verbose(device_t dev);
 341
 342 /*
 343  * Access functions for devclass.
 344  */
 345 int     devclass_add_driver(devclass_t dc, kobj_class_t driver);
 346 int     devclass_delete_driver(devclass_t dc, kobj_class_t driver);
 347 devclass_t      devclass_create(const char *classname);
 348 devclass_t      devclass_find(const char *classname);
 349 device_t        devclass_find_unit(const char *classname, int unit);
 350 kobj_class_t    devclass_find_driver(devclass_t dc, const char *classname);
 351 const char      *devclass_get_name(devclass_t dc);
 352 device_t        devclass_get_device(devclass_t dc, int unit);
 353 void    *devclass_get_softc(devclass_t dc, int unit);
 354 int     devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
 355 int     devclass_get_maxunit(devclass_t dc);
 356 void    devclass_set_parent(devclass_t dc, devclass_t pdc);
 357 devclass_t      devclass_get_parent(devclass_t dc);
 358
 359 /*
 360  * Access functions for device resources.
 361  */
 362
 363 int     resource_int_value(const char *name, int unit, const char *resname,
 364                            int *result);
 365 int     resource_long_value(const char *name, int unit, const char *resname,
 366                             long *result);
 367 int     resource_string_value(const char *name, int unit, const char *resname,
 368                               char **result);
 369 int     resource_disabled(const char *name, int unit);
 370 int     resource_query_string(int i, const char *resname, const char *value);
 371 char    *resource_query_name(int i);
 372 int     resource_query_unit(int i);
 373 int     resource_locate(int i, const char *resname);
 374 int     resource_set_int(const char *name, int unit, const char *resname,
 375                          int value);
 376 int     resource_set_long(const char *name, int unit, const char *resname,
 377                           long value);
 378 int     resource_set_string(const char *name, int unit, const char *resname,
 379                             const char *value);
 380 int     resource_count(void);
 381
 382 /**
 383  * Some convenience defines for probe routines to return.  These are just
 384  * suggested values, and there's nothing magical about them.
 385  * BUS_PROBE_SPECIFIC is for devices that cannot be reprobed, and that no
 386  * possible other driver may exist (typically legacy drivers who don't fallow
 387  * all the rules, or special needs drivers).  BUS_PROBE_VENDOR is the
 388  * suggested value that vendor supplied drivers use.  This is for source or
 389  * binary drivers that are not yet integrated into the FreeBSD tree.  Its use
 390  * in the base OS is prohibited.  BUS_PROBE_DEFAULT is the normal return value
 391  * for drivers to use.  It is intended that nearly all of the drivers in the
 392  * tree should return this value.  BUS_PROBE_LOW_PRIORITY are for drivers that
 393  * have special requirements like when there are two drivers that support
 394  * overlapping series of hardware devices.  In this case the one that supports
 395  * the older part of the line would return this value, while the one that
 396  * supports the newer ones would return BUS_PROBE_DEFAULT.  BUS_PROBE_GENERIC
 397  * is for drivers that wish to have a generic form and a specialized form,
 398  * like is done with the pci bus and the acpi pci bus.  BUS_PROBE_HOOVER is
 399  * for those busses that implement a generic device place-holder for devices on
 400  * the bus that have no more specific driver for them (aka ugen).
 401  */
 402 #define BUS_PROBE_SPECIFIC      0       /* Only I can use this device */
 403 #if notyet
 404 #define BUS_PROBE_VENDOR        (-10)   /* Vendor supplied driver */
 405 #define BUS_PROBE_DEFAULT       (-20)   /* Base OS default driver */
 406 #define BUS_PROBE_LOW_PRIORITY  (-40)   /* Older, less desirable drivers */
 407 #define BUS_PROBE_GENERIC       (-100)  /* generic driver for dev */
 408 #define BUS_PROBE_HOOVER        (-500)  /* Generic dev for all devs on bus */
 409 #else
 410 #define BUS_PROBE_VENDOR        0
 411 #define BUS_PROBE_DEFAULT       0
 412 #define BUS_PROBE_LOW_PRIORITY  0
 413 #define BUS_PROBE_GENERIC       0
 414 #define BUS_PROBE_HOOVER        0
 415 #endif
 416
 417 /*
 418  * Shorthand for constructing method tables.
 419  */
 420 #define DEVMETHOD       KOBJMETHOD
 421
 422 /*
 423  * Some common device interfaces.
 424  */
 425 #include "device_if.h"
 426 #include "bus_if.h"
 427
 428 struct  module;
 429
 430 int     driver_module_handler(struct module *, int, void *);
 431
 432 /*
 433  * Module support for automatically adding drivers to busses.
 434  */
 435 struct driver_module_data {
 436         int             (*dmd_chainevh)(struct module *, int, void *);
 437         void            *dmd_chainarg;
 438         const char      *dmd_busname;
 439         kobj_class_t    dmd_driver;
 440         devclass_t      *dmd_devclass;
 441 };
 442
 443 #define DRIVER_MODULE(name, busname, driver, devclass, evh, arg)        \
 444                                                                         \
 445 static struct driver_module_data name##_##busname##_driver_mod = {      \
 446         evh, arg,                                                       \
 447         #busname,                                                       \
 448         (kobj_class_t) &driver,                                         \
 449         &devclass                                                       \
 450 };                                                                      \
 451                                                                         \
 452 static moduledata_t name##_##busname##_mod = {                          \
 453         #busname "/" #name,                                             \
 454         driver_module_handler,                                          \
 455         &name##_##busname##_driver_mod                                  \
 456 };                                                                      \
 457 DECLARE_MODULE(name##_##busname, name##_##busname##_mod,                \
 458                SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 459
 460 #endif /* _KERNEL */
 461
 462 #endif /* !_SYS_BUS_H_ */