net/ethtool: add netlink interface for the PLCA RS (8580e16c) · Commits · EulixOS / Software / Kernel

Documentation/networking/ethtool-netlink.rst

+138 −0

Original line number	Diff line number	Diff line
		@@ -1716,6 +1716,141 @@ being used. Current supported options are toeplitz, xor or crc32.
		ETHTOOL_A_RSS_INDIR attribute returns RSS indrection table where each byte
		indicates queue number.

		PLCA_GET_CFG
		============

		Gets the IEEE 802.3cg-2019 Clause 148 Physical Layer Collision Avoidance
		(PLCA) Reconciliation Sublayer (RS) attributes.

		Request contents:

		===================================== ====== ==========================
		``ETHTOOL_A_PLCA_HEADER`` nested request header
		===================================== ====== ==========================

		Kernel response contents:

		====================================== ====== =============================
		``ETHTOOL_A_PLCA_HEADER`` nested reply header
		``ETHTOOL_A_PLCA_VERSION`` u16 Supported PLCA management
		interface standard/version
		``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State
		``ETHTOOL_A_PLCA_NODE_ID`` u32 PLCA unique local node ID
		``ETHTOOL_A_PLCA_NODE_CNT`` u32 Number of PLCA nodes on the
		network, including the
		coordinator
		``ETHTOOL_A_PLCA_TO_TMR`` u32 Transmit Opportunity Timer
		value in bit-times (BT)
		``ETHTOOL_A_PLCA_BURST_CNT`` u32 Number of additional packets
		the node is allowed to send
		within a single TO
		``ETHTOOL_A_PLCA_BURST_TMR`` u32 Time to wait for the MAC to
		transmit a new frame before
		terminating the burst
		====================================== ====== =============================

		When set, the optional ``ETHTOOL_A_PLCA_VERSION`` attribute indicates which
		standard and version the PLCA management interface complies to. When not set,
		the interface is vendor-specific and (possibly) supplied by the driver.
		The OPEN Alliance SIG specifies a standard register map for 10BASE-T1S PHYs
		embedding the PLCA Reconcialiation Sublayer. See "10BASE-T1S PLCA Management
		Registers" at https://www.opensig.org/about/specifications/.

		When set, the optional ``ETHTOOL_A_PLCA_ENABLED`` attribute indicates the
		administrative state of the PLCA RS. When not set, the node operates in "plain"
		CSMA/CD mode. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.1
		aPLCAAdminState / 30.16.1.2.1 acPLCAAdminControl.

		When set, the optional ``ETHTOOL_A_PLCA_NODE_ID`` attribute indicates the
		configured local node ID of the PHY. This ID determines which transmit
		opportunity (TO) is reserved for the node to transmit into. This option is
		corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.4 aPLCALocalNodeID. The valid
		range for this attribute is [0 .. 255] where 255 means "not configured".

		When set, the optional ``ETHTOOL_A_PLCA_NODE_CNT`` attribute indicates the
		configured maximum number of PLCA nodes on the mixing-segment. This number
		determines the total number of transmit opportunities generated during a
		PLCA cycle. This attribute is relevant only for the PLCA coordinator, which is
		the node with aPLCALocalNodeID set to 0. Follower nodes ignore this setting.
		This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.3
		aPLCANodeCount. The valid range for this attribute is [1 .. 255].

		When set, the optional ``ETHTOOL_A_PLCA_TO_TMR`` attribute indicates the
		configured value of the transmit opportunity timer in bit-times. This value
		must be set equal across all nodes sharing the medium for PLCA to work
		correctly. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.5
		aPLCATransmitOpportunityTimer. The valid range for this attribute is
		[0 .. 255].

		When set, the optional ``ETHTOOL_A_PLCA_BURST_CNT`` attribute indicates the
		configured number of extra packets that the node is allowed to send during a
		single transmit opportunity. By default, this attribute is 0, meaning that
		the node can only send a sigle frame per TO. When greater than 0, the PLCA RS
		keeps the TO after any transmission, waiting for the MAC to send a new frame
		for up to aPLCABurstTimer BTs. This can only happen a number of times per PLCA
		cycle up to the value of this parameter. After that, the burst is over and the
		normal counting of TOs resumes. This option is corresponding to
		``IEEE 802.3cg-2019`` 30.16.1.1.6 aPLCAMaxBurstCount. The valid range for this
		attribute is [0 .. 255].

		When set, the optional ``ETHTOOL_A_PLCA_BURST_TMR`` attribute indicates how
		many bit-times the PLCA RS waits for the MAC to initiate a new transmission
		when aPLCAMaxBurstCount is greater than 0. If the MAC fails to send a new
		frame within this time, the burst ends and the counting of TOs resumes.
		Otherwise, the new frame is sent as part of the current burst. This option
		is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.7 aPLCABurstTimer. The
		valid range for this attribute is [0 .. 255]. Although, the value should be
		set greater than the Inter-Frame-Gap (IFG) time of the MAC (plus some margin)
		for PLCA burst mode to work as intended.

		PLCA_SET_CFG
		============

		Sets PLCA RS parameters.

		Request contents:

		====================================== ====== =============================
		``ETHTOOL_A_PLCA_HEADER`` nested request header
		``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State
		``ETHTOOL_A_PLCA_NODE_ID`` u8 PLCA unique local node ID
		``ETHTOOL_A_PLCA_NODE_CNT`` u8 Number of PLCA nodes on the
		netkork, including the
		coordinator
		``ETHTOOL_A_PLCA_TO_TMR`` u8 Transmit Opportunity Timer
		value in bit-times (BT)
		``ETHTOOL_A_PLCA_BURST_CNT`` u8 Number of additional packets
		the node is allowed to send
		within a single TO
		``ETHTOOL_A_PLCA_BURST_TMR`` u8 Time to wait for the MAC to
		transmit a new frame before
		terminating the burst
		====================================== ====== =============================

		For a description of each attribute, see ``PLCA_GET_CFG``.

		PLCA_GET_STATUS
		===============

		Gets PLCA RS status information.

		Request contents:

		===================================== ====== ==========================
		``ETHTOOL_A_PLCA_HEADER`` nested request header
		===================================== ====== ==========================

		Kernel response contents:

		====================================== ====== =============================
		``ETHTOOL_A_PLCA_HEADER`` nested reply header
		``ETHTOOL_A_PLCA_STATUS`` u8 PLCA RS operational status
		====================================== ====== =============================

		When set, the ``ETHTOOL_A_PLCA_STATUS`` attribute indicates whether the node is
		detecting the presence of the BEACON on the network. This flag is
		corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.2 aPLCAStatus.

		Request translation
		===================

		@@ -1817,4 +1952,7 @@ are netlink only.
		n/a ``ETHTOOL_MSG_PHC_VCLOCKS_GET``
		n/a ``ETHTOOL_MSG_MODULE_GET``
		n/a ``ETHTOOL_MSG_MODULE_SET``
		n/a ``ETHTOOL_MSG_PLCA_GET_CFG``
		n/a ``ETHTOOL_MSG_PLCA_SET_CFG``
		n/a ``ETHTOOL_MSG_PLCA_GET_STATUS``
		=================================== =====================================

