Commit f2bc8ad3 authored by Andrew Lunn's avatar Andrew Lunn Committed by David S. Miller
Browse files

net: ethtool: Allow PHY cable test TDR data to configured 



Allow the user to configure where on the cable the TDR data should be
retrieved, in terms of first and last sample, and the step between
samples. Also add the ability to ask for TDR data for just one pair.

If this configuration is not provided, it defaults to 1-150m at 1m
intervals for all pairs.

Signed-off-by: default avatarAndrew Lunn <andrew@lunn.ch>

v3:
Move the TDR configuration into a structure
Add a range check on step
Use NL_SET_ERR_MSG_ATTR() when appropriate
Move TDR configuration into a nest
Document attributes in the request

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 0c9bcc1d

Documentation/networking/ethtool-netlink.rst

+19 −3
Original line number Diff line number Diff line
@@ -1023,9 +1023,25 @@ Start a cable test and report raw TDR data 


Request contents:



  ====================================  ======  ==========================

  ``ETHTOOL_A_CABLE_TEST_TDR_HEADER``   nested  request header

  ====================================  ======  ==========================

 +--------------------------------------------+--------+-----------------------+

 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER``        | nested | reply header          |

 +--------------------------------------------+--------+-----------------------+

 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG``           | nested | test configuration    |

 +-+------------------------------------------+--------+-----------------------+

 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE `` | u32    | first data distance   |

 +-+-+----------------------------------------+--------+-----------------------+

 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE ``  | u32    | last data distance    |

 +-+-+----------------------------------------+--------+-----------------------+

 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE ``  | u32    | distance of each step |

 +-+-+----------------------------------------+--------+-----------------------+

 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR``    | u8     | pair to test          |

 +-+-+----------------------------------------+--------+-----------------------+



The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members

of the nest. All distances are expressed in centimeters. The PHY takes

the distances as a guide, and rounds to the nearest distance it

actually supports. If a pair is passed, only that one pair will be

tested. Otherwise all pairs are tested.



Notification contents:

drivers/net/phy/marvell.c

+42 −17
Original line number Diff line number Diff line
@@ -198,6 +198,7 @@ 
#define MII_VCT5_CTRL_PEEK_HYST_DEFAULT			3



#define MII_VCT5_SAMPLE_POINT_DISTANCE		0x18

#define MII_VCT5_SAMPLE_POINT_DISTANCE_MAX	511

#define MII_VCT5_TX_PULSE_CTRL			0x1c

#define MII_VCT5_TX_PULSE_CTRL_DONT_WAIT_LINK_DOWN	BIT(12)

#define MII_VCT5_TX_PULSE_CTRL_PULSE_WIDTH_128nS	(0x0 << 10)
@@ -270,6 +271,10 @@ struct marvell_priv { 
	char *hwmon_name;

	struct device *hwmon_dev;

	bool cable_test_tdr;

	u32 first;

	u32 last;

	u32 step;

	s8 pair;

};



static int marvell_read_page(struct phy_device *phydev)
@@ -1787,12 +1792,18 @@ static u32 marvell_vct5_distance2cm(int distance) 
	return distance * 805 / 10;

}



static u32 marvell_vct5_cm2distance(int cm)

{

	return cm * 10 / 805;

}



static int marvell_vct5_amplitude_distance(struct phy_device *phydev,

					   int distance)

					   int distance, int pair)

