sys/dev/bhnd/bcma/bcmavar.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2015-2016 Landon Fuller <landon@landonf.org>
   5  * Copyright (c) 2017 The FreeBSD Foundation
   6  * All rights reserved.
   7  *
   8  * Portions of this software were developed by Landon Fuller
   9  * under sponsorship from the FreeBSD Foundation.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  19  *    redistribution must be conditioned upon including a substantially
  20  *    similar Disclaimer requirement for further binary redistribution.
  21  *
  22  * NO WARRANTY
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  26  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  27  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  28  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  31  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  33  * THE POSSIBILITY OF SUCH DAMAGES.
  34  *
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _BCMA_BCMAVAR_H_
  39 #define _BCMA_BCMAVAR_H_
  40
  41 #include <sys/param.h>
  42 #include <sys/bus.h>
  43 #include <sys/limits.h>
  44
  45 #include <machine/bus.h>
  46 #include <sys/rman.h>
  47
  48 #include "bcma.h"
  49
  50 /*
  51  * Internal definitions shared by bcma(4) driver implementations.
  52  */
  53
  54 /** Base resource ID for per-core agent register allocations */
  55 #define BCMA_AGENT_RID_BASE     100
  56
  57 /**
  58  * Return the device's core index.
  59  *
  60  * @param _dinfo The bcma_devinfo instance to query.
  61  */
  62 #define BCMA_DINFO_COREIDX(_dinfo)      \
  63         ((_dinfo)->corecfg->core_info.core_idx)
  64
  65
  66 /** BCMA port identifier. */
  67 typedef u_int           bcma_pid_t;
  68 #define BCMA_PID_MAX    UINT_MAX        /**< Maximum bcma_pid_t value */
  69
  70 /** BCMA per-port region map identifier. */
  71 typedef u_int           bcma_rmid_t;
  72 #define BCMA_RMID_MAX   UINT_MAX        /**< Maximum bcma_rmid_t value */
  73
  74 struct bcma_devinfo;
  75 struct bcma_corecfg;
  76 struct bcma_intr;
  77 struct bcma_map;
  78 struct bcma_mport;
  79 struct bcma_sport;
  80
  81 int                      bcma_probe(device_t dev);
  82 int                      bcma_attach(device_t dev);
  83 int                      bcma_detach(device_t dev);
  84 u_int                    bcma_get_intr_count(device_t dev, device_t child);
  85 int                      bcma_get_intr_ivec(device_t dev, device_t child,
  86                              u_int intr, uint32_t *ivec);
  87
  88 int                      bcma_add_children(device_t bus);
  89
  90 struct bcma_sport_list  *bcma_corecfg_get_port_list(struct bcma_corecfg *cfg,
  91                              bhnd_port_type type);
  92
  93 struct bcma_devinfo     *bcma_alloc_dinfo(device_t bus);
  94 int                      bcma_init_dinfo(device_t bus, device_t child,
  95                              struct bcma_devinfo *dinfo,
  96                              struct bcma_corecfg *corecfg);
  97 void                     bcma_free_dinfo(device_t bus, device_t child,
  98                              struct bcma_devinfo *dinfo);
  99
 100 struct bcma_corecfg     *bcma_alloc_corecfg(u_int core_index, int core_unit,
 101                              uint16_t vendor, uint16_t device, uint8_t hwrev);
 102 void                     bcma_free_corecfg(struct bcma_corecfg *corecfg);
 103
 104 struct bcma_intr        *bcma_alloc_intr(uint8_t bank, uint8_t sel,
 105                              uint8_t line);
 106 void                     bcma_free_intr(struct bcma_intr *intr);
 107
 108 struct bcma_sport       *bcma_alloc_sport(bcma_pid_t port_num, bhnd_port_type port_type);
 109 void                     bcma_free_sport(struct bcma_sport *sport);
 110
 111 int                      bcma_dmp_wait_reset(device_t child,
 112                              struct bcma_devinfo *dinfo);
 113 int                      bcma_dmp_write_reset(device_t child,
 114                              struct bcma_devinfo *dinfo, uint32_t value);
 115
 116 /** BCMA master port descriptor */
 117 struct bcma_mport {
 118         bcma_pid_t      mp_num;         /**< AXI port identifier (bus-unique) */
 119         bcma_pid_t      mp_vid;         /**< AXI master virtual ID (core-unique) */
 120         STAILQ_ENTRY(bcma_mport) mp_link;
 121 };
 122
 123 /** BCMA memory region descriptor */
 124 struct bcma_map {
 125         bcma_rmid_t     m_region_num;   /**< region identifier (port-unique). */
 126         bhnd_addr_t     m_base;         /**< base address */
 127         bhnd_size_t     m_size;         /**< size */
 128         int             m_rid;          /**< bus resource id, or -1. */
 129
 130         STAILQ_ENTRY(bcma_map) m_link;
 131 };
 132
 133 /** BCMA interrupt descriptor */
 134 struct bcma_intr {
 135         uint8_t         i_bank;         /**< OOB bank (see BCMA_OOB_BANK[A-D]) */
 136         uint8_t         i_sel;          /**< OOB selector (0-7) */
 137         uint8_t         i_busline;      /**< OOB bus line assigned to this selector */
 138         bool            i_mapped;       /**< if an irq has been mapped for this selector */
 139         int             i_rid;          /**< bus resource id, or -1 */
 140         rman_res_t      i_irq;          /**< the mapped bus irq, if any */
 141
 142         STAILQ_ENTRY(bcma_intr) i_link;
 143 };
 144
 145 /** BCMA slave port descriptor */
 146 struct bcma_sport {
 147         bcma_pid_t      sp_num;         /**< slave port number (core-unique) */
 148         bhnd_port_type  sp_type;        /**< port type */
 149
 150         u_long          sp_num_maps;    /**< number of regions mapped to this port */
 151         STAILQ_HEAD(, bcma_map) sp_maps;
 152         STAILQ_ENTRY(bcma_sport) sp_link;
 153 };
 154
 155 STAILQ_HEAD(bcma_mport_list,    bcma_mport);
 156 STAILQ_HEAD(bcma_intr_list,     bcma_intr);
 157 STAILQ_HEAD(bcma_sport_list,    bcma_sport);
 158
 159 /** BCMA IP core/block configuration */
 160 struct bcma_corecfg {
 161         struct bhnd_core_info   core_info;      /**< standard core info */
 162
 163         u_long          num_master_ports;       /**< number of master port descriptors. */
 164         struct bcma_mport_list  master_ports;   /**< master port descriptors */
 165
 166         u_long          num_dev_ports;          /**< number of device slave port descriptors. */
 167         struct bcma_sport_list  dev_ports;      /**< device port descriptors */
 168
 169         u_long          num_bridge_ports;       /**< number of bridge slave port descriptors. */
 170         struct bcma_sport_list  bridge_ports;   /**< bridge port descriptors */
 171
 172         u_long          num_wrapper_ports;      /**< number of wrapper slave port descriptors. */
 173         struct bcma_sport_list  wrapper_ports;  /**< wrapper port descriptors */
 174 };
 175
 176 /**
 177  * BCMA per-device info
 178  */
 179 struct bcma_devinfo {
 180         struct resource_list     resources;     /**< Slave port memory regions. */
 181         struct bcma_corecfg     *corecfg;       /**< IP core/block config */
 182
 183         struct bhnd_resource    *res_agent;     /**< Agent (wrapper) resource, or NULL. Not
 184                                                   *  all bcma(4) cores have or require an agent. */
 185         int                      rid_agent;     /**< Agent resource ID, or -1 */
 186
 187         u_int                    num_intrs;     /**< number of interrupt descriptors. */
 188         struct bcma_intr_list    intrs;         /**< interrupt descriptors */
 189
 190         void                    *pmu_info;      /**< Bus-managed PMU state, or NULL */
 191 };
 192
 193
 194 /** BMCA per-instance state */
 195 struct bcma_softc {
 196         struct bhnd_softc       bhnd_sc;        /**< bhnd state */
 197 };
 198
 199 #endif /* _BCMA_BCMAVAR_H_ */