1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2015 Landon Fuller <landon@landonf.org> 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 * without modification. 13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 14 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 15 * redistribution must be conditioned upon including a substantially 16 * similar Disclaimer requirement for further binary redistribution. 17 * 18 * NO WARRANTY 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 22 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 23 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 24 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 27 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 29 * THE POSSIBILITY OF SUCH DAMAGES. 30 * 31 */ 32 33 #ifndef _BHND_CORES_PCI_BHND_PCIVAR_H_ 34 #define _BHND_CORES_PCI_BHND_PCIVAR_H_ 35 36 #include <sys/param.h> 37 #include <sys/bus.h> 38 39 /* 40 * Shared PCI Bridge/PCI Host Bridge definitions. 41 */ 42 43 DECLARE_CLASS(bhnd_pci_driver); 44 struct bhnd_pci_softc; 45 46 int bhnd_pci_generic_probe(device_t dev); 47 int bhnd_pci_generic_attach(device_t dev); 48 int bhnd_pci_generic_detach(device_t dev); 49 int bhnd_pci_generic_suspend(device_t dev); 50 int bhnd_pci_generic_resume(device_t dev); 51 52 uint32_t bhnd_pcie_read_proto_reg(struct bhnd_pci_softc *sc, 53 uint32_t addr); 54 void bhnd_pcie_write_proto_reg(struct bhnd_pci_softc *sc, 55 uint32_t addr, uint32_t val); 56 int bhnd_pcie_mdio_read(struct bhnd_pci_softc *sc, int phy, 57 int reg); 58 int bhnd_pcie_mdio_write(struct bhnd_pci_softc *sc, int phy, 59 int reg, int val); 60 int bhnd_pcie_mdio_read_ext(struct bhnd_pci_softc *sc, int phy, 61 int devaddr, int reg); 62 int bhnd_pcie_mdio_write_ext(struct bhnd_pci_softc *sc, int phy, 63 int devaddr, int reg, int val); 64 65 /** PCI register block layouts. */ 66 typedef enum { 67 BHND_PCI_REGFMT_PCI = 0, /* PCI register definitions */ 68 BHND_PCI_REGFMT_PCIE = 1, /* PCIe-Gen1 register definitions */ 69 } bhnd_pci_regfmt_t; 70 71 /** PCI (base driver) quirks */ 72 enum { 73 /** 74 * The PCIe SerDes requires use of a non-standard Clause 22 75 * address extension mechanism to access extended MDIO registers. 76 */ 77 BHND_PCI_QUIRK_SD_C22_EXTADDR = (1<<0), 78 }; 79 80 /** 81 * bhnd_pci child device info 82 */ 83 struct bhnd_pci_devinfo { 84 struct resource_list resources; 85 }; 86 87 /* 88 * Generic PCI bridge/end-point driver state. 89 * 90 * Must be first member of all subclass softc structures. 91 */ 92 struct bhnd_pci_softc { 93 device_t dev; /**< pci device */ 94 uint32_t quirks; /**< quirk flags */ 95 bhnd_pci_regfmt_t regfmt; /**< register format */ 96 97 struct mtx mtx; /**< state mutex used to protect 98 interdependent register 99 accesses. */ 100 101 struct bhnd_resource *mem_res; /**< device register block. */ 102 int mem_rid; /**< register block RID */ 103 }; 104 105 #define BHND_PCI_LOCK_INIT(sc) \ 106 mtx_init(&(sc)->mtx, device_get_nameunit((sc)->dev), \ 107 "BHND PCI driver lock", MTX_DEF) 108 #define BHND_PCI_LOCK(sc) mtx_lock(&(sc)->mtx) 109 #define BHND_PCI_UNLOCK(sc) mtx_unlock(&(sc)->mtx) 110 #define BHND_PCI_LOCK_ASSERT(sc, what) mtx_assert(&(sc)->mtx, what) 111 #define BHND_PCI_LOCK_DESTROY(sc) mtx_destroy(&(sc)->mtx) 112 113 /* BHND_PCI_*_REG_(GET|SET) implementation */ 114 #define _BHND_PCI_REG_GET(_regval, _mask, _shift) \ 115 ((_regval & _mask) >> _shift) 116 #define _BHND_PCI_REG_SET(_regval, _mask, _shift, _setval) \ 117 (((_regval) & ~ _mask) | (((_setval) << _shift) & _mask)) 118 119 /** 120 * Extract a register value by applying _MASK and _SHIFT defines. 121 * 122 * @param _regv The register value containing the desired attribute 123 * @param _attr The register attribute name to which to append `_MASK`/`_SHIFT` 124 * suffixes. 125 */ 126 #define BHND_PCI_REG_GET(_regv, _attr) \ 127 _BHND_PCI_REG_GET(_regv, _attr ## _MASK, _attr ## _SHIFT) 128 129 /** 130 * Insert a value in @p _regv by applying _MASK and _SHIFT defines. 131 * 132 * @param _regv The current register value. 133 * @param _attr The register attribute name to which to append `_MASK`/`_SHIFT` 134 * suffixes. 135 * @param _val The value to be set in @p _regv. 136 */ 137 #define BHND_PCI_REG_SET(_regv, _attr, _val) \ 138 _BHND_PCI_REG_SET(_regv, _attr ## _MASK, _attr ## _SHIFT, _val) 139 140 /** 141 * Extract a value by applying _MASK and _SHIFT defines to the common 142 * PCI/PCIe register definition @p _regv 143 * 144 * @param _regf The PCI core register format (BHND_PCI_REGFMT_*). 145 * @param _regv The register value containing the desired attribute 146 * @param _attr The register attribute name to which to prepend the register 147 * definition prefix and append `_MASK`/`_SHIFT` suffixes. 148 */ 149 #define BHND_PCI_CMN_REG_GET(_regf, _regv, _attr) \ 150 _BHND_PCI_REG_GET(_regv, \ 151 BHND_PCI_COMMON_REG((_regf), _attr ## _MASK), \ 152 BHND_PCI_COMMON_REG((_regf), _attr ## _SHIFT)) 153 154 /** 155 * Insert a register value by applying _MASK and _SHIFT defines to the common 156 * PCI/PCIe register definition @p _regv 157 * 158 * @param _regf The PCI core register format (BHND_PCI_REGFMT_*). 159 * @param _regv The register value containing the desired attribute 160 * @param _attr The register attribute name to which to prepend the register 161 * definition prefix and append `_MASK`/`_SHIFT` suffixes. 162 * @param _val The value to bet set in @p _regv. 163 */ 164 #define BHND_PCI_CMN_REG_SET(_regf, _regv, _attr, _val) \ 165 _BHND_PCI_REG_SET(_regv, \ 166 BHND_PCI_COMMON_REG((_regf), _attr ## _MASK), \ 167 BHND_PCI_COMMON_REG((_regf), _attr ## _SHIFT), \ 168 _val) 169 170 /** 171 * Evaluates to the offset of a common PCI/PCIe register definition. 172 * 173 * This will trigger a compile-time error if the register is not defined 174 * for all supported PCI/PCIe cores. 175 * 176 * This should be optimized down to a constant value if the register constant 177 * is the same across the register definitions. 178 * 179 * @param _regf The PCI core register format (BHND_PCI_REGFMT_*). 180 * @param _name The base name of the register. 181 */ 182 #define BHND_PCI_COMMON_REG(_regf, _name) ( \ 183 (_regf) == BHND_PCI_REGFMT_PCI ? BHND_PCI_ ## _name : \ 184 BHND_PCIE_ ## _name \ 185 ) 186 187 #endif /* _BHND_CORES_PCI_BHND_PCIVAR_H_ */ 188