{

	int mV_pair0, mV_pair1, mV_pair2, mV_pair3;

	u16 reg;

	int err;

	int mV;

	int i;



	err = phy_write_paged(phydev, MII_MARVELL_VCT5_PAGE,

			      MII_VCT5_SAMPLE_POINT_DISTANCE,
@@ -1814,21 +1825,20 @@ static int marvell_vct5_amplitude_distance(struct phy_device *phydev, 
	if (err)

		return err;



	mV_pair0 = marvell_vct5_amplitude(phydev, 0);

	mV_pair1 = marvell_vct5_amplitude(phydev, 1);

	mV_pair2 = marvell_vct5_amplitude(phydev, 2);

	mV_pair3 = marvell_vct5_amplitude(phydev, 3);

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

		if (pair != PHY_PAIR_ALL && i != pair)

			continue;



	ethnl_cable_test_amplitude(phydev, ETHTOOL_A_CABLE_PAIR_A, mV_pair0);

	ethnl_cable_test_amplitude(phydev, ETHTOOL_A_CABLE_PAIR_B, mV_pair1);

	ethnl_cable_test_amplitude(phydev, ETHTOOL_A_CABLE_PAIR_C, mV_pair2);

	ethnl_cable_test_amplitude(phydev, ETHTOOL_A_CABLE_PAIR_D, mV_pair3);

		mV = marvell_vct5_amplitude(phydev, i);

		ethnl_cable_test_amplitude(phydev, i, mV);

	}



	return 0;

}



static int marvell_vct5_amplitude_graph(struct phy_device *phydev)

{

	struct marvell_priv *priv = phydev->priv;

	int distance;

	int err;

	u16 reg;
@@ -1843,8 +1853,11 @@ static int marvell_vct5_amplitude_graph(struct phy_device *phydev) 
	if (err)

		return err;



	for (distance = 0; distance <= 100; distance++) {

		err = marvell_vct5_amplitude_distance(phydev, distance);

	for (distance = priv->first;

	     distance <= priv->last;

	     distance += priv->step) {

		err = marvell_vct5_amplitude_distance(phydev, distance,

						      priv->pair);

		if (err)

			return err;

	}
@@ -1918,11 +1931,24 @@ static int marvell_vct7_cable_test_start(struct phy_device *phydev) 
			       MII_VCT7_CTRL_CENTIMETERS);

}



static int marvell_vct5_cable_test_tdr_start(struct phy_device *phydev)

static int marvell_vct5_cable_test_tdr_start(struct phy_device *phydev,

					     const struct phy_tdr_config *cfg)

{

	struct marvell_priv *priv = phydev->priv;

	int ret;



	priv->cable_test_tdr = true;

	priv->first = marvell_vct5_cm2distance(cfg->first);

	priv->last = marvell_vct5_cm2distance(cfg->last);

	priv->step = marvell_vct5_cm2distance(cfg->step);

	priv->pair = cfg->pair;



	if (priv->first > MII_VCT5_SAMPLE_POINT_DISTANCE_MAX)

		return -EINVAL;



	if (priv->last > MII_VCT5_SAMPLE_POINT_DISTANCE_MAX)

		return -EINVAL;



	/* Disable  VCT7 */

	ret = phy_write_paged(phydev, MII_MARVELL_VCT7_PAGE,

			      MII_VCT7_CTRL, 0);
@@ -1933,15 +1959,14 @@ static int marvell_vct5_cable_test_tdr_start(struct phy_device *phydev) 
	if (ret)

		return ret;



	priv->cable_test_tdr = true;

	ret = ethnl_cable_test_pulse(phydev, 1000);

	if (ret)

		return ret;



	return ethnl_cable_test_step(phydev,

				     marvell_vct5_distance2cm(0),

				     marvell_vct5_distance2cm(100),

				     marvell_vct5_distance2cm(1));

				     marvell_vct5_distance2cm(priv->first),

				     marvell_vct5_distance2cm(priv->last),

				     marvell_vct5_distance2cm(priv->step));

}



static int marvell_vct7_distance_to_length(int distance, bool meter)

drivers/net/phy/phy.c

+3 −2
Original line number Diff line number Diff line
@@ -553,7 +553,8 @@ out: 
EXPORT_SYMBOL(phy_start_cable_test);



int phy_start_cable_test_tdr(struct phy_device *phydev,

			     struct netlink_ext_ack *extack)

			     struct netlink_ext_ack *extack,

			     const struct phy_tdr_config *config)

