Commit a7defa75 authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'add-phy-shared-storage' 



Michael Walle says:

====================
add phy shared storage

Introduce the concept of a shared PHY storage which can be used by some
QSGMII PHYs to ease initialization and access to global per-package
registers.

Changes since v2:
 - restore page to standard after reading the base address in the mscc
   driver, thanks Antoine.

Changes since v1:
 - fix typos and add a comment, thanks Florian.
 - check for "addr < 0" in phy_package_join()
 - remove multiple blank lines and make "checkpatch.pl --strict" happy

Changes since RFC:
 - check return code of kzalloc()
 - fix local variable ordering (reverse christmas tree)
 - add priv_size argument to phy_package_join()
 - add Tested-by tag, thanks Vladimir.
====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 857b4125 deb04e9c

drivers/net/phy/bcm54140.c

+11 −46
Original line number Diff line number Diff line
@@ -132,7 +132,6 @@ struct bcm54140_priv { 
	int port;

	int base_addr;

#if IS_ENABLED(CONFIG_HWMON)

	bool pkg_init;

	/* protect the alarm bits */

	struct mutex alarm_lock;

	u16 alarm;
@@ -407,36 +406,6 @@ static int bcm54140_enable_monitoring(struct phy_device *phydev) 
	return bcm_phy_modify_rdb(phydev, BCM54140_RDB_MON_CTRL, mask, set);

}



/* Check if one PHY has already done the init of the parts common to all PHYs

 * in the Quad PHY package.

 */

static bool bcm54140_is_pkg_init(struct phy_device *phydev)

{

	struct bcm54140_priv *priv = phydev->priv;

	struct mii_bus *bus = phydev->mdio.bus;

	int base_addr = priv->base_addr;

	struct phy_device *phy;

	int i;



	/* Quad PHY */

	for (i = 0; i < 4; i++) {

		phy = mdiobus_get_phy(bus, base_addr + i);

		if (!phy)

			continue;



		if ((phy->phy_id & phydev->drv->phy_id_mask) !=

		    (phydev->drv->phy_id & phydev->drv->phy_id_mask))

			continue;



		priv = phy->priv;



		if (priv && priv->pkg_init)

			return true;

	}



	return false;

}



static int bcm54140_probe_once(struct phy_device *phydev)