MAINTAINERS

+6 −0

Original line number	Diff line number	Diff line
		@@ -16616,6 +16616,12 @@ S: Maintained
		F: Documentation/devicetree/bindings/iio/chemical/plantower,pms7003.yaml
		F: drivers/iio/chemical/pms7003.c

		PLCA RECONCILIATION SUBLAYER (IEEE802.3 Clause 148)
		M: Piergiorgio Beruto <piergiorgio.beruto@gmail.com>
		L: netdev@vger.kernel.org
		S: Maintained
		F: net/ethtool/plca.c

		PLDMFW LIBRARY
		M: Jacob Keller <jacob.e.keller@intel.com>
		S: Maintained

include/linux/ethtool.h

+12 −0

Original line number	Diff line number	Diff line
		@@ -802,12 +802,17 @@ int ethtool_virtdev_set_link_ksettings(struct net_device *dev,

		struct phy_device;
		struct phy_tdr_config;
		struct phy_plca_cfg;
		struct phy_plca_status;

		/**
		* struct ethtool_phy_ops - Optional PHY device options
		* @get_sset_count: Get number of strings that @get_strings will write.
		* @get_strings: Return a set of strings that describe the requested objects
		* @get_stats: Return extended statistics about the PHY device.
		* @get_plca_cfg: Return PLCA configuration.
		* @set_plca_cfg: Set PLCA configuration.
		* @get_plca_status: Get PLCA configuration.
		* @start_cable_test: Start a cable test
		* @start_cable_test_tdr: Start a Time Domain Reflectometry cable test
		*
		@@ -819,6 +824,13 @@ struct ethtool_phy_ops {
		int (get_strings)(struct phy_device dev, u8 *data);
		int (get_stats)(struct phy_device dev,
		struct ethtool_stats stats, u64 data);
		int (get_plca_cfg)(struct phy_device dev,
		struct phy_plca_cfg *plca_cfg);
		int (set_plca_cfg)(struct phy_device dev,
		const struct phy_plca_cfg *plca_cfg,
		struct netlink_ext_ack *extack);
		int (get_plca_status)(struct phy_device dev,
		struct phy_plca_status *plca_st);
		int (start_cable_test)(struct phy_device phydev,
		struct netlink_ext_ack *extack);
		int (start_cable_test_tdr)(struct phy_device phydev,

include/linux/phy.h

+57 −0

Original line number	Diff line number	Diff line
		@@ -773,6 +773,63 @@ struct phy_tdr_config {
		};
		#define PHY_PAIR_ALL -1

		/**
		* struct phy_plca_cfg - Configuration of the PLCA (Physical Layer Collision
		* Avoidance) Reconciliation Sublayer.
		*
		* @version: read-only PLCA register map version. -1 = not available. Ignored
		* when setting the configuration. Format is the same as reported by the PLCA
		* IDVER register (31.CA00). -1 = not available.
		* @enabled: PLCA configured mode (enabled/disabled). -1 = not available / don't
		* set. 0 = disabled, anything else = enabled.
		* @node_id: the PLCA local node identifier. -1 = not available / don't set.
		* Allowed values [0 .. 254]. 255 = node disabled.
		* @node_cnt: the PLCA node count (maximum number of nodes having a TO). Only
		* meaningful for the coordinator (node_id = 0). -1 = not available / don't
		* set. Allowed values [1 .. 255].
		* @to_tmr: The value of the PLCA to_timer in bit-times, which determines the
		* PLCA transmit opportunity window opening. See IEEE802.3 Clause 148 for
		* more details. The to_timer shall be set equal over all nodes.
		* -1 = not available / don't set. Allowed values [0 .. 255].
		* @burst_cnt: controls how many additional frames a node is allowed to send in
		* single transmit opportunity (TO). The default value of 0 means that the
		* node is allowed exactly one frame per TO. A value of 1 allows two frames
		* per TO, and so on. -1 = not available / don't set.
		* Allowed values [0 .. 255].
		* @burst_tmr: controls how many bit times to wait for the MAC to send a new
		* frame before interrupting the burst. This value should be set to a value
		* greater than the MAC inter-packet gap (which is typically 96 bits).
		* -1 = not available / don't set. Allowed values [0 .. 255].
		*
		* A structure containing configuration parameters for setting/getting the PLCA
		* RS configuration. The driver does not need to implement all the parameters,
		* but should report what is actually used.
		*/
		struct phy_plca_cfg {
		int version;
		int enabled;
		int node_id;
		int node_cnt;
		int to_tmr;
		int burst_cnt;
		int burst_tmr;
		};

		/**
		* struct phy_plca_status - Status of the PLCA (Physical Layer Collision
		* Avoidance) Reconciliation Sublayer.
		*
		* @pst: The PLCA status as reported by the PST bit in the PLCA STATUS
		* register(31.CA03), indicating BEACON activity.
		*
		* A structure containing status information of the PLCA RS configuration.
		* The driver does not need to implement all the parameters, but should report
		* what is actually used.
		*/
		struct phy_plca_status {
		bool pst;
		};

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

include/uapi/linux/ethtool_netlink.h

+25 −0

Original line number	Diff line number	Diff line
		@@ -52,6 +52,9 @@ enum {
		ETHTOOL_MSG_PSE_GET,
		ETHTOOL_MSG_PSE_SET,
		ETHTOOL_MSG_RSS_GET,
		ETHTOOL_MSG_PLCA_GET_CFG,
		ETHTOOL_MSG_PLCA_SET_CFG,
		ETHTOOL_MSG_PLCA_GET_STATUS,

		/* add new constants above here */
		__ETHTOOL_MSG_USER_CNT,
		@@ -99,6 +102,9 @@ enum {
		ETHTOOL_MSG_MODULE_NTF,
		ETHTOOL_MSG_PSE_GET_REPLY,
		ETHTOOL_MSG_RSS_GET_REPLY,
		ETHTOOL_MSG_PLCA_GET_CFG_REPLY,
		ETHTOOL_MSG_PLCA_GET_STATUS_REPLY,
		ETHTOOL_MSG_PLCA_NTF,

		/* add new constants above here */
		__ETHTOOL_MSG_KERNEL_CNT,
		@@ -894,6 +900,25 @@ enum {
		ETHTOOL_A_RSS_MAX = (__ETHTOOL_A_RSS_CNT - 1),
		};

		/* PLCA */

		enum {
		ETHTOOL_A_PLCA_UNSPEC,
		ETHTOOL_A_PLCA_HEADER, /* nest - _A_HEADER_* */
		ETHTOOL_A_PLCA_VERSION, /* u16 */
		ETHTOOL_A_PLCA_ENABLED, /* u8 */
		ETHTOOL_A_PLCA_STATUS, /* u8 */
		ETHTOOL_A_PLCA_NODE_CNT, /* u32 */
		ETHTOOL_A_PLCA_NODE_ID, /* u32 */
		ETHTOOL_A_PLCA_TO_TMR, /* u32 */
		ETHTOOL_A_PLCA_BURST_CNT, /* u32 */
		ETHTOOL_A_PLCA_BURST_TMR, /* u32 */

		/* add new constants above here */
		__ETHTOOL_A_PLCA_CNT,
		ETHTOOL_A_PLCA_MAX = (__ETHTOOL_A_PLCA_CNT - 1)
		};

		/* generic netlink info */
		#define ETHTOOL_GENL_NAME "ethtool"
		#define ETHTOOL_GENL_VERSION 1