2 * AMD 10Gb Ethernet driver
4 * This file is available to you under your choice of the following two
9 * Copyright (c) 2014 Advanced Micro Devices, Inc.
11 * This file is free software; you may copy, redistribute and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 2 of the License, or (at
14 * your option) any later version.
16 * This file is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * This file incorporates work covered by the following copyright and
26 * The Synopsys DWC ETHER XGMAC Software Driver and documentation
27 * (hereinafter "Software") is an unsupported proprietary work of Synopsys,
28 * Inc. unless otherwise expressly agreed to in writing between Synopsys
31 * The Software IS NOT an item of Licensed Software or Licensed Product
32 * under any End User Software License Agreement or Agreement for Licensed
33 * Product with Synopsys or any supplement thereto. Permission is hereby
34 * granted, free of charge, to any person obtaining a copy of this software
35 * annotated with this license and the Software, to deal in the Software
36 * without restriction, including without limitation the rights to use,
37 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies
38 * of the Software, and to permit persons to whom the Software is furnished
39 * to do so, subject to the following conditions:
41 * The above copyright notice and this permission notice shall be included
42 * in all copies or substantial portions of the Software.
44 * THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
45 * BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
46 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
47 * PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
48 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
49 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
50 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
51 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
52 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
54 * THE POSSIBILITY OF SUCH DAMAGE.
57 * License 2: Modified BSD
59 * Copyright (c) 2014 Advanced Micro Devices, Inc.
60 * All rights reserved.
62 * Redistribution and use in source and binary forms, with or without
63 * modification, are permitted provided that the following conditions are met:
64 * * Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 * * Redistributions in binary form must reproduce the above copyright
67 * notice, this list of conditions and the following disclaimer in the
68 * documentation and/or other materials provided with the distribution.
69 * * Neither the name of Advanced Micro Devices, Inc. nor the
70 * names of its contributors may be used to endorse or promote products
71 * derived from this software without specific prior written permission.
73 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
74 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
76 * ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
77 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
78 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
79 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
80 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
81 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
82 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
84 * This file incorporates work covered by the following copyright and
86 * The Synopsys DWC ETHER XGMAC Software Driver and documentation
87 * (hereinafter "Software") is an unsupported proprietary work of Synopsys,
88 * Inc. unless otherwise expressly agreed to in writing between Synopsys
91 * The Software IS NOT an item of Licensed Software or Licensed Product
92 * under any End User Software License Agreement or Agreement for Licensed
93 * Product with Synopsys or any supplement thereto. Permission is hereby
94 * granted, free of charge, to any person obtaining a copy of this software
95 * annotated with this license and the Software, to deal in the Software
96 * without restriction, including without limitation the rights to use,
97 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies
98 * of the Software, and to permit persons to whom the Software is furnished
99 * to do so, subject to the following conditions:
101 * The above copyright notice and this permission notice shall be included
102 * in all copies or substantial portions of the Software.
104 * THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
105 * BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
106 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
107 * PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
108 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
109 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
110 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
111 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
112 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
113 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
114 * THE POSSIBILITY OF SUCH DAMAGE.
117 #include <linux/module.h>
118 #include <linux/kmod.h>
119 #include <linux/mdio.h>
120 #include <linux/phy.h>
121 #include <linux/of.h>
124 #include "xgbe-common.h"
126 static int xgbe_mdio_read(struct mii_bus *mii, int prtad, int mmd_reg)
128 struct xgbe_prv_data *pdata = mii->priv;
129 struct xgbe_hw_if *hw_if = &pdata->hw_if;
132 DBGPR_MDIO("-->xgbe_mdio_read: prtad=%#x mmd_reg=%#x\n",
135 mmd_data = hw_if->read_mmd_regs(pdata, prtad, mmd_reg);
137 DBGPR_MDIO("<--xgbe_mdio_read: mmd_data=%#x\n", mmd_data);
142 static int xgbe_mdio_write(struct mii_bus *mii, int prtad, int mmd_reg,
145 struct xgbe_prv_data *pdata = mii->priv;
146 struct xgbe_hw_if *hw_if = &pdata->hw_if;
147 int mmd_data = mmd_val;
149 DBGPR_MDIO("-->xgbe_mdio_write: prtad=%#x mmd_reg=%#x mmd_data=%#x\n",
150 prtad, mmd_reg, mmd_data);
152 hw_if->write_mmd_regs(pdata, prtad, mmd_reg, mmd_data);
154 DBGPR_MDIO("<--xgbe_mdio_write\n");
159 void xgbe_dump_phy_registers(struct xgbe_prv_data *pdata)
161 struct device *dev = pdata->dev;
162 struct phy_device *phydev = pdata->mii->phy_map[XGBE_PRTAD];
165 dev_alert(dev, "\n************* PHY Reg dump **********************\n");
167 dev_alert(dev, "PCS Control Reg (%#04x) = %#04x\n", MDIO_CTRL1,
168 XMDIO_READ(pdata, MDIO_MMD_PCS, MDIO_CTRL1));
169 dev_alert(dev, "PCS Status Reg (%#04x) = %#04x\n", MDIO_STAT1,
170 XMDIO_READ(pdata, MDIO_MMD_PCS, MDIO_STAT1));
171 dev_alert(dev, "Phy Id (PHYS ID 1 %#04x)= %#04x\n", MDIO_DEVID1,
172 XMDIO_READ(pdata, MDIO_MMD_PCS, MDIO_DEVID1));
173 dev_alert(dev, "Phy Id (PHYS ID 2 %#04x)= %#04x\n", MDIO_DEVID2,
174 XMDIO_READ(pdata, MDIO_MMD_PCS, MDIO_DEVID2));
175 dev_alert(dev, "Devices in Package (%#04x)= %#04x\n", MDIO_DEVS1,
176 XMDIO_READ(pdata, MDIO_MMD_PCS, MDIO_DEVS1));
177 dev_alert(dev, "Devices in Package (%#04x)= %#04x\n", MDIO_DEVS2,
178 XMDIO_READ(pdata, MDIO_MMD_PCS, MDIO_DEVS2));
180 dev_alert(dev, "Auto-Neg Control Reg (%#04x) = %#04x\n", MDIO_CTRL1,
181 XMDIO_READ(pdata, MDIO_MMD_AN, MDIO_CTRL1));
182 dev_alert(dev, "Auto-Neg Status Reg (%#04x) = %#04x\n", MDIO_STAT1,
183 XMDIO_READ(pdata, MDIO_MMD_AN, MDIO_STAT1));
184 dev_alert(dev, "Auto-Neg Ad Reg 1 (%#04x) = %#04x\n",
186 XMDIO_READ(pdata, MDIO_MMD_AN, MDIO_AN_ADVERTISE));
187 dev_alert(dev, "Auto-Neg Ad Reg 2 (%#04x) = %#04x\n",
188 MDIO_AN_ADVERTISE + 1,
189 XMDIO_READ(pdata, MDIO_MMD_AN, MDIO_AN_ADVERTISE + 1));
190 dev_alert(dev, "Auto-Neg Ad Reg 3 (%#04x) = %#04x\n",
191 MDIO_AN_ADVERTISE + 2,
192 XMDIO_READ(pdata, MDIO_MMD_AN, MDIO_AN_ADVERTISE + 2));
193 dev_alert(dev, "Auto-Neg Completion Reg (%#04x) = %#04x\n",
195 XMDIO_READ(pdata, MDIO_MMD_AN, MDIO_AN_COMP_STAT));
197 dev_alert(dev, "MMD Device Mask = %#x\n",
198 phydev->c45_ids.devices_in_package);
199 for (i = 0; i < ARRAY_SIZE(phydev->c45_ids.device_ids); i++)
200 dev_alert(dev, " MMD %d: ID = %#08x\n", i,
201 phydev->c45_ids.device_ids[i]);
203 dev_alert(dev, "\n*************************************************\n");
206 int xgbe_mdio_register(struct xgbe_prv_data *pdata)
208 struct device_node *phy_node;
210 struct phy_device *phydev;
213 DBGPR("-->xgbe_mdio_register\n");
215 /* Retrieve the phy-handle */
216 phy_node = of_parse_phandle(pdata->dev->of_node, "phy-handle", 0);
218 dev_err(pdata->dev, "unable to parse phy-handle\n");
222 mii = mdiobus_alloc();
224 dev_err(pdata->dev, "mdiobus_alloc failed\n");
229 /* Register on the MDIO bus (don't probe any PHYs) */
230 mii->name = XGBE_PHY_NAME;
231 mii->read = xgbe_mdio_read;
232 mii->write = xgbe_mdio_write;
233 snprintf(mii->id, sizeof(mii->id), "%s", pdata->mii_bus_id);
236 mii->parent = pdata->dev;
237 ret = mdiobus_register(mii);
239 dev_err(pdata->dev, "mdiobus_register failed\n");
240 goto err_mdiobus_alloc;
242 DBGPR(" mdiobus_register succeeded for %s\n", pdata->mii_bus_id);
244 /* Probe the PCS using Clause 45 */
245 phydev = get_phy_device(mii, XGBE_PRTAD, true);
246 if (IS_ERR(phydev) || !phydev ||
247 !phydev->c45_ids.device_ids[MDIO_MMD_PCS]) {
248 dev_err(pdata->dev, "get_phy_device failed\n");
249 ret = phydev ? PTR_ERR(phydev) : -ENOLINK;
250 goto err_mdiobus_register;
252 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
253 MDIO_ID_ARGS(phydev->c45_ids.device_ids[MDIO_MMD_PCS]));
255 of_node_get(phy_node);
256 phydev->dev.of_node = phy_node;
257 ret = phy_device_register(phydev);
259 dev_err(pdata->dev, "phy_device_register failed\n");
260 of_node_put(phy_node);
264 /* Add a reference to the PHY driver so it can't be unloaded */
265 pdata->phy_module = phydev->dev.driver ?
266 phydev->dev.driver->owner : NULL;
267 if (!try_module_get(pdata->phy_module)) {
268 dev_err(pdata->dev, "try_module_get failed\n");
274 pdata->mdio_mmd = MDIO_MMD_PCS;
276 phydev->autoneg = pdata->default_autoneg;
277 if (phydev->autoneg == AUTONEG_DISABLE) {
278 phydev->speed = pdata->default_speed;
279 phydev->duplex = DUPLEX_FULL;
281 phydev->advertising &= ~ADVERTISED_Autoneg;
284 pdata->phydev = phydev;
286 of_node_put(phy_node);
290 DBGPR("<--xgbe_mdio_register\n");
295 phy_device_free(phydev);
297 err_mdiobus_register:
298 mdiobus_unregister(mii);
304 of_node_put(phy_node);
309 void xgbe_mdio_unregister(struct xgbe_prv_data *pdata)
311 DBGPR("-->xgbe_mdio_unregister\n");
313 pdata->phydev = NULL;
315 module_put(pdata->phy_module);
316 pdata->phy_module = NULL;
318 mdiobus_unregister(pdata->mii);
319 pdata->mii->priv = NULL;
321 mdiobus_free(pdata->mii);
324 DBGPR("<--xgbe_mdio_unregister\n");