net: pcnet: Add Kconfig entries
[platform/kernel/u-boot.git] / include / phy.h
index f23ca63..fedd146 100644 (file)
 #define _PHY_H
 
 #include <dm.h>
+#include <linux/errno.h>
 #include <linux/list.h>
 #include <linux/mii.h>
 #include <linux/ethtool.h>
 #include <linux/mdio.h>
+#include <log.h>
 #include <phy_interface.h>
 
 #define PHY_FIXED_ID           0xa5a55a5a
+#define PHY_NCSI_ID            0xbeefcafe
+
+/*
+ * There is no actual id for this.
+ * This is just a dummy id for gmii2rgmmi converter.
+ */
+#define PHY_GMII2RGMII_ID      0x5a5a5a5a
 
 #define PHY_MAX_ADDR 32
 
@@ -101,7 +110,18 @@ struct phy_driver {
        int (*readext)(struct phy_device *phydev, int addr, int devad, int reg);
        int (*writeext)(struct phy_device *phydev, int addr, int devad, int reg,
                        u16 val);
+
+       /* Phy specific driver override for reading a MMD register */
+       int (*read_mmd)(struct phy_device *phydev, int devad, int reg);
+
+       /* Phy specific driver override for writing a MMD register */
+       int (*write_mmd)(struct phy_device *phydev, int devad, int reg,
+                        u16 val);
+
        struct list_head list;
+
+       /* driver private data */
+       ulong data;
 };
 
 struct phy_device {
@@ -150,41 +170,263 @@ struct fixed_link {
        int asym_pause;
 };
 
+/**
+ * phy_read - Convenience function for reading a given PHY register
+ * @phydev: the phy_device struct
+ * @devad: The MMD to read from
+ * @regnum: register number to read
+ * @return: value for success or negative errno for failure
+ */
 static inline int phy_read(struct phy_device *phydev, int devad, int regnum)
 {
        struct mii_dev *bus = phydev->bus;
 
+       if (!bus || !bus->read) {
+               debug("%s: No bus configured\n", __func__);
+               return -1;
+       }
+
        return bus->read(bus, phydev->addr, devad, regnum);
 }
 
+/**
+ * phy_write - Convenience function for writing a given PHY register
+ * @phydev: the phy_device struct
+ * @devad: The MMD to read from
+ * @regnum: register number to write
+ * @val: value to write to @regnum
+ * @return: 0 for success or negative errno for failure
+ */
 static inline int phy_write(struct phy_device *phydev, int devad, int regnum,
                        u16 val)
 {
        struct mii_dev *bus = phydev->bus;
 
+       if (!bus || !bus->read) {
+               debug("%s: No bus configured\n", __func__);
+               return -1;
+       }
+
        return bus->write(bus, phydev->addr, devad, regnum, val);
 }
 
+/**
+ * phy_mmd_start_indirect - Convenience function for writing MMD registers
+ * @phydev: the phy_device struct
+ * @devad: The MMD to read from
+ * @regnum: register number to write
+ * @return: None
+ */
+static inline void phy_mmd_start_indirect(struct phy_device *phydev, int devad,
+                                         int regnum)
+{
+       /* Write the desired MMD Devad */
+       phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_CTRL, devad);
+
+       /* Write the desired MMD register address */
+       phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_DATA, regnum);
+
+       /* Select the Function : DATA with no post increment */
+       phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_CTRL,
+                 (devad | MII_MMD_CTRL_NOINCR));
+}
+
+/**
+ * phy_read_mmd - Convenience function for reading a register
+ * from an MMD on a given PHY.
+ * @phydev: The phy_device struct
+ * @devad: The MMD to read from
+ * @regnum: The register on the MMD to read
+ * @return: Value for success or negative errno for failure
+ */
+static inline int phy_read_mmd(struct phy_device *phydev, int devad,
+                              int regnum)
+{
+       struct phy_driver *drv = phydev->drv;
+
+       if (regnum > (u16)~0 || devad > 32)
+               return -EINVAL;
+
+       /* driver-specific access */
+       if (drv->read_mmd)
+               return drv->read_mmd(phydev, devad, regnum);
+
+       /* direct C45 / C22 access */
+       if ((drv->features & PHY_10G_FEATURES) == PHY_10G_FEATURES ||
+           devad == MDIO_DEVAD_NONE || !devad)
+               return phy_read(phydev, devad, regnum);
+
+       /* indirect C22 access */
+       phy_mmd_start_indirect(phydev, devad, regnum);
+
+       /* Read the content of the MMD's selected register */
+       return phy_read(phydev, MDIO_DEVAD_NONE, MII_MMD_DATA);
+}
+
+/**
+ * phy_write_mmd - Convenience function for writing a register
+ * on an MMD on a given PHY.
+ * @phydev: The phy_device struct
+ * @devad: The MMD to read from
+ * @regnum: The register on the MMD to read
+ * @val: value to write to @regnum
+ * @return: 0 for success or negative errno for failure
+ */
+static inline int phy_write_mmd(struct phy_device *phydev, int devad,
+                               int regnum, u16 val)
+{
+       struct phy_driver *drv = phydev->drv;
+
+       if (regnum > (u16)~0 || devad > 32)
+               return -EINVAL;
+
+       /* driver-specific access */
+       if (drv->write_mmd)
+               return drv->write_mmd(phydev, devad, regnum, val);
+
+       /* direct C45 / C22 access */
+       if ((drv->features & PHY_10G_FEATURES) == PHY_10G_FEATURES ||
+           devad == MDIO_DEVAD_NONE || !devad)
+               return phy_write(phydev, devad, regnum, val);
+
+       /* indirect C22 access */
+       phy_mmd_start_indirect(phydev, devad, regnum);
+
+       /* Write the data into MMD's selected register */
+       return phy_write(phydev, MDIO_DEVAD_NONE, MII_MMD_DATA, val);
+}
+
+/**
+ * phy_set_bits_mmd - Convenience function for setting bits in a register
+ * on MMD
+ * @phydev: the phy_device struct
+ * @devad: the MMD containing register to modify
+ * @regnum: register number to modify
+ * @val: bits to set
+ * @return: 0 for success or negative errno for failure
+ */
+static inline int phy_set_bits_mmd(struct phy_device *phydev, int devad,
+                                  u32 regnum, u16 val)
+{
+       int value, ret;
+
+       value = phy_read_mmd(phydev, devad, regnum);
+       if (value < 0)
+               return value;
+
+       value |= val;
+
+       ret = phy_write_mmd(phydev, devad, regnum, value);
+       if (ret < 0)
+               return ret;
+
+       return 0;
+}
+
+/**
+ * phy_clear_bits_mmd - Convenience function for clearing bits in a register
+ * on MMD
+ * @phydev: the phy_device struct
+ * @devad: the MMD containing register to modify
+ * @regnum: register number to modify
+ * @val: bits to clear
+ * @return: 0 for success or negative errno for failure
+ */
+static inline int phy_clear_bits_mmd(struct phy_device *phydev, int devad,
+                                    u32 regnum, u16 val)
+{
+       int value, ret;
+
+       value = phy_read_mmd(phydev, devad, regnum);
+       if (value < 0)
+               return value;
+
+       value &= ~val;
+
+       ret = phy_write_mmd(phydev, devad, regnum, value);
+       if (ret < 0)
+               return ret;
+
+       return 0;
+}
+
 #ifdef CONFIG_PHYLIB_10G
 extern struct phy_driver gen10g_driver;
 
