Commit bdbdac76 authored by Oleksij Rempel's avatar Oleksij Rempel Committed by David S. Miller
Browse files

ethtool: provide UAPI for PHY master/slave configuration. 



This UAPI is needed for BroadR-Reach 100BASE-T1 devices. Due to lack of
auto-negotiation support, we needed to be able to configure the
MASTER-SLAVE role of the port manually or from an application in user
space.

The same UAPI can be used for 1000BASE-T or MultiGBASE-T devices to
force MASTER or SLAVE role. See IEEE 802.3-2018:
22.2.4.3.7 MASTER-SLAVE control register (Register 9)
22.2.4.3.8 MASTER-SLAVE status register (Register 10)
40.5.2 MASTER-SLAVE configuration resolution
45.2.1.185.1 MASTER-SLAVE config value (1.2100.14)
45.2.7.10 MultiGBASE-T AN control 1 register (Register 7.32)

The MASTER-SLAVE role affects the clock configuration:

-------------------------------------------------------------------------------
When the  PHY is configured as MASTER, the PMA Transmit function shall
source TX_TCLK from a local clock source. When configured as SLAVE, the
PMA Transmit function shall source TX_TCLK from the clock recovered from
data stream provided by MASTER.

iMX6Q                     KSZ9031                XXX
------\                /-----------\        /------------\
      |                |           |        |            |
 MAC  |<----RGMII----->| PHY Slave |<------>| PHY Master |
      |<--- 125 MHz ---+-<------/  |        | \          |
------/                \-----------/        \------------/
                                               ^
                                                \-TX_TCLK

-------------------------------------------------------------------------------

Since some clock or link related issues are only reproducible in a
specific MASTER-SLAVE-role, MAC and PHY configuration, it is beneficial
to provide generic (not 100BASE-T1 specific) interface to the user space
for configuration flexibility and trouble shooting.

Signed-off-by: default avatarOleksij Rempel <o.rempel@pengutronix.de>
Reviewed-by: default avatarAndrew Lunn <andrew@lunn.ch>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 3d59a583

Documentation/networking/ethtool-netlink.rst

+19 −16
Original line number Diff line number Diff line
@@ -392,14 +392,16 @@ Request contents: 


Kernel response contents:



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

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

  ``ETHTOOL_A_LINKMODES_HEADER``              nested  reply header

  ``ETHTOOL_A_LINKMODES_AUTONEG``             u8      autonegotiation status

  ``ETHTOOL_A_LINKMODES_OURS``                bitset  advertised link modes

  ``ETHTOOL_A_LINKMODES_PEER``                bitset  partner link modes

  ``ETHTOOL_A_LINKMODES_SPEED``               u32     link speed (Mb/s)

  ``ETHTOOL_A_LINKMODES_DUPLEX``              u8      duplex mode

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

  ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG``    u8      Master/slave port mode

  ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE``  u8      Master/slave port state

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



For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask

represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
@@ -414,14 +416,15 @@ LINKMODES_SET 


Request contents:



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

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

  ``ETHTOOL_A_LINKMODES_HEADER``              nested  request header

  ``ETHTOOL_A_LINKMODES_AUTONEG``             u8      autonegotiation status

  ``ETHTOOL_A_LINKMODES_OURS``                bitset  advertised link modes

  ``ETHTOOL_A_LINKMODES_PEER``                bitset  partner link modes

  ``ETHTOOL_A_LINKMODES_SPEED``               u32     link speed (Mb/s)

  ``ETHTOOL_A_LINKMODES_DUPLEX``              u8      duplex mode

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

  ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG``    u8      Master/slave port mode

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



``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If

autonegotiation is on (either set now or kept from before), advertised modes

drivers/net/phy/phy.c

+3 −1
Original line number Diff line number Diff line
@@ -295,7 +295,7 @@ int phy_ethtool_ksettings_set(struct phy_device *phydev, 
			 phydev->advertising, autoneg == AUTONEG_ENABLE);



	phydev->duplex = duplex;



	phydev->master_slave_set = cmd->base.master_slave_cfg;

	phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;



	/* Restart the PHY */
@@ -314,6 +314,8 @@ void phy_ethtool_ksettings_get(struct phy_device *phydev, 


	cmd->base.speed = phydev->speed;

	cmd->base.duplex = phydev->duplex;

	cmd->base.master_slave_cfg = phydev->master_slave_get;

	cmd->base.master_slave_state = phydev->master_slave_state;

	if (phydev->interface == PHY_INTERFACE_MODE_MOCA)

		cmd->base.port = PORT_BNC;

	else

drivers/net/phy/phy_device.c

+94 −0
Original line number Diff line number Diff line
@@ -1913,6 +1913,90 @@ int genphy_setup_forced(struct phy_device *phydev) 
}

EXPORT_SYMBOL(genphy_setup_forced);



static int genphy_setup_master_slave(struct phy_device *phydev)

