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