-/* For now, XGMII is the only 10G interface */
+/*
+ * List all 10G interfaces here, the assumption being that PHYs on these
+ * interfaces are C45
+ */
 static inline int is_10g_interface(phy_interface_t interface)
 {
-       return interface == PHY_INTERFACE_MODE_XGMII;
+       return interface == PHY_INTERFACE_MODE_XGMII ||
+              interface == PHY_INTERFACE_MODE_USXGMII ||
+              interface == PHY_INTERFACE_MODE_XFI;
 }
 
 #endif
 
+/**
+ * phy_init() - Initializes the PHY drivers
+ * This function registers all available PHY drivers
+ *
+ * @return: 0 if OK, -ve on error
+ */
 int phy_init(void);
+
+/**
+ * phy_reset() - Resets the specified PHY
+ * Issues a reset of the PHY and waits for it to complete
+ *
+ * @phydev:    PHY to reset
+ * @return: 0 if OK, -ve on error
+ */
 int phy_reset(struct phy_device *phydev);
+
+/**
+ * phy_find_by_mask() - Searches for a PHY on the specified MDIO bus
+ * The function checks the PHY addresses flagged in phy_mask and returns a
+ * phy_device pointer if it detects a PHY.
+ * This function should only be called if just one PHY is expected to be present
+ * in the set of addresses flagged in phy_mask.  If multiple PHYs are present,
+ * it is undefined which of these PHYs is returned.
+ *
+ * @bus:       MII/MDIO bus to scan
+ * @phy_mask:  bitmap of PYH addresses to scan
+ * @interface: type of MAC-PHY interface
+ * @return: pointer to phy_device if a PHY is found, or NULL otherwise
+ */
 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
                phy_interface_t interface);
