sys/dev/bhnd/bhnd.h

   1 /*-
   2  * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
   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  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13  *    redistribution must be conditioned upon including a substantially
  14  *    similar Disclaimer requirement for further binary redistribution.
  15  *
  16  * NO WARRANTY
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27  * THE POSSIBILITY OF SUCH DAMAGES.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _BHND_BHND_H_
  33 #define _BHND_BHND_H_
  34
  35 #include <sys/types.h>
  36 #include <sys/bus.h>
  37
  38 #include <machine/bus.h>
  39
  40 #include "bhnd_ids.h"
  41 #include "bhnd_types.h"
  42 #include "bhnd_debug.h"
  43 #include "bhnd_bus_if.h"
  44 #include "bhnd_match.h"
  45
  46 extern devclass_t bhnd_devclass;
  47 extern devclass_t bhnd_hostb_devclass;
  48 extern devclass_t bhnd_nvram_devclass;
  49
  50 /**
  51  * bhnd child instance variables
  52  */
  53 enum bhnd_device_vars {
  54         BHND_IVAR_VENDOR,       /**< Designer's JEP-106 manufacturer ID. */
  55         BHND_IVAR_DEVICE,       /**< Part number */
  56         BHND_IVAR_HWREV,        /**< Core revision */
  57         BHND_IVAR_DEVICE_CLASS, /**< Core class (@sa bhnd_devclass_t) */
  58         BHND_IVAR_VENDOR_NAME,  /**< Core vendor name */
  59         BHND_IVAR_DEVICE_NAME,  /**< Core name */
  60         BHND_IVAR_CORE_INDEX,   /**< Bus-assigned core number */
  61         BHND_IVAR_CORE_UNIT,    /**< Bus-assigned core unit number,
  62                                      assigned sequentially (starting at 0) for
  63                                      each vendor/device pair. */
  64 };
  65
  66 /**
  67  * bhnd device probe priority bands.
  68  */
  69 enum {
  70         BHND_PROBE_ROOT         = 0,    /**< Nexus or host bridge */
  71         BHND_PROBE_BUS          = 1000, /**< Busses and bridges */
  72         BHND_PROBE_CPU          = 2000, /**< CPU devices */
  73         BHND_PROBE_INTERRUPT    = 3000, /**< Interrupt controllers. */
  74         BHND_PROBE_TIMER        = 4000, /**< Timers and clocks. */
  75         BHND_PROBE_RESOURCE     = 5000, /**< Resource discovery (including NVRAM/SPROM) */
  76         BHND_PROBE_DEFAULT      = 6000, /**< Default device priority */
  77 };
  78
  79 /**
  80  * Constants defining fine grained ordering within a BHND_PROBE_* priority band.
  81  *
  82  * Example:
  83  * @code
  84  * BHND_PROBE_BUS + BHND_PROBE_ORDER_FIRST
  85  * @endcode
  86  */
  87 enum {
  88         BHND_PROBE_ORDER_FIRST          = 0,
  89         BHND_PROBE_ORDER_EARLY          = 25,
  90         BHND_PROBE_ORDER_MIDDLE         = 50,
  91         BHND_PROBE_ORDER_LATE           = 75,
  92         BHND_PROBE_ORDER_LAST           = 100
  93
  94 };
  95
  96 /*
  97  * Simplified accessors for bhnd device ivars
  98  */
  99 #define BHND_ACCESSOR(var, ivar, type) \
 100         __BUS_ACCESSOR(bhnd, var, BHND, ivar, type)
 101
 102 BHND_ACCESSOR(vendor,           VENDOR,         uint16_t);
 103 BHND_ACCESSOR(device,           DEVICE,         uint16_t);
 104 BHND_ACCESSOR(hwrev,            HWREV,          uint8_t);
 105 BHND_ACCESSOR(class,            DEVICE_CLASS,   bhnd_devclass_t);
 106 BHND_ACCESSOR(vendor_name,      VENDOR_NAME,    const char *);
 107 BHND_ACCESSOR(device_name,      DEVICE_NAME,    const char *);
 108 BHND_ACCESSOR(core_index,       CORE_INDEX,     u_int);
 109 BHND_ACCESSOR(core_unit,        CORE_UNIT,      int);
 110
 111 #undef  BHND_ACCESSOR
 112
 113 /**
 114  * A bhnd(4) board descriptor.
 115  */
 116 struct bhnd_board_info {
 117         uint16_t        board_vendor;   /**< PCI-SIG vendor ID (even on non-PCI
 118                                           *  devices).
 119                                           *
 120                                           *  On PCI devices, this will generally
 121                                           *  be the subsystem vendor ID, but the
 122                                           *  value may be overridden in device
 123                                           *  NVRAM.
 124                                           */
 125         uint16_t        board_type;     /**< Board type (See BHND_BOARD_*)
 126                                           *
 127                                           *  On PCI devices, this will generally
 128                                           *  be the subsystem device ID, but the
 129                                           *  value may be overridden in device
 130                                           *  NVRAM.
 131                                           */
 132         uint16_t        board_rev;      /**< Board revision. */
 133         uint8_t         board_srom_rev; /**< Board SROM format revision */
 134
 135         uint32_t        board_flags;    /**< Board flags (see BHND_BFL_*) */
 136         uint32_t        board_flags2;   /**< Board flags 2 (see BHND_BFL2_*) */
 137         uint32_t        board_flags3;   /**< Board flags 3 (see BHND_BFL3_*) */
 138 };
 139
 140
 141 /**
 142  * Chip Identification
 143  *
 144  * This is read from the ChipCommon ID register; on earlier bhnd(4) devices
 145  * where ChipCommon is unavailable, known values must be supplied.
 146  */
 147 struct bhnd_chipid {
 148         uint16_t        chip_id;        /**< chip id (BHND_CHIPID_*) */
 149         uint8_t         chip_rev;       /**< chip revision */
 150         uint8_t         chip_pkg;       /**< chip package (BHND_PKGID_*) */
 151         uint8_t         chip_type;      /**< chip type (BHND_CHIPTYPE_*) */
 152
 153         bhnd_addr_t     enum_addr;      /**< chip_type-specific enumeration
 154                                           *  address; either the siba(4) base
 155                                           *  core register block, or the bcma(4)
 156                                           *  EROM core address. */
 157
 158         uint8_t         ncores;         /**< number of cores, if known. 0 if
 159                                           *  not available. */
 160 };
 161
 162 /**
 163  * A bhnd(4) core descriptor.
 164  */
 165 struct bhnd_core_info {
 166         uint16_t        vendor;         /**< JEP-106 vendor (BHND_MFGID_*) */
 167         uint16_t        device;         /**< device */
 168         uint16_t        hwrev;          /**< hardware revision */
 169         u_int           core_idx;       /**< bus-assigned core index */
 170         int             unit;           /**< bus-assigned core unit */
 171 };
 172
 173 /**
 174 * A bhnd(4) bus resource.
 175 *
 176 * This provides an abstract interface to per-core resources that may require
 177 * bus-level remapping of address windows prior to access.
 178 */
 179 struct bhnd_resource {
 180         struct resource *res;           /**< the system resource. */
 181         bool             direct;        /**< false if the resource requires
 182                                          *   bus window remapping before it
 183                                          *   is MMIO accessible. */
 184 };
 185
 186 /**
 187  * Device quirk table descriptor.
 188  */
 189 struct bhnd_device_quirk {
 190         struct bhnd_device_match desc;          /**< device match descriptor */
 191         uint32_t                 quirks;        /**< quirk flags */
 192 };
 193
 194 #define BHND_CORE_QUIRK(_rev, _flags)           \
 195         {{ BHND_MATCH_CORE_REV(_rev) }, (_flags) }
 196
 197 #define BHND_CHIP_QUIRK(_chip, _rev, _flags)    \
 198         {{ BHND_CHIP_IR(BCM ## _chip, _rev) }, (_flags) }
 199
 200 #define BHND_PKG_QUIRK(_chip, _pkg, _flags)     \
 201         {{ BHND_CHIP_IP(BCM ## _chip, BCM ## _chip ## _pkg) }, (_flags) }
 202
 203 #define BHND_BOARD_QUIRK(_board, _flags)        \
 204         {{ BHND_MATCH_BOARD_TYPE(_board) },     \
 205             (_flags) }
 206
 207 #define BHND_DEVICE_QUIRK_END           { { BHND_MATCH_ANY }, 0 }
 208 #define BHND_DEVICE_QUIRK_IS_END(_q)    \
 209         (((_q)->desc.m.match_flags == 0) && (_q)->quirks == 0)
 210
 211 enum {
 212         BHND_DF_ANY     = 0,
 213         BHND_DF_HOSTB   = (1<<0),       /**< core is serving as the bus' host
 214                                           *  bridge. implies BHND_DF_ADAPTER */
 215         BHND_DF_SOC     = (1<<1),       /**< core is attached to a native
 216                                              bus (BHND_ATTACH_NATIVE) */
 217         BHND_DF_ADAPTER = (1<<2),       /**< core is attached to a bridged
 218                                           *  adapter (BHND_ATTACH_ADAPTER) */
 219 };
 220
 221 /** Device probe table descriptor */
 222 struct bhnd_device {
 223         const struct bhnd_device_match   core;          /**< core match descriptor */
 224         const char                      *desc;          /**< device description, or NULL. */
 225         const struct bhnd_device_quirk  *quirks_table;  /**< quirks table for this device, or NULL */
 226         uint32_t                         device_flags;  /**< required BHND_DF_* flags */
 227 };
 228
 229 #define _BHND_DEVICE(_vendor, _device, _desc, _quirks,          \
 230      _flags, ...)                                               \
 231         { { BHND_MATCH_CORE(BHND_MFGID_ ## _vendor,             \
 232             BHND_COREID_ ## _device) }, _desc, _quirks,         \
 233             _flags }
 234
 235 #define BHND_MIPS_DEVICE(_device, _desc, _quirks, ...)  \
 236         _BHND_DEVICE(MIPS, _device, _desc, _quirks,     \
 237             ## __VA_ARGS__, 0)
 238
 239 #define BHND_ARM_DEVICE(_device, _desc, _quirks, ...)   \
 240         _BHND_DEVICE(ARM, _device, _desc, _quirks,      \
 241             ## __VA_ARGS__, 0)
 242
 243 #define BHND_DEVICE(_device, _desc, _quirks, ...)               \
 244         _BHND_DEVICE(BCM, _device, _desc, _quirks,      \
 245             ## __VA_ARGS__, 0)
 246
 247 #define BHND_DEVICE_END         { { BHND_MATCH_ANY }, NULL, NULL, 0 }
 248 #define BHND_DEVICE_IS_END(_d)  \
 249         (BHND_MATCH_IS_ANY(&(_d)->core) && (_d)->desc == NULL)
 250
 251 const char                      *bhnd_vendor_name(uint16_t vendor);
 252 const char                      *bhnd_port_type_name(bhnd_port_type port_type);
 253
 254 const char                      *bhnd_find_core_name(uint16_t vendor,
 255                                      uint16_t device);
 256 bhnd_devclass_t                  bhnd_find_core_class(uint16_t vendor,
 257                                      uint16_t device);
 258
 259 const char                      *bhnd_core_name(const struct bhnd_core_info *ci);
 260 bhnd_devclass_t                  bhnd_core_class(const struct bhnd_core_info *ci);
 261
 262
 263 device_t                         bhnd_match_child(device_t dev,
 264                                      const struct bhnd_core_match *desc);
 265
 266 device_t                         bhnd_find_child(device_t dev,
 267                                      bhnd_devclass_t class, int unit);
 268
 269 device_t                         bhnd_find_bridge_root(device_t dev,
 270                                      devclass_t bus_class);
 271
 272 const struct bhnd_core_info     *bhnd_match_core(
 273                                      const struct bhnd_core_info *cores,
 274                                      u_int num_cores,
 275                                      const struct bhnd_core_match *desc);
 276
 277 const struct bhnd_core_info     *bhnd_find_core(
 278                                      const struct bhnd_core_info *cores,
 279                                      u_int num_cores, bhnd_devclass_t class);
 280
 281 bool                             bhnd_core_matches(
 282                                      const struct bhnd_core_info *core,
 283                                      const struct bhnd_core_match *desc);
 284
 285 bool                             bhnd_chip_matches(
 286                                      const struct bhnd_chipid *chipid,
 287                                      const struct bhnd_chip_match *desc);
 288
 289 bool                             bhnd_board_matches(
 290                                      const struct bhnd_board_info *info,
 291                                      const struct bhnd_board_match *desc);
 292
 293 bool                             bhnd_hwrev_matches(uint16_t hwrev,
 294                                      const struct bhnd_hwrev_match *desc);
 295
 296 bool                             bhnd_device_matches(device_t dev,
 297                                      const struct bhnd_device_match *desc);
 298
 299 const struct bhnd_device        *bhnd_device_lookup(device_t dev,
 300                                      const struct bhnd_device *table,
 301                                      size_t entry_size);
 302
 303 uint32_t                         bhnd_device_quirks(device_t dev,
 304                                      const struct bhnd_device *table,
 305                                      size_t entry_size);
 306
 307 struct bhnd_core_info            bhnd_get_core_info(device_t dev);
 308
 309 int                              bhnd_alloc_resources(device_t dev,
 310                                      struct resource_spec *rs,
 311                                      struct bhnd_resource **res);
 312
 313 void                             bhnd_release_resources(device_t dev,
 314                                      const struct resource_spec *rs,
 315                                      struct bhnd_resource **res);
 316
 317 struct bhnd_chipid               bhnd_parse_chipid(uint32_t idreg,
 318                                      bhnd_addr_t enum_addr);
 319
 320 int                              bhnd_read_chipid(device_t dev,
 321                                      struct resource_spec *rs,
 322                                      bus_size_t chipc_offset,
 323                                      struct bhnd_chipid *result);
 324
 325 void                             bhnd_set_custom_core_desc(device_t dev,
 326                                      const char *name);
 327 void                             bhnd_set_default_core_desc(device_t dev);
 328
 329
 330 bool                             bhnd_bus_generic_is_hw_disabled(device_t dev,
 331                                      device_t child);
 332 bool                             bhnd_bus_generic_is_region_valid(device_t dev,
 333                                      device_t child, bhnd_port_type type,
 334                                      u_int port, u_int region);
 335 int                              bhnd_bus_generic_read_nvram_var(device_t dev,
 336                                      device_t child, const char *name,
 337                                      void *buf, size_t *size);
 338 const struct bhnd_chipid        *bhnd_bus_generic_get_chipid(device_t dev,
 339                                      device_t child);
 340 int                              bhnd_bus_generic_read_board_info(device_t dev,
 341                                      device_t child,
 342                                      struct bhnd_board_info *info);
 343 int                              bhnd_bus_generic_get_nvram_var(device_t dev,
 344                                     device_t child, const char *name,
 345                                     void *buf, size_t *size);
 346 struct bhnd_resource            *bhnd_bus_generic_alloc_resource (device_t dev,
 347                                      device_t child, int type, int *rid,
 348                                      rman_res_t start, rman_res_t end,
 349                                      rman_res_t count, u_int flags);
 350 int                              bhnd_bus_generic_release_resource (device_t dev,
 351                                      device_t child, int type, int rid,
 352                                      struct bhnd_resource *r);
 353 int                              bhnd_bus_generic_activate_resource (device_t dev,
 354                                      device_t child, int type, int rid,
 355                                      struct bhnd_resource *r);
 356 int                              bhnd_bus_generic_deactivate_resource (device_t dev,
 357                                      device_t child, int type, int rid,
 358                                      struct bhnd_resource *r);
 359
 360
 361
 362 /**
 363  * Return the active host bridge core for the bhnd bus, if any, or NULL if
 364  * not found.
 365  *
 366  * @param dev A bhnd bus device.
 367  */
 368 static inline device_t
 369 bhnd_find_hostb_device(device_t dev) {
 370         return (BHND_BUS_FIND_HOSTB_DEVICE(dev));
 371 }
 372
 373 /**
 374  * Return true if the hardware components required by @p dev are known to be
 375  * unpopulated or otherwise unusable.
 376  *
 377  * In some cases, enumerated devices may have pins that are left floating, or
 378  * the hardware may otherwise be non-functional; this method allows a parent
 379  * device to explicitly specify if a successfully enumerated @p dev should
 380  * be disabled.
 381  *
 382  * @param dev A bhnd bus child device.
 383  */
 384 static inline bool
 385 bhnd_is_hw_disabled(device_t dev) {
 386         return (BHND_BUS_IS_HW_DISABLED(device_get_parent(dev), dev));
 387 }
 388
 389 /**
 390  * Return the BHND chip identification info for the bhnd bus.
 391  *
 392  * @param dev A bhnd bus child device.
 393  */
 394 static inline const struct bhnd_chipid *
 395 bhnd_get_chipid(device_t dev) {
 396         return (BHND_BUS_GET_CHIPID(device_get_parent(dev), dev));
 397 };
 398
 399 /**
 400  * Return the BHND attachment type of the parent bhnd bus.
 401  *
 402  * @param dev A bhnd bus child device.
 403  *
 404  * @retval BHND_ATTACH_ADAPTER if the bus is resident on a bridged adapter,
 405  * such as a WiFi chipset.
 406  * @retval BHND_ATTACH_NATIVE if the bus provides hardware services (clock,
 407  * CPU, etc) to a directly attached native host.
 408  */
 409 static inline bhnd_attach_type
 410 bhnd_get_attach_type (device_t dev) {
 411         return (BHND_BUS_GET_ATTACH_TYPE(device_get_parent(dev), dev));
 412 }
 413
 414 /**
 415  * Attempt to read the BHND board identification from the bhnd bus.
 416  *
 417  * This relies on NVRAM access, and will fail if a valid NVRAM device cannot
 418  * be found, or is not yet attached.
 419  *
 420  * @param dev The parent of @p child.
 421  * @param child The bhnd device requesting board info.
 422  * @param[out] info On success, will be populated with the bhnd(4) device's
 423  * board information.
 424  *
 425  * @retval 0 success
 426  * @retval ENODEV       No valid NVRAM source could be found.
 427  * @retval non-zero     If reading @p name otherwise fails, a regular unix
 428  *                      error code will be returned.
 429  */
 430 static inline int
 431 bhnd_read_board_info(device_t dev, struct bhnd_board_info *info)
 432 {
 433         return (BHND_BUS_READ_BOARD_INFO(device_get_parent(dev), dev, info));
 434 }
 435
 436 /**
 437  * Determine an NVRAM variable's expected size.
 438  *
 439  * @param       dev     A bhnd bus child device.
 440  * @param       name    The variable name.
 441  * @param[out]  len     On success, the variable's size, in bytes.
 442  *
 443  * @retval 0            success
 444  * @retval ENOENT       The requested variable was not found.
 445  * @retval ENODEV       No valid NVRAM source could be found.
 446  * @retval non-zero     If reading @p name otherwise fails, a regular unix
 447  *                      error code will be returned.
 448  */
 449 static inline int
 450 bhnd_nvram_getvarlen(device_t dev, const char *name, size_t *len)
 451 {
 452         return (BHND_BUS_GET_NVRAM_VAR(device_get_parent(dev), dev, name, NULL,
 453             len));
 454 }
 455
 456 /**
 457  * Read an NVRAM variable.
 458  *
 459  * @param       dev     A bhnd bus child device.
 460  * @param       name    The NVRAM variable name.
 461  * @param       buf     A buffer large enough to hold @p len bytes. On success,
 462  *                      the requested value will be written to this buffer.
 463  * @param       len     The required variable length.
 464  *
 465  * @retval 0            success
 466  * @retval ENOENT       The requested variable was not found.
 467  * @retval EINVAL       If @p len does not match the actual variable size.
 468  * @retval ENODEV       No valid NVRAM source could be found.
 469  * @retval non-zero     If reading @p name otherwise fails, a regular unix
 470  *                      error code will be returned.
 471  */
 472 static inline int
 473 bhnd_nvram_getvar(device_t dev, const char *name, void *buf, size_t len)
 474 {
 475         size_t  var_len;
 476         int     error;
 477
 478         if ((error = bhnd_nvram_getvarlen(dev, name, &var_len)))
 479                 return (error);
 480
 481         if (len != var_len)
 482                 return (EINVAL);
 483
 484         return (BHND_BUS_GET_NVRAM_VAR(device_get_parent(dev), dev, name, buf,
 485             &len));
 486 }
 487
 488 /**
 489  * Allocate a resource from a device's parent bhnd(4) bus.
 490  *
 491  * @param dev The device requesting resource ownership.
 492  * @param type The type of resource to allocate. This may be any type supported
 493  * by the standard bus APIs.
 494  * @param rid The bus-specific handle identifying the resource being allocated.
 495  * @param start The start address of the resource.
 496  * @param end The end address of the resource.
 497  * @param count The size of the resource.
 498  * @param flags The flags for the resource to be allocated. These may be any
 499  * values supported by the standard bus APIs.
 500  *
 501  * To request the resource's default addresses, pass @p start and
 502  * @p end values of @c 0 and @c ~0, respectively, and
 503  * a @p count of @c 1.
 504  *
 505  * @retval NULL The resource could not be allocated.
 506  * @retval resource The allocated resource.
 507  */
 508 static inline struct bhnd_resource *
 509 bhnd_alloc_resource(device_t dev, int type, int *rid, rman_res_t start,
 510     rman_res_t end, rman_res_t count, u_int flags)
 511 {
 512         return BHND_BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, type, rid,
 513             start, end, count, flags);
 514 }
 515
 516
 517 /**
 518  * Allocate a resource from a device's parent bhnd(4) bus, using the
 519  * resource's default start, end, and count values.
 520  *
 521  * @param dev The device requesting resource ownership.
 522  * @param type The type of resource to allocate. This may be any type supported
 523  * by the standard bus APIs.
 524  * @param rid The bus-specific handle identifying the resource being allocated.
 525  * @param flags The flags for the resource to be allocated. These may be any
 526  * values supported by the standard bus APIs.
 527  *
 528  * @retval NULL The resource could not be allocated.
 529  * @retval resource The allocated resource.
 530  */
 531 static inline struct bhnd_resource *
 532 bhnd_alloc_resource_any(device_t dev, int type, int *rid, u_int flags)
 533 {
 534         return bhnd_alloc_resource(dev, type, rid, 0, ~0, 1, flags);
 535 }
 536
 537 /**
 538  * Activate a previously allocated bhnd resource.
 539  *
 540  * @param dev The device holding ownership of the allocated resource.
 541  * @param type The type of the resource.
 542  * @param rid The bus-specific handle identifying the resource.
 543  * @param r A pointer to the resource returned by bhnd_alloc_resource or
 544  * BHND_BUS_ALLOC_RESOURCE.
 545  *
 546  * @retval 0 success
 547  * @retval non-zero an error occurred while activating the resource.
 548  */
 549 static inline int
 550 bhnd_activate_resource(device_t dev, int type, int rid,
 551    struct bhnd_resource *r)
 552 {
 553         return BHND_BUS_ACTIVATE_RESOURCE(device_get_parent(dev), dev, type,
 554             rid, r);
 555 }
 556
 557 /**
 558  * Deactivate a previously activated bhnd resource.
 559  *
 560  * @param dev The device holding ownership of the activated resource.
 561  * @param type The type of the resource.
 562  * @param rid The bus-specific handle identifying the resource.
 563  * @param r A pointer to the resource returned by bhnd_alloc_resource or
 564  * BHND_BUS_ALLOC_RESOURCE.
 565  *
 566  * @retval 0 success
 567  * @retval non-zero an error occurred while activating the resource.
 568  */
 569 static inline int
 570 bhnd_deactivate_resource(device_t dev, int type, int rid,
 571    struct bhnd_resource *r)
 572 {
 573         return BHND_BUS_DEACTIVATE_RESOURCE(device_get_parent(dev), dev, type,
 574             rid, r);
 575 }
 576
 577 /**
 578  * Free a resource allocated by bhnd_alloc_resource().
 579  *
 580  * @param dev The device holding ownership of the resource.
 581  * @param type The type of the resource.
 582  * @param rid The bus-specific handle identifying the resource.
 583  * @param r A pointer to the resource returned by bhnd_alloc_resource or
 584  * BHND_ALLOC_RESOURCE.
 585  *
 586  * @retval 0 success
 587  * @retval non-zero an error occurred while activating the resource.
 588  */
 589 static inline int
 590 bhnd_release_resource(device_t dev, int type, int rid,
 591    struct bhnd_resource *r)
 592 {
 593         return BHND_BUS_RELEASE_RESOURCE(device_get_parent(dev), dev, type,
 594             rid, r);
 595 }
 596
 597 /**
 598  * Return true if @p region_num is a valid region on @p port_num of
 599  * @p type attached to @p dev.
 600  *
 601  * @param dev A bhnd bus child device.
 602  * @param type The port type being queried.
 603  * @param port_num The port number being queried.
 604  * @param region_num The region number being queried.
 605  */
 606 static inline bool
 607 bhnd_is_region_valid(device_t dev, bhnd_port_type type, u_int port_num,
 608     u_int region_num)
 609 {
 610         return (BHND_BUS_IS_REGION_VALID(device_get_parent(dev), dev, type,
 611             port_num, region_num));
 612 }
 613
 614 /**
 615  * Return the number of ports of type @p type attached to @p def.
 616  *
 617  * @param dev A bhnd bus child device.
 618  * @param type The port type being queried.
 619  */
 620 static inline u_int
 621 bhnd_get_port_count(device_t dev, bhnd_port_type type) {
 622         return (BHND_BUS_GET_PORT_COUNT(device_get_parent(dev), dev, type));
 623 }
 624
 625 /**
 626  * Return the number of memory regions mapped to @p child @p port of
 627  * type @p type.
 628  *
 629  * @param dev A bhnd bus child device.
 630  * @param port The port number being queried.
 631  * @param type The port type being queried.
 632  */
 633 static inline u_int
 634 bhnd_get_region_count(device_t dev, bhnd_port_type type, u_int port) {
 635         return (BHND_BUS_GET_REGION_COUNT(device_get_parent(dev), dev, type,
 636             port));
 637 }
 638
 639 /**
 640  * Return the resource-ID for a memory region on the given device port.
 641  *
 642  * @param dev A bhnd bus child device.
 643  * @param type The port type.
 644  * @param port The port identifier.
 645  * @param region The identifier of the memory region on @p port.
 646  *
 647  * @retval int The RID for the given @p port and @p region on @p device.
 648  * @retval -1 No such port/region found.
 649  */
 650 static inline int
 651 bhnd_get_port_rid(device_t dev, bhnd_port_type type, u_int port, u_int region)
 652 {
 653         return BHND_BUS_GET_PORT_RID(device_get_parent(dev), dev, type, port,
 654             region);
 655 }
 656
 657 /**
 658  * Decode a port / region pair on @p dev defined by @p rid.
 659  *
 660  * @param dev A bhnd bus child device.
 661  * @param type The resource type.
 662  * @param rid The resource identifier.
 663  * @param[out] port_type The decoded port type.
 664  * @param[out] port The decoded port identifier.
 665  * @param[out] region The decoded region identifier.
 666  *
 667  * @retval 0 success
 668  * @retval non-zero No matching port/region found.
 669  */
 670 static inline int
 671 bhnd_decode_port_rid(device_t dev, int type, int rid, bhnd_port_type *port_type,
 672     u_int *port, u_int *region)
 673 {
 674         return BHND_BUS_DECODE_PORT_RID(device_get_parent(dev), dev, type, rid,
 675             port_type, port, region);
 676 }
 677
 678 /**
 679  * Get the address and size of @p region on @p port.
 680  *
 681  * @param dev A bhnd bus child device.
 682  * @param port_type The port type.
 683  * @param port The port identifier.
 684  * @param region The identifier of the memory region on @p port.
 685  * @param[out] region_addr The region's base address.
 686  * @param[out] region_size The region's size.
 687  *
 688  * @retval 0 success
 689  * @retval non-zero No matching port/region found.
 690  */
 691 static inline int
 692 bhnd_get_region_addr(device_t dev, bhnd_port_type port_type, u_int port,
 693     u_int region, bhnd_addr_t *region_addr, bhnd_size_t *region_size)
 694 {
 695         return BHND_BUS_GET_REGION_ADDR(device_get_parent(dev), dev, port_type,
 696             port, region, region_addr, region_size);
 697 }
 698
 699 /*
 700  * bhnd bus-level equivalents of the bus_(read|write|set|barrier|...)
 701  * macros (compatible with bhnd_resource).
 702  *
 703  * Generated with bhnd/tools/bus_macro.sh
 704  */
 705 #define bhnd_bus_barrier(r, o, l, f) \
 706     ((r)->direct) ? \
 707         bus_barrier((r)->res, (o), (l), (f)) : \
 708         BHND_BUS_BARRIER( \
 709             device_get_parent(rman_get_device((r)->res)),       \
 710             rman_get_device((r)->res), (r), (o), (l), (f))
 711 #define bhnd_bus_read_1(r, o) \
 712     ((r)->direct) ? \
 713         bus_read_1((r)->res, (o)) : \
 714         BHND_BUS_READ_1( \
 715             device_get_parent(rman_get_device((r)->res)),       \
 716             rman_get_device((r)->res), (r), (o))
 717 #define bhnd_bus_read_multi_1(r, o, d, c) \
 718     ((r)->direct) ? \
 719         bus_read_multi_1((r)->res, (o), (d), (c)) : \
 720         BHND_BUS_READ_MULTI_1( \
 721             device_get_parent(rman_get_device((r)->res)),       \
 722             rman_get_device((r)->res), (r), (o), (d), (c))
 723 #define bhnd_bus_read_region_1(r, o, d, c) \
 724     ((r)->direct) ? \
 725         bus_read_region_1((r)->res, (o), (d), (c)) : \
 726         BHND_BUS_READ_REGION_1( \
 727             device_get_parent(rman_get_device((r)->res)),       \
 728             rman_get_device((r)->res), (r), (o), (d), (c))
 729 #define bhnd_bus_write_1(r, o, v) \
 730     ((r)->direct) ? \
 731         bus_write_1((r)->res, (o), (v)) : \
 732         BHND_BUS_WRITE_1( \
 733             device_get_parent(rman_get_device((r)->res)),       \
 734             rman_get_device((r)->res), (r), (o), (v))
 735 #define bhnd_bus_write_multi_1(r, o, d, c) \
 736     ((r)->direct) ? \
 737         bus_write_multi_1((r)->res, (o), (d), (c)) : \
 738         BHND_BUS_WRITE_MULTI_1( \
 739             device_get_parent(rman_get_device((r)->res)),       \
 740             rman_get_device((r)->res), (r), (o), (d), (c))
 741 #define bhnd_bus_write_region_1(r, o, d, c) \
 742     ((r)->direct) ? \
 743         bus_write_region_1((r)->res, (o), (d), (c)) : \
 744         BHND_BUS_WRITE_REGION_1( \
 745             device_get_parent(rman_get_device((r)->res)),       \
 746             rman_get_device((r)->res), (r), (o), (d), (c))
 747 #define bhnd_bus_read_stream_1(r, o) \
 748     ((r)->direct) ? \
 749         bus_read_stream_1((r)->res, (o)) : \
 750         BHND_BUS_READ_STREAM_1( \
 751             device_get_parent(rman_get_device((r)->res)),       \
 752             rman_get_device((r)->res), (r), (o))
 753 #define bhnd_bus_read_multi_stream_1(r, o, d, c) \
 754     ((r)->direct) ? \
 755         bus_read_multi_stream_1((r)->res, (o), (d), (c)) : \
 756         BHND_BUS_READ_MULTI_STREAM_1( \
 757             device_get_parent(rman_get_device((r)->res)),       \
 758             rman_get_device((r)->res), (r), (o), (d), (c))
 759 #define bhnd_bus_read_region_stream_1(r, o, d, c) \
 760     ((r)->direct) ? \
 761         bus_read_region_stream_1((r)->res, (o), (d), (c)) : \
 762         BHND_BUS_READ_REGION_STREAM_1( \
 763             device_get_parent(rman_get_device((r)->res)),       \
 764             rman_get_device((r)->res), (r), (o), (d), (c))
 765 #define bhnd_bus_write_stream_1(r, o, v) \
 766     ((r)->direct) ? \
 767         bus_write_stream_1((r)->res, (o), (v)) : \
 768         BHND_BUS_WRITE_STREAM_1( \
 769             device_get_parent(rman_get_device((r)->res)),       \
 770             rman_get_device((r)->res), (r), (o), (v))
 771 #define bhnd_bus_write_multi_stream_1(r, o, d, c) \
 772     ((r)->direct) ? \
 773         bus_write_multi_stream_1((r)->res, (o), (d), (c)) : \
 774         BHND_BUS_WRITE_MULTI_STREAM_1( \
 775             device_get_parent(rman_get_device((r)->res)),       \
 776             rman_get_device((r)->res), (r), (o), (d), (c))
 777 #define bhnd_bus_write_region_stream_1(r, o, d, c) \
 778     ((r)->direct) ? \
 779         bus_write_region_stream_1((r)->res, (o), (d), (c)) : \
 780         BHND_BUS_WRITE_REGION_STREAM_1( \
 781             device_get_parent(rman_get_device((r)->res)),       \
 782             rman_get_device((r)->res), (r), (o), (d), (c))
 783 #define bhnd_bus_set_multi_1(r, o, v, c) \
 784     ((r)->direct) ? \
 785         bus_set_multi_1((r)->res, (o), (v), (c)) : \
 786         BHND_BUS_SET_MULTI_1( \
 787             device_get_parent(rman_get_device((r)->res)),       \
 788             rman_get_device((r)->res), (r), (o), (v), (c))
 789 #define bhnd_bus_set_region_1(r, o, v, c) \
 790     ((r)->direct) ? \
 791         bus_set_region_1((r)->res, (o), (v), (c)) : \
 792         BHND_BUS_SET_REGION_1( \
 793             device_get_parent(rman_get_device((r)->res)),       \
 794             rman_get_device((r)->res), (r), (o), (v), (c))
 795 #define bhnd_bus_read_2(r, o) \
 796     ((r)->direct) ? \
 797         bus_read_2((r)->res, (o)) : \
 798         BHND_BUS_READ_2( \
 799             device_get_parent(rman_get_device((r)->res)),       \
 800             rman_get_device((r)->res), (r), (o))
 801 #define bhnd_bus_read_multi_2(r, o, d, c) \
 802     ((r)->direct) ? \
 803         bus_read_multi_2((r)->res, (o), (d), (c)) : \
 804         BHND_BUS_READ_MULTI_2( \
 805             device_get_parent(rman_get_device((r)->res)),       \
 806             rman_get_device((r)->res), (r), (o), (d), (c))
 807 #define bhnd_bus_read_region_2(r, o, d, c) \
 808     ((r)->direct) ? \
 809         bus_read_region_2((r)->res, (o), (d), (c)) : \
 810         BHND_BUS_READ_REGION_2( \
 811             device_get_parent(rman_get_device((r)->res)),       \
 812             rman_get_device((r)->res), (r), (o), (d), (c))
 813 #define bhnd_bus_write_2(r, o, v) \
 814     ((r)->direct) ? \
 815         bus_write_2((r)->res, (o), (v)) : \
 816         BHND_BUS_WRITE_2( \
 817             device_get_parent(rman_get_device((r)->res)),       \
 818             rman_get_device((r)->res), (r), (o), (v))
 819 #define bhnd_bus_write_multi_2(r, o, d, c) \
 820     ((r)->direct) ? \
 821         bus_write_multi_2((r)->res, (o), (d), (c)) : \
 822         BHND_BUS_WRITE_MULTI_2( \
 823             device_get_parent(rman_get_device((r)->res)),       \
 824             rman_get_device((r)->res), (r), (o), (d), (c))
 825 #define bhnd_bus_write_region_2(r, o, d, c) \
 826     ((r)->direct) ? \
 827         bus_write_region_2((r)->res, (o), (d), (c)) : \
 828         BHND_BUS_WRITE_REGION_2( \
 829             device_get_parent(rman_get_device((r)->res)),       \
 830             rman_get_device((r)->res), (r), (o), (d), (c))
 831 #define bhnd_bus_read_stream_2(r, o) \
 832     ((r)->direct) ? \
 833         bus_read_stream_2((r)->res, (o)) : \
 834         BHND_BUS_READ_STREAM_2( \
 835             device_get_parent(rman_get_device((r)->res)),       \
 836             rman_get_device((r)->res), (r), (o))
 837 #define bhnd_bus_read_multi_stream_2(r, o, d, c) \
 838     ((r)->direct) ? \
 839         bus_read_multi_stream_2((r)->res, (o), (d), (c)) : \
 840         BHND_BUS_READ_MULTI_STREAM_2( \
 841             device_get_parent(rman_get_device((r)->res)),       \
 842             rman_get_device((r)->res), (r), (o), (d), (c))
 843 #define bhnd_bus_read_region_stream_2(r, o, d, c) \
 844     ((r)->direct) ? \
 845         bus_read_region_stream_2((r)->res, (o), (d), (c)) : \
 846         BHND_BUS_READ_REGION_STREAM_2( \
 847             device_get_parent(rman_get_device((r)->res)),       \
 848             rman_get_device((r)->res), (r), (o), (d), (c))
 849 #define bhnd_bus_write_stream_2(r, o, v) \
 850     ((r)->direct) ? \
 851         bus_write_stream_2((r)->res, (o), (v)) : \
 852         BHND_BUS_WRITE_STREAM_2( \
 853             device_get_parent(rman_get_device((r)->res)),       \
 854             rman_get_device((r)->res), (r), (o), (v))
 855 #define bhnd_bus_write_multi_stream_2(r, o, d, c) \
 856     ((r)->direct) ? \
 857         bus_write_multi_stream_2((r)->res, (o), (d), (c)) : \
 858         BHND_BUS_WRITE_MULTI_STREAM_2( \
 859             device_get_parent(rman_get_device((r)->res)),       \
 860             rman_get_device((r)->res), (r), (o), (d), (c))
 861 #define bhnd_bus_write_region_stream_2(r, o, d, c) \
 862     ((r)->direct) ? \
 863         bus_write_region_stream_2((r)->res, (o), (d), (c)) : \
 864         BHND_BUS_WRITE_REGION_STREAM_2( \
 865             device_get_parent(rman_get_device((r)->res)),       \
 866             rman_get_device((r)->res), (r), (o), (d), (c))
 867 #define bhnd_bus_set_multi_2(r, o, v, c) \
 868     ((r)->direct) ? \
 869         bus_set_multi_2((r)->res, (o), (v), (c)) : \
 870         BHND_BUS_SET_MULTI_2( \
 871             device_get_parent(rman_get_device((r)->res)),       \
 872             rman_get_device((r)->res), (r), (o), (v), (c))
 873 #define bhnd_bus_set_region_2(r, o, v, c) \
 874     ((r)->direct) ? \
 875         bus_set_region_2((r)->res, (o), (v), (c)) : \
 876         BHND_BUS_SET_REGION_2( \
 877             device_get_parent(rman_get_device((r)->res)),       \
 878             rman_get_device((r)->res), (r), (o), (v), (c))
 879 #define bhnd_bus_read_4(r, o) \
 880     ((r)->direct) ? \
 881         bus_read_4((r)->res, (o)) : \
 882         BHND_BUS_READ_4( \
 883             device_get_parent(rman_get_device((r)->res)),       \
 884             rman_get_device((r)->res), (r), (o))
 885 #define bhnd_bus_read_multi_4(r, o, d, c) \
 886     ((r)->direct) ? \
 887         bus_read_multi_4((r)->res, (o), (d), (c)) : \
 888         BHND_BUS_READ_MULTI_4( \
 889             device_get_parent(rman_get_device((r)->res)),       \
 890             rman_get_device((r)->res), (r), (o), (d), (c))
 891 #define bhnd_bus_read_region_4(r, o, d, c) \
 892     ((r)->direct) ? \
 893         bus_read_region_4((r)->res, (o), (d), (c)) : \
 894         BHND_BUS_READ_REGION_4( \
 895             device_get_parent(rman_get_device((r)->res)),       \
 896             rman_get_device((r)->res), (r), (o), (d), (c))
 897 #define bhnd_bus_write_4(r, o, v) \
 898     ((r)->direct) ? \
 899         bus_write_4((r)->res, (o), (v)) : \
 900         BHND_BUS_WRITE_4( \
 901             device_get_parent(rman_get_device((r)->res)),       \
 902             rman_get_device((r)->res), (r), (o), (v))
 903 #define bhnd_bus_write_multi_4(r, o, d, c) \
 904     ((r)->direct) ? \
 905         bus_write_multi_4((r)->res, (o), (d), (c)) : \
 906         BHND_BUS_WRITE_MULTI_4( \
 907             device_get_parent(rman_get_device((r)->res)),       \
 908             rman_get_device((r)->res), (r), (o), (d), (c))
 909 #define bhnd_bus_write_region_4(r, o, d, c) \
 910     ((r)->direct) ? \
 911         bus_write_region_4((r)->res, (o), (d), (c)) : \
 912         BHND_BUS_WRITE_REGION_4( \
 913             device_get_parent(rman_get_device((r)->res)),       \
 914             rman_get_device((r)->res), (r), (o), (d), (c))
 915 #define bhnd_bus_read_stream_4(r, o) \
 916     ((r)->direct) ? \
 917         bus_read_stream_4((r)->res, (o)) : \
 918         BHND_BUS_READ_STREAM_4( \
 919             device_get_parent(rman_get_device((r)->res)),       \
 920             rman_get_device((r)->res), (r), (o))
 921 #define bhnd_bus_read_multi_stream_4(r, o, d, c) \
 922     ((r)->direct) ? \
 923         bus_read_multi_stream_4((r)->res, (o), (d), (c)) : \
 924         BHND_BUS_READ_MULTI_STREAM_4( \
 925             device_get_parent(rman_get_device((r)->res)),       \
 926             rman_get_device((r)->res), (r), (o), (d), (c))
 927 #define bhnd_bus_read_region_stream_4(r, o, d, c) \
 928     ((r)->direct) ? \
 929         bus_read_region_stream_4((r)->res, (o), (d), (c)) : \
 930         BHND_BUS_READ_REGION_STREAM_4( \
 931             device_get_parent(rman_get_device((r)->res)),       \
 932             rman_get_device((r)->res), (r), (o), (d), (c))
 933 #define bhnd_bus_write_stream_4(r, o, v) \
 934     ((r)->direct) ? \
 935         bus_write_stream_4((r)->res, (o), (v)) : \
 936         BHND_BUS_WRITE_STREAM_4( \
 937             device_get_parent(rman_get_device((r)->res)),       \
 938             rman_get_device((r)->res), (r), (o), (v))
 939 #define bhnd_bus_write_multi_stream_4(r, o, d, c) \
 940     ((r)->direct) ? \
 941         bus_write_multi_stream_4((r)->res, (o), (d), (c)) : \
 942         BHND_BUS_WRITE_MULTI_STREAM_4( \
 943             device_get_parent(rman_get_device((r)->res)),       \
 944             rman_get_device((r)->res), (r), (o), (d), (c))
 945 #define bhnd_bus_write_region_stream_4(r, o, d, c) \
 946     ((r)->direct) ? \
 947         bus_write_region_stream_4((r)->res, (o), (d), (c)) : \
 948         BHND_BUS_WRITE_REGION_STREAM_4( \
 949             device_get_parent(rman_get_device((r)->res)),       \
 950             rman_get_device((r)->res), (r), (o), (d), (c))
 951 #define bhnd_bus_set_multi_4(r, o, v, c) \
 952     ((r)->direct) ? \
 953         bus_set_multi_4((r)->res, (o), (v), (c)) : \
 954         BHND_BUS_SET_MULTI_4( \
 955             device_get_parent(rman_get_device((r)->res)),       \
 956             rman_get_device((r)->res), (r), (o), (v), (c))
 957 #define bhnd_bus_set_region_4(r, o, v, c) \
 958     ((r)->direct) ? \
 959         bus_set_region_4((r)->res, (o), (v), (c)) : \
 960         BHND_BUS_SET_REGION_4( \
 961             device_get_parent(rman_get_device((r)->res)),       \
 962             rman_get_device((r)->res), (r), (o), (v), (c))
 963
 964 #endif /* _BHND_BHND_H_ */