net: phy: add Broadcom BCM7xxx internal PHY driver

This patch adds support for the Broadcom BCM7xxx Set Top Box SoCs
internal PHYs. This driver supports the following generation of SoCs:

- BCM7366, BCM7439, BCM7445 (28nm process)
- all 40nm and 65nm (older MIPS-based SoCs)

The PHYs on these SoCs require a bunch of workarounds to operate
correctly, both during configuration time and at suspend/resume time,
the driver handles that for us.

Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

1 files changed, 343 insertions, 0 deletions

diff --git a/drivers/net/phy/bcm7xxx.c b/drivers/net/phy/bcm7xxx.c
new file mode 100644
index 000000000000..697337220016
--- /dev/null
+++ b/drivers/net/phy/bcm7xxx.c
@@ -0,0 +1,343 @@
+/*
+ * Broadcom BCM7xxx internal transceivers support.
+ *
+ * Copyright (C) 2014, Broadcom Corporation
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version
+ * 2 of the License, or (at your option) any later version.
+ */
+
+#include <linux/module.h>
+#include <linux/phy.h>
+#include <linux/delay.h>
+#include <linux/bitops.h>
+#include <linux/brcmphy.h>
+
+/* Broadcom BCM7xxx internal PHY registers */
+#define MII_BCM7XXX_CHANNEL_WIDTH       0x2000
+
+/* 40nm only register definitions */
+#define MII_BCM7XXX_100TX_AUX_CTL       0x10
+#define MII_BCM7XXX_100TX_FALSE_CAR     0x13
+#define MII_BCM7XXX_100TX_DISC          0x14
+#define MII_BCM7XXX_AUX_MODE            0x1d
+#define  MII_BCM7XX_64CLK_MDIO          BIT(12)
+#define MII_BCM7XXX_CORE_BASE1E         0x1e
+#define MII_BCM7XXX_TEST                0x1f
+#define  MII_BCM7XXX_SHD_MODE_2         BIT(2)
+
+static int bcm7445_config_init(struct phy_device *phydev)
+{
+        int ret;
+        const struct bcm7445_regs {
+                int reg;
+                u16 value;
+        } bcm7445_regs_cfg[] = {
+                /* increases ADC latency by 24ns */
+                { MII_BCM54XX_EXP_SEL, 0x0038 },
+                { MII_BCM54XX_EXP_DATA, 0xAB95 },
+                /* increases internal 1V LDO voltage by 5% */
+                { MII_BCM54XX_EXP_SEL, 0x2038 },
+                { MII_BCM54XX_EXP_DATA, 0xBB22 },
+                /* reduce RX low pass filter corner frequency */
+                { MII_BCM54XX_EXP_SEL, 0x6038 },
+                { MII_BCM54XX_EXP_DATA, 0xFFC5 },
+                /* reduce RX high pass filter corner frequency */
+                { MII_BCM54XX_EXP_SEL, 0x003a },
+                { MII_BCM54XX_EXP_DATA, 0x2002 },
+        };
+        unsigned int i;
+
+        for (i = 0; i < ARRAY_SIZE(bcm7445_regs_cfg); i++) {
+                ret = phy_write(phydev,
+                                bcm7445_regs_cfg[i].reg,
+                                bcm7445_regs_cfg[i].value);
+                if (ret)
+                        return ret;
+        }
+
+        return 0;
+}
+
+static void phy_write_exp(struct phy_device *phydev,
+                                        u16 reg, u16 value)
+{
+        phy_write(phydev, MII_BCM54XX_EXP_SEL, MII_BCM54XX_EXP_SEL_ER | reg);
+        phy_write(phydev, MII_BCM54XX_EXP_DATA, value);
+}
+
+static void phy_write_misc(struct phy_device *phydev,
+                                        u16 reg, u16 chl, u16 value)
+{
+        int tmp;
+
+        phy_write(phydev, MII_BCM54XX_AUX_CTL, MII_BCM54XX_AUXCTL_SHDWSEL_MISC);
+
+        tmp = phy_read(phydev, MII_BCM54XX_AUX_CTL);
+        tmp |= MII_BCM54XX_AUXCTL_ACTL_SMDSP_ENA;
+        phy_write(phydev, MII_BCM54XX_AUX_CTL, tmp);
+
+        tmp = (chl * MII_BCM7XXX_CHANNEL_WIDTH) | reg;
+        phy_write(phydev, MII_BCM54XX_EXP_SEL, tmp);
+
+        phy_write(phydev, MII_BCM54XX_EXP_DATA, value);
+}
+
+static int bcm7xxx_28nm_afe_config_init(struct phy_device *phydev)
+{
+        /* write AFE_RXCONFIG_0 */
+        phy_write_misc(phydev, 0x38, 0x0000, 0xeb19);
+
+        /* write AFE_RXCONFIG_1 */
+        phy_write_misc(phydev, 0x38, 0x0001, 0x9a3f);
+
+        /* write AFE_RX_LP_COUNTER */
+        phy_write_misc(phydev, 0x38, 0x0003, 0x7fc7);
+
+        /* write AFE_HPF_TRIM_OTHERS */
+        phy_write_misc(phydev, 0x3A, 0x0000, 0x000b);
+
+        /* write AFTE_TX_CONFIG */
+        phy_write_misc(phydev, 0x39, 0x0000, 0x0800);
+
+        /* Increase VCO range to prevent unlocking problem of PLL at low
+         * temp
+         */
+        phy_write_misc(phydev, 0x0032, 0x0001, 0x0048);
+
+        /* Change Ki to 011 */
+        phy_write_misc(phydev, 0x0032, 0x0002, 0x021b);
+
+        /* Disable loading of TVCO buffer to bandgap, set bandgap trim
+         * to 111
+         */
+        phy_write_misc(phydev, 0x0033, 0x0000, 0x0e20);
+
+        /* Adjust bias current trim by -3 */
+        phy_write_misc(phydev, 0x000a, 0x0000, 0x690b);
+
+        /* Switch to CORE_BASE1E */
+        phy_write(phydev, MII_BCM7XXX_CORE_BASE1E, 0xd);
+
+        /* Reset R_CAL/RC_CAL Engine */
+        phy_write_exp(phydev, 0x00b0, 0x0010);
+
+        /* Disable Reset R_CAL/RC_CAL Engine */
+        phy_write_exp(phydev, 0x00b0, 0x0000);
+
+        return 0;
+}
+
+static int bcm7xxx_28nm_config_init(struct phy_device *phydev)
+{
+        int ret;
+
+        ret = bcm7445_config_init(phydev);
+        if (ret)
+                return ret;
+
+        return bcm7xxx_28nm_afe_config_init(phydev);
+}
+
+static int phy_set_clr_bits(struct phy_device *dev, int location,
+                                        int set_mask, int clr_mask)
+{
+        int v, ret;
+
+        v = phy_read(dev, location);
+        if (v < 0)
+                return v;
+
+        v &= ~clr_mask;
+        v |= set_mask;
+
+        ret = phy_write(dev, location, v);
+        if (ret < 0)
+                return ret;
+
+        return v;
+}
+
+static int bcm7xxx_config_init(struct phy_device *phydev)
+{
+        int ret;
+
+        /* Enable 64 clock MDIO */
+        phy_write(phydev, MII_BCM7XXX_AUX_MODE, MII_BCM7XX_64CLK_MDIO);
+        phy_read(phydev, MII_BCM7XXX_AUX_MODE);
+
+        /* Workaround only required for 100Mbits/sec */
+        if (!(phydev->dev_flags & PHY_BRCM_100MBPS_WAR))
+                return 0;
+
+        /* set shadow mode 2 */
+        ret = phy_set_clr_bits(phydev, MII_BCM7XXX_TEST,
+                        MII_BCM7XXX_SHD_MODE_2, MII_BCM7XXX_SHD_MODE_2);
+        if (ret < 0)
+                return ret;
+
+        /* set iddq_clkbias */
+        phy_write(phydev, MII_BCM7XXX_100TX_DISC, 0x0F00);
+        udelay(10);
+
+        /* reset iddq_clkbias */
+        phy_write(phydev, MII_BCM7XXX_100TX_DISC, 0x0C00);
+
+        phy_write(phydev, MII_BCM7XXX_100TX_FALSE_CAR, 0x7555);
+
+        /* reset shadow mode 2 */
+        ret = phy_set_clr_bits(phydev, MII_BCM7XXX_TEST, MII_BCM7XXX_SHD_MODE_2, 0);
+        if (ret < 0)
+                return ret;
+
+        return 0;
+}
+
+/* Workaround for putting the PHY in IDDQ mode, required
+ * for all BCM7XXX PHYs
+ */
+static int bcm7xxx_suspend(struct phy_device *phydev)
+{
+        int ret;
+        const struct bcm7xxx_regs {
+                int reg;
+                u16 value;
+        } bcm7xxx_suspend_cfg[] = {
+                { MII_BCM7XXX_TEST, 0x008b },
+                { MII_BCM7XXX_100TX_AUX_CTL, 0x01c0 },
+                { MII_BCM7XXX_100TX_DISC, 0x7000 },
+                { MII_BCM7XXX_TEST, 0x000f },
+                { MII_BCM7XXX_100TX_AUX_CTL, 0x20d0 },
+                { MII_BCM7XXX_TEST, 0x000b },
+        };
+        unsigned int i;
+
+        for (i = 0; i < ARRAY_SIZE(bcm7xxx_suspend_cfg); i++) {
+                ret = phy_write(phydev,
+                                bcm7xxx_suspend_cfg[i].reg,
+                                bcm7xxx_suspend_cfg[i].value);
+                if (ret)
+                        return ret;
+        }
+
+        return 0;
+}
+
+static int bcm7xxx_dummy_config_init(struct phy_device *phydev)
+{
+        return 0;
+}
+
+static struct phy_driver bcm7xxx_driver[] = {
+{
+        .phy_id         = PHY_ID_BCM7366,
+        .phy_id_mask    = 0xfffffff0,
+        .name           = "Broadcom BCM7366",
+        .features       = PHY_GBIT_FEATURES |
+                          SUPPORTED_Pause | SUPPORTED_Asym_Pause,
+        .flags          = PHY_IS_INTERNAL,
+        .config_init    = bcm7xxx_28nm_afe_config_init,
+        .config_aneg    = genphy_config_aneg,
+        .read_status    = genphy_read_status,
+        .suspend        = bcm7xxx_suspend,
+        .resume         = bcm7xxx_28nm_afe_config_init,
+        .driver         = { .owner = THIS_MODULE },
+}, {
+        .phy_id         = PHY_ID_BCM7439,
+        .phy_id_mask    = 0xfffffff0,
+        .name           = "Broadcom BCM7439",
+        .features       = PHY_GBIT_FEATURES |
+                          SUPPORTED_Pause | SUPPORTED_Asym_Pause,
+        .flags          = PHY_IS_INTERNAL,
+        .config_init    = bcm7xxx_28nm_afe_config_init,
+        .config_aneg    = genphy_config_aneg,
+        .read_status    = genphy_read_status,
+        .suspend        = bcm7xxx_suspend,
+        .resume         = bcm7xxx_28nm_afe_config_init,
+        .driver         = { .owner = THIS_MODULE },
+}, {
+        .phy_id         = PHY_ID_BCM7445,
+        .phy_id_mask    = 0xfffffff0,
+        .name           = "Broadcom BCM7445",
+        .features       = PHY_GBIT_FEATURES |
+                          SUPPORTED_Pause | SUPPORTED_Asym_Pause,
+        .flags          = PHY_IS_INTERNAL,
+        .config_init    = bcm7xxx_28nm_config_init,
+        .config_aneg    = genphy_config_aneg,
+        .read_status    = genphy_read_status,
+        .suspend        = bcm7xxx_suspend,
+        .resume         = bcm7xxx_28nm_config_init,
+        .driver         = { .owner = THIS_MODULE },
+}, {
+        .name           = "Broadcom BCM7XXX 28nm",
+        .phy_id         = PHY_ID_BCM7XXX_28,
+        .phy_id_mask    = PHY_BCM_OUI_MASK,
+        .features       = PHY_GBIT_FEATURES |
+                          SUPPORTED_Pause | SUPPORTED_Asym_Pause,
+        .flags          = PHY_IS_INTERNAL,
+        .config_init    = bcm7xxx_28nm_config_init,
+        .config_aneg    = genphy_config_aneg,
+        .read_status    = genphy_read_status,
+        .suspend        = bcm7xxx_suspend,
+        .resume         = bcm7xxx_28nm_config_init,
+        .driver         = { .owner = THIS_MODULE },
+}, {
+        .phy_id         = PHY_BCM_OUI_4,
+        .phy_id_mask    = 0xffff0000,
+        .name           = "Broadcom BCM7XXX 40nm",
+        .features       = PHY_GBIT_FEATURES |
+                          SUPPORTED_Pause | SUPPORTED_Asym_Pause,
+        .flags          = PHY_IS_INTERNAL,
+        .config_init    = bcm7xxx_config_init,
+        .config_aneg    = genphy_config_aneg,
+        .read_status    = genphy_read_status,
+        .suspend        = bcm7xxx_suspend,
+        .resume         = bcm7xxx_config_init,
+        .driver         = { .owner = THIS_MODULE },
+}, {
+        .phy_id         = PHY_BCM_OUI_5,
+        .phy_id_mask    = 0xffffff00,
+        .name           = "Broadcom BCM7XXX 65nm",
+        .features       = PHY_BASIC_FEATURES |
+                          SUPPORTED_Pause | SUPPORTED_Asym_Pause,
+        .flags          = PHY_IS_INTERNAL,
+        .config_init    = bcm7xxx_dummy_config_init,
+        .config_aneg    = genphy_config_aneg,
+        .read_status    = genphy_read_status,
+        .suspend        = bcm7xxx_suspend,
+        .resume         = bcm7xxx_config_init,
+        .driver         = { .owner = THIS_MODULE },
+} };
+
+static struct mdio_device_id __maybe_unused bcm7xxx_tbl[] = {
+        { PHY_ID_BCM7366, 0xfffffff0, },
+        { PHY_ID_BCM7439, 0xfffffff0, },
+        { PHY_ID_BCM7445, 0xfffffff0, },
+        { PHY_ID_BCM7XXX_28, 0xfffffc00 },
+        { PHY_BCM_OUI_4, 0xffff0000 },
+        { PHY_BCM_OUI_5, 0xffffff00 },
+        { }
+};
+
+static int __init bcm7xxx_phy_init(void)
+{
+        return phy_drivers_register(bcm7xxx_driver,
+                        ARRAY_SIZE(bcm7xxx_driver));
+}
+
+static void __exit bcm7xxx_phy_exit(void)
+{
+        phy_drivers_unregister(bcm7xxx_driver,
+                        ARRAY_SIZE(bcm7xxx_driver));
+}
+
+module_init(bcm7xxx_phy_init);
+module_exit(bcm7xxx_phy_exit);
+
+MODULE_DEVICE_TABLE(mdio, bcm7xxx_tbl);
+
+MODULE_DESCRIPTION("Broadcom BCM7xxx internal PHY driver");
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Broadcom Corporation");