drivers/net/ethernet/broadcom/bgmac-platform.c

   1 /*
   2  * Copyright (C) 2016 Broadcom
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation version 2.
   7  *
   8  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
   9  * kind, whether express or implied; without even the implied warranty
  10  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #define pr_fmt(fmt)             KBUILD_MODNAME ": " fmt
  15
  16 #include <linux/bcma/bcma.h>
  17 #include <linux/brcmphy.h>
  18 #include <linux/etherdevice.h>
  19 #include <linux/of_address.h>
  20 #include <linux/of_mdio.h>
  21 #include <linux/of_net.h>
  22 #include "bgmac.h"
  23
  24 #define NICPM_PADRING_CFG               0x00000004
  25 #define NICPM_IOMUX_CTRL                0x00000008
  26
  27 #define NICPM_PADRING_CFG_INIT_VAL      0x74000000
  28 #define NICPM_IOMUX_CTRL_INIT_VAL_AX    0x21880000
  29
  30 #define NICPM_IOMUX_CTRL_INIT_VAL       0x3196e000
  31 #define NICPM_IOMUX_CTRL_SPD_SHIFT      10
  32 #define NICPM_IOMUX_CTRL_SPD_10M        0
  33 #define NICPM_IOMUX_CTRL_SPD_100M       1
  34 #define NICPM_IOMUX_CTRL_SPD_1000M      2
  35
  36 static u32 platform_bgmac_read(struct bgmac *bgmac, u16 offset)
  37 {
  38         return readl(bgmac->plat.base + offset);
  39 }
  40
  41 static void platform_bgmac_write(struct bgmac *bgmac, u16 offset, u32 value)
  42 {
  43         writel(value, bgmac->plat.base + offset);
  44 }
  45
  46 static u32 platform_bgmac_idm_read(struct bgmac *bgmac, u16 offset)
  47 {
  48         return readl(bgmac->plat.idm_base + offset);
  49 }
  50
  51 static void platform_bgmac_idm_write(struct bgmac *bgmac, u16 offset, u32 value)
  52 {
  53         writel(value, bgmac->plat.idm_base + offset);
  54 }
  55
  56 static bool platform_bgmac_clk_enabled(struct bgmac *bgmac)
  57 {
  58         if (!bgmac->plat.idm_base)
  59                 return true;
  60
  61         if ((bgmac_idm_read(bgmac, BCMA_IOCTL) & BGMAC_CLK_EN) != BGMAC_CLK_EN)
  62                 return false;
  63         if (bgmac_idm_read(bgmac, BCMA_RESET_CTL) & BCMA_RESET_CTL_RESET)
  64                 return false;
  65         return true;
  66 }
  67
  68 static void platform_bgmac_clk_enable(struct bgmac *bgmac, u32 flags)
  69 {
  70         u32 val;
  71
  72         if (!bgmac->plat.idm_base)
  73                 return;
  74
  75         /* The Reset Control register only contains a single bit to show if the
  76          * controller is currently in reset.  Do a sanity check here, just in
  77          * case the bootloader happened to leave the device in reset.
  78          */
  79         val = bgmac_idm_read(bgmac, BCMA_RESET_CTL);
  80         if (val) {
  81                 bgmac_idm_write(bgmac, BCMA_RESET_CTL, 0);
  82                 bgmac_idm_read(bgmac, BCMA_RESET_CTL);
  83                 udelay(1);
  84         }
  85
  86         val = bgmac_idm_read(bgmac, BCMA_IOCTL);
  87         /* Some bits of BCMA_IOCTL set by HW/ATF and should not change */
  88         val |= flags & ~(BGMAC_AWCACHE | BGMAC_ARCACHE | BGMAC_AWUSER |
  89                          BGMAC_ARUSER);
  90         val |= BGMAC_CLK_EN;
  91         bgmac_idm_write(bgmac, BCMA_IOCTL, val);
  92         bgmac_idm_read(bgmac, BCMA_IOCTL);
  93         udelay(1);
  94 }
  95
  96 static void platform_bgmac_cco_ctl_maskset(struct bgmac *bgmac, u32 offset,
  97                                            u32 mask, u32 set)
  98 {
  99         /* This shouldn't be encountered */
 100         WARN_ON(1);
 101 }
 102
 103 static u32 platform_bgmac_get_bus_clock(struct bgmac *bgmac)
 104 {
 105         /* This shouldn't be encountered */
 106         WARN_ON(1);
 107
 108         return 0;
 109 }
 110
 111 static void platform_bgmac_cmn_maskset32(struct bgmac *bgmac, u16 offset,
 112                                          u32 mask, u32 set)
 113 {
 114         /* This shouldn't be encountered */
 115         WARN_ON(1);
 116 }
 117
 118 static void bgmac_nicpm_speed_set(struct net_device *net_dev)
 119 {
 120         struct bgmac *bgmac = netdev_priv(net_dev);
 121         u32 val;
 122
 123         if (!bgmac->plat.nicpm_base)
 124                 return;
 125
 126         /* SET RGMII IO CONFIG */
 127         writel(NICPM_PADRING_CFG_INIT_VAL,
 128                bgmac->plat.nicpm_base + NICPM_PADRING_CFG);
 129
 130         val = NICPM_IOMUX_CTRL_INIT_VAL;
 131         switch (bgmac->net_dev->phydev->speed) {
 132         default:
 133                 netdev_err(net_dev, "Unsupported speed. Defaulting to 1000Mb\n");
 134         case SPEED_1000:
 135                 val |= NICPM_IOMUX_CTRL_SPD_1000M << NICPM_IOMUX_CTRL_SPD_SHIFT;
 136                 break;
 137         case SPEED_100:
 138                 val |= NICPM_IOMUX_CTRL_SPD_100M << NICPM_IOMUX_CTRL_SPD_SHIFT;
 139                 break;
 140         case SPEED_10:
 141                 val |= NICPM_IOMUX_CTRL_SPD_10M << NICPM_IOMUX_CTRL_SPD_SHIFT;
 142                 break;
 143         }
 144
 145         writel(val, bgmac->plat.nicpm_base + NICPM_IOMUX_CTRL);
 146
 147         bgmac_adjust_link(bgmac->net_dev);
 148 }
 149
 150 static int platform_phy_connect(struct bgmac *bgmac)
 151 {
 152         struct phy_device *phy_dev;
 153
 154         if (bgmac->plat.nicpm_base)
 155                 phy_dev = of_phy_get_and_connect(bgmac->net_dev,
 156                                                  bgmac->dev->of_node,
 157                                                  bgmac_nicpm_speed_set);
 158         else
 159                 phy_dev = of_phy_get_and_connect(bgmac->net_dev,
 160                                                  bgmac->dev->of_node,
 161                                                  bgmac_adjust_link);
 162         if (!phy_dev) {
 163                 dev_err(bgmac->dev, "PHY connection failed\n");
 164                 return -ENODEV;
 165         }
 166
 167         return 0;
 168 }
 169
 170 static int bgmac_probe(struct platform_device *pdev)
 171 {
 172         struct device_node *np = pdev->dev.of_node;
 173         struct bgmac *bgmac;
 174         struct resource *regs;
 175         const u8 *mac_addr;
 176
 177         bgmac = bgmac_alloc(&pdev->dev);
 178         if (!bgmac)
 179                 return -ENOMEM;
 180
 181         platform_set_drvdata(pdev, bgmac);
 182
 183         /* Set the features of the 4707 family */
 184         bgmac->feature_flags |= BGMAC_FEAT_CLKCTLST;
 185         bgmac->feature_flags |= BGMAC_FEAT_NO_RESET;
 186         bgmac->feature_flags |= BGMAC_FEAT_CMDCFG_SR_REV4;
 187         bgmac->feature_flags |= BGMAC_FEAT_TX_MASK_SETUP;
 188         bgmac->feature_flags |= BGMAC_FEAT_RX_MASK_SETUP;
 189         bgmac->feature_flags |= BGMAC_FEAT_IDM_MASK;
 190
 191         bgmac->dev = &pdev->dev;
 192         bgmac->dma_dev = &pdev->dev;
 193
 194         mac_addr = of_get_mac_address(np);
 195         if (mac_addr)
 196                 ether_addr_copy(bgmac->net_dev->dev_addr, mac_addr);
 197         else
 198                 dev_warn(&pdev->dev, "MAC address not present in device tree\n");
 199
 200         bgmac->irq = platform_get_irq(pdev, 0);
 201         if (bgmac->irq < 0) {
 202                 dev_err(&pdev->dev, "Unable to obtain IRQ\n");
 203                 return bgmac->irq;
 204         }
 205
 206         regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "amac_base");
 207         if (!regs) {
 208                 dev_err(&pdev->dev, "Unable to obtain base resource\n");
 209                 return -EINVAL;
 210         }
 211
 212         bgmac->plat.base = devm_ioremap_resource(&pdev->dev, regs);
 213         if (IS_ERR(bgmac->plat.base))
 214                 return PTR_ERR(bgmac->plat.base);
 215
 216         regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "idm_base");
 217         if (regs) {
 218                 bgmac->plat.idm_base = devm_ioremap_resource(&pdev->dev, regs);
 219                 if (IS_ERR(bgmac->plat.idm_base))
 220                         return PTR_ERR(bgmac->plat.idm_base);
 221                 bgmac->feature_flags &= ~BGMAC_FEAT_IDM_MASK;
 222         }
 223
 224         regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "nicpm_base");
 225         if (regs) {
 226                 bgmac->plat.nicpm_base = devm_ioremap_resource(&pdev->dev,
 227                                                                regs);
 228                 if (IS_ERR(bgmac->plat.nicpm_base))
 229                         return PTR_ERR(bgmac->plat.nicpm_base);
 230         }
 231
 232         bgmac->read = platform_bgmac_read;
 233         bgmac->write = platform_bgmac_write;
 234         bgmac->idm_read = platform_bgmac_idm_read;
 235         bgmac->idm_write = platform_bgmac_idm_write;
 236         bgmac->clk_enabled = platform_bgmac_clk_enabled;
 237         bgmac->clk_enable = platform_bgmac_clk_enable;
 238         bgmac->cco_ctl_maskset = platform_bgmac_cco_ctl_maskset;
 239         bgmac->get_bus_clock = platform_bgmac_get_bus_clock;
 240         bgmac->cmn_maskset32 = platform_bgmac_cmn_maskset32;
 241         if (of_parse_phandle(np, "phy-handle", 0)) {
 242                 bgmac->phy_connect = platform_phy_connect;
 243         } else {
 244                 bgmac->phy_connect = bgmac_phy_connect_direct;
 245                 bgmac->feature_flags |= BGMAC_FEAT_FORCE_SPEED_2500;
 246         }
 247
 248         return bgmac_enet_probe(bgmac);
 249 }
 250
 251 static int bgmac_remove(struct platform_device *pdev)
 252 {
 253         struct bgmac *bgmac = platform_get_drvdata(pdev);
 254
 255         bgmac_enet_remove(bgmac);
 256
 257         return 0;
 258 }
 259
 260 #ifdef CONFIG_PM
 261 static int bgmac_suspend(struct device *dev)
 262 {
 263         struct bgmac *bgmac = dev_get_drvdata(dev);
 264
 265         return bgmac_enet_suspend(bgmac);
 266 }
 267
 268 static int bgmac_resume(struct device *dev)
 269 {
 270         struct bgmac *bgmac = dev_get_drvdata(dev);
 271
 272         return bgmac_enet_resume(bgmac);
 273 }
 274
 275 static const struct dev_pm_ops bgmac_pm_ops = {
 276         .suspend = bgmac_suspend,
 277         .resume = bgmac_resume
 278 };
 279
 280 #define BGMAC_PM_OPS (&bgmac_pm_ops)
 281 #else
 282 #define BGMAC_PM_OPS NULL
 283 #endif /* CONFIG_PM */
 284
 285 static const struct of_device_id bgmac_of_enet_match[] = {
 286         {.compatible = "brcm,amac",},
 287         {.compatible = "brcm,nsp-amac",},
 288         {.compatible = "brcm,ns2-amac",},
 289         {},
 290 };
 291
 292 MODULE_DEVICE_TABLE(of, bgmac_of_enet_match);
 293
 294 static struct platform_driver bgmac_enet_driver = {
 295         .driver = {
 296                 .name  = "bgmac-enet",
 297                 .of_match_table = bgmac_of_enet_match,
 298                 .pm = BGMAC_PM_OPS
 299         },
 300         .probe = bgmac_probe,
 301         .remove = bgmac_remove,
 302 };
 303
 304 module_platform_driver(bgmac_enet_driver);
 305 MODULE_LICENSE("GPL");