{

	u16 ctl = 0;



	if (!phydev->is_gigabit_capable)

		return 0;



	switch (phydev->master_slave_set) {

	case MASTER_SLAVE_CFG_MASTER_PREFERRED:

		ctl |= CTL1000_PREFER_MASTER;

		break;

	case MASTER_SLAVE_CFG_SLAVE_PREFERRED:

		break;

	case MASTER_SLAVE_CFG_MASTER_FORCE:

		ctl |= CTL1000_AS_MASTER;

		/* fallthrough */

	case MASTER_SLAVE_CFG_SLAVE_FORCE:

		ctl |= CTL1000_ENABLE_MASTER;

		break;

	case MASTER_SLAVE_CFG_UNKNOWN:

	case MASTER_SLAVE_CFG_UNSUPPORTED:

		return 0;

	default:

		phydev_warn(phydev, "Unsupported Master/Slave mode\n");

		return -EOPNOTSUPP;

	}



	return phy_modify_changed(phydev, MII_CTRL1000,

				  (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |

				   CTL1000_PREFER_MASTER), ctl);

}



static int genphy_read_master_slave(struct phy_device *phydev)

{

	int cfg, state;

	u16 val;



	if (!phydev->is_gigabit_capable) {

		phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;

		phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;

		return 0;

	}



	phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;

	phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;



	val = phy_read(phydev, MII_CTRL1000);

	if (val < 0)

		return val;



	if (val & CTL1000_ENABLE_MASTER) {

		if (val & CTL1000_AS_MASTER)

			cfg = MASTER_SLAVE_CFG_MASTER_FORCE;

		else

			cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;

	} else {

		if (val & CTL1000_PREFER_MASTER)

			cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;

		else

			cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;

	}



	val = phy_read(phydev, MII_STAT1000);

	if (val < 0)

		return val;



	if (val & LPA_1000MSFAIL) {

		state = MASTER_SLAVE_STATE_ERR;

	} else if (phydev->link) {

		/* this bits are valid only for active link */

		if (val & LPA_1000MSRES)

			state = MASTER_SLAVE_STATE_MASTER;

		else

			state = MASTER_SLAVE_STATE_SLAVE;

	} else {

		state = MASTER_SLAVE_STATE_UNKNOWN;

	}



	phydev->master_slave_get = cfg;

	phydev->master_slave_state = state;



	return 0;

}



/**

 * genphy_restart_aneg - Enable and Restart Autonegotiation

 * @phydev: target phy_device struct
@@ -1971,6 +2055,12 @@ int __genphy_config_aneg(struct phy_device *phydev, bool changed) 
	if (genphy_config_eee_advert(phydev))

		changed = true;



	err = genphy_setup_master_slave(phydev);

	if (err < 0)

		return err;

	else if (err)

		changed = true;



	if (AUTONEG_ENABLE != phydev->autoneg)

		return genphy_setup_forced(phydev);
@@ -2205,6 +2295,10 @@ int genphy_read_status(struct phy_device *phydev) 
	phydev->pause = 0;

	phydev->asym_pause = 0;



	err = genphy_read_master_slave(phydev);

	if (err < 0)

		return err;



	err = genphy_read_lpa(phydev);

	if (err < 0)

		return err;

include/linux/phy.h

+3 −0
Original line number Diff line number Diff line
@@ -477,6 +477,9 @@ struct phy_device { 
	int duplex;

	int pause;

	int asym_pause;

	u8 master_slave_get;

	u8 master_slave_set;

	u8 master_slave_state;



	/* Union of PHY and Attached devices' supported link modes */

	/* See ethtool.h for more info */

include/uapi/linux/ethtool.h

+15 −1
Original line number Diff line number Diff line
@@ -1666,6 +1666,18 @@ static inline int ethtool_validate_duplex(__u8 duplex) 
	return 0;

}



#define MASTER_SLAVE_CFG_UNSUPPORTED		0

#define MASTER_SLAVE_CFG_UNKNOWN		1

#define MASTER_SLAVE_CFG_MASTER_PREFERRED	2

#define MASTER_SLAVE_CFG_SLAVE_PREFERRED	3

#define MASTER_SLAVE_CFG_MASTER_FORCE		4

#define MASTER_SLAVE_CFG_SLAVE_FORCE		5

#define MASTER_SLAVE_STATE_UNSUPPORTED		0

#define MASTER_SLAVE_STATE_UNKNOWN		1

#define MASTER_SLAVE_STATE_MASTER		2

#define MASTER_SLAVE_STATE_SLAVE		3

#define MASTER_SLAVE_STATE_ERR			4



/* Which connector port. */

#define PORT_TP			0x00

#define PORT_AUI		0x01
@@ -1904,7 +1916,9 @@ struct ethtool_link_settings { 
	__u8	eth_tp_mdix_ctrl;

	__s8	link_mode_masks_nwords;

	__u8	transceiver;

	__u8	reserved1[3];

	__u8	master_slave_cfg;

	__u8	master_slave_state;

	__u8	reserved1[1];

	__u32	reserved[7];

	__u32	link_mode_masks[0];

	/* layout of link_mode_masks fields:

CRA Git | Maintained and supported by SUSTech CRA and CCSE