{

	struct net_device *dev = phydev->attached_dev;

	int err = -ENOMEM;
@@ -590,7 +591,7 @@ int phy_start_cable_test_tdr(struct phy_device *phydev, 
	phy_link_down(phydev);



	netif_testing_on(dev);

	err = phydev->drv->cable_test_tdr_start(phydev);

	err = phydev->drv->cable_test_tdr_start(phydev, config);

	if (err) {

		netif_testing_off(dev);

		phy_link_up(phydev);

include/linux/phy.h

+18 −3
Original line number Diff line number Diff line
@@ -548,6 +548,18 @@ struct phy_device { 
#define to_phy_device(d) container_of(to_mdio_device(d), \

				      struct phy_device, mdio)



/* A structure containing possible configuration parameters

 * for a TDR cable test. The driver does not need to implement

 * all the parameters, but should report what is actually used.

 */

struct phy_tdr_config {

	u32 first;

	u32 last;

	u32 step;

	s8 pair;

};

#define PHY_PAIR_ALL -1



/* struct phy_driver: Driver structure for a particular PHY type

 *

 * driver_data: static driver data
@@ -701,7 +713,8 @@ struct phy_driver { 
	int (*cable_test_start)(struct phy_device *dev);



	/* Start a raw TDR cable test */

	int (*cable_test_tdr_start)(struct phy_device *dev);

	int (*cable_test_tdr_start)(struct phy_device *dev,

				    const struct phy_tdr_config *config);



	/* Once per second, or on interrupt, request the status of the

	 * test.
@@ -1256,7 +1269,8 @@ int phy_reset_after_clk_enable(struct phy_device *phydev); 
int phy_start_cable_test(struct phy_device *phydev,

			 struct netlink_ext_ack *extack);

int phy_start_cable_test_tdr(struct phy_device *phydev,

			     struct netlink_ext_ack *extack);

			     struct netlink_ext_ack *extack,

			     const struct phy_tdr_config *config);

#else

static inline

int phy_start_cable_test(struct phy_device *phydev,
@@ -1267,7 +1281,8 @@ int phy_start_cable_test(struct phy_device *phydev, 
}

static inline

int phy_start_cable_test_tdr(struct phy_device *phydev,

			     struct netlink_ext_ack *extack)

			     struct netlink_ext_ack *extack,

			     const struct phy_tdr_config *config)

{

	NL_SET_ERR_MSG(extack, "Kernel not compiled with PHYLIB support");

	return -EOPNOTSUPP;

include/uapi/linux/ethtool_netlink.h

+13 −0
Original line number Diff line number Diff line
@@ -482,9 +482,22 @@ enum { 


/* CABLE TEST TDR */



enum {

	ETHTOOL_A_CABLE_TEST_TDR_CFG_UNSPEC,

	ETHTOOL_A_CABLE_TEST_TDR_CFG_FIRST,		/* u32 */

	ETHTOOL_A_CABLE_TEST_TDR_CFG_LAST,		/* u32 */

	ETHTOOL_A_CABLE_TEST_TDR_CFG_STEP,		/* u32 */

	ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR,		/* u8 */



	/* add new constants above here */

	__ETHTOOL_A_CABLE_TEST_TDR_CFG_CNT,

	ETHTOOL_A_CABLE_TEST_TDR_CFG_MAX = __ETHTOOL_A_CABLE_TEST_TDR_CFG_CNT - 1

};



enum {

	ETHTOOL_A_CABLE_TEST_TDR_UNSPEC,

	ETHTOOL_A_CABLE_TEST_TDR_HEADER,	/* nest - _A_HEADER_* */

	ETHTOOL_A_CABLE_TEST_TDR_CFG,		/* nest - *_TDR_CFG_* */



	/* add new constants above here */

	__ETHTOOL_A_CABLE_TEST_TDR_CNT,

CRA Git | Maintained and supported by SUSTech CRA and CCSE