1 /* 2 * ethtool.h: Defines for Linux ethtool. 3 * 4 * Copyright (C) 1998 David S. Miller ([email protected]) 5 * Copyright 2001 Jeff Garzik <[email protected]> 6 * Portions Copyright 2001 Sun Microsystems ([email protected]) 7 * Portions Copyright 2002 Intel ([email protected], 8 * [email protected], 9 * [email protected]) 10 * Portions Copyright (C) Sun Microsystems 2008 11 */ 12 13 #ifndef _LINUX_ETHTOOL_H 14 #define _LINUX_ETHTOOL_H 15 16 #ifdef __KERNEL__ 17 #include <linux/compat.h> 18 #endif 19 #include <linux/types.h> 20 #include <linux/if_ether.h> 21 22 /* This should work for both 32 and 64 bit userland. */ 23 struct ethtool_cmd { 24 __u32 cmd; 25 __u32 supported; /* Features this interface supports */ 26 __u32 advertising; /* Features this interface advertises */ 27 __u16 speed; /* The forced speed, 10Mb, 100Mb, gigabit */ 28 __u8 duplex; /* Duplex, half or full */ 29 __u8 port; /* Which connector port */ 30 __u8 phy_address; 31 __u8 transceiver; /* Which transceiver to use */ 32 __u8 autoneg; /* Enable or disable autonegotiation */ 33 __u8 mdio_support; 34 __u32 maxtxpkt; /* Tx pkts before generating tx int */ 35 __u32 maxrxpkt; /* Rx pkts before generating rx int */ 36 __u16 speed_hi; 37 __u8 eth_tp_mdix; 38 __u8 reserved2; 39 __u32 lp_advertising; /* Features the link partner advertises */ 40 __u32 reserved[2]; 41 }; 42 43 static inline void ethtool_cmd_speed_set(struct ethtool_cmd *ep, 44 __u32 speed) 45 { 46 47 ep->speed = (__u16)speed; 48 ep->speed_hi = (__u16)(speed >> 16); 49 } 50 51 static inline __u32 ethtool_cmd_speed(struct ethtool_cmd *ep) 52 { 53 return (ep->speed_hi << 16) | ep->speed; 54 } 55 56 #define ETHTOOL_FWVERS_LEN 32 57 #define ETHTOOL_BUSINFO_LEN 32 58 /* these strings are set to whatever the driver author decides... */ 59 struct ethtool_drvinfo { 60 __u32 cmd; 61 char driver[32]; /* driver short name, "tulip", "eepro100" */ 62 char version[32]; /* driver version string */ 63 char fw_version[ETHTOOL_FWVERS_LEN]; /* firmware version string */ 64 char bus_info[ETHTOOL_BUSINFO_LEN]; /* Bus info for this IF. */ 65 /* For PCI devices, use pci_name(pci_dev). */ 66 char reserved1[32]; 67 char reserved2[12]; 68 /* 69 * Some struct members below are filled in 70 * using ops->get_sset_count(). Obtaining 71 * this info from ethtool_drvinfo is now 72 * deprecated; Use ETHTOOL_GSSET_INFO 73 * instead. 74 */ 75 __u32 n_priv_flags; /* number of flags valid in ETHTOOL_GPFLAGS */ 76 __u32 n_stats; /* number of u64's from ETHTOOL_GSTATS */ 77 __u32 testinfo_len; 78 __u32 eedump_len; /* Size of data from ETHTOOL_GEEPROM (bytes) */ 79 __u32 regdump_len; /* Size of data from ETHTOOL_GREGS (bytes) */ 80 }; 81 82 #define SOPASS_MAX 6 83 /* wake-on-lan settings */ 84 struct ethtool_wolinfo { 85 __u32 cmd; 86 __u32 supported; 87 __u32 wolopts; 88 __u8 sopass[SOPASS_MAX]; /* SecureOn(tm) password */ 89 }; 90 91 /* for passing single values */ 92 struct ethtool_value { 93 __u32 cmd; 94 __u32 data; 95 }; 96 97 /* for passing big chunks of data */ 98 struct ethtool_regs { 99 __u32 cmd; 100 __u32 version; /* driver-specific, indicates different chips/revs */ 101 __u32 len; /* bytes */ 102 __u8 data[0]; 103 }; 104 105 /* for passing EEPROM chunks */ 106 struct ethtool_eeprom { 107 __u32 cmd; 108 __u32 magic; 109 __u32 offset; /* in bytes */ 110 __u32 len; /* in bytes */ 111 __u8 data[0]; 112 }; 113 114 /* for configuring coalescing parameters of chip */ 115 struct ethtool_coalesce { 116 __u32 cmd; /* ETHTOOL_{G,S}COALESCE */ 117 118 /* How many usecs to delay an RX interrupt after 119 * a packet arrives. If 0, only rx_max_coalesced_frames 120 * is used. 121 */ 122 __u32 rx_coalesce_usecs; 123 124 /* How many packets to delay an RX interrupt after 125 * a packet arrives. If 0, only rx_coalesce_usecs is 126 * used. It is illegal to set both usecs and max frames 127 * to zero as this would cause RX interrupts to never be 128 * generated. 129 */ 130 __u32 rx_max_coalesced_frames; 131 132 /* Same as above two parameters, except that these values 133 * apply while an IRQ is being serviced by the host. Not 134 * all cards support this feature and the values are ignored 135 * in that case. 136 */ 137 __u32 rx_coalesce_usecs_irq; 138 __u32 rx_max_coalesced_frames_irq; 139 140 /* How many usecs to delay a TX interrupt after 141 * a packet is sent. If 0, only tx_max_coalesced_frames 142 * is used. 143 */ 144 __u32 tx_coalesce_usecs; 145 146 /* How many packets to delay a TX interrupt after 147 * a packet is sent. If 0, only tx_coalesce_usecs is 148 * used. It is illegal to set both usecs and max frames 149 * to zero as this would cause TX interrupts to never be 150 * generated. 151 */ 152 __u32 tx_max_coalesced_frames; 153 154 /* Same as above two parameters, except that these values 155 * apply while an IRQ is being serviced by the host. Not 156 * all cards support this feature and the values are ignored 157 * in that case. 158 */ 159 __u32 tx_coalesce_usecs_irq; 160 __u32 tx_max_coalesced_frames_irq; 161 162 /* How many usecs to delay in-memory statistics 163 * block updates. Some drivers do not have an in-memory 164 * statistic block, and in such cases this value is ignored. 165 * This value must not be zero. 166 */ 167 __u32 stats_block_coalesce_usecs; 168 169 /* Adaptive RX/TX coalescing is an algorithm implemented by 170 * some drivers to improve latency under low packet rates and 171 * improve throughput under high packet rates. Some drivers 172 * only implement one of RX or TX adaptive coalescing. Anything 173 * not implemented by the driver causes these values to be 174 * silently ignored. 175 */ 176 __u32 use_adaptive_rx_coalesce; 177 __u32 use_adaptive_tx_coalesce; 178 179 /* When the packet rate (measured in packets per second) 180 * is below pkt_rate_low, the {rx,tx}_*_low parameters are 181 * used. 182 */ 183 __u32 pkt_rate_low; 184 __u32 rx_coalesce_usecs_low; 185 __u32 rx_max_coalesced_frames_low; 186 __u32 tx_coalesce_usecs_low; 187 __u32 tx_max_coalesced_frames_low; 188 189 /* When the packet rate is below pkt_rate_high but above 190 * pkt_rate_low (both measured in packets per second) the 191 * normal {rx,tx}_* coalescing parameters are used. 192 */ 193 194 /* When the packet rate is (measured in packets per second) 195 * is above pkt_rate_high, the {rx,tx}_*_high parameters are 196 * used. 197 */ 198 __u32 pkt_rate_high; 199 __u32 rx_coalesce_usecs_high; 200 __u32 rx_max_coalesced_frames_high; 201 __u32 tx_coalesce_usecs_high; 202 __u32 tx_max_coalesced_frames_high; 203 204 /* How often to do adaptive coalescing packet rate sampling, 205 * measured in seconds. Must not be zero. 206 */ 207 __u32 rate_sample_interval; 208 }; 209 210 /* for configuring RX/TX ring parameters */ 211 struct ethtool_ringparam { 212 __u32 cmd; /* ETHTOOL_{G,S}RINGPARAM */ 213 214 /* Read only attributes. These indicate the maximum number 215 * of pending RX/TX ring entries the driver will allow the 216 * user to set. 217 */ 218 __u32 rx_max_pending; 219 __u32 rx_mini_max_pending; 220 __u32 rx_jumbo_max_pending; 221 __u32 tx_max_pending; 222 223 /* Values changeable by the user. The valid values are 224 * in the range 1 to the "*_max_pending" counterpart above. 225 */ 226 __u32 rx_pending; 227 __u32 rx_mini_pending; 228 __u32 rx_jumbo_pending; 229 __u32 tx_pending; 230 }; 231 232 /* for configuring link flow control parameters */ 233 struct ethtool_pauseparam { 234 __u32 cmd; /* ETHTOOL_{G,S}PAUSEPARAM */ 235 236 /* If the link is being auto-negotiated (via ethtool_cmd.autoneg 237 * being true) the user may set 'autonet' here non-zero to have the 238 * pause parameters be auto-negotiated too. In such a case, the 239 * {rx,tx}_pause values below determine what capabilities are 240 * advertised. 241 * 242 * If 'autoneg' is zero or the link is not being auto-negotiated, 243 * then {rx,tx}_pause force the driver to use/not-use pause 244 * flow control. 245 */ 246 __u32 autoneg; 247 __u32 rx_pause; 248 __u32 tx_pause; 249 }; 250 251 #define ETH_GSTRING_LEN 32 252 enum ethtool_stringset { 253 ETH_SS_TEST = 0, 254 ETH_SS_STATS, 255 ETH_SS_PRIV_FLAGS, 256 ETH_SS_NTUPLE_FILTERS, 257 ETH_SS_FEATURES, 258 }; 259 260 /* for passing string sets for data tagging */ 261 struct ethtool_gstrings { 262 __u32 cmd; /* ETHTOOL_GSTRINGS */ 263 __u32 string_set; /* string set id e.c. ETH_SS_TEST, etc*/ 264 __u32 len; /* number of strings in the string set */ 265 __u8 data[0]; 266 }; 267 268 struct ethtool_sset_info { 269 __u32 cmd; /* ETHTOOL_GSSET_INFO */ 270 __u32 reserved; 271 __u64 sset_mask; /* input: each bit selects an sset to query */ 272 /* output: each bit a returned sset */ 273 __u32 data[0]; /* ETH_SS_xxx count, in order, based on bits 274 in sset_mask. One bit implies one 275 __u32, two bits implies two 276 __u32's, etc. */ 277 }; 278 279 enum ethtool_test_flags { 280 ETH_TEST_FL_OFFLINE = (1 << 0), /* online / offline */ 281 ETH_TEST_FL_FAILED = (1 << 1), /* test passed / failed */ 282 }; 283 284 /* for requesting NIC test and getting results*/ 285 struct ethtool_test { 286 __u32 cmd; /* ETHTOOL_TEST */ 287 __u32 flags; /* ETH_TEST_FL_xxx */ 288 __u32 reserved; 289 __u32 len; /* result length, in number of u64 elements */ 290 __u64 data[0]; 291 }; 292 293 /* for dumping NIC-specific statistics */ 294 struct ethtool_stats { 295 __u32 cmd; /* ETHTOOL_GSTATS */ 296 __u32 n_stats; /* number of u64's being returned */ 297 __u64 data[0]; 298 }; 299 300 struct ethtool_perm_addr { 301 __u32 cmd; /* ETHTOOL_GPERMADDR */ 302 __u32 size; 303 __u8 data[0]; 304 }; 305 306 /* boolean flags controlling per-interface behavior characteristics. 307 * When reading, the flag indicates whether or not a certain behavior 308 * is enabled/present. When writing, the flag indicates whether 309 * or not the driver should turn on (set) or off (clear) a behavior. 310 * 311 * Some behaviors may read-only (unconditionally absent or present). 312 * If such is the case, return EINVAL in the set-flags operation if the 313 * flag differs from the read-only value. 314 */ 315 enum ethtool_flags { 316 ETH_FLAG_TXVLAN = (1 << 7), /* TX VLAN offload enabled */ 317 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */ 318 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 319 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */ 320 ETH_FLAG_RXHASH = (1 << 28), 321 }; 322 323 /* The following structures are for supporting RX network flow 324 * classification and RX n-tuple configuration. Note, all multibyte 325 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to 326 * be in network byte order. 327 */ 328 329 /** 330 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. 331 * @ip4src: Source host 332 * @ip4dst: Destination host 333 * @psrc: Source port 334 * @pdst: Destination port 335 * @tos: Type-of-service 336 * 337 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. 338 */ 339 struct ethtool_tcpip4_spec { 340 __be32 ip4src; 341 __be32 ip4dst; 342 __be16 psrc; 343 __be16 pdst; 344 __u8 tos; 345 }; 346 347 /** 348 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 349 * @ip4src: Source host 350 * @ip4dst: Destination host 351 * @spi: Security parameters index 352 * @tos: Type-of-service 353 * 354 * This can be used to specify an IPsec transport or tunnel over IPv4. 355 */ 356 struct ethtool_ah_espip4_spec { 357 __be32 ip4src; 358 __be32 ip4dst; 359 __be32 spi; 360 __u8 tos; 361 }; 362 363 #define ETH_RX_NFC_IP4 1 364 365 /** 366 * struct ethtool_usrip4_spec - general flow specification for IPv4 367 * @ip4src: Source host 368 * @ip4dst: Destination host 369 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 370 * @tos: Type-of-service 371 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 372 * @proto: Transport protocol number; mask must be 0 373 */ 374 struct ethtool_usrip4_spec { 375 __be32 ip4src; 376 __be32 ip4dst; 377 __be32 l4_4_bytes; 378 __u8 tos; 379 __u8 ip_ver; 380 __u8 proto; 381 }; 382 383 /** 384 * struct ethtool_rx_flow_spec - specification for RX flow filter 385 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 386 * @h_u: Flow fields to match (dependent on @flow_type) 387 * @m_u: Masks for flow field bits to be ignored 388 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC 389 * if packets should be discarded 390 * @location: Index of filter in hardware table 391 */ 392 struct ethtool_rx_flow_spec { 393 __u32 flow_type; 394 union { 395 struct ethtool_tcpip4_spec tcp_ip4_spec; 396 struct ethtool_tcpip4_spec udp_ip4_spec; 397 struct ethtool_tcpip4_spec sctp_ip4_spec; 398 struct ethtool_ah_espip4_spec ah_ip4_spec; 399 struct ethtool_ah_espip4_spec esp_ip4_spec; 400 struct ethtool_usrip4_spec usr_ip4_spec; 401 struct ethhdr ether_spec; 402 __u8 hdata[72]; 403 } h_u, m_u; 404 __u64 ring_cookie; 405 __u32 location; 406 }; 407 408 /** 409 * struct ethtool_rxnfc - command to get or set RX flow classification rules 410 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, 411 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, 412 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS 413 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW 414 * @data: Command-dependent value 415 * @fs: Flow filter specification 416 * @rule_cnt: Number of rules to be affected 417 * @rule_locs: Array of valid rule indices 418 * 419 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating 420 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following 421 * structure fields must not be used. 422 * 423 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues 424 * on return. 425 * 426 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined 427 * rules on return. 428 * 429 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an 430 * existing filter rule on entry and @fs contains the rule on return. 431 * 432 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the 433 * user buffer for @rule_locs on entry. On return, @data is the size 434 * of the filter table and @rule_locs contains the indices of the 435 * defined rules. 436 * 437 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or 438 * update. @fs.@location specifies the index to use and must not be 439 * ignored. 440 * 441 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an 442 * existing filter rule on entry. 443 * 444 * Implementation of indexed classification rules generally requires a 445 * TCAM. 446 */ 447 struct ethtool_rxnfc { 448 __u32 cmd; 449 __u32 flow_type; 450 __u64 data; 451 struct ethtool_rx_flow_spec fs; 452 __u32 rule_cnt; 453 __u32 rule_locs[0]; 454 }; 455 456 #ifdef __KERNEL__ 457 #ifdef CONFIG_COMPAT 458 459 struct compat_ethtool_rx_flow_spec { 460 u32 flow_type; 461 union { 462 struct ethtool_tcpip4_spec tcp_ip4_spec; 463 struct ethtool_tcpip4_spec udp_ip4_spec; 464 struct ethtool_tcpip4_spec sctp_ip4_spec; 465 struct ethtool_ah_espip4_spec ah_ip4_spec; 466 struct ethtool_ah_espip4_spec esp_ip4_spec; 467 struct ethtool_usrip4_spec usr_ip4_spec; 468 struct ethhdr ether_spec; 469 u8 hdata[72]; 470 } h_u, m_u; 471 compat_u64 ring_cookie; 472 u32 location; 473 }; 474 475 struct compat_ethtool_rxnfc { 476 u32 cmd; 477 u32 flow_type; 478 compat_u64 data; 479 struct compat_ethtool_rx_flow_spec fs; 480 u32 rule_cnt; 481 u32 rule_locs[0]; 482 }; 483 484 #endif /* CONFIG_COMPAT */ 485 #endif /* __KERNEL__ */ 486 487 /** 488 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection 489 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR 490 * @size: On entry, the array size of the user buffer. On return from 491 * %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table. 492 * @ring_index: RX ring/queue index for each hash value 493 */ 494 struct ethtool_rxfh_indir { 495 __u32 cmd; 496 __u32 size; 497 __u32 ring_index[0]; 498 }; 499 500 /** 501 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter 502 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 503 * @h_u: Flow field values to match (dependent on @flow_type) 504 * @m_u: Masks for flow field value bits to be ignored 505 * @vlan_tag: VLAN tag to match 506 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored 507 * @data: Driver-dependent data to match 508 * @data_mask: Mask for driver-dependent data bits to be ignored 509 * @action: RX ring/queue index to deliver to (non-negative) or other action 510 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) 511 * 512 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where 513 * a field value and mask are both zero this is treated as if all mask 514 * bits are set i.e. the field is ignored. 515 */ 516 struct ethtool_rx_ntuple_flow_spec { 517 __u32 flow_type; 518 union { 519 struct ethtool_tcpip4_spec tcp_ip4_spec; 520 struct ethtool_tcpip4_spec udp_ip4_spec; 521 struct ethtool_tcpip4_spec sctp_ip4_spec; 522 struct ethtool_ah_espip4_spec ah_ip4_spec; 523 struct ethtool_ah_espip4_spec esp_ip4_spec; 524 struct ethtool_usrip4_spec usr_ip4_spec; 525 struct ethhdr ether_spec; 526 __u8 hdata[72]; 527 } h_u, m_u; 528 529 __u16 vlan_tag; 530 __u16 vlan_tag_mask; 531 __u64 data; 532 __u64 data_mask; 533 534 __s32 action; 535 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */ 536 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */ 537 }; 538 539 /** 540 * struct ethtool_rx_ntuple - command to set or clear RX flow filter 541 * @cmd: Command number - %ETHTOOL_SRXNTUPLE 542 * @fs: Flow filter specification 543 */ 544 struct ethtool_rx_ntuple { 545 __u32 cmd; 546 struct ethtool_rx_ntuple_flow_spec fs; 547 }; 548 549 #define ETHTOOL_FLASH_MAX_FILENAME 128 550 enum ethtool_flash_op_type { 551 ETHTOOL_FLASH_ALL_REGIONS = 0, 552 }; 553 554 /* for passing firmware flashing related parameters */ 555 struct ethtool_flash { 556 __u32 cmd; 557 __u32 region; 558 char data[ETHTOOL_FLASH_MAX_FILENAME]; 559 }; 560 561 /* for returning and changing feature sets */ 562 563 /** 564 * struct ethtool_get_features_block - block with state of 32 features 565 * @available: mask of changeable features 566 * @requested: mask of features requested to be enabled if possible 567 * @active: mask of currently enabled features 568 * @never_changed: mask of features not changeable for any device 569 */ 570 struct ethtool_get_features_block { 571 __u32 available; 572 __u32 requested; 573 __u32 active; 574 __u32 never_changed; 575 }; 576 577 /** 578 * struct ethtool_gfeatures - command to get state of device's features 579 * @cmd: command number = %ETHTOOL_GFEATURES 580 * @size: in: number of elements in the features[] array; 581 * out: number of elements in features[] needed to hold all features 582 * @features: state of features 583 */ 584 struct ethtool_gfeatures { 585 __u32 cmd; 586 __u32 size; 587 struct ethtool_get_features_block features[0]; 588 }; 589 590 /** 591 * struct ethtool_set_features_block - block with request for 32 features 592 * @valid: mask of features to be changed 593 * @requested: values of features to be changed 594 */ 595 struct ethtool_set_features_block { 596 __u32 valid; 597 __u32 requested; 598 }; 599 600 /** 601 * struct ethtool_sfeatures - command to request change in device's features 602 * @cmd: command number = %ETHTOOL_SFEATURES 603 * @size: array size of the features[] array 604 * @features: feature change masks 605 */ 606 struct ethtool_sfeatures { 607 __u32 cmd; 608 __u32 size; 609 struct ethtool_set_features_block features[0]; 610 }; 611 612 /* 613 * %ETHTOOL_SFEATURES changes features present in features[].valid to the 614 * values of corresponding bits in features[].requested. Bits in .requested 615 * not set in .valid or not changeable are ignored. 616 * 617 * Returns %EINVAL when .valid contains undefined or never-changable bits 618 * or size is not equal to required number of features words (32-bit blocks). 619 * Returns >= 0 if request was completed; bits set in the value mean: 620 * %ETHTOOL_F_UNSUPPORTED - there were bits set in .valid that are not 621 * changeable (not present in %ETHTOOL_GFEATURES' features[].available) 622 * those bits were ignored. 623 * %ETHTOOL_F_WISH - some or all changes requested were recorded but the 624 * resulting state of bits masked by .valid is not equal to .requested. 625 * Probably there are other device-specific constraints on some features 626 * in the set. When %ETHTOOL_F_UNSUPPORTED is set, .valid is considered 627 * here as though ignored bits were cleared. 628 * %ETHTOOL_F_COMPAT - some or all changes requested were made by calling 629 * compatibility functions. Requested offload state cannot be properly 630 * managed by kernel. 631 * 632 * Meaning of bits in the masks are obtained by %ETHTOOL_GSSET_INFO (number of 633 * bits in the arrays - always multiple of 32) and %ETHTOOL_GSTRINGS commands 634 * for ETH_SS_FEATURES string set. First entry in the table corresponds to least 635 * significant bit in features[0] fields. Empty strings mark undefined features. 636 */ 637 enum ethtool_sfeatures_retval_bits { 638 ETHTOOL_F_UNSUPPORTED__BIT, 639 ETHTOOL_F_WISH__BIT, 640 ETHTOOL_F_COMPAT__BIT, 641 }; 642 643 #define ETHTOOL_F_UNSUPPORTED (1 << ETHTOOL_F_UNSUPPORTED__BIT) 644 #define ETHTOOL_F_WISH (1 << ETHTOOL_F_WISH__BIT) 645 #define ETHTOOL_F_COMPAT (1 << ETHTOOL_F_COMPAT__BIT) 646 647 #ifdef __KERNEL__ 648 649 #include <linux/rculist.h> 650 651 struct ethtool_rx_ntuple_flow_spec_container { 652 struct ethtool_rx_ntuple_flow_spec fs; 653 struct list_head list; 654 }; 655 656 struct ethtool_rx_ntuple_list { 657 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024 658 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14 659 struct list_head list; 660 unsigned int count; 661 }; 662 663 struct net_device; 664 665 /* Some generic methods drivers may use in their ethtool_ops */ 666 u32 ethtool_op_get_link(struct net_device *dev); 667 u32 ethtool_op_get_tx_csum(struct net_device *dev); 668 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data); 669 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data); 670 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data); 671 u32 ethtool_op_get_sg(struct net_device *dev); 672 int ethtool_op_set_sg(struct net_device *dev, u32 data); 673 u32 ethtool_op_get_tso(struct net_device *dev); 674 int ethtool_op_set_tso(struct net_device *dev, u32 data); 675 u32 ethtool_op_get_ufo(struct net_device *dev); 676 int ethtool_op_set_ufo(struct net_device *dev, u32 data); 677 u32 ethtool_op_get_flags(struct net_device *dev); 678 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported); 679 void ethtool_ntuple_flush(struct net_device *dev); 680 681 /** 682 * ðtool_ops - Alter and report network device settings 683 * get_settings: Get device-specific settings 684 * set_settings: Set device-specific settings 685 * get_drvinfo: Report driver information 686 * get_regs: Get device registers 687 * get_wol: Report whether Wake-on-Lan is enabled 688 * set_wol: Turn Wake-on-Lan on or off 689 * get_msglevel: Report driver message level 690 * set_msglevel: Set driver message level 691 * nway_reset: Restart autonegotiation 692 * get_link: Get link status 693 * get_eeprom: Read data from the device EEPROM 694 * set_eeprom: Write data to the device EEPROM 695 * get_coalesce: Get interrupt coalescing parameters 696 * set_coalesce: Set interrupt coalescing parameters 697 * get_ringparam: Report ring sizes 698 * set_ringparam: Set ring sizes 699 * get_pauseparam: Report pause parameters 700 * set_pauseparam: Set pause parameters 701 * get_rx_csum: Report whether receive checksums are turned on or off 702 * set_rx_csum: Turn receive checksum on or off 703 * get_tx_csum: Report whether transmit checksums are turned on or off 704 * set_tx_csum: Turn transmit checksums on or off 705 * get_sg: Report whether scatter-gather is enabled 706 * set_sg: Turn scatter-gather on or off 707 * get_tso: Report whether TCP segmentation offload is enabled 708 * set_tso: Turn TCP segmentation offload on or off 709 * get_ufo: Report whether UDP fragmentation offload is enabled 710 * set_ufo: Turn UDP fragmentation offload on or off 711 * self_test: Run specified self-tests 712 * get_strings: Return a set of strings that describe the requested objects 713 * phys_id: Identify the device 714 * get_stats: Return statistics about the device 715 * get_flags: get 32-bit flags bitmap 716 * set_flags: set 32-bit flags bitmap 717 * 718 * Description: 719 * 720 * get_settings: 721 * @get_settings is passed an ðtool_cmd to fill in. It returns 722 * an negative errno or zero. 723 * 724 * set_settings: 725 * @set_settings is passed an ðtool_cmd and should attempt to set 726 * all the settings this device supports. It may return an error value 727 * if something goes wrong (otherwise 0). 728 * 729 * get_eeprom: 730 * Should fill in the magic field. Don't need to check len for zero 731 * or wraparound. Fill in the data argument with the eeprom values 732 * from offset to offset + len. Update len to the amount read. 733 * Returns an error or zero. 734 * 735 * set_eeprom: 736 * Should validate the magic field. Don't need to check len for zero 737 * or wraparound. Update len to the amount written. Returns an error 738 * or zero. 739 */ 740 struct ethtool_ops { 741 int (*get_settings)(struct net_device *, struct ethtool_cmd *); 742 int (*set_settings)(struct net_device *, struct ethtool_cmd *); 743 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 744 int (*get_regs_len)(struct net_device *); 745 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 746 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 747 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 748 u32 (*get_msglevel)(struct net_device *); 749 void (*set_msglevel)(struct net_device *, u32); 750 int (*nway_reset)(struct net_device *); 751 u32 (*get_link)(struct net_device *); 752 int (*get_eeprom_len)(struct net_device *); 753 int (*get_eeprom)(struct net_device *, 754 struct ethtool_eeprom *, u8 *); 755 int (*set_eeprom)(struct net_device *, 756 struct ethtool_eeprom *, u8 *); 757 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); 758 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); 759 void (*get_ringparam)(struct net_device *, 760 struct ethtool_ringparam *); 761 int (*set_ringparam)(struct net_device *, 762 struct ethtool_ringparam *); 763 void (*get_pauseparam)(struct net_device *, 764 struct ethtool_pauseparam*); 765 int (*set_pauseparam)(struct net_device *, 766 struct ethtool_pauseparam*); 767 u32 (*get_rx_csum)(struct net_device *); 768 int (*set_rx_csum)(struct net_device *, u32); 769 u32 (*get_tx_csum)(struct net_device *); 770 int (*set_tx_csum)(struct net_device *, u32); 771 u32 (*get_sg)(struct net_device *); 772 int (*set_sg)(struct net_device *, u32); 773 u32 (*get_tso)(struct net_device *); 774 int (*set_tso)(struct net_device *, u32); 775 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 776 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 777 int (*phys_id)(struct net_device *, u32); 778 void (*get_ethtool_stats)(struct net_device *, 779 struct ethtool_stats *, u64 *); 780 int (*begin)(struct net_device *); 781 void (*complete)(struct net_device *); 782 u32 (*get_ufo)(struct net_device *); 783 int (*set_ufo)(struct net_device *, u32); 784 u32 (*get_flags)(struct net_device *); 785 int (*set_flags)(struct net_device *, u32); 786 u32 (*get_priv_flags)(struct net_device *); 787 int (*set_priv_flags)(struct net_device *, u32); 788 int (*get_sset_count)(struct net_device *, int); 789 int (*get_rxnfc)(struct net_device *, 790 struct ethtool_rxnfc *, void *); 791 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 792 int (*flash_device)(struct net_device *, struct ethtool_flash *); 793 int (*reset)(struct net_device *, u32 *); 794 int (*set_rx_ntuple)(struct net_device *, 795 struct ethtool_rx_ntuple *); 796 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *); 797 int (*get_rxfh_indir)(struct net_device *, 798 struct ethtool_rxfh_indir *); 799 int (*set_rxfh_indir)(struct net_device *, 800 const struct ethtool_rxfh_indir *); 801 }; 802 #endif /* __KERNEL__ */ 803 804 /* CMDs currently supported */ 805 #define ETHTOOL_GSET 0x00000001 /* Get settings. */ 806 #define ETHTOOL_SSET 0x00000002 /* Set settings. */ 807 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 808 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 809 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 810 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 811 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 812 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 813 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 814 /* Get link status for host, i.e. whether the interface *and* the 815 * physical port (if there is one) are up (ethtool_value). */ 816 #define ETHTOOL_GLINK 0x0000000a 817 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 818 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 819 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 820 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 821 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 822 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 823 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 824 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 825 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 826 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 827 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 828 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 829 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 830 * (ethtool_value) */ 831 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 832 * (ethtool_value). */ 833 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 834 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 835 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 836 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 837 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 838 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 839 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 840 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 841 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 842 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 843 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 844 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 845 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 846 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 847 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 848 849 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */ 850 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */ 851 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */ 852 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */ 853 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */ 854 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */ 855 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */ 856 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */ 857 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */ 858 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */ 859 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */ 860 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */ 861 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */ 862 #define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */ 863 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */ 864 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */ 865 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */ 866 867 #define ETHTOOL_GFEATURES 0x0000003a /* Get device offload settings */ 868 #define ETHTOOL_SFEATURES 0x0000003b /* Change device offload settings */ 869 870 /* compatibility with older code */ 871 #define SPARC_ETH_GSET ETHTOOL_GSET 872 #define SPARC_ETH_SSET ETHTOOL_SSET 873 874 /* Indicates what features are supported by the interface. */ 875 #define SUPPORTED_10baseT_Half (1 << 0) 876 #define SUPPORTED_10baseT_Full (1 << 1) 877 #define SUPPORTED_100baseT_Half (1 << 2) 878 #define SUPPORTED_100baseT_Full (1 << 3) 879 #define SUPPORTED_1000baseT_Half (1 << 4) 880 #define SUPPORTED_1000baseT_Full (1 << 5) 881 #define SUPPORTED_Autoneg (1 << 6) 882 #define SUPPORTED_TP (1 << 7) 883 #define SUPPORTED_AUI (1 << 8) 884 #define SUPPORTED_MII (1 << 9) 885 #define SUPPORTED_FIBRE (1 << 10) 886 #define SUPPORTED_BNC (1 << 11) 887 #define SUPPORTED_10000baseT_Full (1 << 12) 888 #define SUPPORTED_Pause (1 << 13) 889 #define SUPPORTED_Asym_Pause (1 << 14) 890 #define SUPPORTED_2500baseX_Full (1 << 15) 891 #define SUPPORTED_Backplane (1 << 16) 892 #define SUPPORTED_1000baseKX_Full (1 << 17) 893 #define SUPPORTED_10000baseKX4_Full (1 << 18) 894 #define SUPPORTED_10000baseKR_Full (1 << 19) 895 #define SUPPORTED_10000baseR_FEC (1 << 20) 896 897 /* Indicates what features are advertised by the interface. */ 898 #define ADVERTISED_10baseT_Half (1 << 0) 899 #define ADVERTISED_10baseT_Full (1 << 1) 900 #define ADVERTISED_100baseT_Half (1 << 2) 901 #define ADVERTISED_100baseT_Full (1 << 3) 902 #define ADVERTISED_1000baseT_Half (1 << 4) 903 #define ADVERTISED_1000baseT_Full (1 << 5) 904 #define ADVERTISED_Autoneg (1 << 6) 905 #define ADVERTISED_TP (1 << 7) 906 #define ADVERTISED_AUI (1 << 8) 907 #define ADVERTISED_MII (1 << 9) 908 #define ADVERTISED_FIBRE (1 << 10) 909 #define ADVERTISED_BNC (1 << 11) 910 #define ADVERTISED_10000baseT_Full (1 << 12) 911 #define ADVERTISED_Pause (1 << 13) 912 #define ADVERTISED_Asym_Pause (1 << 14) 913 #define ADVERTISED_2500baseX_Full (1 << 15) 914 #define ADVERTISED_Backplane (1 << 16) 915 #define ADVERTISED_1000baseKX_Full (1 << 17) 916 #define ADVERTISED_10000baseKX4_Full (1 << 18) 917 #define ADVERTISED_10000baseKR_Full (1 << 19) 918 #define ADVERTISED_10000baseR_FEC (1 << 20) 919 920 /* The following are all involved in forcing a particular link 921 * mode for the device for setting things. When getting the 922 * devices settings, these indicate the current mode and whether 923 * it was foced up into this mode or autonegotiated. 924 */ 925 926 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */ 927 #define SPEED_10 10 928 #define SPEED_100 100 929 #define SPEED_1000 1000 930 #define SPEED_2500 2500 931 #define SPEED_10000 10000 932 933 /* Duplex, half or full. */ 934 #define DUPLEX_HALF 0x00 935 #define DUPLEX_FULL 0x01 936 937 /* Which connector port. */ 938 #define PORT_TP 0x00 939 #define PORT_AUI 0x01 940 #define PORT_MII 0x02 941 #define PORT_FIBRE 0x03 942 #define PORT_BNC 0x04 943 #define PORT_DA 0x05 944 #define PORT_NONE 0xef 945 #define PORT_OTHER 0xff 946 947 /* Which transceiver to use. */ 948 #define XCVR_INTERNAL 0x00 949 #define XCVR_EXTERNAL 0x01 950 #define XCVR_DUMMY1 0x02 951 #define XCVR_DUMMY2 0x03 952 #define XCVR_DUMMY3 0x04 953 954 /* Enable or disable autonegotiation. If this is set to enable, 955 * the forced link modes above are completely ignored. 956 */ 957 #define AUTONEG_DISABLE 0x00 958 #define AUTONEG_ENABLE 0x01 959 960 /* Mode MDI or MDI-X */ 961 #define ETH_TP_MDI_INVALID 0x00 962 #define ETH_TP_MDI 0x01 963 #define ETH_TP_MDI_X 0x02 964 965 /* Wake-On-Lan options. */ 966 #define WAKE_PHY (1 << 0) 967 #define WAKE_UCAST (1 << 1) 968 #define WAKE_MCAST (1 << 2) 969 #define WAKE_BCAST (1 << 3) 970 #define WAKE_ARP (1 << 4) 971 #define WAKE_MAGIC (1 << 5) 972 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 973 974 /* L2-L4 network traffic flow types */ 975 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */ 976 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */ 977 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */ 978 #define AH_ESP_V4_FLOW 0x04 /* hash only */ 979 #define TCP_V6_FLOW 0x05 /* hash only */ 980 #define UDP_V6_FLOW 0x06 /* hash only */ 981 #define SCTP_V6_FLOW 0x07 /* hash only */ 982 #define AH_ESP_V6_FLOW 0x08 /* hash only */ 983 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */ 984 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */ 985 #define AH_V6_FLOW 0x0b /* hash only */ 986 #define ESP_V6_FLOW 0x0c /* hash only */ 987 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */ 988 #define IPV4_FLOW 0x10 /* hash only */ 989 #define IPV6_FLOW 0x11 /* hash only */ 990 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */ 991 992 /* L3-L4 network traffic flow hash options */ 993 #define RXH_L2DA (1 << 1) 994 #define RXH_VLAN (1 << 2) 995 #define RXH_L3_PROTO (1 << 3) 996 #define RXH_IP_SRC (1 << 4) 997 #define RXH_IP_DST (1 << 5) 998 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */ 999 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */ 1000 #define RXH_DISCARD (1 << 31) 1001 1002 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL 1003 1004 /* Reset flags */ 1005 /* The reset() operation must clear the flags for the components which 1006 * were actually reset. On successful return, the flags indicate the 1007 * components which were not reset, either because they do not exist 1008 * in the hardware or because they cannot be reset independently. The 1009 * driver must never reset any components that were not requested. 1010 */ 1011 enum ethtool_reset_flags { 1012 /* These flags represent components dedicated to the interface 1013 * the command is addressed to. Shift any flag left by 1014 * ETH_RESET_SHARED_SHIFT to reset a shared component of the 1015 * same type. 1016 */ 1017 ETH_RESET_MGMT = 1 << 0, /* Management processor */ 1018 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */ 1019 ETH_RESET_DMA = 1 << 2, /* DMA engine */ 1020 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */ 1021 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */ 1022 ETH_RESET_MAC = 1 << 5, /* Media access controller */ 1023 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */ 1024 ETH_RESET_RAM = 1 << 7, /* RAM shared between 1025 * multiple components */ 1026 1027 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to 1028 * this interface */ 1029 ETH_RESET_ALL = 0xffffffff, /* All components used by this 1030 * interface, even if shared */ 1031 }; 1032 #define ETH_RESET_SHARED_SHIFT 16 1033 1034 #endif /* _LINUX_ETHTOOL_H */ 1035