1 // SPDX-License-Identifier: GPL-2.0-only
4 #include <linux/ethtool_netlink.h>
5 #include <linux/pm_runtime.h>
8 static struct genl_family ethtool_genl_family;
10 static bool ethnl_ok __read_mostly;
11 static u32 ethnl_bcast_seq;
13 #define ETHTOOL_FLAGS_BASIC (ETHTOOL_FLAG_COMPACT_BITSETS | \
14 ETHTOOL_FLAG_OMIT_REPLY)
15 #define ETHTOOL_FLAGS_STATS (ETHTOOL_FLAGS_BASIC | ETHTOOL_FLAG_STATS)
17 const struct nla_policy ethnl_header_policy[] = {
18 [ETHTOOL_A_HEADER_DEV_INDEX] = { .type = NLA_U32 },
19 [ETHTOOL_A_HEADER_DEV_NAME] = { .type = NLA_NUL_STRING,
20 .len = ALTIFNAMSIZ - 1 },
21 [ETHTOOL_A_HEADER_FLAGS] = NLA_POLICY_MASK(NLA_U32,
25 const struct nla_policy ethnl_header_policy_stats[] = {
26 [ETHTOOL_A_HEADER_DEV_INDEX] = { .type = NLA_U32 },
27 [ETHTOOL_A_HEADER_DEV_NAME] = { .type = NLA_NUL_STRING,
28 .len = ALTIFNAMSIZ - 1 },
29 [ETHTOOL_A_HEADER_FLAGS] = NLA_POLICY_MASK(NLA_U32,
33 int ethnl_ops_begin(struct net_device *dev)
41 pm_runtime_get_sync(dev->dev.parent);
43 if (!netif_device_present(dev) ||
44 dev->reg_state == NETREG_UNREGISTERING) {
49 if (dev->ethtool_ops->begin) {
50 ret = dev->ethtool_ops->begin(dev);
58 pm_runtime_put(dev->dev.parent);
63 void ethnl_ops_complete(struct net_device *dev)
65 if (dev->ethtool_ops->complete)
66 dev->ethtool_ops->complete(dev);
69 pm_runtime_put(dev->dev.parent);
73 * ethnl_parse_header_dev_get() - parse request header
74 * @req_info: structure to put results into
75 * @header: nest attribute with request header
77 * @extack: netlink extack for error reporting
78 * @require_dev: fail if no device identified in header
80 * Parse request header in nested attribute @nest and puts results into
81 * the structure pointed to by @req_info. Extack from @info is used for error
82 * reporting. If req_info->dev is not null on return, reference to it has
83 * been taken. If error is returned, *req_info is null initialized and no
86 * Return: 0 on success or negative error code
88 int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info,
89 const struct nlattr *header, struct net *net,
90 struct netlink_ext_ack *extack, bool require_dev)
92 struct nlattr *tb[ARRAY_SIZE(ethnl_header_policy)];
93 const struct nlattr *devname_attr;
94 struct net_device *dev = NULL;
99 NL_SET_ERR_MSG(extack, "request header missing");
102 /* No validation here, command policy should have a nested policy set
103 * for the header, therefore validation should have already been done.
105 ret = nla_parse_nested(tb, ARRAY_SIZE(ethnl_header_policy) - 1, header,
109 if (tb[ETHTOOL_A_HEADER_FLAGS])
110 flags = nla_get_u32(tb[ETHTOOL_A_HEADER_FLAGS]);
112 devname_attr = tb[ETHTOOL_A_HEADER_DEV_NAME];
113 if (tb[ETHTOOL_A_HEADER_DEV_INDEX]) {
114 u32 ifindex = nla_get_u32(tb[ETHTOOL_A_HEADER_DEV_INDEX]);
116 dev = dev_get_by_index(net, ifindex);
118 NL_SET_ERR_MSG_ATTR(extack,
119 tb[ETHTOOL_A_HEADER_DEV_INDEX],
120 "no device matches ifindex");
123 /* if both ifindex and ifname are passed, they must match */
125 strncmp(dev->name, nla_data(devname_attr), IFNAMSIZ)) {
127 NL_SET_ERR_MSG_ATTR(extack, header,
128 "ifindex and name do not match");
131 } else if (devname_attr) {
132 dev = dev_get_by_name(net, nla_data(devname_attr));
134 NL_SET_ERR_MSG_ATTR(extack, devname_attr,
135 "no device matches name");
138 } else if (require_dev) {
139 NL_SET_ERR_MSG_ATTR(extack, header,
140 "neither ifindex nor name specified");
146 netdev_tracker_alloc(dev, &req_info->dev_tracker, GFP_KERNEL);
147 req_info->flags = flags;
152 * ethnl_fill_reply_header() - Put common header into a reply message
153 * @skb: skb with the message
154 * @dev: network device to describe in header
155 * @attrtype: attribute type to use for the nest
157 * Create a nested attribute with attributes describing given network device.
159 * Return: 0 on success, error value (-EMSGSIZE only) on error
161 int ethnl_fill_reply_header(struct sk_buff *skb, struct net_device *dev,
168 nest = nla_nest_start(skb, attrtype);
172 if (nla_put_u32(skb, ETHTOOL_A_HEADER_DEV_INDEX, (u32)dev->ifindex) ||
173 nla_put_string(skb, ETHTOOL_A_HEADER_DEV_NAME, dev->name))
174 goto nla_put_failure;
175 /* If more attributes are put into reply header, ethnl_header_size()
176 * must be updated to account for them.
179 nla_nest_end(skb, nest);
183 nla_nest_cancel(skb, nest);
188 * ethnl_reply_init() - Create skb for a reply and fill device identification
189 * @payload: payload length (without netlink and genetlink header)
190 * @dev: device the reply is about (may be null)
191 * @cmd: ETHTOOL_MSG_* message type for reply
192 * @hdr_attrtype: attribute type for common header
193 * @info: genetlink info of the received packet we respond to
194 * @ehdrp: place to store payload pointer returned by genlmsg_new()
196 * Return: pointer to allocated skb on success, NULL on error
198 struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd,
199 u16 hdr_attrtype, struct genl_info *info,
204 skb = genlmsg_new(payload, GFP_KERNEL);
207 *ehdrp = genlmsg_put_reply(skb, info, ðtool_genl_family, 0, cmd);
214 ret = ethnl_fill_reply_header(skb, dev, hdr_attrtype);
224 GENL_SET_ERR_MSG(info, "failed to setup reply message");
228 void *ethnl_dump_put(struct sk_buff *skb, struct netlink_callback *cb, u8 cmd)
230 return genlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
231 ðtool_genl_family, 0, cmd);
234 void *ethnl_bcastmsg_put(struct sk_buff *skb, u8 cmd)
236 return genlmsg_put(skb, 0, ++ethnl_bcast_seq, ðtool_genl_family, 0,
240 int ethnl_multicast(struct sk_buff *skb, struct net_device *dev)
242 return genlmsg_multicast_netns(ðtool_genl_family, dev_net(dev), skb,
243 0, ETHNL_MCGRP_MONITOR, GFP_KERNEL);
246 /* GET request helpers */
249 * struct ethnl_dump_ctx - context structure for generic dumpit() callback
250 * @ops: request ops of currently processed message type
251 * @req_info: parsed request header of processed request
252 * @reply_data: data needed to compose the reply
253 * @pos_hash: saved iteration position - hashbucket
254 * @pos_idx: saved iteration position - index
256 * These parameters are kept in struct netlink_callback as context preserved
257 * between iterations. They are initialized by ethnl_default_start() and used
258 * in ethnl_default_dumpit() and ethnl_default_done().
260 struct ethnl_dump_ctx {
261 const struct ethnl_request_ops *ops;
262 struct ethnl_req_info *req_info;
263 struct ethnl_reply_data *reply_data;
268 static const struct ethnl_request_ops *
269 ethnl_default_requests[__ETHTOOL_MSG_USER_CNT] = {
270 [ETHTOOL_MSG_STRSET_GET] = ðnl_strset_request_ops,
271 [ETHTOOL_MSG_LINKINFO_GET] = ðnl_linkinfo_request_ops,
272 [ETHTOOL_MSG_LINKINFO_SET] = ðnl_linkinfo_request_ops,
273 [ETHTOOL_MSG_LINKMODES_GET] = ðnl_linkmodes_request_ops,
274 [ETHTOOL_MSG_LINKMODES_SET] = ðnl_linkmodes_request_ops,
275 [ETHTOOL_MSG_LINKSTATE_GET] = ðnl_linkstate_request_ops,
276 [ETHTOOL_MSG_DEBUG_GET] = ðnl_debug_request_ops,
277 [ETHTOOL_MSG_DEBUG_SET] = ðnl_debug_request_ops,
278 [ETHTOOL_MSG_WOL_GET] = ðnl_wol_request_ops,
279 [ETHTOOL_MSG_WOL_SET] = ðnl_wol_request_ops,
280 [ETHTOOL_MSG_FEATURES_GET] = ðnl_features_request_ops,
281 [ETHTOOL_MSG_PRIVFLAGS_GET] = ðnl_privflags_request_ops,
282 [ETHTOOL_MSG_PRIVFLAGS_SET] = ðnl_privflags_request_ops,
283 [ETHTOOL_MSG_RINGS_GET] = ðnl_rings_request_ops,
284 [ETHTOOL_MSG_RINGS_SET] = ðnl_rings_request_ops,
285 [ETHTOOL_MSG_CHANNELS_GET] = ðnl_channels_request_ops,
286 [ETHTOOL_MSG_CHANNELS_SET] = ðnl_channels_request_ops,
287 [ETHTOOL_MSG_COALESCE_GET] = ðnl_coalesce_request_ops,
288 [ETHTOOL_MSG_COALESCE_SET] = ðnl_coalesce_request_ops,
289 [ETHTOOL_MSG_PAUSE_GET] = ðnl_pause_request_ops,
290 [ETHTOOL_MSG_PAUSE_SET] = ðnl_pause_request_ops,
291 [ETHTOOL_MSG_EEE_GET] = ðnl_eee_request_ops,
292 [ETHTOOL_MSG_EEE_SET] = ðnl_eee_request_ops,
293 [ETHTOOL_MSG_FEC_GET] = ðnl_fec_request_ops,
294 [ETHTOOL_MSG_FEC_SET] = ðnl_fec_request_ops,
295 [ETHTOOL_MSG_TSINFO_GET] = ðnl_tsinfo_request_ops,
296 [ETHTOOL_MSG_MODULE_EEPROM_GET] = ðnl_module_eeprom_request_ops,
297 [ETHTOOL_MSG_STATS_GET] = ðnl_stats_request_ops,
298 [ETHTOOL_MSG_PHC_VCLOCKS_GET] = ðnl_phc_vclocks_request_ops,
299 [ETHTOOL_MSG_MODULE_GET] = ðnl_module_request_ops,
300 [ETHTOOL_MSG_MODULE_SET] = ðnl_module_request_ops,
301 [ETHTOOL_MSG_PSE_GET] = ðnl_pse_request_ops,
302 [ETHTOOL_MSG_PSE_SET] = ðnl_pse_request_ops,
303 [ETHTOOL_MSG_RSS_GET] = ðnl_rss_request_ops,
304 [ETHTOOL_MSG_PLCA_GET_CFG] = ðnl_plca_cfg_request_ops,
305 [ETHTOOL_MSG_PLCA_SET_CFG] = ðnl_plca_cfg_request_ops,
306 [ETHTOOL_MSG_PLCA_GET_STATUS] = ðnl_plca_status_request_ops,
307 [ETHTOOL_MSG_MM_GET] = ðnl_mm_request_ops,
308 [ETHTOOL_MSG_MM_SET] = ðnl_mm_request_ops,
311 static struct ethnl_dump_ctx *ethnl_dump_context(struct netlink_callback *cb)
313 return (struct ethnl_dump_ctx *)cb->ctx;
317 * ethnl_default_parse() - Parse request message
318 * @req_info: pointer to structure to put data into
319 * @tb: parsed attributes
320 * @net: request netns
321 * @request_ops: struct request_ops for request type
322 * @extack: netlink extack for error reporting
323 * @require_dev: fail if no device identified in header
325 * Parse universal request header and call request specific ->parse_request()
326 * callback (if defined) to parse the rest of the message.
328 * Return: 0 on success or negative error code
330 static int ethnl_default_parse(struct ethnl_req_info *req_info,
331 struct nlattr **tb, struct net *net,
332 const struct ethnl_request_ops *request_ops,
333 struct netlink_ext_ack *extack, bool require_dev)
337 ret = ethnl_parse_header_dev_get(req_info, tb[request_ops->hdr_attr],
338 net, extack, require_dev);
342 if (request_ops->parse_request) {
343 ret = request_ops->parse_request(req_info, tb, extack);
352 * ethnl_init_reply_data() - Initialize reply data for GET request
353 * @reply_data: pointer to embedded struct ethnl_reply_data
354 * @ops: instance of struct ethnl_request_ops describing the layout
355 * @dev: network device to initialize the reply for
357 * Fills the reply data part with zeros and sets the dev member. Must be called
358 * before calling the ->fill_reply() callback (for each iteration when handling
361 static void ethnl_init_reply_data(struct ethnl_reply_data *reply_data,
362 const struct ethnl_request_ops *ops,
363 struct net_device *dev)
365 memset(reply_data, 0, ops->reply_data_size);
366 reply_data->dev = dev;
369 /* default ->doit() handler for GET type requests */
370 static int ethnl_default_doit(struct sk_buff *skb, struct genl_info *info)
372 struct ethnl_reply_data *reply_data = NULL;
373 struct ethnl_req_info *req_info = NULL;
374 const u8 cmd = info->genlhdr->cmd;
375 const struct ethnl_request_ops *ops;
376 int hdr_len, reply_len;
377 struct sk_buff *rskb;
381 ops = ethnl_default_requests[cmd];
382 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", cmd))
384 if (GENL_REQ_ATTR_CHECK(info, ops->hdr_attr))
387 req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
390 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
396 ret = ethnl_default_parse(req_info, info->attrs, genl_info_net(info),
397 ops, info->extack, !ops->allow_nodev_do);
400 ethnl_init_reply_data(reply_data, ops, req_info->dev);
403 ret = ops->prepare_data(req_info, reply_data, info);
407 ret = ops->reply_size(req_info, reply_data);
412 rskb = ethnl_reply_init(reply_len + ethnl_reply_header_size(),
413 req_info->dev, ops->reply_cmd,
414 ops->hdr_attr, info, &reply_payload);
418 ret = ops->fill_reply(rskb, req_info, reply_data);
421 WARN_ONCE(rskb->len - hdr_len > reply_len,
422 "ethnl cmd %d: calculated reply length %d, but consumed %d\n",
423 cmd, reply_len, rskb->len - hdr_len);
424 if (ops->cleanup_data)
425 ops->cleanup_data(reply_data);
427 genlmsg_end(rskb, reply_payload);
428 netdev_put(req_info->dev, &req_info->dev_tracker);
431 return genlmsg_reply(rskb, info);
434 WARN_ONCE(ret == -EMSGSIZE, "calculated message payload length (%d) not sufficient\n", reply_len);
437 if (ops->cleanup_data)
438 ops->cleanup_data(reply_data);
440 netdev_put(req_info->dev, &req_info->dev_tracker);
446 static int ethnl_default_dump_one(struct sk_buff *skb, struct net_device *dev,
447 const struct ethnl_dump_ctx *ctx,
448 struct netlink_callback *cb)
453 ehdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
454 ðtool_genl_family, NLM_F_MULTI,
455 ctx->ops->reply_cmd);
459 ethnl_init_reply_data(ctx->reply_data, ctx->ops, dev);
461 ret = ctx->ops->prepare_data(ctx->req_info, ctx->reply_data, NULL);
465 ret = ethnl_fill_reply_header(skb, dev, ctx->ops->hdr_attr);
468 ret = ctx->ops->fill_reply(skb, ctx->req_info, ctx->reply_data);
471 if (ctx->ops->cleanup_data)
472 ctx->ops->cleanup_data(ctx->reply_data);
473 ctx->reply_data->dev = NULL;
475 genlmsg_cancel(skb, ehdr);
477 genlmsg_end(skb, ehdr);
481 /* Default ->dumpit() handler for GET requests. Device iteration copied from
482 * rtnl_dump_ifinfo(); we have to be more careful about device hashtable
483 * persistence as we cannot guarantee to hold RTNL lock through the whole
484 * function as rtnetnlink does.
486 static int ethnl_default_dumpit(struct sk_buff *skb,
487 struct netlink_callback *cb)
489 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
490 struct net *net = sock_net(skb->sk);
491 int s_idx = ctx->pos_idx;
496 for (h = ctx->pos_hash; h < NETDEV_HASHENTRIES; h++, s_idx = 0) {
497 struct hlist_head *head;
498 struct net_device *dev;
501 head = &net->dev_index_head[h];
504 seq = net->dev_base_seq;
507 hlist_for_each_entry(dev, head, index_hlist) {
513 ret = ethnl_default_dump_one(skb, dev, ctx, cb);
516 if (ret == -EOPNOTSUPP)
518 if (likely(skb->len))
524 if (net->dev_base_seq != seq) {
538 nl_dump_check_consistent(cb, nlmsg_hdr(skb));
543 /* generic ->start() handler for GET requests */
544 static int ethnl_default_start(struct netlink_callback *cb)
546 const struct genl_dumpit_info *info = genl_dumpit_info(cb);
547 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
548 struct ethnl_reply_data *reply_data;
549 const struct ethnl_request_ops *ops;
550 struct ethnl_req_info *req_info;
551 struct genlmsghdr *ghdr;
554 BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx));
556 ghdr = nlmsg_data(cb->nlh);
557 ops = ethnl_default_requests[ghdr->cmd];
558 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", ghdr->cmd))
560 req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
563 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
569 ret = ethnl_default_parse(req_info, info->attrs, sock_net(cb->skb->sk),
570 ops, cb->extack, false);
572 /* We ignore device specification in dump requests but as the
573 * same parser as for non-dump (doit) requests is used, it
574 * would take reference to the device if it finds one
576 netdev_put(req_info->dev, &req_info->dev_tracker);
577 req_info->dev = NULL;
580 goto free_reply_data;
583 ctx->req_info = req_info;
584 ctx->reply_data = reply_data;
598 /* default ->done() handler for GET requests */
599 static int ethnl_default_done(struct netlink_callback *cb)
601 struct ethnl_dump_ctx *ctx = ethnl_dump_context(cb);
603 kfree(ctx->reply_data);
604 kfree(ctx->req_info);
609 static int ethnl_default_set_doit(struct sk_buff *skb, struct genl_info *info)
611 const struct ethnl_request_ops *ops;
612 struct ethnl_req_info req_info = {};
613 const u8 cmd = info->genlhdr->cmd;
616 ops = ethnl_default_requests[cmd];
617 if (WARN_ONCE(!ops, "cmd %u has no ethnl_request_ops\n", cmd))
619 if (GENL_REQ_ATTR_CHECK(info, ops->hdr_attr))
622 ret = ethnl_parse_header_dev_get(&req_info, info->attrs[ops->hdr_attr],
623 genl_info_net(info), info->extack,
628 if (ops->set_validate) {
629 ret = ops->set_validate(&req_info, info);
630 /* 0 means nothing to do */
636 ret = ethnl_ops_begin(req_info.dev);
640 ret = ops->set(&req_info, info);
643 ethtool_notify(req_info.dev, ops->set_ntf_cmd, NULL);
647 ethnl_ops_complete(req_info.dev);
651 ethnl_parse_header_dev_put(&req_info);
655 static const struct ethnl_request_ops *
656 ethnl_default_notify_ops[ETHTOOL_MSG_KERNEL_MAX + 1] = {
657 [ETHTOOL_MSG_LINKINFO_NTF] = ðnl_linkinfo_request_ops,
658 [ETHTOOL_MSG_LINKMODES_NTF] = ðnl_linkmodes_request_ops,
659 [ETHTOOL_MSG_DEBUG_NTF] = ðnl_debug_request_ops,
660 [ETHTOOL_MSG_WOL_NTF] = ðnl_wol_request_ops,
661 [ETHTOOL_MSG_FEATURES_NTF] = ðnl_features_request_ops,
662 [ETHTOOL_MSG_PRIVFLAGS_NTF] = ðnl_privflags_request_ops,
663 [ETHTOOL_MSG_RINGS_NTF] = ðnl_rings_request_ops,
664 [ETHTOOL_MSG_CHANNELS_NTF] = ðnl_channels_request_ops,
665 [ETHTOOL_MSG_COALESCE_NTF] = ðnl_coalesce_request_ops,
666 [ETHTOOL_MSG_PAUSE_NTF] = ðnl_pause_request_ops,
667 [ETHTOOL_MSG_EEE_NTF] = ðnl_eee_request_ops,
668 [ETHTOOL_MSG_FEC_NTF] = ðnl_fec_request_ops,
669 [ETHTOOL_MSG_MODULE_NTF] = ðnl_module_request_ops,
670 [ETHTOOL_MSG_PLCA_NTF] = ðnl_plca_cfg_request_ops,
671 [ETHTOOL_MSG_MM_NTF] = ðnl_mm_request_ops,
674 /* default notification handler */
675 static void ethnl_default_notify(struct net_device *dev, unsigned int cmd,
678 struct ethnl_reply_data *reply_data;
679 const struct ethnl_request_ops *ops;
680 struct ethnl_req_info *req_info;
686 if (WARN_ONCE(cmd > ETHTOOL_MSG_KERNEL_MAX ||
687 !ethnl_default_notify_ops[cmd],
688 "unexpected notification type %u\n", cmd))
690 ops = ethnl_default_notify_ops[cmd];
691 req_info = kzalloc(ops->req_info_size, GFP_KERNEL);
694 reply_data = kmalloc(ops->reply_data_size, GFP_KERNEL);
701 req_info->flags |= ETHTOOL_FLAG_COMPACT_BITSETS;
703 ethnl_init_reply_data(reply_data, ops, dev);
704 ret = ops->prepare_data(req_info, reply_data, NULL);
707 ret = ops->reply_size(req_info, reply_data);
710 reply_len = ret + ethnl_reply_header_size();
711 skb = genlmsg_new(reply_len, GFP_KERNEL);
714 reply_payload = ethnl_bcastmsg_put(skb, cmd);
717 ret = ethnl_fill_reply_header(skb, dev, ops->hdr_attr);
720 ret = ops->fill_reply(skb, req_info, reply_data);
723 if (ops->cleanup_data)
724 ops->cleanup_data(reply_data);
726 genlmsg_end(skb, reply_payload);
729 ethnl_multicast(skb, dev);
733 WARN_ONCE(ret == -EMSGSIZE,
734 "calculated message payload length (%d) not sufficient\n",
739 if (ops->cleanup_data)
740 ops->cleanup_data(reply_data);
748 typedef void (*ethnl_notify_handler_t)(struct net_device *dev, unsigned int cmd,
751 static const ethnl_notify_handler_t ethnl_notify_handlers[] = {
752 [ETHTOOL_MSG_LINKINFO_NTF] = ethnl_default_notify,
753 [ETHTOOL_MSG_LINKMODES_NTF] = ethnl_default_notify,
754 [ETHTOOL_MSG_DEBUG_NTF] = ethnl_default_notify,
755 [ETHTOOL_MSG_WOL_NTF] = ethnl_default_notify,
756 [ETHTOOL_MSG_FEATURES_NTF] = ethnl_default_notify,
757 [ETHTOOL_MSG_PRIVFLAGS_NTF] = ethnl_default_notify,
758 [ETHTOOL_MSG_RINGS_NTF] = ethnl_default_notify,
759 [ETHTOOL_MSG_CHANNELS_NTF] = ethnl_default_notify,
760 [ETHTOOL_MSG_COALESCE_NTF] = ethnl_default_notify,
761 [ETHTOOL_MSG_PAUSE_NTF] = ethnl_default_notify,
762 [ETHTOOL_MSG_EEE_NTF] = ethnl_default_notify,
763 [ETHTOOL_MSG_FEC_NTF] = ethnl_default_notify,
764 [ETHTOOL_MSG_MODULE_NTF] = ethnl_default_notify,
765 [ETHTOOL_MSG_PLCA_NTF] = ethnl_default_notify,
766 [ETHTOOL_MSG_MM_NTF] = ethnl_default_notify,
769 void ethtool_notify(struct net_device *dev, unsigned int cmd, const void *data)
771 if (unlikely(!ethnl_ok))
775 if (likely(cmd < ARRAY_SIZE(ethnl_notify_handlers) &&
776 ethnl_notify_handlers[cmd]))
777 ethnl_notify_handlers[cmd](dev, cmd, data);
779 WARN_ONCE(1, "notification %u not implemented (dev=%s)\n",
780 cmd, netdev_name(dev));
782 EXPORT_SYMBOL(ethtool_notify);
784 static void ethnl_notify_features(struct netdev_notifier_info *info)
786 struct net_device *dev = netdev_notifier_info_to_dev(info);
788 ethtool_notify(dev, ETHTOOL_MSG_FEATURES_NTF, NULL);
791 static int ethnl_netdev_event(struct notifier_block *this, unsigned long event,
795 case NETDEV_FEAT_CHANGE:
796 ethnl_notify_features(ptr);
803 static struct notifier_block ethnl_netdev_notifier = {
804 .notifier_call = ethnl_netdev_event,
807 /* genetlink setup */
809 static const struct genl_ops ethtool_genl_ops[] = {
811 .cmd = ETHTOOL_MSG_STRSET_GET,
812 .doit = ethnl_default_doit,
813 .start = ethnl_default_start,
814 .dumpit = ethnl_default_dumpit,
815 .done = ethnl_default_done,
816 .policy = ethnl_strset_get_policy,
817 .maxattr = ARRAY_SIZE(ethnl_strset_get_policy) - 1,
820 .cmd = ETHTOOL_MSG_LINKINFO_GET,
821 .doit = ethnl_default_doit,
822 .start = ethnl_default_start,
823 .dumpit = ethnl_default_dumpit,
824 .done = ethnl_default_done,
825 .policy = ethnl_linkinfo_get_policy,
826 .maxattr = ARRAY_SIZE(ethnl_linkinfo_get_policy) - 1,
829 .cmd = ETHTOOL_MSG_LINKINFO_SET,
830 .flags = GENL_UNS_ADMIN_PERM,
831 .doit = ethnl_default_set_doit,
832 .policy = ethnl_linkinfo_set_policy,
833 .maxattr = ARRAY_SIZE(ethnl_linkinfo_set_policy) - 1,
836 .cmd = ETHTOOL_MSG_LINKMODES_GET,
837 .doit = ethnl_default_doit,
838 .start = ethnl_default_start,
839 .dumpit = ethnl_default_dumpit,
840 .done = ethnl_default_done,
841 .policy = ethnl_linkmodes_get_policy,
842 .maxattr = ARRAY_SIZE(ethnl_linkmodes_get_policy) - 1,
845 .cmd = ETHTOOL_MSG_LINKMODES_SET,
846 .flags = GENL_UNS_ADMIN_PERM,
847 .doit = ethnl_default_set_doit,
848 .policy = ethnl_linkmodes_set_policy,
849 .maxattr = ARRAY_SIZE(ethnl_linkmodes_set_policy) - 1,
852 .cmd = ETHTOOL_MSG_LINKSTATE_GET,
853 .doit = ethnl_default_doit,
854 .start = ethnl_default_start,
855 .dumpit = ethnl_default_dumpit,
856 .done = ethnl_default_done,
857 .policy = ethnl_linkstate_get_policy,
858 .maxattr = ARRAY_SIZE(ethnl_linkstate_get_policy) - 1,
861 .cmd = ETHTOOL_MSG_DEBUG_GET,
862 .doit = ethnl_default_doit,
863 .start = ethnl_default_start,
864 .dumpit = ethnl_default_dumpit,
865 .done = ethnl_default_done,
866 .policy = ethnl_debug_get_policy,
867 .maxattr = ARRAY_SIZE(ethnl_debug_get_policy) - 1,
870 .cmd = ETHTOOL_MSG_DEBUG_SET,
871 .flags = GENL_UNS_ADMIN_PERM,
872 .doit = ethnl_default_set_doit,
873 .policy = ethnl_debug_set_policy,
874 .maxattr = ARRAY_SIZE(ethnl_debug_set_policy) - 1,
877 .cmd = ETHTOOL_MSG_WOL_GET,
878 .flags = GENL_UNS_ADMIN_PERM,
879 .doit = ethnl_default_doit,
880 .start = ethnl_default_start,
881 .dumpit = ethnl_default_dumpit,
882 .done = ethnl_default_done,
883 .policy = ethnl_wol_get_policy,
884 .maxattr = ARRAY_SIZE(ethnl_wol_get_policy) - 1,
887 .cmd = ETHTOOL_MSG_WOL_SET,
888 .flags = GENL_UNS_ADMIN_PERM,
889 .doit = ethnl_default_set_doit,
890 .policy = ethnl_wol_set_policy,
891 .maxattr = ARRAY_SIZE(ethnl_wol_set_policy) - 1,
894 .cmd = ETHTOOL_MSG_FEATURES_GET,
895 .doit = ethnl_default_doit,
896 .start = ethnl_default_start,
897 .dumpit = ethnl_default_dumpit,
898 .done = ethnl_default_done,
899 .policy = ethnl_features_get_policy,
900 .maxattr = ARRAY_SIZE(ethnl_features_get_policy) - 1,
903 .cmd = ETHTOOL_MSG_FEATURES_SET,
904 .flags = GENL_UNS_ADMIN_PERM,
905 .doit = ethnl_set_features,
906 .policy = ethnl_features_set_policy,
907 .maxattr = ARRAY_SIZE(ethnl_features_set_policy) - 1,
910 .cmd = ETHTOOL_MSG_PRIVFLAGS_GET,
911 .doit = ethnl_default_doit,
912 .start = ethnl_default_start,
913 .dumpit = ethnl_default_dumpit,
914 .done = ethnl_default_done,
915 .policy = ethnl_privflags_get_policy,
916 .maxattr = ARRAY_SIZE(ethnl_privflags_get_policy) - 1,
919 .cmd = ETHTOOL_MSG_PRIVFLAGS_SET,
920 .flags = GENL_UNS_ADMIN_PERM,
921 .doit = ethnl_default_set_doit,
922 .policy = ethnl_privflags_set_policy,
923 .maxattr = ARRAY_SIZE(ethnl_privflags_set_policy) - 1,
926 .cmd = ETHTOOL_MSG_RINGS_GET,
927 .doit = ethnl_default_doit,
928 .start = ethnl_default_start,
929 .dumpit = ethnl_default_dumpit,
930 .done = ethnl_default_done,
931 .policy = ethnl_rings_get_policy,
932 .maxattr = ARRAY_SIZE(ethnl_rings_get_policy) - 1,
935 .cmd = ETHTOOL_MSG_RINGS_SET,
936 .flags = GENL_UNS_ADMIN_PERM,
937 .doit = ethnl_default_set_doit,
938 .policy = ethnl_rings_set_policy,
939 .maxattr = ARRAY_SIZE(ethnl_rings_set_policy) - 1,
942 .cmd = ETHTOOL_MSG_CHANNELS_GET,
943 .doit = ethnl_default_doit,
944 .start = ethnl_default_start,
945 .dumpit = ethnl_default_dumpit,
946 .done = ethnl_default_done,
947 .policy = ethnl_channels_get_policy,
948 .maxattr = ARRAY_SIZE(ethnl_channels_get_policy) - 1,
951 .cmd = ETHTOOL_MSG_CHANNELS_SET,
952 .flags = GENL_UNS_ADMIN_PERM,
953 .doit = ethnl_default_set_doit,
954 .policy = ethnl_channels_set_policy,
955 .maxattr = ARRAY_SIZE(ethnl_channels_set_policy) - 1,
958 .cmd = ETHTOOL_MSG_COALESCE_GET,
959 .doit = ethnl_default_doit,
960 .start = ethnl_default_start,
961 .dumpit = ethnl_default_dumpit,
962 .done = ethnl_default_done,
963 .policy = ethnl_coalesce_get_policy,
964 .maxattr = ARRAY_SIZE(ethnl_coalesce_get_policy) - 1,
967 .cmd = ETHTOOL_MSG_COALESCE_SET,
968 .flags = GENL_UNS_ADMIN_PERM,
969 .doit = ethnl_default_set_doit,
970 .policy = ethnl_coalesce_set_policy,
971 .maxattr = ARRAY_SIZE(ethnl_coalesce_set_policy) - 1,
974 .cmd = ETHTOOL_MSG_PAUSE_GET,
975 .doit = ethnl_default_doit,
976 .start = ethnl_default_start,
977 .dumpit = ethnl_default_dumpit,
978 .done = ethnl_default_done,
979 .policy = ethnl_pause_get_policy,
980 .maxattr = ARRAY_SIZE(ethnl_pause_get_policy) - 1,
983 .cmd = ETHTOOL_MSG_PAUSE_SET,
984 .flags = GENL_UNS_ADMIN_PERM,
985 .doit = ethnl_default_set_doit,
986 .policy = ethnl_pause_set_policy,
987 .maxattr = ARRAY_SIZE(ethnl_pause_set_policy) - 1,
990 .cmd = ETHTOOL_MSG_EEE_GET,
991 .doit = ethnl_default_doit,
992 .start = ethnl_default_start,
993 .dumpit = ethnl_default_dumpit,
994 .done = ethnl_default_done,
995 .policy = ethnl_eee_get_policy,
996 .maxattr = ARRAY_SIZE(ethnl_eee_get_policy) - 1,
999 .cmd = ETHTOOL_MSG_EEE_SET,
1000 .flags = GENL_UNS_ADMIN_PERM,
1001 .doit = ethnl_default_set_doit,
1002 .policy = ethnl_eee_set_policy,
1003 .maxattr = ARRAY_SIZE(ethnl_eee_set_policy) - 1,
1006 .cmd = ETHTOOL_MSG_TSINFO_GET,
1007 .doit = ethnl_default_doit,
1008 .start = ethnl_default_start,
1009 .dumpit = ethnl_default_dumpit,
1010 .done = ethnl_default_done,
1011 .policy = ethnl_tsinfo_get_policy,
1012 .maxattr = ARRAY_SIZE(ethnl_tsinfo_get_policy) - 1,
1015 .cmd = ETHTOOL_MSG_CABLE_TEST_ACT,
1016 .flags = GENL_UNS_ADMIN_PERM,
1017 .doit = ethnl_act_cable_test,
1018 .policy = ethnl_cable_test_act_policy,
1019 .maxattr = ARRAY_SIZE(ethnl_cable_test_act_policy) - 1,
1022 .cmd = ETHTOOL_MSG_CABLE_TEST_TDR_ACT,
1023 .flags = GENL_UNS_ADMIN_PERM,
1024 .doit = ethnl_act_cable_test_tdr,
1025 .policy = ethnl_cable_test_tdr_act_policy,
1026 .maxattr = ARRAY_SIZE(ethnl_cable_test_tdr_act_policy) - 1,
1029 .cmd = ETHTOOL_MSG_TUNNEL_INFO_GET,
1030 .doit = ethnl_tunnel_info_doit,
1031 .start = ethnl_tunnel_info_start,
1032 .dumpit = ethnl_tunnel_info_dumpit,
1033 .policy = ethnl_tunnel_info_get_policy,
1034 .maxattr = ARRAY_SIZE(ethnl_tunnel_info_get_policy) - 1,
1037 .cmd = ETHTOOL_MSG_FEC_GET,
1038 .doit = ethnl_default_doit,
1039 .start = ethnl_default_start,
1040 .dumpit = ethnl_default_dumpit,
1041 .done = ethnl_default_done,
1042 .policy = ethnl_fec_get_policy,
1043 .maxattr = ARRAY_SIZE(ethnl_fec_get_policy) - 1,
1046 .cmd = ETHTOOL_MSG_FEC_SET,
1047 .flags = GENL_UNS_ADMIN_PERM,
1048 .doit = ethnl_default_set_doit,
1049 .policy = ethnl_fec_set_policy,
1050 .maxattr = ARRAY_SIZE(ethnl_fec_set_policy) - 1,
1053 .cmd = ETHTOOL_MSG_MODULE_EEPROM_GET,
1054 .flags = GENL_UNS_ADMIN_PERM,
1055 .doit = ethnl_default_doit,
1056 .start = ethnl_default_start,
1057 .dumpit = ethnl_default_dumpit,
1058 .done = ethnl_default_done,
1059 .policy = ethnl_module_eeprom_get_policy,
1060 .maxattr = ARRAY_SIZE(ethnl_module_eeprom_get_policy) - 1,
1063 .cmd = ETHTOOL_MSG_STATS_GET,
1064 .doit = ethnl_default_doit,
1065 .start = ethnl_default_start,
1066 .dumpit = ethnl_default_dumpit,
1067 .done = ethnl_default_done,
1068 .policy = ethnl_stats_get_policy,
1069 .maxattr = ARRAY_SIZE(ethnl_stats_get_policy) - 1,
1072 .cmd = ETHTOOL_MSG_PHC_VCLOCKS_GET,
1073 .doit = ethnl_default_doit,
1074 .start = ethnl_default_start,
1075 .dumpit = ethnl_default_dumpit,
1076 .done = ethnl_default_done,
1077 .policy = ethnl_phc_vclocks_get_policy,
1078 .maxattr = ARRAY_SIZE(ethnl_phc_vclocks_get_policy) - 1,
1081 .cmd = ETHTOOL_MSG_MODULE_GET,
1082 .doit = ethnl_default_doit,
1083 .start = ethnl_default_start,
1084 .dumpit = ethnl_default_dumpit,
1085 .done = ethnl_default_done,
1086 .policy = ethnl_module_get_policy,
1087 .maxattr = ARRAY_SIZE(ethnl_module_get_policy) - 1,
1090 .cmd = ETHTOOL_MSG_MODULE_SET,
1091 .flags = GENL_UNS_ADMIN_PERM,
1092 .doit = ethnl_default_set_doit,
1093 .policy = ethnl_module_set_policy,
1094 .maxattr = ARRAY_SIZE(ethnl_module_set_policy) - 1,
1097 .cmd = ETHTOOL_MSG_PSE_GET,
1098 .doit = ethnl_default_doit,
1099 .start = ethnl_default_start,
1100 .dumpit = ethnl_default_dumpit,
1101 .done = ethnl_default_done,
1102 .policy = ethnl_pse_get_policy,
1103 .maxattr = ARRAY_SIZE(ethnl_pse_get_policy) - 1,
1106 .cmd = ETHTOOL_MSG_PSE_SET,
1107 .flags = GENL_UNS_ADMIN_PERM,
1108 .doit = ethnl_default_set_doit,
1109 .policy = ethnl_pse_set_policy,
1110 .maxattr = ARRAY_SIZE(ethnl_pse_set_policy) - 1,
1113 .cmd = ETHTOOL_MSG_RSS_GET,
1114 .doit = ethnl_default_doit,
1115 .policy = ethnl_rss_get_policy,
1116 .maxattr = ARRAY_SIZE(ethnl_rss_get_policy) - 1,
1119 .cmd = ETHTOOL_MSG_PLCA_GET_CFG,
1120 .doit = ethnl_default_doit,
1121 .start = ethnl_default_start,
1122 .dumpit = ethnl_default_dumpit,
1123 .done = ethnl_default_done,
1124 .policy = ethnl_plca_get_cfg_policy,
1125 .maxattr = ARRAY_SIZE(ethnl_plca_get_cfg_policy) - 1,
1128 .cmd = ETHTOOL_MSG_PLCA_SET_CFG,
1129 .flags = GENL_UNS_ADMIN_PERM,
1130 .doit = ethnl_default_set_doit,
1131 .policy = ethnl_plca_set_cfg_policy,
1132 .maxattr = ARRAY_SIZE(ethnl_plca_set_cfg_policy) - 1,
1135 .cmd = ETHTOOL_MSG_PLCA_GET_STATUS,
1136 .doit = ethnl_default_doit,
1137 .start = ethnl_default_start,
1138 .dumpit = ethnl_default_dumpit,
1139 .done = ethnl_default_done,
1140 .policy = ethnl_plca_get_status_policy,
1141 .maxattr = ARRAY_SIZE(ethnl_plca_get_status_policy) - 1,
1144 .cmd = ETHTOOL_MSG_MM_GET,
1145 .doit = ethnl_default_doit,
1146 .start = ethnl_default_start,
1147 .dumpit = ethnl_default_dumpit,
1148 .done = ethnl_default_done,
1149 .policy = ethnl_mm_get_policy,
1150 .maxattr = ARRAY_SIZE(ethnl_mm_get_policy) - 1,
1153 .cmd = ETHTOOL_MSG_MM_SET,
1154 .flags = GENL_UNS_ADMIN_PERM,
1155 .doit = ethnl_default_set_doit,
1156 .policy = ethnl_mm_set_policy,
1157 .maxattr = ARRAY_SIZE(ethnl_mm_set_policy) - 1,
1161 static const struct genl_multicast_group ethtool_nl_mcgrps[] = {
1162 [ETHNL_MCGRP_MONITOR] = { .name = ETHTOOL_MCGRP_MONITOR_NAME },
1165 static struct genl_family ethtool_genl_family __ro_after_init = {
1166 .name = ETHTOOL_GENL_NAME,
1167 .version = ETHTOOL_GENL_VERSION,
1169 .parallel_ops = true,
1170 .ops = ethtool_genl_ops,
1171 .n_ops = ARRAY_SIZE(ethtool_genl_ops),
1172 .resv_start_op = ETHTOOL_MSG_MODULE_GET + 1,
1173 .mcgrps = ethtool_nl_mcgrps,
1174 .n_mcgrps = ARRAY_SIZE(ethtool_nl_mcgrps),
1179 static int __init ethnl_init(void)
1183 ret = genl_register_family(ðtool_genl_family);
1184 if (WARN(ret < 0, "ethtool: genetlink family registration failed"))
1188 ret = register_netdevice_notifier(ðnl_netdev_notifier);
1189 WARN(ret < 0, "ethtool: net device notifier registration failed");
1193 subsys_initcall(ethnl_init);