{

	struct device *hwmon;
@@ -457,38 +426,34 @@ static int bcm54140_probe_once(struct phy_device *phydev) 


static int bcm54140_base_read_rdb(struct phy_device *phydev, u16 rdb)

{

	struct bcm54140_priv *priv = phydev->priv;

	struct mii_bus *bus = phydev->mdio.bus;

	int ret;



	mutex_lock(&bus->mdio_lock);

	ret = __mdiobus_write(bus, priv->base_addr, MII_BCM54XX_RDB_ADDR, rdb);

	phy_lock_mdio_bus(phydev);

	ret = __phy_package_write(phydev, MII_BCM54XX_RDB_ADDR, rdb);

	if (ret < 0)

		goto out;



	ret = __mdiobus_read(bus, priv->base_addr, MII_BCM54XX_RDB_DATA);

	ret = __phy_package_read(phydev, MII_BCM54XX_RDB_DATA);



out:

	mutex_unlock(&bus->mdio_lock);

	phy_unlock_mdio_bus(phydev);

	return ret;

}



static int bcm54140_base_write_rdb(struct phy_device *phydev,

				   u16 rdb, u16 val)

{

	struct bcm54140_priv *priv = phydev->priv;

	struct mii_bus *bus = phydev->mdio.bus;

	int ret;



	mutex_lock(&bus->mdio_lock);

	ret = __mdiobus_write(bus, priv->base_addr, MII_BCM54XX_RDB_ADDR, rdb);

	phy_lock_mdio_bus(phydev);

	ret = __phy_package_write(phydev, MII_BCM54XX_RDB_ADDR, rdb);

	if (ret < 0)

		goto out;



	ret = __mdiobus_write(bus, priv->base_addr, MII_BCM54XX_RDB_DATA, val);

	ret = __phy_package_write(phydev, MII_BCM54XX_RDB_DATA, val);



out:

	mutex_unlock(&bus->mdio_lock);

	phy_unlock_mdio_bus(phydev);

	return ret;

}
@@ -618,16 +583,16 @@ static int bcm54140_probe(struct phy_device *phydev) 
	if (ret)

		return ret;



	devm_phy_package_join(&phydev->mdio.dev, phydev, priv->base_addr, 0);



#if IS_ENABLED(CONFIG_HWMON)

	mutex_init(&priv->alarm_lock);



	if (!bcm54140_is_pkg_init(phydev)) {

	if (phy_package_init_once(phydev)) {

		ret = bcm54140_probe_once(phydev);

		if (ret)

			return ret;

	}



	priv->pkg_init = true;

#endif



	phydev_dbg(phydev, "probed (port %d, base PHY address %d)\n",

drivers/net/phy/mdio_bus.c

+1 −0
Original line number Diff line number Diff line
@@ -614,6 +614,7 @@ int __mdiobus_register(struct mii_bus *bus, struct module *owner) 
	}



	mutex_init(&bus->mdio_lock);

	mutex_init(&bus->shared_lock);



	/* de-assert bus level PHY GPIO reset */

	gpiod = devm_gpiod_get_optional(&bus->dev, "reset", GPIOD_OUT_LOW);

drivers/net/phy/mscc/mscc.h

+0 −1
Original line number Diff line number Diff line
@@ -353,7 +353,6 @@ struct vsc8531_private { 
	const struct vsc85xx_hw_stat *hw_stats;

	u64 *stats;

	int nstats;

	bool pkg_init;

	/* For multiple port PHYs; the MDIO address of the base PHY in the

	 * package.

	 */

drivers/net/phy/mscc/mscc_main.c

+32 −69
Original line number Diff line number Diff line
@@ -691,27 +691,23 @@ out_unlock: 
/* phydev->bus->mdio_lock should be locked when using this function */

static int phy_base_write(struct phy_device *phydev, u32 regnum, u16 val)

{

	struct vsc8531_private *priv = phydev->priv;



	if (unlikely(!mutex_is_locked(&phydev->mdio.bus->mdio_lock))) {

		dev_err(&phydev->mdio.dev, "MDIO bus lock not held!\n");

		dump_stack();

	}



	return __mdiobus_write(phydev->mdio.bus, priv->base_addr, regnum, val);

	return __phy_package_write(phydev, regnum, val);

}



/* phydev->bus->mdio_lock should be locked when using this function */

static int phy_base_read(struct phy_device *phydev, u32 regnum)

{

	struct vsc8531_private *priv = phydev->priv;



	if (unlikely(!mutex_is_locked(&phydev->mdio.bus->mdio_lock))) {

		dev_err(&phydev->mdio.dev, "MDIO bus lock not held!\n");

		dump_stack();

	}



	return __mdiobus_read(phydev->mdio.bus, priv->base_addr, regnum);

	return __phy_package_read(phydev, regnum);

}



/* bus->mdio_lock should be locked when using this function */
@@ -1287,65 +1283,38 @@ out: 
	return ret;

}



/* Check if one PHY has already done the init of the parts common to all PHYs

 * in the Quad PHY package.

 */

static bool vsc8584_is_pkg_init(struct phy_device *phydev, bool reversed)

static void vsc8584_get_base_addr(struct phy_device *phydev)

{

	struct mii_bus *bus = phydev->mdio.bus;

	struct vsc8531_private *vsc8531;

	struct phy_device *phy;

	int i, addr;



	/* VSC8584 is a Quad PHY */

	for (i = 0; i < 4; i++) {

		vsc8531 = phydev->priv;



		if (reversed)

			addr = vsc8531->base_addr - i;

		else

			addr = vsc8531->base_addr + i;

	struct vsc8531_private *vsc8531 = phydev->priv;

	u16 val, addr;



		phy = mdiobus_get_phy(bus, addr);

		if (!phy)

			continue;

	mutex_lock(&phydev->mdio.bus->mdio_lock);

	__phy_write(phydev, MSCC_EXT_PAGE_ACCESS, MSCC_PHY_PAGE_EXTENDED);



		if ((phy->phy_id & phydev->drv->phy_id_mask) !=

		    (phydev->drv->phy_id & phydev->drv->phy_id_mask))

			continue;

	addr = __phy_read(phydev, MSCC_PHY_EXT_PHY_CNTL_4);

	addr >>= PHY_CNTL_4_ADDR_POS;



		vsc8531 = phy->priv;

	val = __phy_read(phydev, MSCC_PHY_ACTIPHY_CNTL);



		if (vsc8531 && vsc8531->pkg_init)

			return true;

	}

	__phy_write(phydev, MSCC_EXT_PAGE_ACCESS, MSCC_PHY_PAGE_STANDARD);

	mutex_unlock(&phydev->mdio.bus->mdio_lock);



	return false;

	if (val & PHY_ADDR_REVERSED)

		vsc8531->base_addr = phydev->mdio.addr + addr;

	else

		vsc8531->base_addr = phydev->mdio.addr - addr;

}



static int vsc8584_config_init(struct phy_device *phydev)

{

	struct vsc8531_private *vsc8531 = phydev->priv;

	u16 addr, val;

	int ret, i;

	u16 val;



	phydev->mdix_ctrl = ETH_TP_MDI_AUTO;



	mutex_lock(&phydev->mdio.bus->mdio_lock);



	__mdiobus_write(phydev->mdio.bus, phydev->mdio.addr,

			MSCC_EXT_PAGE_ACCESS, MSCC_PHY_PAGE_EXTENDED);

	addr = __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr,

			      MSCC_PHY_EXT_PHY_CNTL_4);

	addr >>= PHY_CNTL_4_ADDR_POS;



	val = __mdiobus_read(phydev->mdio.bus, phydev->mdio.addr,

			     MSCC_PHY_ACTIPHY_CNTL);

	if (val & PHY_ADDR_REVERSED)

		vsc8531->base_addr = phydev->mdio.addr + addr;

	else

		vsc8531->base_addr = phydev->mdio.addr - addr;



	/* Some parts of the init sequence are identical for every PHY in the

	 * package. Some parts are modifying the GPIO register bank which is a

	 * set of registers that are affecting all PHYs, a few resetting the
@@ -1359,7 +1328,7 @@ static int vsc8584_config_init(struct phy_device *phydev) 
	 * do the correct init sequence for all PHYs that are package-critical

	 * in this pre-init function.

	 */

	if (!vsc8584_is_pkg_init(phydev, val & PHY_ADDR_REVERSED ? 1 : 0)) {

	if (phy_package_init_once(phydev)) {

		/* The following switch statement assumes that the lowest

		 * nibble of the phy_id_mask is always 0. This works because

		 * the lowest nibble of the PHY_ID's below are also 0.
@@ -1388,8 +1357,6 @@ static int vsc8584_config_init(struct phy_device *phydev) 
			goto err;

	}



	vsc8531->pkg_init = true;



	phy_base_write(phydev, MSCC_EXT_PAGE_ACCESS,

		       MSCC_PHY_PAGE_EXTENDED_GPIO);
@@ -1427,7 +1394,8 @@ static int vsc8584_config_init(struct phy_device *phydev) 


	/* Disable SerDes for 100Base-FX */

	ret = vsc8584_cmd(phydev, PROC_CMD_FIBER_MEDIA_CONF |

			  PROC_CMD_FIBER_PORT(addr) | PROC_CMD_FIBER_DISABLE |

			  PROC_CMD_FIBER_PORT(vsc8531->base_addr) |

			  PROC_CMD_FIBER_DISABLE |

			  PROC_CMD_READ_MOD_WRITE_PORT |

			  PROC_CMD_RST_CONF_PORT | PROC_CMD_FIBER_100BASE_FX);

	if (ret)
@@ -1435,7 +1403,8 @@ static int vsc8584_config_init(struct phy_device *phydev) 


	/* Disable SerDes for 1000Base-X */

	ret = vsc8584_cmd(phydev, PROC_CMD_FIBER_MEDIA_CONF |

			  PROC_CMD_FIBER_PORT(addr) | PROC_CMD_FIBER_DISABLE |

			  PROC_CMD_FIBER_PORT(vsc8531->base_addr) |

			  PROC_CMD_FIBER_DISABLE |

			  PROC_CMD_READ_MOD_WRITE_PORT |

			  PROC_CMD_RST_CONF_PORT | PROC_CMD_FIBER_1000BASE_X);

	if (ret)
@@ -1750,26 +1719,14 @@ static int vsc8514_config_init(struct phy_device *phydev) 
{

	struct vsc8531_private *vsc8531 = phydev->priv;

	unsigned long deadline;

	u16 val, addr;

	int ret, i;

	u16 val;

	u32 reg;



	phydev->mdix_ctrl = ETH_TP_MDI_AUTO;



	mutex_lock(&phydev->mdio.bus->mdio_lock);



	__phy_write(phydev, MSCC_EXT_PAGE_ACCESS, MSCC_PHY_PAGE_EXTENDED);



	addr = __phy_read(phydev, MSCC_PHY_EXT_PHY_CNTL_4);

	addr >>= PHY_CNTL_4_ADDR_POS;



	val = __phy_read(phydev, MSCC_PHY_ACTIPHY_CNTL);



	if (val & PHY_ADDR_REVERSED)

		vsc8531->base_addr = phydev->mdio.addr + addr;

	else

		vsc8531->base_addr = phydev->mdio.addr - addr;



	/* Some parts of the init sequence are identical for every PHY in the

	 * package. Some parts are modifying the GPIO register bank which is a

	 * set of registers that are affecting all PHYs, a few resetting the
@@ -1781,11 +1738,9 @@ static int vsc8514_config_init(struct phy_device *phydev) 
	 * do the correct init sequence for all PHYs that are package-critical

	 * in this pre-init function.

	 */

	if (!vsc8584_is_pkg_init(phydev, val & PHY_ADDR_REVERSED ? 1 : 0))

	if (phy_package_init_once(phydev))

		vsc8514_config_pre_init(phydev);



	vsc8531->pkg_init = true;



	phy_base_write(phydev, MSCC_EXT_PAGE_ACCESS,

		       MSCC_PHY_PAGE_EXTENDED_GPIO);
@@ -1991,6 +1946,10 @@ static int vsc8514_probe(struct phy_device *phydev) 


	phydev->priv = vsc8531;



	vsc8584_get_base_addr(phydev);

	devm_phy_package_join(&phydev->mdio.dev, phydev,

			      vsc8531->base_addr, 0);



	vsc8531->nleds = 4;

	vsc8531->supp_led_modes = VSC85XX_SUPP_LED_MODES;

	vsc8531->hw_stats = vsc85xx_hw_stats;
@@ -2046,6 +2005,10 @@ static int vsc8584_probe(struct phy_device *phydev) 


	phydev->priv = vsc8531;



	vsc8584_get_base_addr(phydev);

	devm_phy_package_join(&phydev->mdio.dev, phydev,

			      vsc8531->base_addr, 0);



	vsc8531->nleds = 4;

	vsc8531->supp_led_modes = VSC8584_SUPP_LED_MODES;

	vsc8531->hw_stats = vsc8584_hw_stats;

drivers/net/phy/phy_device.c

+138 −0
Original line number Diff line number Diff line
@@ -1461,6 +1461,144 @@ bool phy_driver_is_genphy_10g(struct phy_device *phydev) 
}

EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);



/**

 * phy_package_join - join a common PHY group

 * @phydev: target phy_device struct

 * @addr: cookie and PHY address for global register access

 * @priv_size: if non-zero allocate this amount of bytes for private data

 *

 * This joins a PHY group and provides a shared storage for all phydevs in

 * this group. This is intended to be used for packages which contain

 * more than one PHY, for example a quad PHY transceiver.

 *

 * The addr parameter serves as a cookie which has to have the same value

 * for all members of one group and as a PHY address to access generic

 * registers of a PHY package. Usually, one of the PHY addresses of the

 * different PHYs in the package provides access to these global registers.

 * The address which is given here, will be used in the phy_package_read()

 * and phy_package_write() convenience functions. If your PHY doesn't have

 * global registers you can just pick any of the PHY addresses.

 *

 * This will set the shared pointer of the phydev to the shared storage.

 * If this is the first call for a this cookie the shared storage will be

 * allocated. If priv_size is non-zero, the given amount of bytes are

 * allocated for the priv member.

 *

 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()

 * with the same cookie but a different priv_size is an error.

 */

int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)

{

	struct mii_bus *bus = phydev->mdio.bus;

	struct phy_package_shared *shared;

	int ret;



	if (addr < 0 || addr >= PHY_MAX_ADDR)

		return -EINVAL;



	mutex_lock(&bus->shared_lock);

	shared = bus->shared[addr];

	if (!shared) {

		ret = -ENOMEM;

		shared = kzalloc(sizeof(*shared), GFP_KERNEL);

		if (!shared)

			goto err_unlock;

		if (priv_size) {

			shared->priv = kzalloc(priv_size, GFP_KERNEL);

			if (!shared->priv)

				goto err_free;

			shared->priv_size = priv_size;

		}

		shared->addr = addr;

		refcount_set(&shared->refcnt, 1);

		bus->shared[addr] = shared;

	} else {

		ret = -EINVAL;

		if (priv_size && priv_size != shared->priv_size)

			goto err_unlock;

		refcount_inc(&shared->refcnt);

	}

	mutex_unlock(&bus->shared_lock);



	phydev->shared = shared;



	return 0;



err_free:

	kfree(shared);

err_unlock:

	mutex_unlock(&bus->shared_lock);

	return ret;

}

EXPORT_SYMBOL_GPL(phy_package_join);



/**

 * phy_package_leave - leave a common PHY group

 * @phydev: target phy_device struct

 *

 * This leaves a PHY group created by phy_package_join(). If this phydev

 * was the last user of the shared data between the group, this data is

 * freed. Resets the phydev->shared pointer to NULL.

 */

void phy_package_leave(struct phy_device *phydev)

{

	struct phy_package_shared *shared = phydev->shared;

	struct mii_bus *bus = phydev->mdio.bus;



	if (!shared)

		return;



	if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {

		bus->shared[shared->addr] = NULL;

		mutex_unlock(&bus->shared_lock);

		kfree(shared->priv);

		kfree(shared);

	}



	phydev->shared = NULL;

}

EXPORT_SYMBOL_GPL(phy_package_leave);



static void devm_phy_package_leave(struct device *dev, void *res)

{

	phy_package_leave(*(struct phy_device **)res);

}



/**

 * devm_phy_package_join - resource managed phy_package_join()

 * @dev: device that is registering this PHY package

 * @phydev: target phy_device struct

 * @addr: cookie and PHY address for global register access

 * @priv_size: if non-zero allocate this amount of bytes for private data

 *

 * Managed phy_package_join(). Shared storage fetched by this function,

 * phy_package_leave() is automatically called on driver detach. See

 * phy_package_join() for more information.

 */

int devm_phy_package_join(struct device *dev, struct phy_device *phydev,

			  int addr, size_t priv_size)

{

	struct phy_device **ptr;

	int ret;



	ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),

			   GFP_KERNEL);

	if (!ptr)

		return -ENOMEM;



	ret = phy_package_join(phydev, addr, priv_size);



	if (!ret) {

		*ptr = phydev;

		devres_add(dev, ptr);

	} else {

		devres_free(ptr);

	}



	return ret;

}

EXPORT_SYMBOL_GPL(devm_phy_package_join);



/**

 * phy_detach - detach a PHY device from its network device

 * @phydev: target phy_device struct

CRA Git | Maintained and supported by SUSTech CRA and CCSE