1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 3 #ifndef _NET_ETHTOOL_NETLINK_H 4 #define _NET_ETHTOOL_NETLINK_H 5 6 #include <linux/ethtool_netlink.h> 7 #include <linux/netdevice.h> 8 #include <net/genetlink.h> 9 #include <net/sock.h> 10 11 struct ethnl_req_info; 12 13 int ethnl_parse_header_dev_get(struct ethnl_req_info *req_info, 14 const struct nlattr *nest, struct net *net, 15 struct netlink_ext_ack *extack, 16 bool require_dev); 17 int ethnl_fill_reply_header(struct sk_buff *skb, struct net_device *dev, 18 u16 attrtype); 19 struct sk_buff *ethnl_reply_init(size_t payload, struct net_device *dev, u8 cmd, 20 u16 hdr_attrtype, struct genl_info *info, 21 void **ehdrp); 22 void *ethnl_dump_put(struct sk_buff *skb, struct netlink_callback *cb, u8 cmd); 23 void *ethnl_bcastmsg_put(struct sk_buff *skb, u8 cmd); 24 void *ethnl_unicast_put(struct sk_buff *skb, u32 portid, u32 seq, u8 cmd); 25 int ethnl_multicast(struct sk_buff *skb, struct net_device *dev); 26 27 /** 28 * ethnl_strz_size() - calculate attribute length for fixed size string 29 * @s: ETH_GSTRING_LEN sized string (may not be null terminated) 30 * 31 * Return: total length of an attribute with null terminated string from @s 32 */ 33 static inline int ethnl_strz_size(const char *s) 34 { 35 return nla_total_size(strnlen(s, ETH_GSTRING_LEN) + 1); 36 } 37 38 /** 39 * ethnl_put_strz() - put string attribute with fixed size string 40 * @skb: skb with the message 41 * @attrtype: attribute type 42 * @s: ETH_GSTRING_LEN sized string (may not be null terminated) 43 * 44 * Puts an attribute with null terminated string from @s into the message. 45 * 46 * Return: 0 on success, negative error code on failure 47 */ 48 static inline int ethnl_put_strz(struct sk_buff *skb, u16 attrtype, 49 const char *s) 50 { 51 unsigned int len = strnlen(s, ETH_GSTRING_LEN); 52 struct nlattr *attr; 53 54 attr = nla_reserve(skb, attrtype, len + 1); 55 if (!attr) 56 return -EMSGSIZE; 57 58 memcpy(nla_data(attr), s, len); 59 ((char *)nla_data(attr))[len] = '\0'; 60 return 0; 61 } 62 63 /** 64 * ethnl_update_u32() - update u32 value from NLA_U32 attribute 65 * @dst: value to update 66 * @attr: netlink attribute with new value or null 67 * @mod: pointer to bool for modification tracking 68 * 69 * Copy the u32 value from NLA_U32 netlink attribute @attr into variable 70 * pointed to by @dst; do nothing if @attr is null. Bool pointed to by @mod 71 * is set to true if this function changed the value of *dst, otherwise it 72 * is left as is. 73 */ 74 static inline void ethnl_update_u32(u32 *dst, const struct nlattr *attr, 75 bool *mod) 76 { 77 u32 val; 78 79 if (!attr) 80 return; 81 val = nla_get_u32(attr); 82 if (*dst == val) 83 return; 84 85 *dst = val; 86 *mod = true; 87 } 88 89 /** 90 * ethnl_update_u8() - update u8 value from NLA_U8 attribute 91 * @dst: value to update 92 * @attr: netlink attribute with new value or null 93 * @mod: pointer to bool for modification tracking 94 * 95 * Copy the u8 value from NLA_U8 netlink attribute @attr into variable 96 * pointed to by @dst; do nothing if @attr is null. Bool pointed to by @mod 97 * is set to true if this function changed the value of *dst, otherwise it 98 * is left as is. 99 */ 100 static inline void ethnl_update_u8(u8 *dst, const struct nlattr *attr, 101 bool *mod) 102 { 103 u8 val; 104 105 if (!attr) 106 return; 107 val = nla_get_u8(attr); 108 if (*dst == val) 109 return; 110 111 *dst = val; 112 *mod = true; 113 } 114 115 /** 116 * ethnl_update_bool32() - update u32 used as bool from NLA_U8 attribute 117 * @dst: value to update 118 * @attr: netlink attribute with new value or null 119 * @mod: pointer to bool for modification tracking 120 * 121 * Use the u8 value from NLA_U8 netlink attribute @attr to set u32 variable 122 * pointed to by @dst to 0 (if zero) or 1 (if not); do nothing if @attr is 123 * null. Bool pointed to by @mod is set to true if this function changed the 124 * logical value of *dst, otherwise it is left as is. 125 */ 126 static inline void ethnl_update_bool32(u32 *dst, const struct nlattr *attr, 127 bool *mod) 128 { 129 u8 val; 130 131 if (!attr) 132 return; 133 val = !!nla_get_u8(attr); 134 if (!!*dst == val) 135 return; 136 137 *dst = val; 138 *mod = true; 139 } 140 141 /** 142 * ethnl_update_bool() - updateb bool used as bool from NLA_U8 attribute 143 * @dst: value to update 144 * @attr: netlink attribute with new value or null 145 * @mod: pointer to bool for modification tracking 146 * 147 * Use the bool value from NLA_U8 netlink attribute @attr to set bool variable 148 * pointed to by @dst to 0 (if zero) or 1 (if not); do nothing if @attr is 149 * null. Bool pointed to by @mod is set to true if this function changed the 150 * logical value of *dst, otherwise it is left as is. 151 */ 152 static inline void ethnl_update_bool(bool *dst, const struct nlattr *attr, 153 bool *mod) 154 { 155 u8 val; 156 157 if (!attr) 158 return; 159 val = !!nla_get_u8(attr); 160 if (!!*dst == val) 161 return; 162 163 *dst = val; 164 *mod = true; 165 } 166 167 /** 168 * ethnl_update_binary() - update binary data from NLA_BINARY attribute 169 * @dst: value to update 170 * @len: destination buffer length 171 * @attr: netlink attribute with new value or null 172 * @mod: pointer to bool for modification tracking 173 * 174 * Use the u8 value from NLA_U8 netlink attribute @attr to rewrite data block 175 * of length @len at @dst by attribute payload; do nothing if @attr is null. 176 * Bool pointed to by @mod is set to true if this function changed the logical 177 * value of *dst, otherwise it is left as is. 178 */ 179 static inline void ethnl_update_binary(void *dst, unsigned int len, 180 const struct nlattr *attr, bool *mod) 181 { 182 if (!attr) 183 return; 184 if (nla_len(attr) < len) 185 len = nla_len(attr); 186 if (!memcmp(dst, nla_data(attr), len)) 187 return; 188 189 memcpy(dst, nla_data(attr), len); 190 *mod = true; 191 } 192 193 /** 194 * ethnl_update_bitfield32() - update u32 value from NLA_BITFIELD32 attribute 195 * @dst: value to update 196 * @attr: netlink attribute with new value or null 197 * @mod: pointer to bool for modification tracking 198 * 199 * Update bits in u32 value which are set in attribute's mask to values from 200 * attribute's value. Do nothing if @attr is null or the value wouldn't change; 201 * otherwise, set bool pointed to by @mod to true. 202 */ 203 static inline void ethnl_update_bitfield32(u32 *dst, const struct nlattr *attr, 204 bool *mod) 205 { 206 struct nla_bitfield32 change; 207 u32 newval; 208 209 if (!attr) 210 return; 211 change = nla_get_bitfield32(attr); 212 newval = (*dst & ~change.selector) | (change.value & change.selector); 213 if (*dst == newval) 214 return; 215 216 *dst = newval; 217 *mod = true; 218 } 219 220 /** 221 * ethnl_reply_header_size() - total size of reply header 222 * 223 * This is an upper estimate so that we do not need to hold RTNL lock longer 224 * than necessary (to prevent rename between size estimate and composing the 225 * message). Accounts only for device ifindex and name as those are the only 226 * attributes ethnl_fill_reply_header() puts into the reply header. 227 */ 228 static inline unsigned int ethnl_reply_header_size(void) 229 { 230 return nla_total_size(nla_total_size(sizeof(u32)) + 231 nla_total_size(IFNAMSIZ)); 232 } 233 234 /* GET request handling */ 235 236 /* Unified processing of GET requests uses two data structures: request info 237 * and reply data. Request info holds information parsed from client request 238 * and its stays constant through all request processing. Reply data holds data 239 * retrieved from ethtool_ops callbacks or other internal sources which is used 240 * to compose the reply. When processing a dump request, request info is filled 241 * only once (when the request message is parsed) but reply data is filled for 242 * each reply message. 243 * 244 * Both structures consist of part common for all request types (struct 245 * ethnl_req_info and struct ethnl_reply_data defined below) and optional 246 * parts specific for each request type. Common part always starts at offset 0. 247 */ 248 249 /** 250 * struct ethnl_req_info - base type of request information for GET requests 251 * @dev: network device the request is for (may be null) 252 * @dev_tracker: refcount tracker for @dev reference 253 * @flags: request flags common for all request types 254 * 255 * This is a common base for request specific structures holding data from 256 * parsed userspace request. These always embed struct ethnl_req_info at 257 * zero offset. 258 */ 259 struct ethnl_req_info { 260 struct net_device *dev; 261 netdevice_tracker dev_tracker; 262 u32 flags; 263 }; 264 265 static inline void ethnl_parse_header_dev_put(struct ethnl_req_info *req_info) 266 { 267 netdev_put(req_info->dev, &req_info->dev_tracker); 268 } 269 270 /** 271 * struct ethnl_reply_data - base type of reply data for GET requests 272 * @dev: device for current reply message; in single shot requests it is 273 * equal to ðnl_req_info.dev; in dumps it's different for each 274 * reply message 275 * 276 * This is a common base for request specific structures holding data for 277 * kernel reply message. These always embed struct ethnl_reply_data at zero 278 * offset. 279 */ 280 struct ethnl_reply_data { 281 struct net_device *dev; 282 }; 283 284 int ethnl_ops_begin(struct net_device *dev); 285 void ethnl_ops_complete(struct net_device *dev); 286 287 enum ethnl_sock_type { 288 ETHTOOL_SOCK_TYPE_MODULE_FW_FLASH, 289 }; 290 291 struct ethnl_sock_priv { 292 struct net_device *dev; 293 u32 portid; 294 enum ethnl_sock_type type; 295 }; 296 297 int ethnl_sock_priv_set(struct sk_buff *skb, struct net_device *dev, u32 portid, 298 enum ethnl_sock_type type); 299 300 /** 301 * struct ethnl_request_ops - unified handling of GET and SET requests 302 * @request_cmd: command id for request (GET) 303 * @reply_cmd: command id for reply (GET_REPLY) 304 * @hdr_attr: attribute type for request header 305 * @req_info_size: size of request info 306 * @reply_data_size: size of reply data 307 * @allow_nodev_do: allow non-dump request with no device identification 308 * @set_ntf_cmd: notification to generate on changes (SET) 309 * @parse_request: 310 * Parse request except common header (struct ethnl_req_info). Common 311 * header is already filled on entry, the rest up to @repdata_offset 312 * is zero initialized. This callback should only modify type specific 313 * request info by parsed attributes from request message. 314 * @prepare_data: 315 * Retrieve and prepare data needed to compose a reply message. Calls to 316 * ethtool_ops handlers are limited to this callback. Common reply data 317 * (struct ethnl_reply_data) is filled on entry, type specific part after 318 * it is zero initialized. This callback should only modify the type 319 * specific part of reply data. Device identification from struct 320 * ethnl_reply_data is to be used as for dump requests, it iterates 321 * through network devices while dev member of struct ethnl_req_info 322 * points to the device from client request. 323 * @reply_size: 324 * Estimate reply message size. Returned value must be sufficient for 325 * message payload without common reply header. The callback may returned 326 * estimate higher than actual message size if exact calculation would 327 * not be worth the saved memory space. 328 * @fill_reply: 329 * Fill reply message payload (except for common header) from reply data. 330 * The callback must not generate more payload than previously called 331 * ->reply_size() estimated. 332 * @cleanup_data: 333 * Optional cleanup called when reply data is no longer needed. Can be 334 * used e.g. to free any additional data structures outside the main 335 * structure which were allocated by ->prepare_data(). When processing 336 * dump requests, ->cleanup() is called for each message. 337 * @set_validate: 338 * Check if set operation is supported for a given device, and perform 339 * extra input checks. Expected return values: 340 * - 0 if the operation is a noop for the device (rare) 341 * - 1 if operation should proceed to calling @set 342 * - negative errno on errors 343 * Called without any locks, just a reference on the netdev. 344 * @set: 345 * Execute the set operation. The implementation should return 346 * - 0 if no configuration has changed 347 * - 1 if configuration changed and notification should be generated 348 * - negative errno on errors 349 * 350 * Description of variable parts of GET request handling when using the 351 * unified infrastructure. When used, a pointer to an instance of this 352 * structure is to be added to ðnl_default_requests array and generic 353 * handlers ethnl_default_doit(), ethnl_default_dumpit(), 354 * ethnl_default_start() and ethnl_default_done() used in @ethtool_genl_ops; 355 * ethnl_default_notify() can be used in @ethnl_notify_handlers to send 356 * notifications of the corresponding type. 357 */ 358 struct ethnl_request_ops { 359 u8 request_cmd; 360 u8 reply_cmd; 361 u16 hdr_attr; 362 unsigned int req_info_size; 363 unsigned int reply_data_size; 364 bool allow_nodev_do; 365 u8 set_ntf_cmd; 366 367 int (*parse_request)(struct ethnl_req_info *req_info, 368 struct nlattr **tb, 369 struct netlink_ext_ack *extack); 370 int (*prepare_data)(const struct ethnl_req_info *req_info, 371 struct ethnl_reply_data *reply_data, 372 const struct genl_info *info); 373 int (*reply_size)(const struct ethnl_req_info *req_info, 374 const struct ethnl_reply_data *reply_data); 375 int (*fill_reply)(struct sk_buff *skb, 376 const struct ethnl_req_info *req_info, 377 const struct ethnl_reply_data *reply_data); 378 void (*cleanup_data)(struct ethnl_reply_data *reply_data); 379 380 int (*set_validate)(struct ethnl_req_info *req_info, 381 struct genl_info *info); 382 int (*set)(struct ethnl_req_info *req_info, 383 struct genl_info *info); 384 }; 385 386 /* request handlers */ 387 388 extern const struct ethnl_request_ops ethnl_strset_request_ops; 389 extern const struct ethnl_request_ops ethnl_linkinfo_request_ops; 390 extern const struct ethnl_request_ops ethnl_linkmodes_request_ops; 391 extern const struct ethnl_request_ops ethnl_linkstate_request_ops; 392 extern const struct ethnl_request_ops ethnl_debug_request_ops; 393 extern const struct ethnl_request_ops ethnl_wol_request_ops; 394 extern const struct ethnl_request_ops ethnl_features_request_ops; 395 extern const struct ethnl_request_ops ethnl_privflags_request_ops; 396 extern const struct ethnl_request_ops ethnl_rings_request_ops; 397 extern const struct ethnl_request_ops ethnl_channels_request_ops; 398 extern const struct ethnl_request_ops ethnl_coalesce_request_ops; 399 extern const struct ethnl_request_ops ethnl_pause_request_ops; 400 extern const struct ethnl_request_ops ethnl_eee_request_ops; 401 extern const struct ethnl_request_ops ethnl_tsinfo_request_ops; 402 extern const struct ethnl_request_ops ethnl_fec_request_ops; 403 extern const struct ethnl_request_ops ethnl_module_eeprom_request_ops; 404 extern const struct ethnl_request_ops ethnl_stats_request_ops; 405 extern const struct ethnl_request_ops ethnl_phc_vclocks_request_ops; 406 extern const struct ethnl_request_ops ethnl_module_request_ops; 407 extern const struct ethnl_request_ops ethnl_pse_request_ops; 408 extern const struct ethnl_request_ops ethnl_rss_request_ops; 409 extern const struct ethnl_request_ops ethnl_plca_cfg_request_ops; 410 extern const struct ethnl_request_ops ethnl_plca_status_request_ops; 411 extern const struct ethnl_request_ops ethnl_mm_request_ops; 412 413 extern const struct nla_policy ethnl_header_policy[ETHTOOL_A_HEADER_FLAGS + 1]; 414 extern const struct nla_policy ethnl_header_policy_stats[ETHTOOL_A_HEADER_FLAGS + 1]; 415 extern const struct nla_policy ethnl_strset_get_policy[ETHTOOL_A_STRSET_COUNTS_ONLY + 1]; 416 extern const struct nla_policy ethnl_linkinfo_get_policy[ETHTOOL_A_LINKINFO_HEADER + 1]; 417 extern const struct nla_policy ethnl_linkinfo_set_policy[ETHTOOL_A_LINKINFO_TP_MDIX_CTRL + 1]; 418 extern const struct nla_policy ethnl_linkmodes_get_policy[ETHTOOL_A_LINKMODES_HEADER + 1]; 419 extern const struct nla_policy ethnl_linkmodes_set_policy[ETHTOOL_A_LINKMODES_LANES + 1]; 420 extern const struct nla_policy ethnl_linkstate_get_policy[ETHTOOL_A_LINKSTATE_HEADER + 1]; 421 extern const struct nla_policy ethnl_debug_get_policy[ETHTOOL_A_DEBUG_HEADER + 1]; 422 extern const struct nla_policy ethnl_debug_set_policy[ETHTOOL_A_DEBUG_MSGMASK + 1]; 423 extern const struct nla_policy ethnl_wol_get_policy[ETHTOOL_A_WOL_HEADER + 1]; 424 extern const struct nla_policy ethnl_wol_set_policy[ETHTOOL_A_WOL_SOPASS + 1]; 425 extern const struct nla_policy ethnl_features_get_policy[ETHTOOL_A_FEATURES_HEADER + 1]; 426 extern const struct nla_policy ethnl_features_set_policy[ETHTOOL_A_FEATURES_WANTED + 1]; 427 extern const struct nla_policy ethnl_privflags_get_policy[ETHTOOL_A_PRIVFLAGS_HEADER + 1]; 428 extern const struct nla_policy ethnl_privflags_set_policy[ETHTOOL_A_PRIVFLAGS_FLAGS + 1]; 429 extern const struct nla_policy ethnl_rings_get_policy[ETHTOOL_A_RINGS_HEADER + 1]; 430 extern const struct nla_policy ethnl_rings_set_policy[ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN_MAX + 1]; 431 extern const struct nla_policy ethnl_channels_get_policy[ETHTOOL_A_CHANNELS_HEADER + 1]; 432 extern const struct nla_policy ethnl_channels_set_policy[ETHTOOL_A_CHANNELS_COMBINED_COUNT + 1]; 433 extern const struct nla_policy ethnl_coalesce_get_policy[ETHTOOL_A_COALESCE_HEADER + 1]; 434 extern const struct nla_policy ethnl_coalesce_set_policy[ETHTOOL_A_COALESCE_MAX + 1]; 435 extern const struct nla_policy ethnl_pause_get_policy[ETHTOOL_A_PAUSE_STATS_SRC + 1]; 436 extern const struct nla_policy ethnl_pause_set_policy[ETHTOOL_A_PAUSE_TX + 1]; 437 extern const struct nla_policy ethnl_eee_get_policy[ETHTOOL_A_EEE_HEADER + 1]; 438 extern const struct nla_policy ethnl_eee_set_policy[ETHTOOL_A_EEE_TX_LPI_TIMER + 1]; 439 extern const struct nla_policy ethnl_tsinfo_get_policy[ETHTOOL_A_TSINFO_HEADER + 1]; 440 extern const struct nla_policy ethnl_cable_test_act_policy[ETHTOOL_A_CABLE_TEST_HEADER + 1]; 441 extern const struct nla_policy ethnl_cable_test_tdr_act_policy[ETHTOOL_A_CABLE_TEST_TDR_CFG + 1]; 442 extern const struct nla_policy ethnl_tunnel_info_get_policy[ETHTOOL_A_TUNNEL_INFO_HEADER + 1]; 443 extern const struct nla_policy ethnl_fec_get_policy[ETHTOOL_A_FEC_HEADER + 1]; 444 extern const struct nla_policy ethnl_fec_set_policy[ETHTOOL_A_FEC_AUTO + 1]; 445 extern const struct nla_policy ethnl_module_eeprom_get_policy[ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS + 1]; 446 extern const struct nla_policy ethnl_stats_get_policy[ETHTOOL_A_STATS_SRC + 1]; 447 extern const struct nla_policy ethnl_phc_vclocks_get_policy[ETHTOOL_A_PHC_VCLOCKS_HEADER + 1]; 448 extern const struct nla_policy ethnl_module_get_policy[ETHTOOL_A_MODULE_HEADER + 1]; 449 extern const struct nla_policy ethnl_module_set_policy[ETHTOOL_A_MODULE_POWER_MODE_POLICY + 1]; 450 extern const struct nla_policy ethnl_pse_get_policy[ETHTOOL_A_PSE_HEADER + 1]; 451 extern const struct nla_policy ethnl_pse_set_policy[ETHTOOL_A_PSE_MAX + 1]; 452 extern const struct nla_policy ethnl_rss_get_policy[ETHTOOL_A_RSS_CONTEXT + 1]; 453 extern const struct nla_policy ethnl_plca_get_cfg_policy[ETHTOOL_A_PLCA_HEADER + 1]; 454 extern const struct nla_policy ethnl_plca_set_cfg_policy[ETHTOOL_A_PLCA_MAX + 1]; 455 extern const struct nla_policy ethnl_plca_get_status_policy[ETHTOOL_A_PLCA_HEADER + 1]; 456 extern const struct nla_policy ethnl_mm_get_policy[ETHTOOL_A_MM_HEADER + 1]; 457 extern const struct nla_policy ethnl_mm_set_policy[ETHTOOL_A_MM_MAX + 1]; 458 extern const struct nla_policy ethnl_module_fw_flash_act_policy[ETHTOOL_A_MODULE_FW_FLASH_PASSWORD + 1]; 459 460 int ethnl_set_features(struct sk_buff *skb, struct genl_info *info); 461 int ethnl_act_cable_test(struct sk_buff *skb, struct genl_info *info); 462 int ethnl_act_cable_test_tdr(struct sk_buff *skb, struct genl_info *info); 463 int ethnl_tunnel_info_doit(struct sk_buff *skb, struct genl_info *info); 464 int ethnl_tunnel_info_start(struct netlink_callback *cb); 465 int ethnl_tunnel_info_dumpit(struct sk_buff *skb, struct netlink_callback *cb); 466 int ethnl_act_module_fw_flash(struct sk_buff *skb, struct genl_info *info); 467 468 extern const char stats_std_names[__ETHTOOL_STATS_CNT][ETH_GSTRING_LEN]; 469 extern const char stats_eth_phy_names[__ETHTOOL_A_STATS_ETH_PHY_CNT][ETH_GSTRING_LEN]; 470 extern const char stats_eth_mac_names[__ETHTOOL_A_STATS_ETH_MAC_CNT][ETH_GSTRING_LEN]; 471 extern const char stats_eth_ctrl_names[__ETHTOOL_A_STATS_ETH_CTRL_CNT][ETH_GSTRING_LEN]; 472 extern const char stats_rmon_names[__ETHTOOL_A_STATS_RMON_CNT][ETH_GSTRING_LEN]; 473 474 #endif /* _NET_ETHTOOL_NETLINK_H */ 475