net: ethtool: Allow passing a phy index for some commands
authorMaxime Chevallier <maxime.chevallier@bootlin.com>
Thu, 21 Dec 2023 18:00:38 +0000 (19:00 +0100)
committerDavid S. Miller <davem@davemloft.net>
Mon, 1 Jan 2024 18:38:57 +0000 (18:38 +0000)
Some netlink commands are target towards ethernet PHYs, to control some
of their features. As there's several such commands, add the ability to
pass a PHY index in the ethnl request, which will populate the generic
ethnl_req_info with the relevant phydev when the command targets a PHY.

Signed-off-by: Maxime Chevallier <maxime.chevallier@bootlin.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/ethtool-netlink.rst
include/uapi/linux/ethtool_netlink.h
net/ethtool/netlink.c
net/ethtool/netlink.h

index d583d9abf2f80698a7f4ca3ef47ce676e71767e1..3ca6c21e74af6e2a20ea0419d6ace7838b8699d3 100644 (file)
@@ -57,6 +57,7 @@ Structure of this header is
   ``ETHTOOL_A_HEADER_DEV_INDEX``  u32     device ifindex
   ``ETHTOOL_A_HEADER_DEV_NAME``   string  device name
   ``ETHTOOL_A_HEADER_FLAGS``      u32     flags common for all requests
+  ``ETHTOOL_A_HEADER_PHY_INDEX``  u32     phy device index
   ==============================  ======  =============================
 
 ``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
@@ -81,6 +82,12 @@ the behaviour is backward compatible, i.e. requests from old clients not aware
 of the flag should be interpreted the way the client expects. A client must
 not set flags it does not understand.
 
+``ETHTOOL_A_HEADER_PHY_INDEX`` identify the ethernet PHY the message relates to.
+As there are numerous commands that are related to PHY configuration, and because
+we can have more than one PHY on the link, the PHY index can be passed in the
+request for the commands that needs it. It is however not mandatory, and if it
+is not passed for commands that target a PHY, the net_device.phydev pointer
+is used, as a fallback that keeps the legacy behaviour.
 
 Bit sets
 ========
index 3f89074aa06c6284632517c647d343782cf9dabb..422e8cfdd98c8358785c8c7e9e07a293533c458d 100644 (file)
@@ -133,6 +133,7 @@ enum {
        ETHTOOL_A_HEADER_DEV_INDEX,             /* u32 */
        ETHTOOL_A_HEADER_DEV_NAME,              /* string */
        ETHTOOL_A_HEADER_FLAGS,                 /* u32 - ETHTOOL_FLAG_* */
+       ETHTOOL_A_HEADER_PHY_INDEX,             /* u32 */
 
        /* add new constants above here */
        __ETHTOOL_A_HEADER_CNT,
index fe3553f60bf39e64602d932505a0851e692348a0..1c26766ce996a9740c695d339376c64010066433 100644 (file)
@@ -4,6 +4,7 @@
 #include <linux/ethtool_netlink.h>
 #include <linux/pm_runtime.h>
 #include "netlink.h"
+#include <linux/phy_link_topology.h>
 
 static struct genl_family ethtool_genl_family;
 
@@ -20,6 +21,7 @@ const struct nla_policy ethnl_header_policy[] = {
                                            .len = ALTIFNAMSIZ - 1 },
        [ETHTOOL_A_HEADER_FLAGS]        = NLA_POLICY_MASK(NLA_U32,
                                                          ETHTOOL_FLAGS_BASIC),
+       [ETHTOOL_A_HEADER_PHY_INDEX]            = NLA_POLICY_MIN(NLA_U32, 1),
 };
 
 const struct nla_policy ethnl_header_policy_stats[] = {
@@ -28,6 +30,7 @@ const struct nla_policy ethnl_header_policy_stats[] = {
                                            .len = ALTIFNAMSIZ - 1 },
        [ETHTOOL_A_HEADER_FLAGS]        = NLA_POLICY_MASK(NLA_U32,
                                                          ETHTOOL_FLAGS_STATS),
+       [ETHTOOL_A_HEADER_PHY_INDEX]            = NLA_POLICY_MIN(NLA_U32, 1),
 };
 
 int ethnl_ops_begin(struct net_device *dev)
@@ -91,6 +94,7 @@ int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
 {
        struct nlattr *tb[ARRAY_SIZE(ethnl_header_policy)];
        const struct nlattr *devname_attr;
+       struct phy_device *phydev = NULL;
        struct net_device *dev = NULL;
        u32 flags = 0;
        int ret;
@@ -145,6 +149,26 @@ int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
                return -EINVAL;
        }
 
+       if (dev) {
+               if (tb[ETHTOOL_A_HEADER_PHY_INDEX]) {
+                       u32 phy_index = nla_get_u32(tb[ETHTOOL_A_HEADER_PHY_INDEX]);
+
+                       phydev = phy_link_topo_get_phy(&dev->link_topo,
+                                                      phy_index);
+                       if (!phydev) {
+                               NL_SET_ERR_MSG_ATTR(extack, header,
+                                                   "no phy matches phy index");
+                               return -EINVAL;
+                       }
+               } else {
+                       /* If we need a PHY but no phy index is specified, fallback
+                        * to dev->phydev
+                        */
+                       phydev = dev->phydev;
+               }
+       }
+
+       req_info->phydev = phydev;
        req_info->dev = dev;
        req_info->flags = flags;
        return 0;
index 9a333a8d04c1f0d83c14e8983e4ca01578cb26f7..def84e2def9e05730816b50e7638d28c13b4b7f7 100644 (file)
@@ -250,6 +250,7 @@ static inline unsigned int ethnl_reply_header_size(void)
  * @dev:   network device the request is for (may be null)
  * @dev_tracker: refcount tracker for @dev reference
  * @flags: request flags common for all request types
+ * @phydev: phy_device connected to @dev this request is for (may be null)
  *
  * This is a common base for request specific structures holding data from
  * parsed userspace request. These always embed struct ethnl_req_info at
@@ -259,6 +260,7 @@ struct ethnl_req_info {
        struct net_device       *dev;
        netdevice_tracker       dev_tracker;
        u32                     flags;
+       struct phy_device       *phydev;
 };
 
 static inline void ethnl_parse_header_dev_put(struct ethnl_req_info *req_info)
@@ -395,9 +397,10 @@ extern const struct ethnl_request_ops ethnl_rss_request_ops;
 extern const struct ethnl_request_ops ethnl_plca_cfg_request_ops;
 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 nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_FLAGS + 1];
-extern const struct nla_policy ethnl_header_policy_stats[ETHTOOL_A_HEADER_FLAGS + 1];
+extern const struct nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_PHY_INDEX + 1];
+extern const struct nla_policy ethnl_header_policy_stats[ETHTOOL_A_HEADER_PHY_INDEX + 1];
 extern const struct nla_policy ethnl_strset_get_policy[ETHTOOL_A_STRSET_COUNTS_ONLY + 1];
 extern const struct nla_policy ethnl_linkinfo_get_policy[ETHTOOL_A_LINKINFO_HEADER + 1];
 extern const struct nla_policy ethnl_linkinfo_set_policy[ETHTOOL_A_LINKINFO_TP_MDIX_CTRL + 1];