sys/dev/bhnd/siba/sibavar.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 _SIBA_SIBAVAR_H_
  33 #define _SIBA_SIBAVAR_H_
  34
  35 #include <sys/param.h>
  36 #include <sys/bus.h>
  37 #include <sys/limits.h>
  38
  39 #include <machine/bus.h>
  40 #include <sys/rman.h>
  41
  42 #include "siba.h"
  43
  44 /*
  45  * Internal definitions shared by siba(4) driver implementations.
  46  */
  47
  48 struct siba_addrspace;
  49 struct siba_devinfo;
  50 struct siba_core_id;
  51
  52 int                      siba_probe(device_t dev);
  53 int                      siba_attach(device_t dev);
  54 int                      siba_detach(device_t dev);
  55 int                      siba_resume(device_t dev);
  56 int                      siba_suspend(device_t dev);
  57
  58 uint16_t                 siba_get_bhnd_mfgid(uint16_t ocp_vendor);
  59
  60 struct siba_core_id      siba_parse_core_id(uint32_t idhigh, uint32_t idlow,
  61                              u_int core_idx, int unit);
  62
  63 int                      siba_add_children(device_t bus);
  64
  65 struct siba_devinfo     *siba_alloc_dinfo(device_t dev);
  66 int                      siba_init_dinfo(device_t dev,
  67                              struct siba_devinfo *dinfo,
  68                              const struct siba_core_id *core_id);
  69 void                     siba_free_dinfo(device_t dev,
  70                              struct siba_devinfo *dinfo);
  71
  72 u_int                    siba_addrspace_port_count(u_int num_addrspace);
  73 u_int                    siba_addrspace_region_count(u_int num_addrspace,
  74                              u_int port);
  75
  76 u_int                    siba_addrspace_port(u_int addrspace);
  77 u_int                    siba_addrspace_region(u_int addrspace);
  78 int                      siba_addrspace_index(u_int num_addrspace,
  79                              bhnd_port_type type, u_int port, u_int region,
  80                              u_int *addridx);
  81 bool                     siba_is_port_valid(u_int num_addrspace,
  82                              bhnd_port_type type, u_int port);
  83
  84 struct siba_addrspace   *siba_find_addrspace(struct siba_devinfo *dinfo,
  85                              bhnd_port_type type, u_int port, u_int region);
  86
  87 int                      siba_append_dinfo_region(struct siba_devinfo *dinfo,
  88                              uint8_t sid, uint32_t base, uint32_t size,
  89                              uint32_t bus_reserved);
  90
  91 u_int                    siba_admatch_offset(uint8_t addrspace);
  92 int                      siba_parse_admatch(uint32_t am, uint32_t *addr,
  93                              uint32_t *size);
  94
  95
  96 /* Sonics configuration register blocks */
  97 #define SIBA_CFG_NUM_2_2        1                       /**< sonics <= 2.2 maps SIBA_CFG0. */
  98 #define SIBA_CFG_NUM_2_3        2                       /**< sonics <= 2.3 maps SIBA_CFG0 and SIBA_CFG1 */
  99 #define SIBA_MAX_CFG            SIBA_CFG_NUM_2_3        /**< maximum number of supported config
 100                                                              register blocks */
 101
 102 #define SIBA_CFG_RID_BASE       100                     /**< base resource ID for SIBA_CFG* register allocations */
 103 #define SIBA_CFG_RID(_dinfo, _cfg)      \
 104         (SIBA_CFG_RID_BASE + (_cfg) +   \
 105             (_dinfo->core_id.core_info.core_idx * SIBA_MAX_CFG))
 106
 107 /* Sonics/OCP address space mappings */
 108 #define SIBA_CORE_ADDRSPACE     0       /**< Address space mapping the primary
 109                                              device registers */
 110
 111 #define SIBA_MAX_ADDRSPACE      4       /**< Maximum number of Sonics/OCP
 112                                           *  address space mappings for a
 113                                           *  single core. */
 114
 115 /* bhnd(4) (port,region) representation of siba address space mappings */
 116 #define SIBA_MAX_PORT           2       /**< maximum number of advertised
 117                                           *  bhnd(4) ports */
 118
 119 /** siba(4) address space descriptor */
 120 struct siba_addrspace {
 121         uint32_t        sa_base;        /**< base address */
 122         uint32_t        sa_size;        /**< size */
 123         int             sa_rid;         /**< bus resource id */
 124         uint32_t        sa_bus_reserved;/**< number of bytes at high end of
 125                                           *  address space reserved for the bus */
 126 };
 127
 128 /**
 129  * siba(4) per-core identification info.
 130  */
 131 struct siba_core_id {
 132         struct bhnd_core_info   core_info;      /**< standard bhnd(4) core info */
 133         uint16_t                sonics_vendor;  /**< OCP vendor identifier used to generate
 134                                                   *  the JEDEC-106 bhnd(4) vendor identifier. */
 135         uint8_t                 sonics_rev;     /**< sonics backplane revision code */
 136         uint8_t                 num_addrspace;  /**< number of address ranges mapped to
 137                                                      this core. */
 138         uint8_t                 num_cfg_blocks; /**< number of Sonics configuration register
 139                                                      blocks mapped to the core's enumeration
 140                                                      space */
 141 };
 142
 143 /**
 144  * siba(4) per-device info
 145  */
 146 struct siba_devinfo {
 147         struct bhnd_devinfo      bhnd_dinfo;    /**< superclass device info. */
 148
 149         struct resource_list     resources;     /**< per-core memory regions. */
 150         struct siba_core_id      core_id;       /**< core identification info */
 151         struct siba_addrspace    addrspace[SIBA_MAX_ADDRSPACE]; /**< memory map descriptors */
 152
 153         struct bhnd_resource    *cfg[SIBA_MAX_CFG];     /**< SIBA_CFG_* registers */
 154         int                      cfg_rid[SIBA_MAX_CFG]; /**< SIBA_CFG_* resource IDs */
 155 };
 156
 157
 158 /** siba(4) per-instance state */
 159 struct siba_softc {
 160         struct bhnd_softc       bhnd_sc;        /**< bhnd state */
 161         device_t                dev;            /**< siba device */
 162 };
 163
 164 #endif /* _SIBA_SIBAVAR_H_ */