Commit f625aa9b authored by Michal Kubecek's avatar Michal Kubecek Committed by David S. Miller
Browse files

ethtool: provide link mode information with LINKMODES_GET request 



Implement LINKMODES_GET netlink request to get link modes related
information provided by ETHTOOL_GLINKSETTINGS and ETHTOOL_GSET ioctl
commands.

This request provides supported, advertised and peer advertised link modes,
autonegotiation flag, speed and duplex.

LINKMODES_GET request can be used with NLM_F_DUMP (without device
identification) to request the information for all devices in current
network namespace providing the data.

Signed-off-by: default avatarMichal Kubecek <mkubecek@suse.cz>
Reviewed-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 73286734

Documentation/networking/ethtool-netlink.rst

+36 −0
Original line number Diff line number Diff line
@@ -182,6 +182,7 @@ Userspace to kernel: 
  ``ETHTOOL_MSG_STRSET_GET``            get string set

  ``ETHTOOL_MSG_LINKINFO_GET``          get link settings

  ``ETHTOOL_MSG_LINKINFO_SET``          set link settings

  ``ETHTOOL_MSG_LINKMODES_GET``         get link modes info

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



Kernel to userspace:
@@ -190,6 +191,7 @@ Kernel to userspace: 
  ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents

  ``ETHTOOL_MSG_LINKINFO_GET_REPLY``    link settings

  ``ETHTOOL_MSG_LINKINFO_NTF``          link settings notification

  ``ETHTOOL_MSG_LINKMODES_GET_REPLY``   link modes info

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



``GET`` requests are sent by userspace applications to retrieve device
@@ -332,6 +334,38 @@ MDI(-X) status and transceiver cannot be set, request with the corresponding 
attributes is rejected.





LINKMODES_GET

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



Requests link modes (supported, advertised and peer advertised) and related

information (autonegotiation status, link speed and duplex) as provided by

``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.



Request contents:



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

  ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header

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



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

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



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

represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit

list.



``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all

devices supporting the request).





Request translation

===================
@@ -343,6 +377,7 @@ have their netlink replacement yet. 
  ioctl command                       netlink command

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

  ``ETHTOOL_GSET``                    ``ETHTOOL_MSG_LINKINFO_GET``

                                      ``ETHTOOL_MSG_LINKMODES_GET``

  ``ETHTOOL_SSET``                    ``ETHTOOL_MSG_LINKINFO_SET``

  ``ETHTOOL_GDRVINFO``                n/a

  ``ETHTOOL_GREGS``                   n/a
@@ -417,6 +452,7 @@ have their netlink replacement yet. 
  ``ETHTOOL_GPHYSTATS``               n/a

  ``ETHTOOL_PERQUEUE``                n/a

  ``ETHTOOL_GLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_GET``

                                      ``ETHTOOL_MSG_LINKMODES_GET``

  ``ETHTOOL_SLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_SET``

  ``ETHTOOL_PHY_GTUNABLE``            n/a

  ``ETHTOOL_PHY_STUNABLE``            n/a

include/linux/ethtool_netlink.h

+3 −0
Original line number Diff line number Diff line
@@ -7,6 +7,9 @@ 
#include <linux/ethtool.h>

#include <linux/netdevice.h>



#define __ETHTOOL_LINK_MODE_MASK_NWORDS \

	DIV_ROUND_UP(__ETHTOOL_LINK_MODE_MASK_NBITS, 32)



enum ethtool_multicast_groups {

	ETHNL_MCGRP_MONITOR,

};

include/uapi/linux/ethtool_netlink.h

