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