pch_gbe: Add MinnowBoard support

The MinnowBoard uses an AR803x PHY with the PCH GBE which requires
special handling. Use the MinnowBoard PCI Subsystem ID to detect this
and add a pci_device_id.driver_data structure and functions to handle
platform setup.

The AR803x does not implement the RGMII 2ns TX clock delay in the trace
routing nor via strapping. Add a detection method for the board and the
PHY and enable the TX clock delay via the registers.

This PHY will hibernate without link for 10 seconds. Ensure the PHY is
awake for probe and then disable hibernation. A future improvement would
be to convert pch_gbe to using PHYLIB and making sure we can wake the
PHY at the necessary times rather than permanently disabling it.

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: Peter Waskiewicz <peter.p.waskiewicz.jr@intel.com>
Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Joe Perches <joe@perches.com>
Cc: netdev@vger.kernel.org

4 files changed, 163 insertions, 0 deletions

diff --git a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe.h b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe.h
index 7779036690cc..6797b1075874 100644
--- a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe.h
+++ b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe.h
@@ -582,6 +582,19 @@ struct pch_gbe_hw_stats {
 };
 
 /**
+ * struct pch_gbe_privdata - PCI Device ID driver data
+ * @phy_tx_clk_delay:           Bool, configure the PHY TX delay in software
+ * @phy_disable_hibernate:      Bool, disable PHY hibernation
+ * @platform_init:              Platform initialization callback, called from
+ *                              probe, prior to PHY initialization.
+ */
+struct pch_gbe_privdata {
+        bool phy_tx_clk_delay;
+        bool phy_disable_hibernate;
+        int (*platform_init)(struct pci_dev *pdev);
+};
+
+/**
  * struct pch_gbe_adapter - board specific private data structure
  * @stats_lock: Spinlock structure for status
  * @ethtool_lock:       Spinlock structure for ethtool
@@ -604,6 +617,7 @@ struct pch_gbe_hw_stats {
  * @rx_buffer_len:      Receive buffer length
  * @tx_queue_len:       Transmit queue length
  * @have_msi:           PCI MSI mode flag
+ * @pch_gbe_privdata:   PCI Device ID driver_data
  */
 
 struct pch_gbe_adapter {
@@ -631,6 +645,7 @@ struct pch_gbe_adapter {
         int hwts_tx_en;
         int hwts_rx_en;
         struct pci_dev *ptp_pdev;
+        struct pch_gbe_privdata *pdata;
 };
 
 #define pch_gbe_hw_to_adapter(hw)       container_of(hw, struct pch_gbe_adapter, hw)
diff --git a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_main.c b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_main.c
index 749ddd918282..e19f1be60d5e 100644
--- a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_main.c
+++ b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_main.c
@@ -23,6 +23,7 @@
 #include <linux/module.h>
 #include <linux/net_tstamp.h>
 #include <linux/ptp_classify.h>
+#include <linux/gpio.h>
 
 #define DRV_VERSION     "1.01"
 const char pch_driver_version[] = DRV_VERSION;
@@ -111,6 +112,8 @@ const char pch_driver_version[] = DRV_VERSION;
 #define PTP_L4_MULTICAST_SA "01:00:5e:00:01:81"
 #define PTP_L2_MULTICAST_SA "01:1b:19:00:00:00"
 
+#define MINNOW_PHY_RESET_GPIO           13
+
 static unsigned int copybreak __read_mostly = PCH_GBE_COPYBREAK_DEFAULT;
 
 static int pch_gbe_mdio_read(struct net_device *netdev, int addr, int reg);
@@ -2635,6 +2638,9 @@ static int pch_gbe_probe(struct pci_dev *pdev,
         adapter->pdev = pdev;
         adapter->hw.back = adapter;
         adapter->hw.reg = pcim_iomap_table(pdev)[PCH_GBE_PCI_BAR];
+        adapter->pdata = (struct pch_gbe_privdata *)pci_id->driver_data;
+        if (adapter->pdata && adapter->pdata->platform_init)
+                adapter->pdata->platform_init(pdev);
 
         adapter->ptp_pdev = pci_get_bus_and_slot(adapter->pdev->bus->number,
                                                PCI_DEVFN(12, 4));
@@ -2710,6 +2716,10 @@ static int pch_gbe_probe(struct pci_dev *pdev,
 
         dev_dbg(&pdev->dev, "PCH Network Connection\n");
 
+        /* Disable hibernation on certain platforms */
+        if (adapter->pdata && adapter->pdata->phy_disable_hibernate)
+                pch_gbe_phy_disable_hibernate(&adapter->hw);
+
         device_set_wakeup_enable(&pdev->dev, 1);
         return 0;
 
@@ -2720,9 +2730,48 @@ err_free_netdev:
         return ret;
 }
 
+/* The AR803X PHY on the MinnowBoard requires a physical pin to be toggled to
+ * ensure it is awake for probe and init. Request the line and reset the PHY.
+ */
+static int pch_gbe_minnow_platform_init(struct pci_dev *pdev)
+{
+        unsigned long flags = GPIOF_DIR_OUT | GPIOF_INIT_HIGH | GPIOF_EXPORT;
+        unsigned gpio = MINNOW_PHY_RESET_GPIO;
+        int ret;
+
+        ret = devm_gpio_request_one(&pdev->dev, gpio, flags,
+                                    "minnow_phy_reset");
+        if (ret) {
+                dev_err(&pdev->dev,
+                        "ERR: Can't request PHY reset GPIO line '%d'\n", gpio);
+                return ret;
+        }
+
+        gpio_set_value(gpio, 0);
+        usleep_range(1250, 1500);
+        gpio_set_value(gpio, 1);
+        usleep_range(1250, 1500);
+
+        return ret;
+}
+
+static struct pch_gbe_privdata pch_gbe_minnow_privdata = {
+        .phy_tx_clk_delay = true,
+        .phy_disable_hibernate = true,
+        .platform_init = pch_gbe_minnow_platform_init,
+};
+
 static DEFINE_PCI_DEVICE_TABLE(pch_gbe_pcidev_id) = {
         {.vendor = PCI_VENDOR_ID_INTEL,
          .device = PCI_DEVICE_ID_INTEL_IOH1_GBE,
+         .subvendor = PCI_VENDOR_ID_CIRCUITCO,
+         .subdevice = PCI_SUBSYSTEM_ID_CIRCUITCO_MINNOWBOARD,
+         .class = (PCI_CLASS_NETWORK_ETHERNET << 8),
+         .class_mask = (0xFFFF00),
+         .driver_data = (kernel_ulong_t)&pch_gbe_minnow_privdata
+         },
+        {.vendor = PCI_VENDOR_ID_INTEL,
+         .device = PCI_DEVICE_ID_INTEL_IOH1_GBE,
          .subvendor = PCI_ANY_ID,
          .subdevice = PCI_ANY_ID,
          .class = (PCI_CLASS_NETWORK_ETHERNET << 8),
diff --git a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.c b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.c
index da079073a6c6..8b7ff75fc8e0 100644
--- a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.c
+++ b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.c
@@ -74,6 +74,15 @@
 #define MII_SR_100X_FD_CAPS      0x4000 /* 100X  Full Duplex Capable */
 #define MII_SR_100T4_CAPS        0x8000 /* 100T4 Capable */
 
+/* AR8031 PHY Debug Registers */
+#define PHY_AR803X_ID           0x00001374
+#define PHY_AR8031_DBG_OFF      0x1D
+#define PHY_AR8031_DBG_DAT      0x1E
+#define PHY_AR8031_SERDES       0x05
+#define PHY_AR8031_HIBERNATE    0x0B
+#define PHY_AR8031_SERDES_TX_CLK_DLY   0x0100 /* TX clock delay of 2.0ns */
+#define PHY_AR8031_PS_HIB_EN           0x8000 /* Hibernate enable */
+
 /* Phy Id Register (word 2) */
 #define PHY_REVISION_MASK        0x000F
 
@@ -249,6 +258,51 @@ void pch_gbe_phy_set_rgmii(struct pch_gbe_hw *hw)
 }
 
 /**
+ * pch_gbe_phy_tx_clk_delay - Setup TX clock delay via the PHY
+ * @hw:             Pointer to the HW structure
+ * Returns
+ *      0:              Successful.
+ *      -EINVAL:        Invalid argument.
+ */
+static int pch_gbe_phy_tx_clk_delay(struct pch_gbe_hw *hw)
+{
+        /* The RGMII interface requires a ~2ns TX clock delay. This is typically
+         * done in layout with a longer trace or via PHY strapping, but can also
+         * be done via PHY configuration registers.
+         */
+        struct pch_gbe_adapter *adapter = pch_gbe_hw_to_adapter(hw);
+        u16 mii_reg;
+        int ret = 0;
+
+        switch (hw->phy.id) {
+        case PHY_AR803X_ID:
+                netdev_dbg(adapter->netdev,
+                           "Configuring AR803X PHY for 2ns TX clock delay\n");
+                pch_gbe_phy_read_reg_miic(hw, PHY_AR8031_DBG_OFF, &mii_reg);
+                ret = pch_gbe_phy_write_reg_miic(hw, PHY_AR8031_DBG_OFF,
+                                                 PHY_AR8031_SERDES);
+                if (ret)
+                        break;
+
+                pch_gbe_phy_read_reg_miic(hw, PHY_AR8031_DBG_DAT, &mii_reg);
+                mii_reg |= PHY_AR8031_SERDES_TX_CLK_DLY;
+                ret = pch_gbe_phy_write_reg_miic(hw, PHY_AR8031_DBG_DAT,
+                                                 mii_reg);
+                break;
+        default:
+                netdev_err(adapter->netdev,
+                           "Unknown PHY (%x), could not set TX clock delay\n",
+                           hw->phy.id);
+                return -EINVAL;
+        }
+
+        if (ret)
+                netdev_err(adapter->netdev,
+                           "Could not configure tx clock delay for PHY\n");
+        return ret;
+}
+
+/**
  * pch_gbe_phy_init_setting - PHY initial setting
  * @hw:             Pointer to the HW structure
  */
@@ -277,4 +331,48 @@ void pch_gbe_phy_init_setting(struct pch_gbe_hw *hw)
         pch_gbe_phy_read_reg_miic(hw, PHY_PHYSP_CONTROL, &mii_reg);
         mii_reg |= PHYSP_CTRL_ASSERT_CRS_TX;
         pch_gbe_phy_write_reg_miic(hw, PHY_PHYSP_CONTROL, mii_reg);
+
+        /* Setup a TX clock delay on certain platforms */
+        if (adapter->pdata && adapter->pdata->phy_tx_clk_delay)
+                pch_gbe_phy_tx_clk_delay(hw);
+}
+
+/**
+ * pch_gbe_phy_disable_hibernate - Disable the PHY low power state
+ * @hw:             Pointer to the HW structure
+ * Returns
+ *      0:              Successful.
+ *      -EINVAL:        Invalid argument.
+ */
+int pch_gbe_phy_disable_hibernate(struct pch_gbe_hw *hw)
+{
+        struct pch_gbe_adapter *adapter = pch_gbe_hw_to_adapter(hw);
+        u16 mii_reg;
+        int ret = 0;
+
+        switch (hw->phy.id) {
+        case PHY_AR803X_ID:
+                netdev_dbg(adapter->netdev,
+                           "Disabling hibernation for AR803X PHY\n");
+                ret = pch_gbe_phy_write_reg_miic(hw, PHY_AR8031_DBG_OFF,
+                                                 PHY_AR8031_HIBERNATE);
+                if (ret)
+                        break;
+
+                pch_gbe_phy_read_reg_miic(hw, PHY_AR8031_DBG_DAT, &mii_reg);
+                mii_reg &= ~PHY_AR8031_PS_HIB_EN;
+                ret = pch_gbe_phy_write_reg_miic(hw, PHY_AR8031_DBG_DAT,
+                                                 mii_reg);
+                break;
+        default:
+                netdev_err(adapter->netdev,
+                           "Unknown PHY (%x), could not disable hibernation\n",
+                           hw->phy.id);
+                return -EINVAL;
+        }
+
+        if (ret)
+                netdev_err(adapter->netdev,
+                           "Could not disable PHY hibernation\n");
+        return ret;
 }
diff --git a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.h b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.h
index 03264dc7b5ec..0cbe69206e04 100644
--- a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.h
+++ b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.h
@@ -33,5 +33,6 @@ void pch_gbe_phy_power_up(struct pch_gbe_hw *hw);
 void pch_gbe_phy_power_down(struct pch_gbe_hw *hw);
 void pch_gbe_phy_set_rgmii(struct pch_gbe_hw *hw);
 void pch_gbe_phy_init_setting(struct pch_gbe_hw *hw);
+int pch_gbe_phy_disable_hibernate(struct pch_gbe_hw *hw);
 
 #endif /* _PCH_GBE_PHY_H_ */