netdev - Re: [PATCH net-next v3 2/5] ethtool: netlink: add ETHTOOL_MSG_MSE

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20250820114158.187a5043@kmaincent-XPS-13-7390>
Date: Wed, 20 Aug 2025 11:41:58 +0200
From: Kory Maincent <kory.maincent@...tlin.com>
To: Oleksij Rempel <o.rempel@...gutronix.de>
Cc: Andrew Lunn <andrew@...n.ch>, Jakub Kicinski <kuba@...nel.org>, "David
 S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, Paolo
 Abeni <pabeni@...hat.com>, Simon Horman <horms@...nel.org>, Donald Hunter
 <donald.hunter@...il.com>, Jonathan Corbet <corbet@....net>, Heiner
 Kallweit <hkallweit1@...il.com>, Russell King <linux@...linux.org.uk>,
 Maxime Chevallier <maxime.chevallier@...tlin.com>, Nishanth Menon
 <nm@...com>, kernel@...gutronix.de, linux-kernel@...r.kernel.org,
 netdev@...r.kernel.org, UNGLinuxDriver@...rochip.com,
 linux-doc@...r.kernel.org, Michal Kubecek <mkubecek@...e.cz>, Roan van Dijk
 <roan@...tonic.nl>
Subject: Re: [PATCH net-next v3 2/5] ethtool: netlink: add
 ETHTOOL_MSG_MSE_GET and wire up PHY MSE access

Le Tue, 19 Aug 2025 09:12:53 +0200,
Oleksij Rempel <o.rempel@...gutronix.de> a écrit :

> 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@...gutronix.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 6bffac0904f1..ed4774826b16
> 100644 --- a/Documentation/netlink/specs/ethtool.yaml
> +++ b/Documentation/netlink/specs/ethtool.yaml
> @@ -1872,6 +1872,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

Please use double dash here, Jakub wants to remove all underscore from the
specs.

> +  -
> +    name: mse-snapshot
> +    attr-cnt-name: __ethtool-a-mse-snapshot-cnt

Same

> +    name: mse
> +    attr-cnt-name: __ethtool-a-mse-cnt

Same

...

> +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

I think you forgot to remove this kernel-doc lines as the MSE snapshot is
described below.

> +
> +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
>  ===================

-- 
Köry Maincent, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com