+18 −0
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ enum { 
	ETHTOOL_MSG_STRSET_GET,

	ETHTOOL_MSG_LINKINFO_GET,

	ETHTOOL_MSG_LINKINFO_SET,

	ETHTOOL_MSG_LINKMODES_GET,



	/* add new constants above here */

	__ETHTOOL_MSG_USER_CNT,
@@ -29,6 +30,7 @@ enum { 
	ETHTOOL_MSG_STRSET_GET_REPLY,

	ETHTOOL_MSG_LINKINFO_GET_REPLY,

	ETHTOOL_MSG_LINKINFO_NTF,

	ETHTOOL_MSG_LINKMODES_GET_REPLY,



	/* add new constants above here */

	__ETHTOOL_MSG_KERNEL_CNT,
@@ -161,6 +163,22 @@ enum { 
	ETHTOOL_A_LINKINFO_MAX = __ETHTOOL_A_LINKINFO_CNT - 1

};



/* LINKMODES */



enum {

	ETHTOOL_A_LINKMODES_UNSPEC,

	ETHTOOL_A_LINKMODES_HEADER,		/* nest - _A_HEADER_* */

	ETHTOOL_A_LINKMODES_AUTONEG,		/* u8 */

	ETHTOOL_A_LINKMODES_OURS,		/* bitset */

	ETHTOOL_A_LINKMODES_PEER,		/* bitset */

	ETHTOOL_A_LINKMODES_SPEED,		/* u32 */

	ETHTOOL_A_LINKMODES_DUPLEX,		/* u8 */



	/* add new constants above here */

	__ETHTOOL_A_LINKMODES_CNT,

	ETHTOOL_A_LINKMODES_MAX = __ETHTOOL_A_LINKMODES_CNT - 1

};



/* generic netlink info */

#define ETHTOOL_GENL_NAME "ethtool"

#define ETHTOOL_GENL_VERSION 1

net/ethtool/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -4,4 +4,4 @@ obj-y += ioctl.o common.o 


obj-$(CONFIG_ETHTOOL_NETLINK)	+= ethtool_nl.o



ethtool_nl-y	:= netlink.o bitset.o strset.o linkinfo.o
 
ethtool_nl-y	:= netlink.o bitset.o strset.o linkinfo.o linkmodes.o

net/ethtool/linkmodes.c

0 → 100644
+140 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only



#include "netlink.h"

#include "common.h"

#include "bitset.h"



struct linkmodes_req_info {

	struct ethnl_req_info		base;

};



struct linkmodes_reply_data {

	struct ethnl_reply_data		base;

	struct ethtool_link_ksettings	ksettings;

	struct ethtool_link_settings	*lsettings;

	bool				peer_empty;

};



#define LINKMODES_REPDATA(__reply_base) \

	container_of(__reply_base, struct linkmodes_reply_data, base)



static const struct nla_policy

linkmodes_get_policy[ETHTOOL_A_LINKMODES_MAX + 1] = {

	[ETHTOOL_A_LINKMODES_UNSPEC]		= { .type = NLA_REJECT },

	[ETHTOOL_A_LINKMODES_HEADER]		= { .type = NLA_NESTED },

	[ETHTOOL_A_LINKMODES_AUTONEG]		= { .type = NLA_REJECT },

	[ETHTOOL_A_LINKMODES_OURS]		= { .type = NLA_REJECT },

	[ETHTOOL_A_LINKMODES_PEER]		= { .type = NLA_REJECT },

	[ETHTOOL_A_LINKMODES_SPEED]		= { .type = NLA_REJECT },

	[ETHTOOL_A_LINKMODES_DUPLEX]		= { .type = NLA_REJECT },

};



static int linkmodes_prepare_data(const struct ethnl_req_info *req_base,

				  struct ethnl_reply_data *reply_base,

				  struct genl_info *info)

{

	struct linkmodes_reply_data *data = LINKMODES_REPDATA(reply_base);

	struct net_device *dev = reply_base->dev;

	int ret;



	data->lsettings = &data->ksettings.base;



	ret = ethnl_ops_begin(dev);

	if (ret < 0)

		return ret;



	ret = __ethtool_get_link_ksettings(dev, &data->ksettings);

	if (ret < 0 && info) {

		GENL_SET_ERR_MSG(info, "failed to retrieve link settings");

		goto out;

	}



	data->peer_empty =

		bitmap_empty(data->ksettings.link_modes.lp_advertising,

			     __ETHTOOL_LINK_MODE_MASK_NBITS);



out:

	ethnl_ops_complete(dev);

	return ret;

}



static int linkmodes_reply_size(const struct ethnl_req_info *req_base,

				const struct ethnl_reply_data *reply_base)

{

	const struct linkmodes_reply_data *data = LINKMODES_REPDATA(reply_base);

	const struct ethtool_link_ksettings *ksettings = &data->ksettings;

	bool compact = req_base->flags & ETHTOOL_FLAG_COMPACT_BITSETS;

	int len, ret;



	len = nla_total_size(sizeof(u8)) /* LINKMODES_AUTONEG */

		+ nla_total_size(sizeof(u32)) /* LINKMODES_SPEED */

		+ nla_total_size(sizeof(u8)) /* LINKMODES_DUPLEX */

		+ 0;

	ret = ethnl_bitset_size(ksettings->link_modes.advertising,

				ksettings->link_modes.supported,

				__ETHTOOL_LINK_MODE_MASK_NBITS,

				link_mode_names, compact);

	if (ret < 0)

		return ret;

	len += ret;

	if (!data->peer_empty) {

		ret = ethnl_bitset_size(ksettings->link_modes.lp_advertising,

					NULL, __ETHTOOL_LINK_MODE_MASK_NBITS,

					link_mode_names, compact);

		if (ret < 0)

			return ret;

		len += ret;

	}



	return len;

}



static int linkmodes_fill_reply(struct sk_buff *skb,

				const struct ethnl_req_info *req_base,

				const struct ethnl_reply_data *reply_base)

{

	const struct linkmodes_reply_data *data = LINKMODES_REPDATA(reply_base);

	const struct ethtool_link_ksettings *ksettings = &data->ksettings;

	const struct ethtool_link_settings *lsettings = &ksettings->base;

	bool compact = req_base->flags & ETHTOOL_FLAG_COMPACT_BITSETS;

	int ret;



	if (nla_put_u8(skb, ETHTOOL_A_LINKMODES_AUTONEG, lsettings->autoneg))

		return -EMSGSIZE;



	ret = ethnl_put_bitset(skb, ETHTOOL_A_LINKMODES_OURS,

			       ksettings->link_modes.advertising,

			       ksettings->link_modes.supported,

			       __ETHTOOL_LINK_MODE_MASK_NBITS, link_mode_names,

			       compact);

	if (ret < 0)

		return -EMSGSIZE;

	if (!data->peer_empty) {

		ret = ethnl_put_bitset(skb, ETHTOOL_A_LINKMODES_PEER,

				       ksettings->link_modes.lp_advertising,

				       NULL, __ETHTOOL_LINK_MODE_MASK_NBITS,

				       link_mode_names, compact);

		if (ret < 0)

			return -EMSGSIZE;

	}



	if (nla_put_u32(skb, ETHTOOL_A_LINKMODES_SPEED, lsettings->speed) ||

	    nla_put_u8(skb, ETHTOOL_A_LINKMODES_DUPLEX, lsettings->duplex))

		return -EMSGSIZE;



	return 0;

}



const struct ethnl_request_ops ethnl_linkmodes_request_ops = {

	.request_cmd		= ETHTOOL_MSG_LINKMODES_GET,

	.reply_cmd		= ETHTOOL_MSG_LINKMODES_GET_REPLY,

	.hdr_attr		= ETHTOOL_A_LINKMODES_HEADER,

	.max_attr		= ETHTOOL_A_LINKMODES_MAX,

	.req_info_size		= sizeof(struct linkmodes_req_info),

	.reply_data_size	= sizeof(struct linkmodes_reply_data),

	.request_policy		= linkmodes_get_policy,



	.prepare_data		= linkmodes_prepare_data,

	.reply_size		= linkmodes_reply_size,

	.fill_reply		= linkmodes_fill_reply,

};

CRA Git | Maintained and supported by SUSTech CRA and CCSE