sys/dev/bhnd/bhndb/bhndb.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_BHNDB_H_
  33 #define _BHND_BHNDB_H_
  34
  35 #include <sys/param.h>
  36 #include <sys/bus.h>
  37
  38 #include <machine/bus.h>
  39 #include <sys/rman.h>
  40 #include <machine/resource.h>
  41
  42 #include <dev/bhnd/bhnd.h>
  43
  44 #include "bhndb_bus_if.h"
  45
  46 extern devclass_t bhndb_devclass;
  47 DECLARE_CLASS(bhnd_bhndb_driver);
  48
  49 int     bhndb_attach_bridge(device_t parent, device_t *bhndb, int unit);
  50
  51 /**
  52  * bhndb register window types.
  53  */
  54 typedef enum {
  55         BHNDB_REGWIN_T_CORE,            /**< Fixed mapping of a core port region. */
  56         BHNDB_REGWIN_T_SPROM,           /**< Fixed mapping of device SPROM */
  57         BHNDB_REGWIN_T_DYN,             /**< A dynamically configurable window */
  58         BHNDB_REGWIN_T_INVALID          /**< Invalid type */
  59 } bhndb_regwin_type_t;
  60
  61 /**
  62  * Evaluates to true if @p _rt defines a static mapping.
  63  *
  64  * @param _rt A bhndb_regwin_type_t value.
  65  */
  66 #define BHNDB_REGWIN_T_IS_STATIC(_rt)           \
  67         ((_rt) == BHNDB_REGWIN_T_CORE ||        \
  68          (_rt) == BHNDB_REGWIN_T_SPROM)
  69
  70 /**
  71  * bhndb register window definition.
  72  */
  73 struct bhndb_regwin {
  74         bhndb_regwin_type_t     win_type;       /**< window type */
  75         bus_size_t              win_offset;     /**< offset of the window within the resource */
  76         bus_size_t              win_size;       /**< size of the window */
  77
  78         /** Resource identification */
  79         struct {
  80                 int             type;           /**< resource type */
  81                 int             rid;            /**< resource id */
  82         } res;
  83
  84         union {
  85                 /** Core-specific register window (BHNDB_REGWIN_T_CORE). */
  86                 struct {
  87                         bhnd_devclass_t class;          /**< mapped core's class */
  88                         u_int           unit;           /**< mapped core's unit */
  89                         bhnd_port_type  port_type;      /**< mapped port type */
  90                         u_int           port;           /**< mapped port number */
  91                         u_int           region;         /**< mapped region number */
  92                         bhnd_size_t     offset;         /**< mapped offset within the region */
  93                 } core;
  94
  95                 /** SPROM register window (BHNDB_REGWIN_T_SPROM). */
  96                 struct {} sprom;
  97
  98                 /** Dynamic register window (BHNDB_REGWIN_T_DYN). */
  99                 struct {
 100                         bus_size_t      cfg_offset;     /**< window address config offset. */
 101                 } dyn;
 102         } d;
 103 };
 104 #define BHNDB_REGWIN_TABLE_END  { BHNDB_REGWIN_T_INVALID, 0, 0, { 0, 0 } }
 105
 106 /**
 107  * Bridge hardware configuration.
 108  *
 109  * Provides the bridge's DMA address translation descriptions, register/address
 110  * mappings, and the resources via which those mappings may be accessed.
 111  */
 112 struct bhndb_hwcfg {
 113         const struct resource_spec              *resource_specs;        /**< resources required by our register windows */
 114         const struct bhndb_regwin               *register_windows;      /**< register window table */
 115         const struct bhnd_dma_translation       *dma_translations;      /**< DMA address translation table, or NULL if DMA is not supported */
 116 };
 117
 118 /**
 119  * Hardware specification entry.
 120  *
 121  * Defines a set of match criteria that may be used to determine the
 122  * register map and resource configuration for a bhndb bridge device.
 123  */
 124 struct bhndb_hw {
 125         const char                      *name;          /**< configuration name */
 126         const struct bhnd_core_match    *hw_reqs;       /**< match requirements */
 127         u_int                            num_hw_reqs;   /**< number of match requirements */
 128         const struct bhndb_hwcfg        *cfg;           /**< associated hardware configuration */
 129 };
 130
 131 /**
 132  * bhndb resource allocation priorities.
 133  */
 134 typedef enum {
 135         /** No direct resources should ever be allocated for this device. */
 136         BHNDB_PRIORITY_NONE     = 0,
 137
 138         /** Allocate a direct resource if available after serving all other
 139           * higher-priority requests. */
 140         BHNDB_PRIORITY_LOW      = 1,
 141
 142         /** Direct resource allocation is preferred, but not necessary
 143          *  for reasonable runtime performance. */
 144         BHNDB_PRIORITY_DEFAULT  = 2,
 145
 146         /** Indirect resource allocation would incur high runtime overhead. */
 147         BHNDB_PRIORITY_HIGH     = 3
 148 } bhndb_priority_t;
 149
 150 /**
 151  * bhndb resource allocation flags.
 152  */
 153 enum bhndb_alloc_flags {
 154         /**
 155          * If resource overcommit prevents fulfilling a request for this
 156          * resource, an in-use resource should be be borrowed to fulfill the
 157          * request.
 158          *
 159          * The only known use case is to support accessing the ChipCommon core
 160          * during Wi-Fi driver operation on early PCI Wi-Fi devices
 161          * (PCI_V0, SSB) that do not provide a dedicated ChipCommon register
 162          * window mapping; on such devices, device and firmware semantics
 163          * guarantee the safety of -- after disabling interrupts -- borrowing
 164          * the single dynamic register window that's been assigned to the D11
 165          * core to perform the few ChipCommon operations required by the driver.
 166          */
 167         BHNDB_ALLOC_FULFILL_ON_OVERCOMMIT       = (1<<0),
 168 };
 169
 170 /**
 171  * Port resource priority descriptor.
 172  */
 173 struct bhndb_port_priority {
 174         bhnd_port_type          type;           /**< port type. */
 175         u_int                   port;           /**< port */
 176         u_int                   region;         /**< region */
 177         bhndb_priority_t        priority;       /**< port priority */
 178         uint32_t                alloc_flags;    /**< port allocation flags (@see bhndb_alloc_flags) */
 179 };
 180
 181 /**
 182  * Core resource priority descriptor.
 183  */
 184 struct bhndb_hw_priority {
 185         struct bhnd_core_match                   match;         /**< core match descriptor */
 186         bhndb_priority_t                         priority;      /**< core-level priority */
 187         const struct bhndb_port_priority        *ports;         /**< port priorities */
 188         u_int                                    num_ports;     /**< number of port priority records. */
 189 };
 190 #define BHNDB_HW_PRIORITY_TABLE_END     { {}, BHNDB_PRIORITY_NONE, NULL, 0 }
 191
 192 #endif /* _BHND_BHNDB_H_ */