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

ethtool: provide private flags with PRIVFLAGS_GET request 



Implement PRIVFLAGS_GET request to get private flags for a network device.
These are traditionally available via ETHTOOL_GPFLAGS ioctl request.

Signed-off-by: default avatarMichal Kubecek <mkubecek@suse.cz>
Reviewed-by: default avatarJakub Kicinski <kuba@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 9c6451ef

Documentation/networking/ethtool-netlink.rst

+29 −1
Original line number Diff line number Diff line
@@ -191,6 +191,7 @@ Userspace to kernel: 
  ``ETHTOOL_MSG_WOL_SET``               set wake-on-lan settings

  ``ETHTOOL_MSG_FEATURES_GET``          get device features

  ``ETHTOOL_MSG_FEATURES_SET``          set device features

  ``ETHTOOL_MSG_PRIVFLAGS_GET``         get private flags

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



Kernel to userspace:
@@ -209,6 +210,7 @@ Kernel to userspace: 
  ``ETHTOOL_MSG_FEATURES_GET_REPLY``    device features

  ``ETHTOOL_MSG_FEATURES_SET_REPLY``    optional reply to FEATURES_SET

  ``ETHTOOL_MSG_FEATURES_NTF``          netdev features notification

  ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY``   private flags

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



``GET`` requests are sent by userspace applications to retrieve device
@@ -598,6 +600,32 @@ request but also each time features are modified with netdev_update_features() 
or netdev_change_features().





PRIVFLAGS_GET

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



Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.



Request contents:



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

  ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header

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



Kernel response contents:



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

  ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  reply header

  ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags

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



``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.

These flags are defined by driver, their number and names (and also meaning)

are device dependent. For compact bitset format, names can be retrieved as

``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,

response uses all private flags supported by the device as mask so that client

gets the full information without having to fetch the string set with names.





Request translation

===================
@@ -647,7 +675,7 @@ have their netlink replacement yet. 
  ``ETHTOOL_SGSO``                    ``ETHTOOL_MSG_FEATURES_SET``

  ``ETHTOOL_GFLAGS``                  ``ETHTOOL_MSG_FEATURES_GET``

  ``ETHTOOL_SFLAGS``                  ``ETHTOOL_MSG_FEATURES_SET``

  ``ETHTOOL_GPFLAGS``                 n/a

  ``ETHTOOL_GPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_GET``

  ``ETHTOOL_SPFLAGS``                 n/a

  ``ETHTOOL_GRXFH``                   n/a

  ``ETHTOOL_SRXFH``                   n/a

include/uapi/linux/ethtool_netlink.h

+14 −0
Original line number Diff line number Diff line
@@ -26,6 +26,7 @@ enum { 
	ETHTOOL_MSG_WOL_SET,

	ETHTOOL_MSG_FEATURES_GET,

	ETHTOOL_MSG_FEATURES_SET,

	ETHTOOL_MSG_PRIVFLAGS_GET,



	/* add new constants above here */

	__ETHTOOL_MSG_USER_CNT,
@@ -48,6 +49,7 @@ enum { 
	ETHTOOL_MSG_FEATURES_GET_REPLY,

	ETHTOOL_MSG_FEATURES_SET_REPLY,

	ETHTOOL_MSG_FEATURES_NTF,

	ETHTOOL_MSG_PRIVFLAGS_GET_REPLY,



	/* add new constants above here */

	__ETHTOOL_MSG_KERNEL_CNT,
@@ -248,6 +250,18 @@ enum { 
	ETHTOOL_A_FEATURES_MAX = __ETHTOOL_A_FEATURES_CNT - 1

};



/* PRIVFLAGS */



enum {

	ETHTOOL_A_PRIVFLAGS_UNSPEC,

	ETHTOOL_A_PRIVFLAGS_HEADER,			/* nest - _A_HEADER_* */

	ETHTOOL_A_PRIVFLAGS_FLAGS,			/* bitset */



	/* add new constants above here */

	__ETHTOOL_A_PRIVFLAGS_CNT,

	ETHTOOL_A_PRIVFLAGS_MAX = __ETHTOOL_A_PRIVFLAGS_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
@@ -5,4 +5,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 linkmodes.o \

		   linkstate.o debug.o wol.o features.o
 
		   linkstate.o debug.o wol.o features.o privflags.o

net/ethtool/netlink.c

+8 −0
Original line number Diff line number Diff line
@@ -216,6 +216,7 @@ ethnl_default_requests[__ETHTOOL_MSG_USER_CNT] = { 
	[ETHTOOL_MSG_DEBUG_GET]		= &ethnl_debug_request_ops,

	[ETHTOOL_MSG_WOL_GET]		= &ethnl_wol_request_ops,

	[ETHTOOL_MSG_FEATURES_GET]	= &ethnl_features_request_ops,

	[ETHTOOL_MSG_PRIVFLAGS_GET]	= &ethnl_privflags_request_ops,

};



static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb)
@@ -733,6 +734,13 @@ static const struct genl_ops ethtool_genl_ops[] = { 
		.flags	= GENL_UNS_ADMIN_PERM,

		.doit	= ethnl_set_features,

	},

	{

		.cmd	= ETHTOOL_MSG_PRIVFLAGS_GET,

		.doit	= ethnl_default_doit,

		.start	= ethnl_default_start,

		.dumpit	= ethnl_default_dumpit,

		.done	= ethnl_default_done,

	},

};



static const struct genl_multicast_group ethtool_nl_mcgrps[] = {

net/ethtool/netlink.h

+1 −0
Original line number Diff line number Diff line
@@ -338,6 +338,7 @@ extern const struct ethnl_request_ops ethnl_linkstate_request_ops; 
extern const struct ethnl_request_ops ethnl_debug_request_ops;

extern const struct ethnl_request_ops ethnl_wol_request_ops;

extern const struct ethnl_request_ops ethnl_features_request_ops;

extern const struct ethnl_request_ops ethnl_privflags_request_ops;



int ethnl_set_linkinfo(struct sk_buff *skb, struct genl_info *info);

int ethnl_set_linkmodes(struct sk_buff *skb, struct genl_info *info);