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$
  27  */
  28
  29 #ifndef _SYS_BUS_H_
  30 #define _SYS_BUS_H_
  31
  32 /*
  33  * Interface information structure.
  34  */
  35 struct u_businfo {
  36         int     ub_version;             /* interface version */
  37 #define BUS_USER_VERSION        1
  38         int     ub_generation;          /* generation count */
  39 };
  40
  41 /*
  42  * Device information exported to userspace.
  43  */
  44 struct u_device {
  45         uintptr_t       dv_handle;
  46         uintptr_t       dv_parent;
  47
  48         char    dv_name[32];
  49         char    dv_desc[32];
  50         char    dv_drivername[32];
  51         /* XXX more driver info? */
  52 };
  53
  54 #ifdef _KERNEL
  55
  56 #include <sys/queue.h>
  57 #include <sys/kobj.h>
  58
  59 /*
  60  * Forward declarations
  61  */
  62 typedef struct device           *device_t;
  63 typedef struct driver           driver_t;
  64 typedef struct devclass         *devclass_t;
  65 #define device_method_t         kobj_method_t
  66
  67 typedef void driver_intr_t(void*);
  68
  69 /*
  70  * Interrupt type bits.  These flags are used both by newbus interrupt
  71  * registration (nexus.c) and also in struct intrec, which defines
  72  * interrupt properties.
  73  *
  74  * XXX We should probably revisit this and remove the vestiges of the
  75  * spls implicit in names like INTR_TYPE_TTY.  In the meantime, don't
  76  * confuse things by renaming them (Grog, 18 July 2000).
  77  *
  78  * We define this in terms of bits because some devices may belong
  79  * to multiple classes (and therefore need to be included in
  80  * multiple interrupt masks, which is what this really serves to
  81  * indicate.  Buses which do interrupt remapping will want to
  82  * change their type to reflect what sort of devices are underneath.
  83  */
  84 enum intr_type {
  85         INTR_TYPE_TTY = 1,
  86         INTR_TYPE_BIO = 2,
  87         INTR_TYPE_NET = 4,
  88         INTR_TYPE_CAM = 8,
  89         INTR_TYPE_MISC = 16,
  90         INTR_TYPE_CLK = 32,
  91         INTR_TYPE_AV = 64,
  92         INTR_FAST = 128,
  93         INTR_EXCL = 256,                /* exclusive interrupt */
  94         INTR_MPSAFE = 512,              /* this interrupt is SMP safe */
  95         INTR_ENTROPY = 1024             /* this interrupt provides entropy */
  96 };
  97
  98 typedef int (*devop_t)(void);
  99
 100 struct driver {
 101         KOBJ_CLASS_FIELDS;
 102         void    *priv;                  /* driver private data */
 103 };
 104
 105 typedef enum device_state {
 106         DS_NOTPRESENT,                  /* not probed or probe failed */
 107         DS_ALIVE,                       /* probe succeeded */
 108         DS_ATTACHED,                    /* attach method called */
 109         DS_BUSY                         /* device is open */
 110 } device_state_t;
 111
 112 /*
 113  * Definitions for drivers which need to keep simple lists of resources
 114  * for their child devices.
 115  */
 116 struct  resource;
 117
 118 struct resource_list_entry {
 119         SLIST_ENTRY(resource_list_entry) link;
 120         int     type;                   /* type argument to alloc_resource */
 121         int     rid;                    /* resource identifier */
 122         struct  resource *res;          /* the real resource when allocated */
 123         u_long  start;                  /* start of resource range */
 124         u_long  end;                    /* end of resource range */
 125         u_long  count;                  /* count within range */
 126 };
 127 SLIST_HEAD(resource_list, resource_list_entry);
 128
 129 /*
 130  * Initialise a resource list.
 131  */
 132 void    resource_list_init(struct resource_list *rl);
 133
 134 /*
 135  * Reclaim memory used by a resource list.
 136  */
 137 void    resource_list_free(struct resource_list *rl);
 138
 139 /*
 140  * Add a resource entry or modify an existing entry if one exists with
 141  * the same type and rid.
 142  */
 143 void    resource_list_add(struct resource_list *rl,
 144                           int type, int rid,
 145                           u_long start, u_long end, u_long count);
 146
 147 /*
 148  * Find a resource entry by type and rid.
 149  */
 150 struct resource_list_entry*
 151         resource_list_find(struct resource_list *rl,
 152                            int type, int rid);
 153
 154 /*
 155  * Delete a resource entry.
 156  */
 157 void    resource_list_delete(struct resource_list *rl,
 158                              int type, int rid);
 159
 160 /*
 161  * Implement BUS_ALLOC_RESOURCE by looking up a resource from the list
 162  * and passing the allocation up to the parent of bus. This assumes
 163  * that the first entry of device_get_ivars(child) is a struct
 164  * resource_list. This also handles 'passthrough' allocations where a
 165  * child is a remote descendant of bus by passing the allocation up to
 166  * the parent of bus.
 167  */
 168 struct resource *
 169         resource_list_alloc(struct resource_list *rl,
 170                             device_t bus, device_t child,
 171                             int type, int *rid,
 172                             u_long start, u_long end,
 173                             u_long count, u_int flags);
 174
 175 /*
 176  * Implement BUS_RELEASE_RESOURCE.
 177  */
 178 int     resource_list_release(struct resource_list *rl,
 179                               device_t bus, device_t child,
 180                               int type, int rid, struct resource *res);
 181
 182 /*
 183  * The root bus, to which all top-level busses are attached.
 184  */
 185 extern device_t root_bus;
 186 extern devclass_t root_devclass;
 187 void    root_bus_configure(void);
 188
 189 /*
 190  * Useful functions for implementing busses.
 191  */
 192
 193 int     bus_generic_activate_resource(device_t dev, device_t child, int type,
 194                                       int rid, struct resource *r);
 195 struct resource *
 196         bus_generic_alloc_resource(device_t bus, device_t child, int type,
 197                                    int *rid, u_long start, u_long end,
 198                                    u_long count, u_int flags);
 199 int     bus_generic_attach(device_t dev);
 200 int     bus_generic_deactivate_resource(device_t dev, device_t child, int type,
 201                                         int rid, struct resource *r);
 202 int     bus_generic_detach(device_t dev);
 203 void    bus_generic_driver_added(device_t dev, driver_t *driver);
 204 struct resource_list *
 205         bus_generic_get_resource_list (device_t, device_t);
 206 int     bus_print_child_header(device_t dev, device_t child);
 207 int     bus_print_child_footer(device_t dev, device_t child);
 208 int     bus_generic_print_child(device_t dev, device_t child);
 209 int     bus_generic_probe(device_t dev);
 210 int     bus_generic_read_ivar(device_t dev, device_t child, int which,
 211                               uintptr_t *result);
 212 int     bus_generic_release_resource(device_t bus, device_t child,
 213                                      int type, int rid, struct resource *r);
 214 int     bus_generic_resume(device_t dev);
 215 int     bus_generic_setup_intr(device_t dev, device_t child,
 216                                struct resource *irq, int flags,
 217                                driver_intr_t *intr, void *arg, void **cookiep);
 218
 219 struct resource *
 220         bus_generic_rl_alloc_resource (device_t, device_t, int, int *,
 221                                        u_long, u_long, u_long, u_int);
 222 void    bus_generic_rl_delete_resource (device_t, device_t, int, int);
 223 int     bus_generic_rl_get_resource (device_t, device_t, int, int, u_long *,
 224                                      u_long *);
 225 int     bus_generic_rl_set_resource (device_t, device_t, int, int, u_long,
 226                                      u_long);
 227 int     bus_generic_rl_release_resource (device_t, device_t, int, int,
 228                                          struct resource *);
 229
 230 int     bus_generic_shutdown(device_t dev);
 231 int     bus_generic_suspend(device_t dev);
 232 int     bus_generic_teardown_intr(device_t dev, device_t child,
 233                                   struct resource *irq, void *cookie);
 234 int     bus_generic_write_ivar(device_t dev, device_t child, int which,
 235                                uintptr_t value);
 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
 261 /*
 262  * Access functions for device.
 263  */
 264 device_t        device_add_child(device_t dev, const char *name, int unit);
 265 device_t        device_add_child_ordered(device_t dev, int order,
 266                                          const char *name, int unit);
 267 void    device_busy(device_t dev);
 268 int     device_delete_child(device_t dev, device_t child);
 269 int     device_detach(device_t dev);
 270 void    device_disable(device_t dev);
 271 void    device_enable(device_t dev);
 272 device_t        device_find_child(device_t dev, const char *classname,
 273                                   int unit);
 274 const char      *device_get_desc(device_t dev);
 275 devclass_t      device_get_devclass(device_t dev);
 276 driver_t        *device_get_driver(device_t dev);
 277 u_int32_t       device_get_flags(device_t dev);
 278 device_t        device_get_parent(device_t dev);
 279 int     device_get_children(device_t dev, device_t **listp, int *countp);
 280 void    *device_get_ivars(device_t dev);
 281 void    device_set_ivars(device_t dev, void *ivars);
 282 const   char *device_get_name(device_t dev);
 283 const   char *device_get_nameunit(device_t dev);
 284 void    *device_get_softc(device_t dev);
 285 device_state_t  device_get_state(device_t dev);
 286 int     device_get_unit(device_t dev);
 287 int     device_is_alive(device_t dev);  /* did probe succeed? */
 288 int     device_is_enabled(device_t dev);
 289 int     device_is_quiet(device_t dev);
 290 int     device_print_prettyname(device_t dev);
 291 int     device_printf(device_t dev, const char *, ...) __printflike(2, 3);
 292 int     device_probe_and_attach(device_t dev);
 293 void    device_quiet(device_t dev);
 294 void    device_set_desc(device_t dev, const char* desc);
 295 void    device_set_desc_copy(device_t dev, const char* desc);
 296 int     device_set_devclass(device_t dev, const char *classname);
 297 int     device_set_driver(device_t dev, driver_t *driver);
 298 void    device_set_flags(device_t dev, u_int32_t flags);
 299 void    device_set_softc(device_t dev, void *softc);
 300 int     device_set_unit(device_t dev, int unit);        /* XXX DONT USE XXX */
 301 int     device_shutdown(device_t dev);
 302 void    device_unbusy(device_t dev);
 303 void    device_verbose(device_t dev);
 304
 305 /*
 306  * Access functions for devclass.
 307  */
 308 int     devclass_add_driver(devclass_t dc, driver_t *driver);
 309 int     devclass_delete_driver(devclass_t dc, driver_t *driver);
 310 devclass_t      devclass_create(const char *classname);
 311 devclass_t      devclass_find(const char *classname);
 312 driver_t        *devclass_find_driver(devclass_t dc, const char *classname);
 313 const char      *devclass_get_name(devclass_t dc);
 314 device_t        devclass_get_device(devclass_t dc, int unit);
 315 void    *devclass_get_softc(devclass_t dc, int unit);
 316 int     devclass_get_devices(devclass_t dc, device_t **listp, int *countp);
 317 int     devclass_get_maxunit(devclass_t dc);
 318
 319 /*
 320  * Access functions for device resources.
 321  */
 322
 323 int     resource_int_value(const char *name, int unit, const char *resname,
 324                            int *result);
 325 int     resource_long_value(const char *name, int unit, const char *resname,
 326                             long *result);
 327 int     resource_string_value(const char *name, int unit, const char *resname,
 328                               const char **result);
 329 int     resource_find_match(int *anchor, const char **name, int *unit,
 330                             const char *resname, const char *value);
 331 int     resource_find_dev(int *anchor, const char *name, int *unit,
 332                           const char *resname, const char *value);
 333 int     resource_set_int(const char *name, int unit, const char *resname,
 334                          int value);
 335 int     resource_set_long(const char *name, int unit, const char *resname,
 336                           long value);
 337 int     resource_set_string(const char *name, int unit, const char *resname,
 338                             const char *value);
 339 /*
 340  * Functions for maintaining and checking consistency of
 341  * bus information exported to userspace.
 342  */
 343 int     bus_data_generation_check(int generation);
 344 void    bus_data_generation_update(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_ */