+
 #ifdef CONFIG_DM_ETH
+
+/**
+ * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
+ * @phydev:    PHY device
+ * @dev:       Ethernet device
+ */
 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev);
+
+/**
+ * phy_connect() - Creates a PHY device for the Ethernet interface
+ * Creates a PHY device for the PHY at the given address, if one doesn't exist
+ * already, and associates it with the Ethernet device.
+ * The function may be called with addr <= 0, in this case addr value is ignored
+ * and the bus is scanned to detect a PHY.  Scanning should only be used if only
+ * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
+ * which PHY is returned.
+ *
+ * @bus:       MII/MDIO bus that hosts the PHY
+ * @addr:      PHY address on MDIO bus
+ * @dev:       Ethernet device to associate to the PHY
+ * @interface: type of MAC-PHY interface
+ * @return: pointer to phy_device if a PHY is found, or NULL otherwise
+ */
 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
                                struct udevice *dev,
                                phy_interface_t interface);
+
 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 {
        if (ofnode_valid(phydev->node))
@@ -193,10 +435,33 @@ static inline ofnode phy_get_ofnode(struct phy_device *phydev)
                return dev_ofnode(phydev->dev);
 }
 #else
+
+/**
+ * phy_connect_dev() - Associates the given pair of PHY and Ethernet devices
+ * @phydev:    PHY device
+ * @dev:       Ethernet device
+ */
 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev);
+
+/**
+ * phy_connect() - Creates a PHY device for the Ethernet interface
+ * Creates a PHY device for the PHY at the given address, if one doesn't exist
+ * already, and associates it with the Ethernet device.
+ * The function may be called with addr <= 0, in this case addr value is ignored
+ * and the bus is scanned to detect a PHY.  Scanning should only be used if only
+ * one PHY is expected to be present on the MDIO bus, otherwise it is undefined
+ * which PHY is returned.
+ *
+ * @bus:       MII/MDIO bus that hosts the PHY
+ * @addr:      PHY address on MDIO bus
+ * @dev:       Ethernet device to associate to the PHY
+ * @interface: type of MAC-PHY interface
+ * @return: pointer to phy_device if a PHY is found, or NULL otherwise
+ */
 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
                                struct eth_device *dev,
                                phy_interface_t interface);
+
 static inline ofnode phy_get_ofnode(struct phy_device *phydev)
 {
        return ofnode_null();
@@ -241,6 +506,8 @@ int phy_vitesse_init(void);
 int phy_xilinx_init(void);
 int phy_mscc_init(void);
 int phy_fixed_init(void);
+int phy_ncsi_init(void);
+int phy_xilinx_gmii2rgmii_init(void);
 
 int board_phy_config(struct phy_device *phydev);
 int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
@@ -249,7 +516,7 @@ int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id);
  * phy_get_interface_by_name() - Look up a PHY interface name
  *
  * @str:       PHY interface name, e.g. "mii"
- * @return PHY_INTERFACE_MODE_... value, or -1 if not found
+ * @return: PHY_INTERFACE_MODE_... value, or -1 if not found
  */
 int phy_get_interface_by_name(const char *str);
 
@@ -257,6 +524,7 @@ int phy_get_interface_by_name(const char *str);
  * phy_interface_is_rgmii - Convenience function for testing if a PHY interface
  * is RGMII (all variants)
  * @phydev: the phy_device struct
+ * @return: true if MII bus is RGMII or false if it is not
  */
 static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
 {
@@ -268,6 +536,7 @@ static inline bool phy_interface_is_rgmii(struct phy_device *phydev)
  * phy_interface_is_sgmii - Convenience function for testing if a PHY interface
  * is SGMII (all variants)
  * @phydev: the phy_device struct
+ * @return: true if MII bus is SGMII or false if it is not
  */
 static inline bool phy_interface_is_sgmii(struct phy_device *phydev)
 {