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_TXVLAN = (1 << 7), /* TX VLAN offload enabled */ 313 ETH_FLAG_RXVLAN = (1 << 8), /* RX VLAN offload enabled */ 314 ETH_FLAG_LRO = (1 << 15), /* LRO is enabled */ 315 ETH_FLAG_NTUPLE = (1 << 27), /* N-tuple filters enabled */ 316 ETH_FLAG_RXHASH = (1 << 28), 317 }; 318 319 /* The following structures are for supporting RX network flow 320 * classification and RX n-tuple configuration. Note, all multibyte 321 * fields, e.g., ip4src, ip4dst, psrc, pdst, spi, etc. are expected to 322 * be in network byte order. 323 */ 324 325 /** 326 * struct ethtool_tcpip4_spec - flow specification for TCP/IPv4 etc. 327 * @ip4src: Source host 328 * @ip4dst: Destination host 329 * @psrc: Source port 330 * @pdst: Destination port 331 * @tos: Type-of-service 332 * 333 * This can be used to specify a TCP/IPv4, UDP/IPv4 or SCTP/IPv4 flow. 334 */ 335 struct ethtool_tcpip4_spec { 336 __be32 ip4src; 337 __be32 ip4dst; 338 __be16 psrc; 339 __be16 pdst; 340 __u8 tos; 341 }; 342 343 /** 344 * struct ethtool_ah_espip4_spec - flow specification for IPsec/IPv4 345 * @ip4src: Source host 346 * @ip4dst: Destination host 347 * @spi: Security parameters index 348 * @tos: Type-of-service 349 * 350 * This can be used to specify an IPsec transport or tunnel over IPv4. 351 */ 352 struct ethtool_ah_espip4_spec { 353 __be32 ip4src; 354 __be32 ip4dst; 355 __be32 spi; 356 __u8 tos; 357 }; 358 359 #define ETH_RX_NFC_IP4 1 360 361 /** 362 * struct ethtool_usrip4_spec - general flow specification for IPv4 363 * @ip4src: Source host 364 * @ip4dst: Destination host 365 * @l4_4_bytes: First 4 bytes of transport (layer 4) header 366 * @tos: Type-of-service 367 * @ip_ver: Value must be %ETH_RX_NFC_IP4; mask must be 0 368 * @proto: Transport protocol number; mask must be 0 369 */ 370 struct ethtool_usrip4_spec { 371 __be32 ip4src; 372 __be32 ip4dst; 373 __be32 l4_4_bytes; 374 __u8 tos; 375 __u8 ip_ver; 376 __u8 proto; 377 }; 378 379 /** 380 * struct ethtool_rx_flow_spec - specification for RX flow filter 381 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 382 * @h_u: Flow fields to match (dependent on @flow_type) 383 * @m_u: Masks for flow field bits to be ignored 384 * @ring_cookie: RX ring/queue index to deliver to, or %RX_CLS_FLOW_DISC 385 * if packets should be discarded 386 * @location: Index of filter in hardware table 387 */ 388 struct ethtool_rx_flow_spec { 389 __u32 flow_type; 390 union { 391 struct ethtool_tcpip4_spec tcp_ip4_spec; 392 struct ethtool_tcpip4_spec udp_ip4_spec; 393 struct ethtool_tcpip4_spec sctp_ip4_spec; 394 struct ethtool_ah_espip4_spec ah_ip4_spec; 395 struct ethtool_ah_espip4_spec esp_ip4_spec; 396 struct ethtool_usrip4_spec usr_ip4_spec; 397 struct ethhdr ether_spec; 398 __u8 hdata[72]; 399 } h_u, m_u; 400 __u64 ring_cookie; 401 __u32 location; 402 }; 403 404 /** 405 * struct ethtool_rxnfc - command to get or set RX flow classification rules 406 * @cmd: Specific command number - %ETHTOOL_GRXFH, %ETHTOOL_SRXFH, 407 * %ETHTOOL_GRXRINGS, %ETHTOOL_GRXCLSRLCNT, %ETHTOOL_GRXCLSRULE, 408 * %ETHTOOL_GRXCLSRLALL, %ETHTOOL_SRXCLSRLDEL or %ETHTOOL_SRXCLSRLINS 409 * @flow_type: Type of flow to be affected, e.g. %TCP_V4_FLOW 410 * @data: Command-dependent value 411 * @fs: Flow filter specification 412 * @rule_cnt: Number of rules to be affected 413 * @rule_locs: Array of valid rule indices 414 * 415 * For %ETHTOOL_GRXFH and %ETHTOOL_SRXFH, @data is a bitmask indicating 416 * the fields included in the flow hash, e.g. %RXH_IP_SRC. The following 417 * structure fields must not be used. 418 * 419 * For %ETHTOOL_GRXRINGS, @data is set to the number of RX rings/queues 420 * on return. 421 * 422 * For %ETHTOOL_GRXCLSRLCNT, @rule_cnt is set to the number of defined 423 * rules on return. 424 * 425 * For %ETHTOOL_GRXCLSRULE, @fs.@location specifies the index of an 426 * existing filter rule on entry and @fs contains the rule on return. 427 * 428 * For %ETHTOOL_GRXCLSRLALL, @rule_cnt specifies the array size of the 429 * user buffer for @rule_locs on entry. On return, @data is the size 430 * of the filter table and @rule_locs contains the indices of the 431 * defined rules. 432 * 433 * For %ETHTOOL_SRXCLSRLINS, @fs specifies the filter rule to add or 434 * update. @fs.@location specifies the index to use and must not be 435 * ignored. 436 * 437 * For %ETHTOOL_SRXCLSRLDEL, @fs.@location specifies the index of an 438 * existing filter rule on entry. 439 * 440 * Implementation of indexed classification rules generally requires a 441 * TCAM. 442 */ 443 struct ethtool_rxnfc { 444 __u32 cmd; 445 __u32 flow_type; 446 __u64 data; 447 struct ethtool_rx_flow_spec fs; 448 __u32 rule_cnt; 449 __u32 rule_locs[0]; 450 }; 451 452 /** 453 * struct ethtool_rxfh_indir - command to get or set RX flow hash indirection 454 * @cmd: Specific command number - %ETHTOOL_GRXFHINDIR or %ETHTOOL_SRXFHINDIR 455 * @size: On entry, the array size of the user buffer. On return from 456 * %ETHTOOL_GRXFHINDIR, the array size of the hardware indirection table. 457 * @ring_index: RX ring/queue index for each hash value 458 */ 459 struct ethtool_rxfh_indir { 460 __u32 cmd; 461 __u32 size; 462 __u32 ring_index[0]; 463 }; 464 465 /** 466 * struct ethtool_rx_ntuple_flow_spec - specification for RX flow filter 467 * @flow_type: Type of match to perform, e.g. %TCP_V4_FLOW 468 * @h_u: Flow field values to match (dependent on @flow_type) 469 * @m_u: Masks for flow field value bits to be ignored 470 * @vlan_tag: VLAN tag to match 471 * @vlan_tag_mask: Mask for VLAN tag bits to be ignored 472 * @data: Driver-dependent data to match 473 * @data_mask: Mask for driver-dependent data bits to be ignored 474 * @action: RX ring/queue index to deliver to (non-negative) or other action 475 * (negative, e.g. %ETHTOOL_RXNTUPLE_ACTION_DROP) 476 * 477 * For flow types %TCP_V4_FLOW, %UDP_V4_FLOW and %SCTP_V4_FLOW, where 478 * a field value and mask are both zero this is treated as if all mask 479 * bits are set i.e. the field is ignored. 480 */ 481 struct ethtool_rx_ntuple_flow_spec { 482 __u32 flow_type; 483 union { 484 struct ethtool_tcpip4_spec tcp_ip4_spec; 485 struct ethtool_tcpip4_spec udp_ip4_spec; 486 struct ethtool_tcpip4_spec sctp_ip4_spec; 487 struct ethtool_ah_espip4_spec ah_ip4_spec; 488 struct ethtool_ah_espip4_spec esp_ip4_spec; 489 struct ethtool_usrip4_spec usr_ip4_spec; 490 struct ethhdr ether_spec; 491 __u8 hdata[72]; 492 } h_u, m_u; 493 494 __u16 vlan_tag; 495 __u16 vlan_tag_mask; 496 __u64 data; 497 __u64 data_mask; 498 499 __s32 action; 500 #define ETHTOOL_RXNTUPLE_ACTION_DROP (-1) /* drop packet */ 501 #define ETHTOOL_RXNTUPLE_ACTION_CLEAR (-2) /* clear filter */ 502 }; 503 504 /** 505 * struct ethtool_rx_ntuple - command to set or clear RX flow filter 506 * @cmd: Command number - %ETHTOOL_SRXNTUPLE 507 * @fs: Flow filter specification 508 */ 509 struct ethtool_rx_ntuple { 510 __u32 cmd; 511 struct ethtool_rx_ntuple_flow_spec fs; 512 }; 513 514 #define ETHTOOL_FLASH_MAX_FILENAME 128 515 enum ethtool_flash_op_type { 516 ETHTOOL_FLASH_ALL_REGIONS = 0, 517 }; 518 519 /* for passing firmware flashing related parameters */ 520 struct ethtool_flash { 521 __u32 cmd; 522 __u32 region; 523 char data[ETHTOOL_FLASH_MAX_FILENAME]; 524 }; 525 526 #ifdef __KERNEL__ 527 528 #include <linux/rculist.h> 529 530 struct ethtool_rx_ntuple_flow_spec_container { 531 struct ethtool_rx_ntuple_flow_spec fs; 532 struct list_head list; 533 }; 534 535 struct ethtool_rx_ntuple_list { 536 #define ETHTOOL_MAX_NTUPLE_LIST_ENTRY 1024 537 #define ETHTOOL_MAX_NTUPLE_STRING_PER_ENTRY 14 538 struct list_head list; 539 unsigned int count; 540 }; 541 542 struct net_device; 543 544 /* Some generic methods drivers may use in their ethtool_ops */ 545 u32 ethtool_op_get_link(struct net_device *dev); 546 u32 ethtool_op_get_rx_csum(struct net_device *dev); 547 u32 ethtool_op_get_tx_csum(struct net_device *dev); 548 int ethtool_op_set_tx_csum(struct net_device *dev, u32 data); 549 int ethtool_op_set_tx_hw_csum(struct net_device *dev, u32 data); 550 int ethtool_op_set_tx_ipv6_csum(struct net_device *dev, u32 data); 551 u32 ethtool_op_get_sg(struct net_device *dev); 552 int ethtool_op_set_sg(struct net_device *dev, u32 data); 553 u32 ethtool_op_get_tso(struct net_device *dev); 554 int ethtool_op_set_tso(struct net_device *dev, u32 data); 555 u32 ethtool_op_get_ufo(struct net_device *dev); 556 int ethtool_op_set_ufo(struct net_device *dev, u32 data); 557 u32 ethtool_op_get_flags(struct net_device *dev); 558 int ethtool_op_set_flags(struct net_device *dev, u32 data, u32 supported); 559 void ethtool_ntuple_flush(struct net_device *dev); 560 561 /** 562 * ðtool_ops - Alter and report network device settings 563 * get_settings: Get device-specific settings 564 * set_settings: Set device-specific settings 565 * get_drvinfo: Report driver information 566 * get_regs: Get device registers 567 * get_wol: Report whether Wake-on-Lan is enabled 568 * set_wol: Turn Wake-on-Lan on or off 569 * get_msglevel: Report driver message level 570 * set_msglevel: Set driver message level 571 * nway_reset: Restart autonegotiation 572 * get_link: Get link status 573 * get_eeprom: Read data from the device EEPROM 574 * set_eeprom: Write data to the device EEPROM 575 * get_coalesce: Get interrupt coalescing parameters 576 * set_coalesce: Set interrupt coalescing parameters 577 * get_ringparam: Report ring sizes 578 * set_ringparam: Set ring sizes 579 * get_pauseparam: Report pause parameters 580 * set_pauseparam: Set pause parameters 581 * get_rx_csum: Report whether receive checksums are turned on or off 582 * set_rx_csum: Turn receive checksum on or off 583 * get_tx_csum: Report whether transmit checksums are turned on or off 584 * set_tx_csum: Turn transmit checksums on or off 585 * get_sg: Report whether scatter-gather is enabled 586 * set_sg: Turn scatter-gather on or off 587 * get_tso: Report whether TCP segmentation offload is enabled 588 * set_tso: Turn TCP segmentation offload on or off 589 * get_ufo: Report whether UDP fragmentation offload is enabled 590 * set_ufo: Turn UDP fragmentation offload on or off 591 * self_test: Run specified self-tests 592 * get_strings: Return a set of strings that describe the requested objects 593 * phys_id: Identify the device 594 * get_stats: Return statistics about the device 595 * get_flags: get 32-bit flags bitmap 596 * set_flags: set 32-bit flags bitmap 597 * 598 * Description: 599 * 600 * get_settings: 601 * @get_settings is passed an ðtool_cmd to fill in. It returns 602 * an negative errno or zero. 603 * 604 * set_settings: 605 * @set_settings is passed an ðtool_cmd and should attempt to set 606 * all the settings this device supports. It may return an error value 607 * if something goes wrong (otherwise 0). 608 * 609 * get_eeprom: 610 * Should fill in the magic field. Don't need to check len for zero 611 * or wraparound. Fill in the data argument with the eeprom values 612 * from offset to offset + len. Update len to the amount read. 613 * Returns an error or zero. 614 * 615 * set_eeprom: 616 * Should validate the magic field. Don't need to check len for zero 617 * or wraparound. Update len to the amount written. Returns an error 618 * or zero. 619 */ 620 struct ethtool_ops { 621 int (*get_settings)(struct net_device *, struct ethtool_cmd *); 622 int (*set_settings)(struct net_device *, struct ethtool_cmd *); 623 void (*get_drvinfo)(struct net_device *, struct ethtool_drvinfo *); 624 int (*get_regs_len)(struct net_device *); 625 void (*get_regs)(struct net_device *, struct ethtool_regs *, void *); 626 void (*get_wol)(struct net_device *, struct ethtool_wolinfo *); 627 int (*set_wol)(struct net_device *, struct ethtool_wolinfo *); 628 u32 (*get_msglevel)(struct net_device *); 629 void (*set_msglevel)(struct net_device *, u32); 630 int (*nway_reset)(struct net_device *); 631 u32 (*get_link)(struct net_device *); 632 int (*get_eeprom_len)(struct net_device *); 633 int (*get_eeprom)(struct net_device *, 634 struct ethtool_eeprom *, u8 *); 635 int (*set_eeprom)(struct net_device *, 636 struct ethtool_eeprom *, u8 *); 637 int (*get_coalesce)(struct net_device *, struct ethtool_coalesce *); 638 int (*set_coalesce)(struct net_device *, struct ethtool_coalesce *); 639 void (*get_ringparam)(struct net_device *, 640 struct ethtool_ringparam *); 641 int (*set_ringparam)(struct net_device *, 642 struct ethtool_ringparam *); 643 void (*get_pauseparam)(struct net_device *, 644 struct ethtool_pauseparam*); 645 int (*set_pauseparam)(struct net_device *, 646 struct ethtool_pauseparam*); 647 u32 (*get_rx_csum)(struct net_device *); 648 int (*set_rx_csum)(struct net_device *, u32); 649 u32 (*get_tx_csum)(struct net_device *); 650 int (*set_tx_csum)(struct net_device *, u32); 651 u32 (*get_sg)(struct net_device *); 652 int (*set_sg)(struct net_device *, u32); 653 u32 (*get_tso)(struct net_device *); 654 int (*set_tso)(struct net_device *, u32); 655 void (*self_test)(struct net_device *, struct ethtool_test *, u64 *); 656 void (*get_strings)(struct net_device *, u32 stringset, u8 *); 657 int (*phys_id)(struct net_device *, u32); 658 void (*get_ethtool_stats)(struct net_device *, 659 struct ethtool_stats *, u64 *); 660 int (*begin)(struct net_device *); 661 void (*complete)(struct net_device *); 662 u32 (*get_ufo)(struct net_device *); 663 int (*set_ufo)(struct net_device *, u32); 664 u32 (*get_flags)(struct net_device *); 665 int (*set_flags)(struct net_device *, u32); 666 u32 (*get_priv_flags)(struct net_device *); 667 int (*set_priv_flags)(struct net_device *, u32); 668 int (*get_sset_count)(struct net_device *, int); 669 int (*get_rxnfc)(struct net_device *, 670 struct ethtool_rxnfc *, void *); 671 int (*set_rxnfc)(struct net_device *, struct ethtool_rxnfc *); 672 int (*flash_device)(struct net_device *, struct ethtool_flash *); 673 int (*reset)(struct net_device *, u32 *); 674 int (*set_rx_ntuple)(struct net_device *, 675 struct ethtool_rx_ntuple *); 676 int (*get_rx_ntuple)(struct net_device *, u32 stringset, void *); 677 int (*get_rxfh_indir)(struct net_device *, 678 struct ethtool_rxfh_indir *); 679 int (*set_rxfh_indir)(struct net_device *, 680 const struct ethtool_rxfh_indir *); 681 }; 682 #endif /* __KERNEL__ */ 683 684 /* CMDs currently supported */ 685 #define ETHTOOL_GSET 0x00000001 /* Get settings. */ 686 #define ETHTOOL_SSET 0x00000002 /* Set settings. */ 687 #define ETHTOOL_GDRVINFO 0x00000003 /* Get driver info. */ 688 #define ETHTOOL_GREGS 0x00000004 /* Get NIC registers. */ 689 #define ETHTOOL_GWOL 0x00000005 /* Get wake-on-lan options. */ 690 #define ETHTOOL_SWOL 0x00000006 /* Set wake-on-lan options. */ 691 #define ETHTOOL_GMSGLVL 0x00000007 /* Get driver message level */ 692 #define ETHTOOL_SMSGLVL 0x00000008 /* Set driver msg level. */ 693 #define ETHTOOL_NWAY_RST 0x00000009 /* Restart autonegotiation. */ 694 /* Get link status for host, i.e. whether the interface *and* the 695 * physical port (if there is one) are up (ethtool_value). */ 696 #define ETHTOOL_GLINK 0x0000000a 697 #define ETHTOOL_GEEPROM 0x0000000b /* Get EEPROM data */ 698 #define ETHTOOL_SEEPROM 0x0000000c /* Set EEPROM data. */ 699 #define ETHTOOL_GCOALESCE 0x0000000e /* Get coalesce config */ 700 #define ETHTOOL_SCOALESCE 0x0000000f /* Set coalesce config. */ 701 #define ETHTOOL_GRINGPARAM 0x00000010 /* Get ring parameters */ 702 #define ETHTOOL_SRINGPARAM 0x00000011 /* Set ring parameters. */ 703 #define ETHTOOL_GPAUSEPARAM 0x00000012 /* Get pause parameters */ 704 #define ETHTOOL_SPAUSEPARAM 0x00000013 /* Set pause parameters. */ 705 #define ETHTOOL_GRXCSUM 0x00000014 /* Get RX hw csum enable (ethtool_value) */ 706 #define ETHTOOL_SRXCSUM 0x00000015 /* Set RX hw csum enable (ethtool_value) */ 707 #define ETHTOOL_GTXCSUM 0x00000016 /* Get TX hw csum enable (ethtool_value) */ 708 #define ETHTOOL_STXCSUM 0x00000017 /* Set TX hw csum enable (ethtool_value) */ 709 #define ETHTOOL_GSG 0x00000018 /* Get scatter-gather enable 710 * (ethtool_value) */ 711 #define ETHTOOL_SSG 0x00000019 /* Set scatter-gather enable 712 * (ethtool_value). */ 713 #define ETHTOOL_TEST 0x0000001a /* execute NIC self-test. */ 714 #define ETHTOOL_GSTRINGS 0x0000001b /* get specified string set */ 715 #define ETHTOOL_PHYS_ID 0x0000001c /* identify the NIC */ 716 #define ETHTOOL_GSTATS 0x0000001d /* get NIC-specific statistics */ 717 #define ETHTOOL_GTSO 0x0000001e /* Get TSO enable (ethtool_value) */ 718 #define ETHTOOL_STSO 0x0000001f /* Set TSO enable (ethtool_value) */ 719 #define ETHTOOL_GPERMADDR 0x00000020 /* Get permanent hardware address */ 720 #define ETHTOOL_GUFO 0x00000021 /* Get UFO enable (ethtool_value) */ 721 #define ETHTOOL_SUFO 0x00000022 /* Set UFO enable (ethtool_value) */ 722 #define ETHTOOL_GGSO 0x00000023 /* Get GSO enable (ethtool_value) */ 723 #define ETHTOOL_SGSO 0x00000024 /* Set GSO enable (ethtool_value) */ 724 #define ETHTOOL_GFLAGS 0x00000025 /* Get flags bitmap(ethtool_value) */ 725 #define ETHTOOL_SFLAGS 0x00000026 /* Set flags bitmap(ethtool_value) */ 726 #define ETHTOOL_GPFLAGS 0x00000027 /* Get driver-private flags bitmap */ 727 #define ETHTOOL_SPFLAGS 0x00000028 /* Set driver-private flags bitmap */ 728 729 #define ETHTOOL_GRXFH 0x00000029 /* Get RX flow hash configuration */ 730 #define ETHTOOL_SRXFH 0x0000002a /* Set RX flow hash configuration */ 731 #define ETHTOOL_GGRO 0x0000002b /* Get GRO enable (ethtool_value) */ 732 #define ETHTOOL_SGRO 0x0000002c /* Set GRO enable (ethtool_value) */ 733 #define ETHTOOL_GRXRINGS 0x0000002d /* Get RX rings available for LB */ 734 #define ETHTOOL_GRXCLSRLCNT 0x0000002e /* Get RX class rule count */ 735 #define ETHTOOL_GRXCLSRULE 0x0000002f /* Get RX classification rule */ 736 #define ETHTOOL_GRXCLSRLALL 0x00000030 /* Get all RX classification rule */ 737 #define ETHTOOL_SRXCLSRLDEL 0x00000031 /* Delete RX classification rule */ 738 #define ETHTOOL_SRXCLSRLINS 0x00000032 /* Insert RX classification rule */ 739 #define ETHTOOL_FLASHDEV 0x00000033 /* Flash firmware to device */ 740 #define ETHTOOL_RESET 0x00000034 /* Reset hardware */ 741 #define ETHTOOL_SRXNTUPLE 0x00000035 /* Add an n-tuple filter to device */ 742 #define ETHTOOL_GRXNTUPLE 0x00000036 /* Get n-tuple filters from device */ 743 #define ETHTOOL_GSSET_INFO 0x00000037 /* Get string set info */ 744 #define ETHTOOL_GRXFHINDIR 0x00000038 /* Get RX flow hash indir'n table */ 745 #define ETHTOOL_SRXFHINDIR 0x00000039 /* Set RX flow hash indir'n table */ 746 747 /* compatibility with older code */ 748 #define SPARC_ETH_GSET ETHTOOL_GSET 749 #define SPARC_ETH_SSET ETHTOOL_SSET 750 751 /* Indicates what features are supported by the interface. */ 752 #define SUPPORTED_10baseT_Half (1 << 0) 753 #define SUPPORTED_10baseT_Full (1 << 1) 754 #define SUPPORTED_100baseT_Half (1 << 2) 755 #define SUPPORTED_100baseT_Full (1 << 3) 756 #define SUPPORTED_1000baseT_Half (1 << 4) 757 #define SUPPORTED_1000baseT_Full (1 << 5) 758 #define SUPPORTED_Autoneg (1 << 6) 759 #define SUPPORTED_TP (1 << 7) 760 #define SUPPORTED_AUI (1 << 8) 761 #define SUPPORTED_MII (1 << 9) 762 #define SUPPORTED_FIBRE (1 << 10) 763 #define SUPPORTED_BNC (1 << 11) 764 #define SUPPORTED_10000baseT_Full (1 << 12) 765 #define SUPPORTED_Pause (1 << 13) 766 #define SUPPORTED_Asym_Pause (1 << 14) 767 #define SUPPORTED_2500baseX_Full (1 << 15) 768 #define SUPPORTED_Backplane (1 << 16) 769 #define SUPPORTED_1000baseKX_Full (1 << 17) 770 #define SUPPORTED_10000baseKX4_Full (1 << 18) 771 #define SUPPORTED_10000baseKR_Full (1 << 19) 772 #define SUPPORTED_10000baseR_FEC (1 << 20) 773 774 /* Indicates what features are advertised by the interface. */ 775 #define ADVERTISED_10baseT_Half (1 << 0) 776 #define ADVERTISED_10baseT_Full (1 << 1) 777 #define ADVERTISED_100baseT_Half (1 << 2) 778 #define ADVERTISED_100baseT_Full (1 << 3) 779 #define ADVERTISED_1000baseT_Half (1 << 4) 780 #define ADVERTISED_1000baseT_Full (1 << 5) 781 #define ADVERTISED_Autoneg (1 << 6) 782 #define ADVERTISED_TP (1 << 7) 783 #define ADVERTISED_AUI (1 << 8) 784 #define ADVERTISED_MII (1 << 9) 785 #define ADVERTISED_FIBRE (1 << 10) 786 #define ADVERTISED_BNC (1 << 11) 787 #define ADVERTISED_10000baseT_Full (1 << 12) 788 #define ADVERTISED_Pause (1 << 13) 789 #define ADVERTISED_Asym_Pause (1 << 14) 790 #define ADVERTISED_2500baseX_Full (1 << 15) 791 #define ADVERTISED_Backplane (1 << 16) 792 #define ADVERTISED_1000baseKX_Full (1 << 17) 793 #define ADVERTISED_10000baseKX4_Full (1 << 18) 794 #define ADVERTISED_10000baseKR_Full (1 << 19) 795 #define ADVERTISED_10000baseR_FEC (1 << 20) 796 797 /* The following are all involved in forcing a particular link 798 * mode for the device for setting things. When getting the 799 * devices settings, these indicate the current mode and whether 800 * it was foced up into this mode or autonegotiated. 801 */ 802 803 /* The forced speed, 10Mb, 100Mb, gigabit, 2.5Gb, 10GbE. */ 804 #define SPEED_10 10 805 #define SPEED_100 100 806 #define SPEED_1000 1000 807 #define SPEED_2500 2500 808 #define SPEED_10000 10000 809 810 /* Duplex, half or full. */ 811 #define DUPLEX_HALF 0x00 812 #define DUPLEX_FULL 0x01 813 814 /* Which connector port. */ 815 #define PORT_TP 0x00 816 #define PORT_AUI 0x01 817 #define PORT_MII 0x02 818 #define PORT_FIBRE 0x03 819 #define PORT_BNC 0x04 820 #define PORT_DA 0x05 821 #define PORT_NONE 0xef 822 #define PORT_OTHER 0xff 823 824 /* Which transceiver to use. */ 825 #define XCVR_INTERNAL 0x00 826 #define XCVR_EXTERNAL 0x01 827 #define XCVR_DUMMY1 0x02 828 #define XCVR_DUMMY2 0x03 829 #define XCVR_DUMMY3 0x04 830 831 /* Enable or disable autonegotiation. If this is set to enable, 832 * the forced link modes above are completely ignored. 833 */ 834 #define AUTONEG_DISABLE 0x00 835 #define AUTONEG_ENABLE 0x01 836 837 /* Mode MDI or MDI-X */ 838 #define ETH_TP_MDI_INVALID 0x00 839 #define ETH_TP_MDI 0x01 840 #define ETH_TP_MDI_X 0x02 841 842 /* Wake-On-Lan options. */ 843 #define WAKE_PHY (1 << 0) 844 #define WAKE_UCAST (1 << 1) 845 #define WAKE_MCAST (1 << 2) 846 #define WAKE_BCAST (1 << 3) 847 #define WAKE_ARP (1 << 4) 848 #define WAKE_MAGIC (1 << 5) 849 #define WAKE_MAGICSECURE (1 << 6) /* only meaningful if WAKE_MAGIC */ 850 851 /* L2-L4 network traffic flow types */ 852 #define TCP_V4_FLOW 0x01 /* hash or spec (tcp_ip4_spec) */ 853 #define UDP_V4_FLOW 0x02 /* hash or spec (udp_ip4_spec) */ 854 #define SCTP_V4_FLOW 0x03 /* hash or spec (sctp_ip4_spec) */ 855 #define AH_ESP_V4_FLOW 0x04 /* hash only */ 856 #define TCP_V6_FLOW 0x05 /* hash only */ 857 #define UDP_V6_FLOW 0x06 /* hash only */ 858 #define SCTP_V6_FLOW 0x07 /* hash only */ 859 #define AH_ESP_V6_FLOW 0x08 /* hash only */ 860 #define AH_V4_FLOW 0x09 /* hash or spec (ah_ip4_spec) */ 861 #define ESP_V4_FLOW 0x0a /* hash or spec (esp_ip4_spec) */ 862 #define AH_V6_FLOW 0x0b /* hash only */ 863 #define ESP_V6_FLOW 0x0c /* hash only */ 864 #define IP_USER_FLOW 0x0d /* spec only (usr_ip4_spec) */ 865 #define IPV4_FLOW 0x10 /* hash only */ 866 #define IPV6_FLOW 0x11 /* hash only */ 867 #define ETHER_FLOW 0x12 /* spec only (ether_spec) */ 868 869 /* L3-L4 network traffic flow hash options */ 870 #define RXH_L2DA (1 << 1) 871 #define RXH_VLAN (1 << 2) 872 #define RXH_L3_PROTO (1 << 3) 873 #define RXH_IP_SRC (1 << 4) 874 #define RXH_IP_DST (1 << 5) 875 #define RXH_L4_B_0_1 (1 << 6) /* src port in case of TCP/UDP/SCTP */ 876 #define RXH_L4_B_2_3 (1 << 7) /* dst port in case of TCP/UDP/SCTP */ 877 #define RXH_DISCARD (1 << 31) 878 879 #define RX_CLS_FLOW_DISC 0xffffffffffffffffULL 880 881 /* Reset flags */ 882 /* The reset() operation must clear the flags for the components which 883 * were actually reset. On successful return, the flags indicate the 884 * components which were not reset, either because they do not exist 885 * in the hardware or because they cannot be reset independently. The 886 * driver must never reset any components that were not requested. 887 */ 888 enum ethtool_reset_flags { 889 /* These flags represent components dedicated to the interface 890 * the command is addressed to. Shift any flag left by 891 * ETH_RESET_SHARED_SHIFT to reset a shared component of the 892 * same type. 893 */ 894 ETH_RESET_MGMT = 1 << 0, /* Management processor */ 895 ETH_RESET_IRQ = 1 << 1, /* Interrupt requester */ 896 ETH_RESET_DMA = 1 << 2, /* DMA engine */ 897 ETH_RESET_FILTER = 1 << 3, /* Filtering/flow direction */ 898 ETH_RESET_OFFLOAD = 1 << 4, /* Protocol offload */ 899 ETH_RESET_MAC = 1 << 5, /* Media access controller */ 900 ETH_RESET_PHY = 1 << 6, /* Transceiver/PHY */ 901 ETH_RESET_RAM = 1 << 7, /* RAM shared between 902 * multiple components */ 903 904 ETH_RESET_DEDICATED = 0x0000ffff, /* All components dedicated to 905 * this interface */ 906 ETH_RESET_ALL = 0xffffffff, /* All components used by this 907 * interface, even if shared */ 908 }; 909 #define ETH_RESET_SHARED_SHIFT 16 910 911 #endif /* _LINUX_ETHTOOL_H */ 912