drivers/net/phy/mdio-xgene.c

   1 /* Applied Micro X-Gene SoC MDIO Driver
   2  *
   3  * Copyright (c) 2016, Applied Micro Circuits Corporation
   4  * Author: Iyappan Subramanian <isubramanian@apm.com>
   5  *
   6  * This program is free software; you can redistribute  it and/or modify it
   7  * under  the terms of  the GNU General  Public License as published by the
   8  * Free Software Foundation;  either version 2 of the  License, or (at your
   9  * option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <linux/acpi.h>
  21 #include <linux/clk.h>
  22 #include <linux/device.h>
  23 #include <linux/efi.h>
  24 #include <linux/if_vlan.h>
  25 #include <linux/io.h>
  26 #include <linux/module.h>
  27 #include <linux/of_platform.h>
  28 #include <linux/of_net.h>
  29 #include <linux/of_mdio.h>
  30 #include <linux/prefetch.h>
  31 #include <linux/phy.h>
  32 #include <net/ip.h>
  33 #include "mdio-xgene.h"
  34
  35 static bool xgene_mdio_status;
  36
  37 u32 xgene_mdio_rd_mac(struct xgene_mdio_pdata *pdata, u32 rd_addr)
  38 {
  39         void __iomem *addr, *rd, *cmd, *cmd_done;
  40         u32 done, rd_data = BUSY_MASK;
  41         u8 wait = 10;
  42
  43         addr = pdata->mac_csr_addr + MAC_ADDR_REG_OFFSET;
  44         rd = pdata->mac_csr_addr + MAC_READ_REG_OFFSET;
  45         cmd = pdata->mac_csr_addr + MAC_COMMAND_REG_OFFSET;
  46         cmd_done = pdata->mac_csr_addr + MAC_COMMAND_DONE_REG_OFFSET;
  47
  48         spin_lock(&pdata->mac_lock);
  49         iowrite32(rd_addr, addr);
  50         iowrite32(XGENE_ENET_RD_CMD, cmd);
  51
  52         while (!(done = ioread32(cmd_done)) && wait--)
  53                 udelay(1);
  54
  55         if (done)
  56                 rd_data = ioread32(rd);
  57
  58         iowrite32(0, cmd);
  59         spin_unlock(&pdata->mac_lock);
  60
  61         return rd_data;
  62 }
  63 EXPORT_SYMBOL(xgene_mdio_rd_mac);
  64
  65 void xgene_mdio_wr_mac(struct xgene_mdio_pdata *pdata, u32 wr_addr, u32 data)
  66 {
  67         void __iomem *addr, *wr, *cmd, *cmd_done;
  68         u8 wait = 10;
  69         u32 done;
  70
  71         addr = pdata->mac_csr_addr + MAC_ADDR_REG_OFFSET;
  72         wr = pdata->mac_csr_addr + MAC_WRITE_REG_OFFSET;
  73         cmd = pdata->mac_csr_addr + MAC_COMMAND_REG_OFFSET;
  74         cmd_done = pdata->mac_csr_addr + MAC_COMMAND_DONE_REG_OFFSET;
  75
  76         spin_lock(&pdata->mac_lock);
  77         iowrite32(wr_addr, addr);
  78         iowrite32(data, wr);
  79         iowrite32(XGENE_ENET_WR_CMD, cmd);
  80
  81         while (!(done = ioread32(cmd_done)) && wait--)
  82                 udelay(1);
  83
  84         if (!done)
  85                 pr_err("MCX mac write failed, addr: 0x%04x\n", wr_addr);
  86
  87         iowrite32(0, cmd);
  88         spin_unlock(&pdata->mac_lock);
  89 }
  90 EXPORT_SYMBOL(xgene_mdio_wr_mac);
  91
  92 int xgene_mdio_rgmii_read(struct mii_bus *bus, int phy_id, int reg)
  93 {
  94         struct xgene_mdio_pdata *pdata = (struct xgene_mdio_pdata *)bus->priv;
  95         u32 data, done;
  96         u8 wait = 10;
  97
  98         data = SET_VAL(PHY_ADDR, phy_id) | SET_VAL(REG_ADDR, reg);
  99         xgene_mdio_wr_mac(pdata, MII_MGMT_ADDRESS_ADDR, data);
 100         xgene_mdio_wr_mac(pdata, MII_MGMT_COMMAND_ADDR, READ_CYCLE_MASK);
 101         do {
 102                 usleep_range(5, 10);
 103                 done = xgene_mdio_rd_mac(pdata, MII_MGMT_INDICATORS_ADDR);
 104         } while ((done & BUSY_MASK) && wait--);
 105
 106         if (done & BUSY_MASK) {
 107                 dev_err(&bus->dev, "MII_MGMT read failed\n");
 108                 return -EBUSY;
 109         }
 110
 111         data = xgene_mdio_rd_mac(pdata, MII_MGMT_STATUS_ADDR);
 112         xgene_mdio_wr_mac(pdata, MII_MGMT_COMMAND_ADDR, 0);
 113
 114         return data;
 115 }
 116 EXPORT_SYMBOL(xgene_mdio_rgmii_read);
 117
 118 int xgene_mdio_rgmii_write(struct mii_bus *bus, int phy_id, int reg, u16 data)
 119 {
 120         struct xgene_mdio_pdata *pdata = (struct xgene_mdio_pdata *)bus->priv;
 121         u32 val, done;
 122         u8 wait = 10;
 123
 124         val = SET_VAL(PHY_ADDR, phy_id) | SET_VAL(REG_ADDR, reg);
 125         xgene_mdio_wr_mac(pdata, MII_MGMT_ADDRESS_ADDR, val);
 126
 127         xgene_mdio_wr_mac(pdata, MII_MGMT_CONTROL_ADDR, data);
 128         do {
 129                 usleep_range(5, 10);
 130                 done = xgene_mdio_rd_mac(pdata, MII_MGMT_INDICATORS_ADDR);
 131         } while ((done & BUSY_MASK) && wait--);
 132
 133         if (done & BUSY_MASK) {
 134                 dev_err(&bus->dev, "MII_MGMT write failed\n");
 135                 return -EBUSY;
 136         }
 137
 138         return 0;
 139 }
 140 EXPORT_SYMBOL(xgene_mdio_rgmii_write);
 141
 142 static u32 xgene_menet_rd_diag_csr(struct xgene_mdio_pdata *pdata, u32 offset)
 143 {
 144         return ioread32(pdata->diag_csr_addr + offset);
 145 }
 146
 147 static void xgene_menet_wr_diag_csr(struct xgene_mdio_pdata *pdata,
 148                                     u32 offset, u32 val)
 149 {
 150         iowrite32(val, pdata->diag_csr_addr + offset);
 151 }
 152
 153 static int xgene_enet_ecc_init(struct xgene_mdio_pdata *pdata)
 154 {
 155         u32 data;
 156         u8 wait = 10;
 157
 158         xgene_menet_wr_diag_csr(pdata, MENET_CFG_MEM_RAM_SHUTDOWN_ADDR, 0x0);
 159         do {
 160                 usleep_range(100, 110);
 161                 data = xgene_menet_rd_diag_csr(pdata, MENET_BLOCK_MEM_RDY_ADDR);
 162         } while ((data != 0xffffffff) && wait--);
 163
 164         if (data != 0xffffffff) {
 165                 dev_err(pdata->dev, "Failed to release memory from shutdown\n");
 166                 return -ENODEV;
 167         }
 168
 169         return 0;
 170 }
 171
 172 static void xgene_gmac_reset(struct xgene_mdio_pdata *pdata)
 173 {
 174         xgene_mdio_wr_mac(pdata, MAC_CONFIG_1_ADDR, SOFT_RESET);
 175         xgene_mdio_wr_mac(pdata, MAC_CONFIG_1_ADDR, 0);
 176 }
 177
 178 static int xgene_mdio_reset(struct xgene_mdio_pdata *pdata)
 179 {
 180         int ret;
 181
 182         if (pdata->dev->of_node) {
 183                 clk_prepare_enable(pdata->clk);
 184                 udelay(5);
 185                 clk_disable_unprepare(pdata->clk);
 186                 udelay(5);
 187                 clk_prepare_enable(pdata->clk);
 188                 udelay(5);
 189         } else {
 190 #ifdef CONFIG_ACPI
 191                 acpi_evaluate_object(ACPI_HANDLE(pdata->dev),
 192                                      "_RST", NULL, NULL);
 193 #endif
 194         }
 195
 196         ret = xgene_enet_ecc_init(pdata);
 197         if (ret)
 198                 return ret;
 199         xgene_gmac_reset(pdata);
 200
 201         return 0;
 202 }
 203
 204 static void xgene_enet_rd_mdio_csr(void __iomem *base_addr,
 205                                    u32 offset, u32 *val)
 206 {
 207         void __iomem *addr = base_addr  + offset;
 208
 209         *val = ioread32(addr);
 210 }
 211
 212 static void xgene_enet_wr_mdio_csr(void __iomem *base_addr,
 213                                    u32 offset, u32 val)
 214 {
 215         void __iomem *addr = base_addr  + offset;
 216
 217         iowrite32(val, addr);
 218 }
 219
 220 static int xgene_xfi_mdio_write(struct mii_bus *bus, int phy_id,
 221                                 int reg, u16 data)
 222 {
 223         void __iomem *addr = (void __iomem *)bus->priv;
 224         int timeout = 100;
 225         u32 status, val;
 226
 227         val = SET_VAL(HSTPHYADX, phy_id) | SET_VAL(HSTREGADX, reg) |
 228               SET_VAL(HSTMIIMWRDAT, data);
 229         xgene_enet_wr_mdio_csr(addr, MIIM_FIELD_ADDR, val);
 230
 231         val = HSTLDCMD | SET_VAL(HSTMIIMCMD, MIIM_CMD_LEGACY_WRITE);
 232         xgene_enet_wr_mdio_csr(addr, MIIM_COMMAND_ADDR, val);
 233
 234         do {
 235                 usleep_range(5, 10);
 236                 xgene_enet_rd_mdio_csr(addr, MIIM_INDICATOR_ADDR, &status);
 237         } while ((status & BUSY_MASK) && timeout--);
 238
 239         xgene_enet_wr_mdio_csr(addr, MIIM_COMMAND_ADDR, 0);
 240
 241         return 0;
 242 }
 243
 244 static int xgene_xfi_mdio_read(struct mii_bus *bus, int phy_id, int reg)
 245 {
 246         void __iomem *addr = (void __iomem *)bus->priv;
 247         u32 data, status, val;
 248         int timeout = 100;
 249
 250         val = SET_VAL(HSTPHYADX, phy_id) | SET_VAL(HSTREGADX, reg);
 251         xgene_enet_wr_mdio_csr(addr, MIIM_FIELD_ADDR, val);
 252
 253         val = HSTLDCMD | SET_VAL(HSTMIIMCMD, MIIM_CMD_LEGACY_READ);
 254         xgene_enet_wr_mdio_csr(addr, MIIM_COMMAND_ADDR, val);
 255
 256         do {
 257                 usleep_range(5, 10);
 258                 xgene_enet_rd_mdio_csr(addr, MIIM_INDICATOR_ADDR, &status);
 259         } while ((status & BUSY_MASK) && timeout--);
 260
 261         if (status & BUSY_MASK) {
 262                 pr_err("XGENET_MII_MGMT write failed\n");
 263                 return -EBUSY;
 264         }
 265
 266         xgene_enet_rd_mdio_csr(addr, MIIMRD_FIELD_ADDR, &data);
 267         xgene_enet_wr_mdio_csr(addr, MIIM_COMMAND_ADDR, 0);
 268
 269         return data;
 270 }
 271
 272 struct phy_device *xgene_enet_phy_register(struct mii_bus *bus, int phy_addr)
 273 {
 274         struct phy_device *phy_dev;
 275
 276         phy_dev = get_phy_device(bus, phy_addr, false);
 277         if (!phy_dev || IS_ERR(phy_dev))
 278                 return NULL;
 279
 280         if (phy_device_register(phy_dev))
 281                 phy_device_free(phy_dev);
 282
 283         return phy_dev;
 284 }
 285 EXPORT_SYMBOL(xgene_enet_phy_register);
 286
 287 #ifdef CONFIG_ACPI
 288 static acpi_status acpi_register_phy(acpi_handle handle, u32 lvl,
 289                                      void *context, void **ret)
 290 {
 291         struct mii_bus *mdio = context;
 292         struct acpi_device *adev;
 293         struct phy_device *phy_dev;
 294         const union acpi_object *obj;
 295         u32 phy_addr;
 296
 297         if (acpi_bus_get_device(handle, &adev))
 298                 return AE_OK;
 299
 300         if (acpi_dev_get_property(adev, "phy-channel", ACPI_TYPE_INTEGER, &obj))
 301                 return AE_OK;
 302         phy_addr = obj->integer.value;
 303
 304         phy_dev = xgene_enet_phy_register(mdio, phy_addr);
 305         adev->driver_data = phy_dev;
 306
 307         return AE_OK;
 308 }
 309 #endif
 310
 311 static const struct of_device_id xgene_mdio_of_match[] = {
 312         {
 313                 .compatible = "apm,xgene-mdio-rgmii",
 314                 .data = (void *)XGENE_MDIO_RGMII
 315         },
 316         {
 317                 .compatible = "apm,xgene-mdio-xfi",
 318                 .data = (void *)XGENE_MDIO_XFI
 319         },
 320         {},
 321 };
 322 MODULE_DEVICE_TABLE(of, xgene_mdio_of_match);
 323
 324 #ifdef CONFIG_ACPI
 325 static const struct acpi_device_id xgene_mdio_acpi_match[] = {
 326         { "APMC0D65", XGENE_MDIO_RGMII },
 327         { "APMC0D66", XGENE_MDIO_XFI },
 328         { }
 329 };
 330
 331 MODULE_DEVICE_TABLE(acpi, xgene_mdio_acpi_match);
 332 #endif
 333
 334
 335 static int xgene_mdio_probe(struct platform_device *pdev)
 336 {
 337         struct device *dev = &pdev->dev;
 338         struct mii_bus *mdio_bus;
 339         const struct of_device_id *of_id;
 340         struct resource *res;
 341         struct xgene_mdio_pdata *pdata;
 342         void __iomem *csr_base;
 343         int mdio_id = 0, ret = 0;
 344
 345         of_id = of_match_device(xgene_mdio_of_match, &pdev->dev);
 346         if (of_id) {
 347                 mdio_id = (enum xgene_mdio_id)of_id->data;
 348         } else {
 349 #ifdef CONFIG_ACPI
 350                 const struct acpi_device_id *acpi_id;
 351
 352                 acpi_id = acpi_match_device(xgene_mdio_acpi_match, &pdev->dev);
 353                 if (acpi_id)
 354                         mdio_id = (enum xgene_mdio_id)acpi_id->driver_data;
 355 #endif
 356         }
 357
 358         if (!mdio_id)
 359                 return -ENODEV;
 360
 361         pdata = devm_kzalloc(dev, sizeof(struct xgene_mdio_pdata), GFP_KERNEL);
 362         if (!pdata)
 363                 return -ENOMEM;
 364         pdata->mdio_id = mdio_id;
 365         pdata->dev = dev;
 366
 367         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 368         csr_base = devm_ioremap_resource(dev, res);
 369         if (IS_ERR(csr_base))
 370                 return PTR_ERR(csr_base);
 371         pdata->mac_csr_addr = csr_base;
 372         pdata->mdio_csr_addr = csr_base + BLOCK_XG_MDIO_CSR_OFFSET;
 373         pdata->diag_csr_addr = csr_base + BLOCK_DIAG_CSR_OFFSET;
 374
 375         if (mdio_id == XGENE_MDIO_RGMII)
 376                 spin_lock_init(&pdata->mac_lock);
 377
 378         if (dev->of_node) {
 379                 pdata->clk = devm_clk_get(dev, NULL);
 380                 if (IS_ERR(pdata->clk)) {
 381                         dev_err(dev, "Unable to retrieve clk\n");
 382                         return PTR_ERR(pdata->clk);
 383                 }
 384         }
 385
 386         ret = xgene_mdio_reset(pdata);
 387         if (ret)
 388                 return ret;
 389
 390         mdio_bus = mdiobus_alloc();
 391         if (!mdio_bus)
 392                 return -ENOMEM;
 393
 394         mdio_bus->name = "APM X-Gene MDIO bus";
 395
 396         if (mdio_id == XGENE_MDIO_RGMII) {
 397                 mdio_bus->read = xgene_mdio_rgmii_read;
 398                 mdio_bus->write = xgene_mdio_rgmii_write;
 399                 mdio_bus->priv = (void __force *)pdata;
 400                 snprintf(mdio_bus->id, MII_BUS_ID_SIZE, "%s",
 401                          "xgene-mii-rgmii");
 402         } else {
 403                 mdio_bus->read = xgene_xfi_mdio_read;
 404                 mdio_bus->write = xgene_xfi_mdio_write;
 405                 mdio_bus->priv = (void __force *)pdata->mdio_csr_addr;
 406                 snprintf(mdio_bus->id, MII_BUS_ID_SIZE, "%s",
 407                          "xgene-mii-xfi");
 408         }
 409
 410         mdio_bus->parent = dev;
 411         platform_set_drvdata(pdev, pdata);
 412
 413         if (dev->of_node) {
 414                 ret = of_mdiobus_register(mdio_bus, dev->of_node);
 415         } else {
 416 #ifdef CONFIG_ACPI
 417                 /* Mask out all PHYs from auto probing. */
 418                 mdio_bus->phy_mask = ~0;
 419                 ret = mdiobus_register(mdio_bus);
 420                 if (ret)
 421                         goto out;
 422
 423                 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_HANDLE(dev), 1,
 424                                     acpi_register_phy, NULL, mdio_bus, NULL);
 425 #endif
 426         }
 427
 428         if (ret)
 429                 goto out;
 430
 431         pdata->mdio_bus = mdio_bus;
 432         xgene_mdio_status = true;
 433
 434         return 0;
 435
 436 out:
 437         mdiobus_free(mdio_bus);
 438
 439         return ret;
 440 }
 441
 442 static int xgene_mdio_remove(struct platform_device *pdev)
 443 {
 444         struct xgene_mdio_pdata *pdata = platform_get_drvdata(pdev);
 445         struct mii_bus *mdio_bus = pdata->mdio_bus;
 446         struct device *dev = &pdev->dev;
 447
 448         mdiobus_unregister(mdio_bus);
 449         mdiobus_free(mdio_bus);
 450
 451         if (dev->of_node)
 452                 clk_disable_unprepare(pdata->clk);
 453
 454         return 0;
 455 }
 456
 457 static struct platform_driver xgene_mdio_driver = {
 458         .driver = {
 459                 .name = "xgene-mdio",
 460                 .of_match_table = of_match_ptr(xgene_mdio_of_match),
 461                 .acpi_match_table = ACPI_PTR(xgene_mdio_acpi_match),
 462         },
 463         .probe = xgene_mdio_probe,
 464         .remove = xgene_mdio_remove,
 465 };
 466
 467 module_platform_driver(xgene_mdio_driver);
 468
 469 MODULE_DESCRIPTION("APM X-Gene SoC MDIO driver");
 470 MODULE_AUTHOR("Iyappan Subramanian <isubramanian@apm.com>");
 471 MODULE_LICENSE("GPL");