* [PATCH net-next v1 1/5] ethtool: introduce core UAPI and driver API for PHY MSE diagnostics
2025-08-13 8:14 [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Oleksij Rempel
@ 2025-08-13 8:14 ` Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 2/5] ethtool: netlink: add ETHTOOL_MSG_MSE_GET and wire up PHY MSE access Oleksij Rempel
` (4 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Oleksij Rempel @ 2025-08-13 8:14 UTC (permalink / raw)
To: Andrew Lunn, Jakub Kicinski, David S. Miller, Eric Dumazet,
Paolo Abeni, Simon Horman, Donald Hunter, Jonathan Corbet,
Heiner Kallweit, Russell King, Kory Maincent, Maxime Chevallier,
Nishanth Menon
Cc: Oleksij Rempel, kernel, linux-kernel, netdev, UNGLinuxDriver,
linux-doc, Michal Kubecek, Roan van Dijk
Add the base infrastructure for Mean Square Error (MSE) diagnostics,
as proposed by the OPEN Alliance "Advanced diagnostic features for
100BASE-T1 automotive Ethernet PHYs" [1] specification.
The OPEN Alliance spec defines only average MSE and average peak MSE
over a fixed number of symbols. However, other PHYs, such as the
KSZ9131, additionally expose a worst-peak MSE value latched since the
last channel capture. This API accounts for such vendor extensions by
adding a distinct capability bit and snapshot field.
Channel-to-pair mapping is normally straightforward, but in some cases
(e.g. 100BASE-TX with MDI-X resolution unknown) the mapping is ambiguous.
If hardware does not expose MDI-X status, the exact pair cannot be
determined. To avoid returning misleading per-channel data in this case,
a LINK selector is defined for aggregate MSE measurements.
All investigated devices differ in MSE configuration parameters, such
as sample rate, number of analyzed symbols, and scaling factors.
For example, the KSZ9131 uses different scaling for MSE and pMSE.
To make this visible to userspace, scale limits and timing information
are returned via get_mse_config().
Some PHYs sample very few symbols at high frequency (e.g. 2 µs update
rate). To cover such cases and allow for future high-speed PHYs with
even shorter intervals, the refresh rate is reported as u64 in
picoseconds.
This patch defines new UAPI enums for MSE capability flags and channel
selectors in ethtool_netlink (generated from YAML), kernel-side
`struct phy_mse_config` and `struct phy_mse_snapshot`, and new
phy_driver ops:
- get_mse_config(): report supported capabilities, scaling, and
sampling parameters for the current link mode
- get_mse_snapshot(): retrieve a correlated set of MSE values from
the latest measurement window
These definitions form the core API; no driver implements them yet.
[1] <https://opensig.org/wp-content/uploads/2024/01/
Advanced_PHY_features_for_automotive_Ethernet_V1.0.pdf>
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
Documentation/netlink/specs/ethtool.yaml | 78 +++++++++++
include/linux/phy.h | 126 ++++++++++++++++++
.../uapi/linux/ethtool_netlink_generated.h | 54 ++++++++
3 files changed, 258 insertions(+)
diff --git a/Documentation/netlink/specs/ethtool.yaml b/Documentation/netlink/specs/ethtool.yaml
index 1bc1bd7d33c2..f2f7c42c5e92 100644
--- a/Documentation/netlink/specs/ethtool.yaml
+++ b/Documentation/netlink/specs/ethtool.yaml
@@ -208,6 +208,84 @@ definitions:
name: discard
value: 31
+ -
+ name: phy-mse-capability
+ doc: |
+ Bitmask flags for MSE capabilities.
+
+ These flags are used in the 'supported_caps' field of struct
+ phy_mse_config to indicate which measurement capabilities are supported
+ by the PHY hardware.
+ type: flags
+ name-prefix: phy-mse-cap-
+ entries:
+ -
+ name: avg
+ doc: Average MSE value is supported.
+ -
+ name: peak
+ doc: Current peak MSE value is supported.
+ -
+ name: worst-peak
+ doc: Worst-case peak MSE (latched high-water mark) is supported.
+ -
+ name: channel-a
+ doc: Diagnostics for Channel A are supported.
+ -
+ name: channel-b
+ doc: Diagnostics for Channel B are supported.
+ -
+ name: channel-c
+ doc: Diagnostics for Channel C are supported.
+ -
+ name: channel-d
+ doc: Diagnostics for Channel D are supported.
+ -
+ name: worst-channel
+ doc: |
+ Hardware or drivers can identify the single worst-performing channel
+ without needing to query each one individually.
+ -
+ name: link
+ doc: |
+ Hardware provides only a link-wide aggregate MSE or cannot map
+ the measurement to a specific channel/pair. Typical for media where
+ the MDI/MDI-X resolution or pair mapping is unknown (e.g. 100BASE-TX).
+
+ -
+ name: phy-mse-channel
+ doc: |
+ Identifiers for the 'channel' parameter used to select which diagnostic
+ data to retrieve.
+ type: enum
+ name-prefix: phy-mse-channel-
+ entries:
+ -
+ name: a
+ value: 0
+ doc: Request data for channel A.
+ -
+ name: b
+ doc: Request data for channel B.
+ -
+ name: c
+ doc: Request data for channel C.
+ -
+ name: d
+ doc: Request data for channel D.
+ -
+ name: link
+ doc: |
+ Request data for the link as a whole. Use when the PHY exposes only
+ a link-wide aggregate MSE or cannot attribute results to any single
+ channel/pair (e.g. 100BASE-TX with unknown MDI/MDI-X mapping).
+ -
+ name: worst
+ doc: |
+ Request data for the single worst-performing channel. This is a
+ convenience for PHYs or drivers that can identify the worst channel
+ in hardware.
+
attribute-sets:
-
name: header
diff --git a/include/linux/phy.h b/include/linux/phy.h
index 4c2b8b6e7187..469268b07b7b 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -893,6 +893,78 @@ struct phy_led {
#define to_phy_led(d) container_of(d, struct phy_led, led_cdev)
+/**
+ * struct phy_mse_config - Configuration for MSE measurement (current link mode)
+ *
+ * These properties apply to the current link mode and may change when link
+ * settings change. Callers should re-query after any link state change.
+ *
+ * Scaling:
+ * - max_average_mse and max_peak_mse define the scale for corresponding
+ * snapshot values. Users may normalize by dividing snapshot by the
+ * respective max_* value to obtain a 0..1 ratio. Drivers must ensure
+ * snapshot values do not exceed the corresponding max_*.
+ * - If PHY_MSE_CAP_AVG is set, max_average_mse MUST be > 0.
+ * - If PHY_MSE_CAP_PEAK or PHY_MSE_CAP_WORST_PEAK is set,
+ * max_peak_mse MUST be > 0.
+ *
+ * Timing:
+ * - refresh_rate_ps is the typical interval (picoseconds) between hardware
+ * updates. Implementations may return older snapshots; do not assume
+ * synchronous sampling.
+ * - num_symbols is the number of symbols aggregated per hardware sample.
+ *
+ * Link-wide mode:
+ * - Some PHYs only expose a link-wide aggregate MSE, or cannot map their
+ * measurement to a specific channel/pair (e.g. 100BASE-TX when MDI/MDI-X
+ * resolution is unknown). In that case, callers must use the LINK selector.
+ *
+ * Capabilities:
+ * - supported_caps is a bitmask composed of PHY_MSE_CAP_* values from the
+ * UAPI header. Channel-related capability bits indicate which channel
+ * identifiers are valid.
+ * - Callers should select only those channels/selectors that are indicated
+ * as supported by supported_caps.
+ *
+ * If supported_caps is 0 the device provides no MSE diagnostics and drivers
+ * should typically return -EOPNOTSUPP from the ops.
+ */
+struct phy_mse_config {
+ u32 max_average_mse;
+ u32 max_peak_mse;
+ u64 refresh_rate_ps;
+ u64 num_symbols;
+ u32 supported_caps;
+};
+
+/**
+ * struct phy_mse_snapshot - Snapshot of MSE diagnostic values
+ *
+ * All fields refer to the same measurement window.
+ *
+ * Semantics:
+ * - peak_mse is the current peak within the window.
+ * - worst_peak_mse is a latched high-water mark since the last successful
+ * read and MUST be cleared by the driver or hardware on read
+ * (read-to-clear).
+ *
+ * Channel:
+ * - 'channel' holds an integer identifier compatible with the UAPI
+ * ethtool_phy_mse_channel enum. Callers must validate the requested
+ * channel against supported_caps returned by get_mse_config() and must
+ * use LINK when only link-wide is supported.
+ * - Values must be one of the PHY_MSE_CHANNEL_* constants.
+ * - Drivers must not coerce the requested selector (e.g. must not switch
+ * a per-channel request to LINK). If an unsupported selector is requested,
+ * return -EOPNOTSUPP.
+ */
+struct phy_mse_snapshot {
+ u32 channel;
+ u32 average_mse;
+ u32 peak_mse;
+ u32 worst_peak_mse;
+};
+
/**
* struct phy_driver - Driver structure for a particular PHY type
*
@@ -1174,6 +1246,60 @@ struct phy_driver {
/** @get_sqi_max: Get the maximum signal quality indication */
int (*get_sqi_max)(struct phy_device *dev);
+ /**
+ * get_mse_config - Get configuration and scale of MSE measurement
+ * @dev: PHY device
+ * @config: Output (filled on success)
+ *
+ * Fill @config with the PHY's MSE configuration for the current
+ * link mode: scale limits (max_average_mse, max_peak_mse), update
+ * interval (refresh_rate_ps), sample length (num_symbols) and the
+ * capability bitmask (supported_caps).
+ *
+ * Implementations may defer configuration until hardware has
+ * converged; in that case they should return -EAGAIN and allow the
+ * caller to retry later.
+ *
+ * Return:
+ * * 0 - success, @config is valid
+ * * -EOPNOTSUPP - MSE configuration not implemented by the PHY
+ * or not supported in the current link mode
+ * * -ENETDOWN - link is down and configuration is not
+ * available in that state
+ * * -EAGAIN - configuration not yet established; retry later
+ * * <other> - other negative errno on failure
+ */
+ int (*get_mse_config)(struct phy_device *dev,
+ struct phy_mse_config *config);
+
+ /**
+ * get_mse_snapshot - Retrieve a snapshot of MSE diagnostic values
+ * @dev: PHY device
+ * @channel: Channel identifier (PHY_MSE_CHANNEL_*)
+ * @snapshot: Output (filled on success)
+ *
+ * Fill @snapshot with a correlated set of MSE values from the most
+ * recent measurement window.
+ *
+ * Callers must validate @channel against supported_caps returned by
+ * get_mse_config(). Drivers must not coerce @channel; if the requested
+ * selector is not implemented by the device or current link mode,
+ * the operation must fail.
+ *
+ * On success, @snapshot->channel MUST equal the requested @channel.
+ * worst_peak_mse is latched and must be treated as read-to-clear.
+ *
+ * Return:
+ * * 0 - success, @snapshot is valid
+ * * -EOPNOTSUPP - selector not implemented by device or link mode
+ * * -ENETDOWN - link is down and data is not available in that state
+ * * -EAGAIN - data not yet available (e.g. first sampling
+ * incomplete)
+ * * <other> - other negative errno on failure
+ */
+ int (*get_mse_snapshot)(struct phy_device *dev, u32 channel,
+ struct phy_mse_snapshot *snapshot);
+
/* PLCA RS interface */
/** @get_plca_cfg: Return the current PLCA configuration */
int (*get_plca_cfg)(struct phy_device *dev,
diff --git a/include/uapi/linux/ethtool_netlink_generated.h b/include/uapi/linux/ethtool_netlink_generated.h
index e3b8813465d7..71d0ded01a3a 100644
--- a/include/uapi/linux/ethtool_netlink_generated.h
+++ b/include/uapi/linux/ethtool_netlink_generated.h
@@ -77,6 +77,60 @@ enum ethtool_pse_event {
ETHTOOL_PSE_EVENT_SW_PW_CONTROL_ERROR = 64,
};
+/**
+ * enum ethtool_phy_mse_capability - Bitmask flags for MSE capabilities. These
+ * flags are used in the 'supported_caps' field of struct phy_mse_config to
+ * indicate which measurement capabilities are supported by the PHY hardware.
+ * @PHY_MSE_CAP_AVG: Average MSE value is supported.
+ * @PHY_MSE_CAP_PEAK: Current peak MSE value is supported.
+ * @PHY_MSE_CAP_WORST_PEAK: Worst-case peak MSE (latched high-water mark) is
+ * supported.
+ * @PHY_MSE_CAP_CHANNEL_A: Diagnostics for Channel A are supported.
+ * @PHY_MSE_CAP_CHANNEL_B: Diagnostics for Channel B are supported.
+ * @PHY_MSE_CAP_CHANNEL_C: Diagnostics for Channel C are supported.
+ * @PHY_MSE_CAP_CHANNEL_D: Diagnostics for Channel D are supported.
+ * @PHY_MSE_CAP_WORST_CHANNEL: Hardware or drivers can identify the single
+ * worst-performing channel without needing to query each one individually.
+ * @PHY_MSE_CAP_LINK: Hardware provides only a link-wide aggregate MSE or
+ * cannot map the measurement to a specific channel/pair. Typical for media
+ * where the MDI/MDI-X resolution or pair mapping is unknown (e.g.
+ * 100BASE-TX).
+ */
+enum ethtool_phy_mse_capability {
+ PHY_MSE_CAP_AVG = 1,
+ PHY_MSE_CAP_PEAK = 2,
+ PHY_MSE_CAP_WORST_PEAK = 4,
+ PHY_MSE_CAP_CHANNEL_A = 8,
+ PHY_MSE_CAP_CHANNEL_B = 16,
+ PHY_MSE_CAP_CHANNEL_C = 32,
+ PHY_MSE_CAP_CHANNEL_D = 64,
+ PHY_MSE_CAP_WORST_CHANNEL = 128,
+ PHY_MSE_CAP_LINK = 256,
+};
+
+/**
+ * enum ethtool_phy_mse_channel - Identifiers for the 'channel' parameter used
+ * to select which diagnostic data to retrieve.
+ * @PHY_MSE_CHANNEL_A: Request data for channel A.
+ * @PHY_MSE_CHANNEL_B: Request data for channel B.
+ * @PHY_MSE_CHANNEL_C: Request data for channel C.
+ * @PHY_MSE_CHANNEL_D: Request data for channel D.
+ * @PHY_MSE_CHANNEL_LINK: Request data for the link as a whole. Use when the
+ * PHY exposes only a link-wide aggregate MSE or cannot attribute results to
+ * any single channel/pair (e.g. 100BASE-TX with unknown MDI/MDI-X mapping).
+ * @PHY_MSE_CHANNEL_WORST: Request data for the single worst-performing
+ * channel. This is a convenience for PHYs or drivers that can identify the
+ * worst channel in hardware.
+ */
+enum ethtool_phy_mse_channel {
+ PHY_MSE_CHANNEL_A,
+ PHY_MSE_CHANNEL_B,
+ PHY_MSE_CHANNEL_C,
+ PHY_MSE_CHANNEL_D,
+ PHY_MSE_CHANNEL_LINK,
+ PHY_MSE_CHANNEL_WORST,
+};
+
enum {
ETHTOOL_A_HEADER_UNSPEC,
ETHTOOL_A_HEADER_DEV_INDEX,
--
2.39.5
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH net-next v1 2/5] ethtool: netlink: add ETHTOOL_MSG_MSE_GET and wire up PHY MSE access
2025-08-13 8:14 [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 1/5] ethtool: introduce core UAPI and driver API for PHY MSE diagnostics Oleksij Rempel
@ 2025-08-13 8:14 ` Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 3/5] ethtool: netlink: add lightweight MSE reporting to LINKSTATE_GET Oleksij Rempel
` (3 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Oleksij Rempel @ 2025-08-13 8:14 UTC (permalink / raw)
To: Andrew Lunn, Jakub Kicinski, David S. Miller, Eric Dumazet,
Paolo Abeni, Simon Horman, Donald Hunter, Jonathan Corbet,
Heiner Kallweit, Russell King, Kory Maincent, Maxime Chevallier,
Nishanth Menon
Cc: Oleksij Rempel, kernel, linux-kernel, netdev, UNGLinuxDriver,
linux-doc, Michal Kubecek, Roan van Dijk
Introduce the userspace entry point for PHY MSE diagnostics via
ethtool netlink. This exposes the core API added previously and
returns both configuration and one or more snapshots.
Userspace sends ETHTOOL_MSG_MSE_GET with an optional channel
selector. The reply carries:
- ETHTOOL_A_MSE_CONFIG: scale limits, timing, and supported
capability bitmask
- ETHTOOL_A_MSE_SNAPSHOT+: one or more snapshots, each tagged
with the selected channel
If no channel is requested, the kernel returns snapshots for all
supported selectors (per‑channel if available, otherwise WORST,
otherwise LINK). Requests for unsupported selectors fail with
-EOPNOTSUPP; link down returns -ENOLINK.
Changes:
- YAML: add attribute sets (mse, mse-config, mse-snapshot) and
the mse-get operation
- UAPI (generated): add ETHTOOL_A_MSE_* enums and message IDs,
ETHTOOL_MSG_MSE_GET/REPLY
- ethtool core: add net/ethtool/mse.c implementing the request,
register genl op, and hook into ethnl dispatch
- docs: document MSE_GET in ethtool-netlink.rst
The include/uapi/linux/ethtool_netlink_generated.h is generated
from Documentation/netlink/specs/ethtool.yaml.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
Documentation/netlink/specs/ethtool.yaml | 88 +++++
Documentation/networking/ethtool-netlink.rst | 65 ++++
.../uapi/linux/ethtool_netlink_generated.h | 37 ++
net/ethtool/Makefile | 2 +-
net/ethtool/mse.c | 362 ++++++++++++++++++
net/ethtool/netlink.c | 10 +
net/ethtool/netlink.h | 2 +
7 files changed, 565 insertions(+), 1 deletion(-)
create mode 100644 net/ethtool/mse.c
diff --git a/Documentation/netlink/specs/ethtool.yaml b/Documentation/netlink/specs/ethtool.yaml
index f2f7c42c5e92..446474d9381c 100644
--- a/Documentation/netlink/specs/ethtool.yaml
+++ b/Documentation/netlink/specs/ethtool.yaml
@@ -1869,6 +1869,79 @@ attribute-sets:
type: uint
enum: pse-event
doc: List of events reported by the PSE controller
+ -
+ name: mse-config
+ attr-cnt-name: __ethtool-a-mse-config-cnt
+ attributes:
+ -
+ name: unspec
+ type: unused
+ value: 0
+ -
+ name: max-average-mse
+ type: u32
+ -
+ name: max-peak-mse
+ type: u32
+ -
+ name: refresh-rate-ps
+ type: u64
+ -
+ name: num-symbols
+ type: u64
+ -
+ name: supported-caps
+ type: nest
+ nested-attributes: bitset
+ -
+ name: pad
+ type: pad
+ -
+ name: mse-snapshot
+ attr-cnt-name: __ethtool-a-mse-snapshot-cnt
+ attributes:
+ -
+ name: unspec
+ type: unused
+ value: 0
+ -
+ name: channel
+ type: u32
+ enum: phy-mse-channel
+ -
+ name: average-mse
+ type: u32
+ -
+ name: peak-mse
+ type: u32
+ -
+ name: worst-peak-mse
+ type: u32
+ -
+ name: mse
+ attr-cnt-name: __ethtool-a-mse-cnt
+ attributes:
+ -
+ name: unspec
+ type: unused
+ value: 0
+ -
+ name: header
+ type: nest
+ nested-attributes: header
+ -
+ name: channel
+ type: u32
+ enum: phy-mse-channel
+ -
+ name: config
+ type: nest
+ nested-attributes: mse-config
+ -
+ name: snapshot
+ type: nest
+ multi-attr: true
+ nested-attributes: mse-snapshot
operations:
enum-model: directional
@@ -2802,6 +2875,21 @@ operations:
attributes:
- header
- context
+ -
+ name: mse-get
+ doc: Get PHY MSE measurement data and configuration.
+ attribute-set: mse
+ do: &mse-get-op
+ request:
+ attributes:
+ - header
+ - channel
+ reply:
+ attributes: &mse-reply
+ - header
+ - config
+ - snapshot
+ dump: *mse-get-op
mcast-groups:
list:
diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index 14916e1988d8..4f89c0b4e44e 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -242,6 +242,7 @@ Userspace to kernel:
``ETHTOOL_MSG_RSS_SET`` set RSS settings
``ETHTOOL_MSG_RSS_CREATE_ACT`` create an additional RSS context
``ETHTOOL_MSG_RSS_DELETE_ACT`` delete an additional RSS context
+ ``ETHTOOL_MSG_MSE_GET`` get MSE diagnostic data
===================================== =================================
Kernel to userspace:
@@ -299,6 +300,7 @@ Kernel to userspace:
``ETHTOOL_MSG_RSS_CREATE_ACT_REPLY`` create an additional RSS context
``ETHTOOL_MSG_RSS_CREATE_NTF`` additional RSS context created
``ETHTOOL_MSG_RSS_DELETE_NTF`` additional RSS context deleted
+ ``ETHTOOL_MSG_MSE_GET_REPLY`` MSE diagnostic data
======================================== =================================
``GET`` requests are sent by userspace applications to retrieve device
@@ -2528,6 +2530,69 @@ Kernel response contents:
For a description of each attribute, see ``TSCONFIG_GET``.
+MSE_GET
+=======
+
+Retrieves detailed Mean Square Error (MSE) diagnostic information from the PHY.
+
+Request Contents:
+
+ ==================================== ====== ============================
+ ETHTOOL_A_MSE_HEADER nested request header
+ ETHTOOL_A_MSE_CHANNEL u32 optional channel enum value
+ ==================================== ====== ============================
+
+.. kernel-doc:: include/uapi/linux/ethtool_netlink_generated.h
+ :identifiers: phy_mse_channel
+
+The optional ``ETHTOOL_A_MSE_CHANNEL`` attribute allows the caller to request
+data for a specific channel. If omitted, the kernel will return snapshots for
+all supported channels.
+
+Kernel Response Contents:
+
+ ==================================== ====== ============================
+ ETHTOOL_A_MSE_HEADER nested reply header
+ ETHTOOL_A_MSE_CONFIG nested MSE measurement configuration
+ ETHTOOL_A_MSE_SNAPSHOT+ nested one or more MSE snapshots
+ ==================================== ====== ============================
+
+MSE Configuration
+-----------------
+
+This nested attribute contains the full configuration properties for the MSE
+measurements
+
+ =============================================== ====== ====================
+ ETHTOOL_A_MSE_CONFIG_MAX_AVERAGE_MSE u32 max avg_mse scale
+ ETHTOOL_A_MSE_CONFIG_MAX_PEAK_MSE u32 max peak_mse scale
+ ETHTOOL_A_MSE_CONFIG_REFRESH_RATE_PS u64 sample rate (ps)
+ ETHTOOL_A_MSE_CONFIG_NUM_SYMBOLS u64 symbols per sample
+ ETHTOOL_A_MSE_CONFIG_SUPPORTED_CAPS bitset capability bitmask
+ =============================================== ====== ====================
+
+.. kernel-doc:: include/linux/phy.h
+ :identifiers: phy_mse_config
+
+.. kernel-doc:: include/uapi/linux/ethtool_netlink_generated.h
+ :identifiers: phy_mse_snapshot
+
+MSE Snapshot
+------------
+
+This nested attribute contains an atomic snapshot of MSE values for a specific
+channel or for the link as a whole.
+
+ =============================================== ====== ======================
+ ETHTOOL_A_MSE_SNAPSHOT_CHANNEL u32 channel enum value
+ ETHTOOL_A_MSE_SNAPSHOT_AVERAGE_MSE u32 average MSE value
+ ETHTOOL_A_MSE_SNAPSHOT_PEAK_MSE u32 current peak MSE
+ ETHTOOL_A_MSE_SNAPSHOT_WORST_PEAK_MSE u32 worst-case peak MSE
+ =============================================== ====== ======================
+
+.. kernel-doc:: include/linux/phy.h
+ :identifiers: phy_mse_snapshot
+
Request translation
===================
diff --git a/include/uapi/linux/ethtool_netlink_generated.h b/include/uapi/linux/ethtool_netlink_generated.h
index 71d0ded01a3a..9c37a96a320b 100644
--- a/include/uapi/linux/ethtool_netlink_generated.h
+++ b/include/uapi/linux/ethtool_netlink_generated.h
@@ -845,6 +845,41 @@ enum {
ETHTOOL_A_PSE_NTF_MAX = (__ETHTOOL_A_PSE_NTF_CNT - 1)
};
+enum {
+ ETHTOOL_A_MSE_CONFIG_UNSPEC,
+ ETHTOOL_A_MSE_CONFIG_MAX_AVERAGE_MSE,
+ ETHTOOL_A_MSE_CONFIG_MAX_PEAK_MSE,
+ ETHTOOL_A_MSE_CONFIG_REFRESH_RATE_PS,
+ ETHTOOL_A_MSE_CONFIG_NUM_SYMBOLS,
+ ETHTOOL_A_MSE_CONFIG_SUPPORTED_CAPS,
+ ETHTOOL_A_MSE_CONFIG_PAD,
+
+ __ETHTOOL_A_MSE_CONFIG_CNT,
+ ETHTOOL_A_MSE_CONFIG_MAX = (__ETHTOOL_A_MSE_CONFIG_CNT - 1)
+};
+
+enum {
+ ETHTOOL_A_MSE_SNAPSHOT_UNSPEC,
+ ETHTOOL_A_MSE_SNAPSHOT_CHANNEL,
+ ETHTOOL_A_MSE_SNAPSHOT_AVERAGE_MSE,
+ ETHTOOL_A_MSE_SNAPSHOT_PEAK_MSE,
+ ETHTOOL_A_MSE_SNAPSHOT_WORST_PEAK_MSE,
+
+ __ETHTOOL_A_MSE_SNAPSHOT_CNT,
+ ETHTOOL_A_MSE_SNAPSHOT_MAX = (__ETHTOOL_A_MSE_SNAPSHOT_CNT - 1)
+};
+
+enum {
+ ETHTOOL_A_MSE_UNSPEC,
+ ETHTOOL_A_MSE_HEADER,
+ ETHTOOL_A_MSE_CHANNEL,
+ ETHTOOL_A_MSE_CONFIG,
+ ETHTOOL_A_MSE_SNAPSHOT,
+
+ __ETHTOOL_A_MSE_CNT,
+ ETHTOOL_A_MSE_MAX = (__ETHTOOL_A_MSE_CNT - 1)
+};
+
enum {
ETHTOOL_MSG_USER_NONE = 0,
ETHTOOL_MSG_STRSET_GET = 1,
@@ -897,6 +932,7 @@ enum {
ETHTOOL_MSG_RSS_SET,
ETHTOOL_MSG_RSS_CREATE_ACT,
ETHTOOL_MSG_RSS_DELETE_ACT,
+ ETHTOOL_MSG_MSE_GET,
__ETHTOOL_MSG_USER_CNT,
ETHTOOL_MSG_USER_MAX = (__ETHTOOL_MSG_USER_CNT - 1)
@@ -957,6 +993,7 @@ enum {
ETHTOOL_MSG_RSS_CREATE_ACT_REPLY,
ETHTOOL_MSG_RSS_CREATE_NTF,
ETHTOOL_MSG_RSS_DELETE_NTF,
+ ETHTOOL_MSG_MSE_GET_REPLY,
__ETHTOOL_MSG_KERNEL_CNT,
ETHTOOL_MSG_KERNEL_MAX = (__ETHTOOL_MSG_KERNEL_CNT - 1)
diff --git a/net/ethtool/Makefile b/net/ethtool/Makefile
index a1490c4afe6b..1be76e8d584f 100644
--- a/net/ethtool/Makefile
+++ b/net/ethtool/Makefile
@@ -9,4 +9,4 @@ ethtool_nl-y := netlink.o bitset.o strset.o linkinfo.o linkmodes.o rss.o \
channels.o coalesce.o pause.o eee.o tsinfo.o cabletest.o \
tunnels.o fec.o eeprom.o stats.o phc_vclocks.o mm.o \
module.o cmis_fw_update.o cmis_cdb.o pse-pd.o plca.o mm.o \
- phy.o tsconfig.o
+ phy.o tsconfig.o mse.o
diff --git a/net/ethtool/mse.c b/net/ethtool/mse.c
new file mode 100644
index 000000000000..78389491cc49
--- /dev/null
+++ b/net/ethtool/mse.c
@@ -0,0 +1,362 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+#include <linux/ethtool.h>
+#include <linux/phy.h>
+#include <linux/slab.h>
+
+#include "netlink.h"
+#include "common.h"
+
+#define PHY_MSE_CHANNEL_COUNT 4
+
+struct mse_req_info {
+ struct ethnl_req_info base;
+};
+
+struct mse_snapshot_entry {
+ struct phy_mse_snapshot snapshot;
+ int channel;
+};
+
+struct mse_reply_data {
+ struct ethnl_reply_data base;
+ struct phy_mse_config config;
+ struct mse_snapshot_entry *snapshots;
+ unsigned int num_snapshots;
+};
+
+static inline struct mse_reply_data *
+mse_repdata(const struct ethnl_reply_data *reply_base)
+{
+ return container_of(reply_base, struct mse_reply_data, base);
+}
+
+const struct nla_policy ethnl_mse_get_policy[] = {
+ [ETHTOOL_A_MSE_HEADER] = NLA_POLICY_NESTED(ethnl_header_policy_phy),
+ [ETHTOOL_A_MSE_CHANNEL] = { .type = NLA_U32 },
+};
+
+static int get_snapshot_if_supported(struct phy_device *phydev,
+ struct mse_reply_data *data,
+ unsigned int *idx, u32 cap_bit,
+ int channel_id)
+{
+ int ret;
+
+ if (data->config.supported_caps & cap_bit) {
+ ret = phydev->drv->get_mse_snapshot(phydev, channel_id,
+ &data->snapshots[*idx].snapshot);
+ if (ret)
+ return ret;
+ data->snapshots[*idx].channel = channel_id;
+ (*idx)++;
+ }
+
+ return 0;
+}
+
+static int mse_get_channels(struct phy_device *phydev,
+ struct mse_reply_data *data)
+{
+ unsigned int i = 0;
+ int ret;
+
+ if (!data->config.supported_caps)
+ return 0;
+
+ data->snapshots = kcalloc(PHY_MSE_CHANNEL_COUNT,
+ sizeof(*data->snapshots), GFP_KERNEL);
+ if (!data->snapshots)
+ return -ENOMEM;
+
+ /* Priority 1: Individual channels */
+ ret = get_snapshot_if_supported(phydev, data, &i, PHY_MSE_CAP_CHANNEL_A,
+ PHY_MSE_CHANNEL_A);
+ if (ret)
+ return ret;
+ ret = get_snapshot_if_supported(phydev, data, &i, PHY_MSE_CAP_CHANNEL_B,
+ PHY_MSE_CHANNEL_B);
+ if (ret)
+ return ret;
+ ret = get_snapshot_if_supported(phydev, data, &i, PHY_MSE_CAP_CHANNEL_C,
+ PHY_MSE_CHANNEL_C);
+ if (ret)
+ return ret;
+ ret = get_snapshot_if_supported(phydev, data, &i, PHY_MSE_CAP_CHANNEL_D,
+ PHY_MSE_CHANNEL_D);
+ if (ret)
+ return ret;
+
+ /* If any individual channels were found, we are done. */
+ if (i > 0) {
+ data->num_snapshots = i;
+ return 0;
+ }
+
+ /* Priority 2: Worst channel, if no individual channels supported. */
+ ret = get_snapshot_if_supported(phydev, data, &i,
+ PHY_MSE_CAP_WORST_CHANNEL,
+ PHY_MSE_CHANNEL_WORST);
+ if (ret)
+ return ret;
+
+ /* If worst channel was found, we are done. */
+ if (i > 0) {
+ data->num_snapshots = i;
+ return 0;
+ }
+
+ /* Priority 3: Link-wide, if nothing else is supported. */
+ ret = get_snapshot_if_supported(phydev, data, &i, PHY_MSE_CAP_LINK,
+ PHY_MSE_CHANNEL_LINK);
+ if (ret)
+ return ret;
+
+ data->num_snapshots = i;
+ return 0;
+}
+
+static int mse_get_one_channel(struct phy_device *phydev,
+ struct mse_reply_data *data, int channel)
+{
+ u32 cap_bit = 0;
+ int ret;
+
+ switch (channel) {
+ case PHY_MSE_CHANNEL_A:
+ cap_bit = PHY_MSE_CAP_CHANNEL_A;
+ break;
+ case PHY_MSE_CHANNEL_B:
+ cap_bit = PHY_MSE_CAP_CHANNEL_B;
+ break;
+ case PHY_MSE_CHANNEL_C:
+ cap_bit = PHY_MSE_CAP_CHANNEL_C;
+ break;
+ case PHY_MSE_CHANNEL_D:
+ cap_bit = PHY_MSE_CAP_CHANNEL_D;
+ break;
+ case PHY_MSE_CHANNEL_WORST:
+ cap_bit = PHY_MSE_CAP_WORST_CHANNEL;
+ break;
+ case PHY_MSE_CHANNEL_LINK:
+ cap_bit = PHY_MSE_CAP_LINK;
+ break;
+ default:
+ return -EINVAL;
+ }
+
+ if (!(data->config.supported_caps & cap_bit))
+ return -EOPNOTSUPP;
+
+ data->snapshots = kzalloc(sizeof(*data->snapshots), GFP_KERNEL);
+ if (!data->snapshots)
+ return -ENOMEM;
+
+ ret = phydev->drv->get_mse_snapshot(phydev, channel,
+ &data->snapshots[0].snapshot);
+ if (ret)
+ return ret;
+
+ data->snapshots[0].channel = channel;
+ data->num_snapshots = 1;
+ return 0;
+}
+
+static int mse_prepare_data(const struct ethnl_req_info *req_base,
+ struct ethnl_reply_data *reply_base,
+ const struct genl_info *info)
+{
+ struct mse_reply_data *data = mse_repdata(reply_base);
+ struct net_device *dev = reply_base->dev;
+ struct phy_device *phydev;
+ int ret;
+
+ phydev = ethnl_req_get_phydev(req_base, info->attrs,
+ ETHTOOL_A_MSE_HEADER, info->extack);
+ if (IS_ERR(phydev))
+ return PTR_ERR(phydev);
+ if (!phydev)
+ return -EOPNOTSUPP;
+
+ ret = ethnl_ops_begin(dev);
+ if (ret)
+ return ret;
+
+ mutex_lock(&phydev->lock);
+
+ if (!phydev->drv || !phydev->drv->get_mse_config ||
+ !phydev->drv->get_mse_snapshot) {
+ ret = -EOPNOTSUPP;
+ goto out_unlock;
+ }
+ if (!phydev->link) {
+ ret = -ENETDOWN;
+ goto out_unlock;
+ }
+
+ ret = phydev->drv->get_mse_config(phydev, &data->config);
+ if (ret)
+ goto out_unlock;
+
+ if (info->attrs[ETHTOOL_A_MSE_CHANNEL]) {
+ u32 channel = nla_get_u32(info->attrs[ETHTOOL_A_MSE_CHANNEL]);
+
+ ret = mse_get_one_channel(phydev, data, channel);
+ } else {
+ ret = mse_get_channels(phydev, data);
+ }
+
+out_unlock:
+ mutex_unlock(&phydev->lock);
+ ethnl_ops_complete(dev);
+ if (ret)
+ kfree(data->snapshots);
+ return ret;
+}
+
+static void mse_cleanup_data(struct ethnl_reply_data *reply_base)
+{
+ struct mse_reply_data *data = mse_repdata(reply_base);
+
+ kfree(data->snapshots);
+}
+
+static int mse_reply_size(const struct ethnl_req_info *req_base,
+ const struct ethnl_reply_data *reply_base)
+{
+ const struct mse_reply_data *data = mse_repdata(reply_base);
+ size_t len = 0;
+ unsigned int i;
+
+ /* ETHTOOL_A_MSE_CONFIG */
+ len += nla_total_size(0);
+ if (data->config.supported_caps & PHY_MSE_CAP_AVG)
+ /* ETHTOOL_A_MSE_CONFIG_MAX_AVERAGE_MSE */
+ len += nla_total_size(sizeof(u32));
+ if (data->config.supported_caps & (PHY_MSE_CAP_PEAK |
+ PHY_MSE_CAP_WORST_PEAK))
+ /* ETHTOOL_A_MSE_CONFIG_MAX_PEAK_MSE */
+ len += nla_total_size(sizeof(u32));
+ /* ETHTOOL_A_MSE_CONFIG_REFRESH_RATE_PS */
+ len += nla_total_size(sizeof(u64));
+ /* ETHTOOL_A_MSE_CONFIG_NUM_SYMBOLS */
+ len += nla_total_size(sizeof(u64));
+ /* ETHTOOL_A_MSE_CONFIG_SUPPORTED_CAPS */
+ len += nla_total_size(sizeof(u32));
+
+ for (i = 0; i < data->num_snapshots; i++) {
+ size_t snapshot_len = 0;
+
+ /* ETHTOOL_A_MSE_SNAPSHOT */
+ snapshot_len += nla_total_size(0);
+ /* ETHTOOL_A_MSE_SNAPSHOT_CHANNEL */
+ snapshot_len += nla_total_size(sizeof(u32));
+
+ if (data->config.supported_caps & PHY_MSE_CAP_AVG)
+ snapshot_len += nla_total_size(sizeof(u32));
+ if (data->config.supported_caps & PHY_MSE_CAP_PEAK)
+ snapshot_len += nla_total_size(sizeof(u32));
+ if (data->config.supported_caps & PHY_MSE_CAP_WORST_PEAK)
+ snapshot_len += nla_total_size(sizeof(u32));
+
+ len += snapshot_len;
+ }
+
+ return len;
+}
+
+static int mse_fill_reply(struct sk_buff *skb,
+ const struct ethnl_req_info *req_base,
+ const struct ethnl_reply_data *reply_base)
+{
+ const struct mse_reply_data *data = mse_repdata(reply_base);
+ struct nlattr *config_nest, *snapshot_nest;
+ unsigned int i;
+ int ret;
+
+ config_nest = nla_nest_start(skb, ETHTOOL_A_MSE_CONFIG);
+ if (!config_nest)
+ return -EMSGSIZE;
+
+ if (data->config.supported_caps & PHY_MSE_CAP_AVG)
+ if (nla_put_u32(skb, ETHTOOL_A_MSE_CONFIG_MAX_AVERAGE_MSE,
+ data->config.max_average_mse))
+ goto nla_put_config_failure;
+
+ if (data->config.supported_caps & (PHY_MSE_CAP_PEAK |
+ PHY_MSE_CAP_WORST_PEAK))
+ if (nla_put_u32(skb, ETHTOOL_A_MSE_CONFIG_MAX_PEAK_MSE,
+ data->config.max_peak_mse))
+ goto nla_put_config_failure;
+
+ if (nla_put_u64_64bit(skb, ETHTOOL_A_MSE_CONFIG_REFRESH_RATE_PS,
+ data->config.refresh_rate_ps,
+ ETHTOOL_A_MSE_CONFIG_PAD) ||
+ nla_put_u64_64bit(skb, ETHTOOL_A_MSE_CONFIG_NUM_SYMBOLS,
+ data->config.num_symbols,
+ ETHTOOL_A_MSE_CONFIG_PAD) ||
+ nla_put_u32(skb, ETHTOOL_A_MSE_CONFIG_SUPPORTED_CAPS,
+ data->config.supported_caps))
+ goto nla_put_config_failure;
+
+ nla_nest_end(skb, config_nest);
+
+ for (i = 0; i < data->num_snapshots; i++) {
+ const struct mse_snapshot_entry *s = &data->snapshots[i];
+
+ snapshot_nest = nla_nest_start(skb, ETHTOOL_A_MSE_SNAPSHOT);
+ if (!snapshot_nest)
+ return -EMSGSIZE;
+
+ ret = nla_put_u32(skb, ETHTOOL_A_MSE_SNAPSHOT_CHANNEL,
+ s->channel);
+ if (ret)
+ goto nla_put_failure;
+
+ if (data->config.supported_caps & PHY_MSE_CAP_AVG) {
+ ret = nla_put_u32(skb,
+ ETHTOOL_A_MSE_SNAPSHOT_AVERAGE_MSE,
+ s->snapshot.average_mse);
+ if (ret)
+ goto nla_put_failure;
+ }
+ if (data->config.supported_caps & PHY_MSE_CAP_PEAK) {
+ ret = nla_put_u32(skb, ETHTOOL_A_MSE_SNAPSHOT_PEAK_MSE,
+ s->snapshot.peak_mse);
+ if (ret)
+ goto nla_put_failure;
+ }
+ if (data->config.supported_caps & PHY_MSE_CAP_WORST_PEAK) {
+ ret = nla_put_u32(skb,
+ ETHTOOL_A_MSE_SNAPSHOT_WORST_PEAK_MSE,
+ s->snapshot.worst_peak_mse);
+ if (ret)
+ goto nla_put_failure;
+ }
+
+ nla_nest_end(skb, snapshot_nest);
+ }
+
+ return 0;
+
+nla_put_config_failure:
+ nla_nest_cancel(skb, config_nest);
+ return -EMSGSIZE;
+
+nla_put_failure:
+ nla_nest_cancel(skb, snapshot_nest);
+ return -EMSGSIZE;
+}
+
+const struct ethnl_request_ops ethnl_mse_request_ops = {
+ .request_cmd = ETHTOOL_MSG_MSE_GET,
+ .reply_cmd = ETHTOOL_MSG_MSE_GET_REPLY,
+ .hdr_attr = ETHTOOL_A_MSE_HEADER,
+ .req_info_size = sizeof(struct mse_req_info),
+ .reply_data_size = sizeof(struct mse_reply_data),
+
+ .prepare_data = mse_prepare_data,
+ .cleanup_data = mse_cleanup_data,
+ .reply_size = mse_reply_size,
+ .fill_reply = mse_fill_reply,
+};
diff --git a/net/ethtool/netlink.c b/net/ethtool/netlink.c
index 2f813f25f07e..6e5f0f4f815a 100644
--- a/net/ethtool/netlink.c
+++ b/net/ethtool/netlink.c
@@ -420,6 +420,7 @@ ethnl_default_requests[__ETHTOOL_MSG_USER_CNT] = {
[ETHTOOL_MSG_TSCONFIG_GET] = ðnl_tsconfig_request_ops,
[ETHTOOL_MSG_TSCONFIG_SET] = ðnl_tsconfig_request_ops,
[ETHTOOL_MSG_PHY_GET] = ðnl_phy_request_ops,
+ [ETHTOOL_MSG_MSE_GET] = ðnl_mse_request_ops,
};
static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb)
@@ -1534,6 +1535,15 @@ static const struct genl_ops ethtool_genl_ops[] = {
.policy = ethnl_rss_delete_policy,
.maxattr = ARRAY_SIZE(ethnl_rss_delete_policy) - 1,
},
+ {
+ .cmd = ETHTOOL_MSG_MSE_GET,
+ .doit = ethnl_default_doit,
+ .start = ethnl_perphy_start,
+ .dumpit = ethnl_perphy_dumpit,
+ .done = ethnl_perphy_done,
+ .policy = ethnl_mse_get_policy,
+ .maxattr = ARRAY_SIZE(ethnl_mse_get_policy) - 1,
+ },
};
static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
diff --git a/net/ethtool/netlink.h b/net/ethtool/netlink.h
index 1d4f9ecb3d26..f9ebcfb327a6 100644
--- a/net/ethtool/netlink.h
+++ b/net/ethtool/netlink.h
@@ -442,6 +442,7 @@ extern const struct ethnl_request_ops ethnl_plca_status_request_ops;
extern const struct ethnl_request_ops ethnl_mm_request_ops;
extern const struct ethnl_request_ops ethnl_phy_request_ops;
extern const struct ethnl_request_ops ethnl_tsconfig_request_ops;
+extern const struct ethnl_request_ops ethnl_mse_request_ops;
extern const struct nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_FLAGS + 1];
extern const struct nla_policy ethnl_header_policy_stats[ETHTOOL_A_HEADER_FLAGS + 1];
@@ -497,6 +498,7 @@ extern const struct nla_policy ethnl_module_fw_flash_act_policy[ETHTOOL_A_MODULE
extern const struct nla_policy ethnl_phy_get_policy[ETHTOOL_A_PHY_HEADER + 1];
extern const struct nla_policy ethnl_tsconfig_get_policy[ETHTOOL_A_TSCONFIG_HEADER + 1];
extern const struct nla_policy ethnl_tsconfig_set_policy[ETHTOOL_A_TSCONFIG_MAX + 1];
+extern const struct nla_policy ethnl_mse_get_policy[ETHTOOL_A_MSE_CHANNEL + 1];
int ethnl_set_features(struct sk_buff *skb, struct genl_info *info);
int ethnl_act_cable_test(struct sk_buff *skb, struct genl_info *info);
--
2.39.5
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH net-next v1 3/5] ethtool: netlink: add lightweight MSE reporting to LINKSTATE_GET
2025-08-13 8:14 [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 1/5] ethtool: introduce core UAPI and driver API for PHY MSE diagnostics Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 2/5] ethtool: netlink: add ETHTOOL_MSG_MSE_GET and wire up PHY MSE access Oleksij Rempel
@ 2025-08-13 8:14 ` Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 4/5] net: phy: micrel: add MSE interface support for KSZ9477 family Oleksij Rempel
` (2 subsequent siblings)
5 siblings, 0 replies; 7+ messages in thread
From: Oleksij Rempel @ 2025-08-13 8:14 UTC (permalink / raw)
To: Andrew Lunn, Jakub Kicinski, David S. Miller, Eric Dumazet,
Paolo Abeni, Simon Horman, Donald Hunter, Jonathan Corbet,
Heiner Kallweit, Russell King, Kory Maincent, Maxime Chevallier,
Nishanth Menon
Cc: Oleksij Rempel, kernel, linux-kernel, netdev, UNGLinuxDriver,
linux-doc, Michal Kubecek, Roan van Dijk
Extend ETHTOOL_MSG_LINKSTATE_GET to optionally return a simplified
Mean Square Error (MSE) reading alongside existing link status fields.
The new attributes are:
- ETHTOOL_A_LINKSTATE_MSE_VALUE: current average MSE value
- ETHTOOL_A_LINKSTATE_MSE_MAX: scale limit for the reported value
- ETHTOOL_A_LINKSTATE_MSE_CHANNEL: source channel selector
This path reuses the PHY MSE core API, but only retrieves a single
value intended for quick link-health checks:
* If the PHY supports a WORST channel selector, report its current
average MSE.
* Otherwise, if LINK-wide measurements are supported, report those.
* If neither is available, omit the attributes.
Unlike the full MSE_GET interface, LINKSTATE_GET does not expose
per-channel or peak/worst-peak values and incurs minimal overhead.
Drivers that implement get_mse_config() / get_mse_snapshot() will
automatically populate this data.
The intent is to provide tooling with a “fast path” health indicator
without issuing a separate MSE_GET request, though the long-term
overlap with the full interface may need reevaluation.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
Documentation/networking/ethtool-netlink.rst | 9 ++
.../uapi/linux/ethtool_netlink_generated.h | 3 +
net/ethtool/linkstate.c | 84 +++++++++++++++++++
3 files changed, 96 insertions(+)
diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index 4f89c0b4e44e..696a6a6bbeb2 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -530,6 +530,9 @@ Kernel response contents:
``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state
``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate
``ETHTOOL_A_LINKSTATE_EXT_DOWN_CNT`` u32 count of link down events
+ ``ETHTOOL_A_LINKSTATE_MSE_VALUE`` u32 Current average MSE value
+ ``ETHTOOL_A_LINKSTATE_MSE_MAX`` u32 Max scale for average MSE
+ ``ETHTOOL_A_LINKSTATE_MSE_CHANNEL`` u32 Source of MSE value
==================================== ====== ============================
For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
@@ -541,6 +544,12 @@ optional values. ethtool core can provide either both
``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
+``ETHTOOL_A_LINKSTATE_MSE_VALUE`` and ``ETHTOOL_A_LINKSTATE_MSE_MAX`` are
+optional values. The MSE value provided by this interface is a lightweight,
+less detailed version for quick health checks. If only one channel is used, it
+returns the current average MSE value. If multiple channels are supported, it
+returns the current average MSE of the channel with the worst MSE.
+
``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
devices supporting the request).
diff --git a/include/uapi/linux/ethtool_netlink_generated.h b/include/uapi/linux/ethtool_netlink_generated.h
index 9c37a96a320b..6ef03a7de4ab 100644
--- a/include/uapi/linux/ethtool_netlink_generated.h
+++ b/include/uapi/linux/ethtool_netlink_generated.h
@@ -322,6 +322,9 @@ enum {
ETHTOOL_A_LINKSTATE_EXT_STATE,
ETHTOOL_A_LINKSTATE_EXT_SUBSTATE,
ETHTOOL_A_LINKSTATE_EXT_DOWN_CNT,
+ ETHTOOL_A_LINKSTATE_MSE_VALUE,
+ ETHTOOL_A_LINKSTATE_MSE_MAX,
+ ETHTOOL_A_LINKSTATE_MSE_CHANNEL,
__ETHTOOL_A_LINKSTATE_CNT,
ETHTOOL_A_LINKSTATE_MAX = (__ETHTOOL_A_LINKSTATE_CNT - 1)
diff --git a/net/ethtool/linkstate.c b/net/ethtool/linkstate.c
index 05a5f72c99fa..b27fb0ffc526 100644
--- a/net/ethtool/linkstate.c
+++ b/net/ethtool/linkstate.c
@@ -14,6 +14,9 @@ struct linkstate_reply_data {
int link;
int sqi;
int sqi_max;
+ u32 mse_value;
+ u32 mse_max;
+ u32 mse_channel;
struct ethtool_link_ext_stats link_stats;
bool link_ext_state_provided;
struct ethtool_link_ext_state_info ethtool_link_ext_state_info;
@@ -76,6 +79,65 @@ static bool linkstate_sqi_valid(struct linkstate_reply_data *data)
data->sqi <= data->sqi_max;
}
+static int linkstate_get_mse(struct phy_device *phydev,
+ struct linkstate_reply_data *data)
+{
+ struct phy_mse_snapshot snapshot = {};
+ struct phy_mse_config config = {};
+ int channel, ret;
+
+ if (!phydev)
+ return -EOPNOTSUPP;
+
+ mutex_lock(&phydev->lock);
+
+ if (!phydev->drv || !phydev->drv->get_mse_config ||
+ !phydev->drv->get_mse_snapshot) {
+ ret = -EOPNOTSUPP;
+ goto unlock;
+ }
+
+ if (!phydev->link) {
+ ret = -ENETDOWN;
+ goto unlock;
+ }
+
+ ret = phydev->drv->get_mse_config(phydev, &config);
+ if (ret)
+ goto unlock;
+
+ if (config.supported_caps & PHY_MSE_CAP_WORST_CHANNEL) {
+ channel = PHY_MSE_CHANNEL_WORST;
+ } else if (config.supported_caps & PHY_MSE_CAP_LINK) {
+ channel = PHY_MSE_CHANNEL_LINK;
+ } else {
+ ret = -EOPNOTSUPP;
+ goto unlock;
+ }
+
+ ret = phydev->drv->get_mse_snapshot(phydev, channel, &snapshot);
+ if (ret)
+ goto unlock;
+
+ data->mse_value = snapshot.average_mse;
+ data->mse_max = config.max_average_mse;
+ data->mse_channel = channel;
+
+unlock:
+ mutex_unlock(&phydev->lock);
+ return ret;
+}
+
+static bool linkstate_mse_critical_error(int err)
+{
+ return err < 0 && err != -EOPNOTSUPP && err != -ENETDOWN;
+}
+
+static bool linkstate_mse_valid(struct linkstate_reply_data *data)
+{
+ return data->mse_max > 0 && data->mse_value <= data->mse_max;
+}
+
static int linkstate_get_link_ext_state(struct net_device *dev,
struct linkstate_reply_data *data)
{
@@ -125,6 +187,10 @@ static int linkstate_prepare_data(const struct ethnl_req_info *req_base,
goto out;
data->sqi_max = ret;
+ ret = linkstate_get_mse(phydev, data);
+ if (linkstate_mse_critical_error(ret))
+ goto out;
+
if (dev->flags & IFF_UP) {
ret = linkstate_get_link_ext_state(dev, data);
if (ret < 0 && ret != -EOPNOTSUPP && ret != -ENODATA)
@@ -164,6 +230,12 @@ static int linkstate_reply_size(const struct ethnl_req_info *req_base,
len += nla_total_size(sizeof(u32)); /* LINKSTATE_SQI_MAX */
}
+ if (linkstate_mse_valid(data)) {
+ len += nla_total_size(sizeof(u32)); /* LINKSTATE_MSE_VALUE */
+ len += nla_total_size(sizeof(u32)); /* LINKSTATE_MSE_MAX */
+ len += nla_total_size(sizeof(u32)); /* LINKSTATE_MSE_CHANNEL */
+ }
+
if (data->link_ext_state_provided)
len += nla_total_size(sizeof(u8)); /* LINKSTATE_EXT_STATE */
@@ -195,6 +267,18 @@ static int linkstate_fill_reply(struct sk_buff *skb,
return -EMSGSIZE;
}
+ if (linkstate_mse_valid(data)) {
+ if (nla_put_u32(skb, ETHTOOL_A_LINKSTATE_MSE_VALUE,
+ data->mse_value))
+ return -EMSGSIZE;
+ if (nla_put_u32(skb, ETHTOOL_A_LINKSTATE_MSE_MAX,
+ data->mse_max))
+ return -EMSGSIZE;
+ if (nla_put_u32(skb, ETHTOOL_A_LINKSTATE_MSE_CHANNEL,
+ data->mse_channel))
+ return -EMSGSIZE;
+ }
+
if (data->link_ext_state_provided) {
if (nla_put_u8(skb, ETHTOOL_A_LINKSTATE_EXT_STATE,
data->ethtool_link_ext_state_info.link_ext_state))
--
2.39.5
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH net-next v1 4/5] net: phy: micrel: add MSE interface support for KSZ9477 family
2025-08-13 8:14 [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Oleksij Rempel
` (2 preceding siblings ...)
2025-08-13 8:14 ` [PATCH net-next v1 3/5] ethtool: netlink: add lightweight MSE reporting to LINKSTATE_GET Oleksij Rempel
@ 2025-08-13 8:14 ` Oleksij Rempel
2025-08-13 8:14 ` [PATCH net-next v1 5/5] net: phy: dp83td510: add MSE interface support for 10BASE-T1L Oleksij Rempel
2025-08-15 0:34 ` [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Jakub Kicinski
5 siblings, 0 replies; 7+ messages in thread
From: Oleksij Rempel @ 2025-08-13 8:14 UTC (permalink / raw)
To: Andrew Lunn, Jakub Kicinski, David S. Miller, Eric Dumazet,
Paolo Abeni, Simon Horman, Donald Hunter, Jonathan Corbet,
Heiner Kallweit, Russell King, Kory Maincent, Maxime Chevallier,
Nishanth Menon
Cc: Oleksij Rempel, kernel, linux-kernel, netdev, UNGLinuxDriver,
linux-doc, Michal Kubecek, Roan van Dijk
Implement the get_mse_config() and get_mse_snapshot() PHY driver ops
for KSZ9477-series integrated PHYs to demonstrate the new PHY MSE
UAPI.
These PHYs do not expose a documented direct MSE register, but the
Signal Quality Indicator (SQI) registers are derived from the
internal MSE computation. This hook maps SQI readings into the MSE
interface so that tooling can retrieve the raw value together with
metadata for correct interpretation in userspace.
Behaviour:
- For 1000BASE-T, report per-channel (A–D) values and support a
WORST channel selector.
- For 100BASE-TX, only LINK-wide measurements are available.
- Report average MSE only, with a max scale based on
KSZ9477_MMD_SQI_MASK and a fixed refresh rate of 2 µs.
This mapping differs from the OPEN Alliance SQI definition, which
assigns thresholds such as pre-fail indices; the MSE interface
instead provides the raw measurement, leaving interpretation to
userspace.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
drivers/net/phy/micrel.c | 76 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 76 insertions(+)
diff --git a/drivers/net/phy/micrel.c b/drivers/net/phy/micrel.c
index dc0e6b55147b..4505053bf5f1 100644
--- a/drivers/net/phy/micrel.c
+++ b/drivers/net/phy/micrel.c
@@ -2316,6 +2316,80 @@ static int kszphy_get_sqi_max(struct phy_device *phydev)
return KSZ9477_SQI_MAX;
}
+static int kszphy_get_mse_config(struct phy_device *phydev,
+ struct phy_mse_config *config)
+{
+ if (phydev->speed == SPEED_1000)
+ config->supported_caps |= PHY_MSE_CAP_CHANNEL_A |
+ PHY_MSE_CAP_CHANNEL_B |
+ PHY_MSE_CAP_CHANNEL_C |
+ PHY_MSE_CAP_CHANNEL_D |
+ PHY_MSE_CAP_WORST_CHANNEL;
+ else if (phydev->speed == SPEED_100)
+ config->supported_caps |= PHY_MSE_CAP_LINK;
+ else
+ return -EOPNOTSUPP;
+
+ config->max_average_mse = FIELD_MAX(KSZ9477_MMD_SQI_MASK);
+ config->refresh_rate_ps = 2000000; /* 2 us */
+ /* Estimated from link modulation (125 MBd per channel) and documented
+ * refresh rate of 2 µs
+ */
+ config->num_symbols = 250;
+
+ config->supported_caps |= PHY_MSE_CAP_AVG;
+
+ return 0;
+}
+
+static int kszphy_get_mse_snapshot(struct phy_device *phydev, u32 channel,
+ struct phy_mse_snapshot *snapshot)
+{
+ u8 num_channels;
+ int ret;
+
+ if (phydev->speed == SPEED_1000)
+ num_channels = 4;
+ else if (phydev->speed == SPEED_100)
+ num_channels = 1;
+ else
+ return -EOPNOTSUPP;
+
+ if (channel == PHY_MSE_CHANNEL_WORST) {
+ u32 worst_val = 0;
+ int i;
+
+ for (i = 0; i < num_channels; i++) {
+ ret = phy_read_mmd(phydev, MDIO_MMD_PMAPMD,
+ KSZ9477_MMD_SIGNAL_QUALITY_CHAN_A + i);
+ if (ret < 0)
+ return ret;
+
+ ret = FIELD_GET(KSZ9477_MMD_SQI_MASK, ret);
+ if (ret > worst_val)
+ worst_val = ret;
+ }
+ snapshot->average_mse = worst_val;
+ } else if (channel == PHY_MSE_CHANNEL_LINK && num_channels == 1) {
+ ret = phy_read_mmd(phydev, MDIO_MMD_PMAPMD,
+ KSZ9477_MMD_SIGNAL_QUALITY_CHAN_A);
+ if (ret < 0)
+ return ret;
+ snapshot->average_mse = FIELD_GET(KSZ9477_MMD_SQI_MASK, ret);
+ } else if (channel >= PHY_MSE_CHANNEL_A &&
+ channel <= PHY_MSE_CHANNEL_D) {
+ ret = phy_read_mmd(phydev, MDIO_MMD_PMAPMD,
+ KSZ9477_MMD_SIGNAL_QUALITY_CHAN_A + channel);
+ if (ret < 0)
+ return ret;
+ snapshot->average_mse = FIELD_GET(KSZ9477_MMD_SQI_MASK, ret);
+ } else {
+ return -EINVAL;
+ }
+
+ return 0;
+}
+
static void kszphy_enable_clk(struct phy_device *phydev)
{
struct kszphy_priv *priv = phydev->priv;
@@ -5954,6 +6028,8 @@ static struct phy_driver ksphy_driver[] = {
.cable_test_get_status = ksz9x31_cable_test_get_status,
.get_sqi = kszphy_get_sqi,
.get_sqi_max = kszphy_get_sqi_max,
+ .get_mse_config = kszphy_get_mse_config,
+ .get_mse_snapshot = kszphy_get_mse_snapshot,
.link_change_notify = kszphy_link_change_notify,
.soft_reset = genphy_soft_reset,
} };
--
2.39.5
^ permalink raw reply related [flat|nested] 7+ messages in thread* [PATCH net-next v1 5/5] net: phy: dp83td510: add MSE interface support for 10BASE-T1L
2025-08-13 8:14 [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Oleksij Rempel
` (3 preceding siblings ...)
2025-08-13 8:14 ` [PATCH net-next v1 4/5] net: phy: micrel: add MSE interface support for KSZ9477 family Oleksij Rempel
@ 2025-08-13 8:14 ` Oleksij Rempel
2025-08-15 0:34 ` [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Jakub Kicinski
5 siblings, 0 replies; 7+ messages in thread
From: Oleksij Rempel @ 2025-08-13 8:14 UTC (permalink / raw)
To: Andrew Lunn, Jakub Kicinski, David S. Miller, Eric Dumazet,
Paolo Abeni, Simon Horman, Donald Hunter, Jonathan Corbet,
Heiner Kallweit, Russell King, Kory Maincent, Maxime Chevallier,
Nishanth Menon
Cc: Oleksij Rempel, kernel, linux-kernel, netdev, UNGLinuxDriver,
linux-doc, Michal Kubecek, Roan van Dijk
Implement get_mse_config() and get_mse_snapshot() for the DP83TD510E
to expose its Mean Square Error (MSE) register via the new PHY MSE
UAPI.
The DP83TD510E does not document any peak MSE values; it only exposes
a single average MSE register used internally to derive SQI. This
implementation therefore advertises only PHY_MSE_CAP_AVG, along with
LINK and channel-A selectors. Scaling is fixed to 0xFFFF, and the
refresh interval/number of symbols are estimated from 10BASE-T1L
symbol rate (7.5 MBd) and typical diagnostic intervals (~1 ms).
For 10BASE-T1L deployments, SQI is a reliable indicator of link
modulation quality once the link is established, but it does not
indicate whether autonegotiation pulses will be correctly received
in marginal conditions. MSE provides a direct measurement of slicer
error rate that can be used to evaluate if autonegotiation is likely
to succeed under a given cable length and condition. In practice,
testing such scenarios often requires forcing a fixed-link setup to
isolate MSE behaviour from the autonegotiation process.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
drivers/net/phy/dp83td510.c | 44 +++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/drivers/net/phy/dp83td510.c b/drivers/net/phy/dp83td510.c
index 23af1ac194fa..094c070f3f96 100644
--- a/drivers/net/phy/dp83td510.c
+++ b/drivers/net/phy/dp83td510.c
@@ -249,6 +249,47 @@ struct dp83td510_priv {
#define DP83TD510E_ALCD_COMPLETE BIT(15)
#define DP83TD510E_ALCD_CABLE_LENGTH GENMASK(10, 0)
+static int dp83td510_get_mse_config(struct phy_device *phydev,
+ struct phy_mse_config *config)
+{
+ /* The DP83TD510E datasheet does not specify peak MSE values.
+ * It only provides a single MSE value which is used to derive SQI.
+ * Therefore, we only support the average MSE capability.
+ */
+ config->supported_caps = PHY_MSE_CAP_AVG | PHY_MSE_CAP_LINK |
+ PHY_MSE_CAP_CHANNEL_A;
+ config->max_average_mse = 0xFFFF;
+
+ /* The datasheet does not specify the refresh rate or symbol count,
+ * but based on similar PHYs and standards, we can assume a common
+ * value. For 10BaseT1L, the symbol rate is 7.5 MBd. A common
+ * diagnostic interval is around 1ms.
+ * 7.5e6 symbols/sec * 0.001 sec = 7500 symbols.
+ */
+ config->refresh_rate_ps = 1000000000; /* 1 ms */
+ config->num_symbols = 7500;
+
+ return 0;
+}
+
+static int dp83td510_get_mse_snapshot(struct phy_device *phydev, u32 channel,
+ struct phy_mse_snapshot *snapshot)
+{
+ int ret;
+
+ if (channel != PHY_MSE_CHANNEL_LINK &&
+ channel != PHY_MSE_CHANNEL_A)
+ return -EOPNOTSUPP;
+
+ ret = phy_read_mmd(phydev, MDIO_MMD_VEND2, DP83TD510E_MSE_DETECT);
+ if (ret < 0)
+ return ret;
+
+ snapshot->average_mse = ret;
+
+ return 0;
+}
+
static int dp83td510_led_brightness_set(struct phy_device *phydev, u8 index,
enum led_brightness brightness)
{
@@ -893,6 +934,9 @@ static struct phy_driver dp83td510_driver[] = {
.get_phy_stats = dp83td510_get_phy_stats,
.update_stats = dp83td510_update_stats,
+ .get_mse_config = dp83td510_get_mse_config,
+ .get_mse_snapshot = dp83td510_get_mse_snapshot,
+
.led_brightness_set = dp83td510_led_brightness_set,
.led_hw_is_supported = dp83td510_led_hw_is_supported,
.led_hw_control_set = dp83td510_led_hw_control_set,
--
2.39.5
^ permalink raw reply related [flat|nested] 7+ messages in thread* Re: [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers
2025-08-13 8:14 [PATCH net-next v1 0/5] ethtool: introduce PHY MSE diagnostics UAPI and drivers Oleksij Rempel
` (4 preceding siblings ...)
2025-08-13 8:14 ` [PATCH net-next v1 5/5] net: phy: dp83td510: add MSE interface support for 10BASE-T1L Oleksij Rempel
@ 2025-08-15 0:34 ` Jakub Kicinski
5 siblings, 0 replies; 7+ messages in thread
From: Jakub Kicinski @ 2025-08-15 0:34 UTC (permalink / raw)
To: Oleksij Rempel
Cc: Andrew Lunn, David S. Miller, Eric Dumazet, Paolo Abeni,
Simon Horman, Donald Hunter, Jonathan Corbet, Heiner Kallweit,
Russell King, Kory Maincent, Maxime Chevallier, Nishanth Menon,
kernel, linux-kernel, netdev, UNGLinuxDriver, linux-doc,
Michal Kubecek, Roan van Dijk
On Wed, 13 Aug 2025 10:14:48 +0200 Oleksij Rempel wrote:
> This series introduces a generic kernel-userspace API for retrieving PHY
> Mean Square Error (MSE) diagnostics, together with netlink integration,
> a fast-path reporting hook in LINKSTATE_GET, and initial driver
> implementations for the KSZ9477 and DP83TD510E PHYs.
Hi Oleksij, the series doesn't apply, could you respin?
I haven't had a chance to look at the code unfortunately
--
pw-bot: cr
^ permalink raw reply [flat|nested] 7+ messages in thread