sys/sparc64/pci/ofw_pci.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1999, 2000 Matthew R. Green
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 /*-
  32  * Copyright (c) 1998, 1999 Eduardo E. Horvath
  33  * Copyright (c) 2001, 2003 by Thomas Moestl <tmm@FreeBSD.org>
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. The name of the author may not be used to endorse or promote products
  45  *    derived from this software without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  48  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  49  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  50  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  51  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  52  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  53  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  54  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  55  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  57  * SUCH DAMAGE.
  58  *
  59  *      from: NetBSD: psychoreg.h,v 1.14 2008/05/30 02:29:37 mrg Exp
  60  *
  61  * $FreeBSD$
  62  */
  63
  64 #ifndef _SPARC64_PCI_OFW_PCI_H_
  65 #define _SPARC64_PCI_OFW_PCI_H_
  66
  67 #include <sys/rman.h>
  68
  69 #include <dev/ofw/ofw_bus_subr.h>
  70
  71 #include "ofw_pci_if.h"
  72
  73 typedef uint32_t ofw_pci_intr_t;
  74
  75 /* PCI range child spaces. XXX: are these MI? */
  76 #define OFW_PCI_CS_CONFIG       0x00
  77 #define OFW_PCI_CS_IO           0x01
  78 #define OFW_PCI_CS_MEM32        0x02
  79 #define OFW_PCI_CS_MEM64        0x03
  80 #define OFW_PCI_NUM_CS          4
  81
  82 /* OFW device types */
  83 #define OFW_TYPE_PCI            "pci"
  84 #define OFW_TYPE_PCIE           "pciex"
  85
  86 struct ofw_pci_msi_addr_ranges {
  87         uint32_t        addr32_hi;
  88         uint32_t        addr32_lo;
  89         uint32_t        addr32_sz;
  90         uint32_t        addr64_hi;
  91         uint32_t        addr64_lo;
  92         uint32_t        addr64_sz;
  93 };
  94
  95 #define OFW_PCI_MSI_ADDR_RANGE_32(r) \
  96         (((uint64_t)(r)->addr32_hi << 32) | (uint64_t)(r)->addr32_lo)
  97 #define OFW_PCI_MSI_ADDR_RANGE_64(r) \
  98         (((uint64_t)(r)->addr64_hi << 32) | (uint64_t)(r)->addr64_lo)
  99
 100 struct ofw_pci_msi_eq_to_devino {
 101         uint32_t        eq_first;
 102         uint32_t        eq_count;
 103         uint32_t        devino_first;
 104 };
 105
 106 struct ofw_pci_msi_ranges {
 107         uint32_t        first;
 108         uint32_t        count;
 109 };
 110
 111 struct ofw_pci_ranges {
 112         uint32_t        cspace;
 113         uint32_t        child_hi;
 114         uint32_t        child_lo;
 115         uint32_t        phys_hi;
 116         uint32_t        phys_lo;
 117         uint32_t        size_hi;
 118         uint32_t        size_lo;
 119 };
 120
 121 #define OFW_PCI_RANGE_CHILD(r) \
 122         (((uint64_t)(r)->child_hi << 32) | (uint64_t)(r)->child_lo)
 123 #define OFW_PCI_RANGE_PHYS(r) \
 124         (((uint64_t)(r)->phys_hi << 32) | (uint64_t)(r)->phys_lo)
 125 #define OFW_PCI_RANGE_SIZE(r) \
 126         (((uint64_t)(r)->size_hi << 32) | (uint64_t)(r)->size_lo)
 127 #define OFW_PCI_RANGE_CS(r)     (((r)->cspace >> 24) & 0x03)
 128
 129 /* default values */
 130 #define OFW_PCI_LATENCY 64
 131
 132 /*
 133  * Common and generic parts of host-PCI-bridge support
 134  */
 135
 136 struct ofw_pci_softc {
 137         struct rman             sc_pci_mem_rman;
 138         struct rman             sc_pci_io_rman;
 139
 140         bus_space_handle_t      sc_pci_bh[OFW_PCI_NUM_CS];
 141         bus_space_tag_t         sc_pci_cfgt;
 142         bus_space_tag_t         sc_pci_iot;
 143         bus_dma_tag_t           sc_pci_dmat;
 144
 145         struct ofw_bus_iinfo    sc_pci_iinfo;
 146
 147         phandle_t               sc_node;
 148
 149         uint8_t                 sc_pci_secbus;
 150         uint8_t                 sc_pci_subbus;
 151 };
 152
 153 int ofw_pci_attach_common(device_t dev, bus_dma_tag_t dmat, u_long iosize,
 154     u_long memsize);
 155 uint32_t ofw_pci_read_config_common(device_t dev, u_int regmax, u_long offset,
 156     u_int bus, u_int slot, u_int func, u_int reg, int width);
 157 void ofw_pci_write_config_common(device_t dev, u_int regmax, u_long offset,
 158     u_int bus, u_int slot, u_int func, u_int reg, uint32_t val, int width);
 159 ofw_pci_intr_t ofw_pci_route_interrupt_common(device_t bridge, device_t dev,
 160     int pin);
 161
 162 void ofw_pci_dmamap_sync_stst_order_common(void);
 163
 164 bus_activate_resource_t ofw_pci_activate_resource;
 165 bus_adjust_resource_t ofw_pci_adjust_resource;
 166 bus_alloc_resource_t ofw_pci_alloc_resource;
 167 bus_get_dma_tag_t ofw_pci_get_dma_tag;
 168 bus_read_ivar_t ofw_pci_read_ivar;
 169
 170 ofw_bus_get_node_t ofw_pci_get_node;
 171
 172 #endif /* ! _SPARC64_PCI_OFW_PCI_H_ */