2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
34 #ifndef _BHND_CORES_PCI_BHND_PCIVAR_H_
35 #define _BHND_CORES_PCI_BHND_PCIVAR_H_
37 #include <sys/param.h>
41 * Shared PCI Bridge/PCI Host Bridge definitions.
44 DECLARE_CLASS(bhnd_pci_driver);
45 struct bhnd_pci_softc;
47 int bhnd_pci_generic_probe(device_t dev);
48 int bhnd_pci_generic_attach(device_t dev);
49 int bhnd_pci_generic_detach(device_t dev);
50 int bhnd_pci_generic_suspend(device_t dev);
51 int bhnd_pci_generic_resume(device_t dev);
53 uint32_t bhnd_pcie_read_proto_reg(struct bhnd_pci_softc *sc,
55 void bhnd_pcie_write_proto_reg(struct bhnd_pci_softc *sc,
56 uint32_t addr, uint32_t val);
57 int bhnd_pcie_mdio_read(struct bhnd_pci_softc *sc, int phy,
59 int bhnd_pcie_mdio_write(struct bhnd_pci_softc *sc, int phy,
61 int bhnd_pcie_mdio_read_ext(struct bhnd_pci_softc *sc, int phy,
62 int devaddr, int reg);
63 int bhnd_pcie_mdio_write_ext(struct bhnd_pci_softc *sc, int phy,
64 int devaddr, int reg, int val);
66 /** PCI register block layouts. */
68 BHND_PCI_REGFMT_PCI = 0, /* PCI register definitions */
69 BHND_PCI_REGFMT_PCIE = 1, /* PCIe-Gen1 register definitions */
72 /** PCI (base driver) quirks */
75 * The PCIe SerDes requires use of a non-standard Clause 22
76 * address extension mechanism to access extended MDIO registers.
78 BHND_PCI_QUIRK_SD_C22_EXTADDR = (1<<0),
82 * bhnd_pci child device info
84 struct bhnd_pci_devinfo {
85 struct resource_list resources;
89 * Generic PCI bridge/end-point driver state.
91 * Must be first member of all subclass softc structures.
93 struct bhnd_pci_softc {
94 device_t dev; /**< pci device */
95 uint32_t quirks; /**< quirk flags */
96 bhnd_pci_regfmt_t regfmt; /**< register format */
98 struct mtx mtx; /**< state mutex used to protect
99 interdependent register
102 struct bhnd_resource *mem_res; /**< device register block. */
103 int mem_rid; /**< register block RID */
107 #define BHND_PCI_LOCK_INIT(sc) \
108 mtx_init(&(sc)->mtx, device_get_nameunit((sc)->dev), \
109 "BHND PCI driver lock", MTX_DEF)
110 #define BHND_PCI_LOCK(sc) mtx_lock(&(sc)->mtx)
111 #define BHND_PCI_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
112 #define BHND_PCI_LOCK_ASSERT(sc, what) mtx_assert(&(sc)->mtx, what)
113 #define BHND_PCI_LOCK_DESTROY(sc) mtx_destroy(&(sc)->mtx)
115 /* BHND_PCI_*_REG_(GET|SET) implementation */
116 #define _BHND_PCI_REG_GET(_regval, _mask, _shift) \
117 ((_regval & _mask) >> _shift)
118 #define _BHND_PCI_REG_SET(_regval, _mask, _shift, _setval) \
119 (((_regval) & ~ _mask) | (((_setval) << _shift) & _mask))
122 * Extract a register value by applying _MASK and _SHIFT defines.
124 * @param _regv The register value containing the desired attribute
125 * @param _attr The register attribute name to which to append `_MASK`/`_SHIFT`
128 #define BHND_PCI_REG_GET(_regv, _attr) \
129 _BHND_PCI_REG_GET(_regv, _attr ## _MASK, _attr ## _SHIFT)
132 * Insert a value in @p _regv by applying _MASK and _SHIFT defines.
134 * @param _regv The current register value.
135 * @param _attr The register attribute name to which to append `_MASK`/`_SHIFT`
137 * @param _val The value to be set in @p _regv.
139 #define BHND_PCI_REG_SET(_regv, _attr, _val) \
140 _BHND_PCI_REG_SET(_regv, _attr ## _MASK, _attr ## _SHIFT, _val)
143 * Extract a value by applying _MASK and _SHIFT defines to the common
144 * PCI/PCIe register definition @p _regv
146 * @param _regf The PCI core register format (BHND_PCI_REGFMT_*).
147 * @param _regv The register value containing the desired attribute
148 * @param _attr The register attribute name to which to prepend the register
149 * definition prefix and append `_MASK`/`_SHIFT` suffixes.
151 #define BHND_PCI_CMN_REG_GET(_regf, _regv, _attr) \
152 _BHND_PCI_REG_GET(_regv, \
153 BHND_PCI_COMMON_REG((_regf), _attr ## _MASK), \
154 BHND_PCI_COMMON_REG((_regf), _attr ## _SHIFT))
157 * Insert a register value by applying _MASK and _SHIFT defines to the common
158 * PCI/PCIe register definition @p _regv
160 * @param _regf The PCI core register format (BHND_PCI_REGFMT_*).
161 * @param _regv The register value containing the desired attribute
162 * @param _attr The register attribute name to which to prepend the register
163 * definition prefix and append `_MASK`/`_SHIFT` suffixes.
164 * @param _val The value to bet set in @p _regv.
166 #define BHND_PCI_CMN_REG_SET(_regf, _regv, _attr, _val) \
167 _BHND_PCI_REG_SET(_regv, \
168 BHND_PCI_COMMON_REG((_regf), _attr ## _MASK), \
169 BHND_PCI_COMMON_REG((_regf), _attr ## _SHIFT), \
174 * Evaluates to the offset of a common PCI/PCIe register definition.
176 * This will trigger a compile-time error if the register is not defined
177 * for all supported PCI/PCIe cores.
179 * This should be optimized down to a constant value if the register constant
180 * is the same across the register definitions.
182 * @param _regf The PCI core register format (BHND_PCI_REGFMT_*).
183 * @param _name The base name of the register.
185 #define BHND_PCI_COMMON_REG(_regf, _name) ( \
186 (_regf) == BHND_PCI_REGFMT_PCI ? BHND_PCI_ ## _name : \
187 BHND_PCIE_ ## _name \
190 #endif /* _BHND_CORES_PCI_BHND_PCIVAR_H_ */