1============================= 2Netlink interface for ethtool 3============================= 4 5 6Basic information 7================= 8 9Netlink interface for ethtool uses generic netlink family ``ethtool`` 10(userspace application should use macros ``ETHTOOL_GENL_NAME`` and 11``ETHTOOL_GENL_VERSION`` defined in ``<linux/ethtool_netlink.h>`` uapi 12header). This family does not use a specific header, all information in 13requests and replies is passed using netlink attributes. 14 15The ethtool netlink interface uses extended ACK for error and warning 16reporting, userspace application developers are encouraged to make these 17messages available to user in a suitable way. 18 19Requests can be divided into three categories: "get" (retrieving information), 20"set" (setting parameters) and "action" (invoking an action). 21 22All "set" and "action" type requests require admin privileges 23(``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for 24anyone but there are exceptions (where the response contains sensitive 25information). In some cases, the request as such is allowed for anyone but 26unprivileged users have attributes with sensitive information (e.g. 27wake-on-lan password) omitted. 28 29 30Conventions 31=========== 32 33Attributes which represent a boolean value usually use NLA_U8 type so that we 34can distinguish three states: "on", "off" and "not present" (meaning the 35information is not available in "get" requests or value is not to be changed 36in "set" requests). For these attributes, the "true" value should be passed as 37number 1 but any non-zero value should be understood as "true" by recipient. 38In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way. 39 40In the message structure descriptions below, if an attribute name is suffixed 41with "+", parent nest can contain multiple attributes of the same type. This 42implements an array of entries. 43 44 45Request header 46============== 47 48Each request or reply message contains a nested attribute with common header. 49Structure of this header is 50 51 ============================== ====== ============================= 52 ``ETHTOOL_A_HEADER_DEV_INDEX`` u32 device ifindex 53 ``ETHTOOL_A_HEADER_DEV_NAME`` string device name 54 ``ETHTOOL_A_HEADER_FLAGS`` u32 flags common for all requests 55 ============================== ====== ============================= 56 57``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the 58device message relates to. One of them is sufficient in requests, if both are 59used, they must identify the same device. Some requests, e.g. global string 60sets, do not require device identification. Most ``GET`` requests also allow 61dump requests without device identification to query the same information for 62all devices providing it (each device in a separate message). 63 64``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request 65types. The interpretation of these flags is the same for all request types but 66the flags may not apply to requests. Recognized flags are: 67 68 ================================= =================================== 69 ``ETHTOOL_FLAG_COMPACT_BITSETS`` use compact format bitsets in reply 70 ``ETHTOOL_FLAG_OMIT_REPLY`` omit optional reply (_SET and _ACT) 71 ``ETHTOOL_FLAG_STATS`` include optional device statistics 72 ================================= =================================== 73 74New request flags should follow the general idea that if the flag is not set, 75the behaviour is backward compatible, i.e. requests from old clients not aware 76of the flag should be interpreted the way the client expects. A client must 77not set flags it does not understand. 78 79 80Bit sets 81======== 82 83For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32`` 84type is used. For arbitrary length bitmaps, ethtool netlink uses a nested 85attribute with contents of one of two forms: compact (two binary bitmaps 86representing bit values and mask of affected bits) and bit-by-bit (list of 87bits identified by either index or name). 88 89Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together 90with their values which saves a round trip (when the bitset is passed in a 91request) or at least a second request (when the bitset is in a reply). This is 92useful for one shot applications like traditional ethtool command. On the 93other hand, long running applications like ethtool monitor (displaying 94notifications) or network management daemons may prefer fetching the names 95only once and using compact form to save message size. Notifications from 96ethtool netlink interface always use compact form for bitsets. 97 98A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK`` 99not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests 100modifying a bitmap, the former changes the bit set in mask to values set in 101value and preserves the rest; the latter sets the bits set in the bitmap and 102clears the rest. 103 104Compact form: nested (bitset) atrribute contents: 105 106 ============================ ====== ============================ 107 ``ETHTOOL_A_BITSET_NOMASK`` flag no mask, only a list 108 ``ETHTOOL_A_BITSET_SIZE`` u32 number of significant bits 109 ``ETHTOOL_A_BITSET_VALUE`` binary bitmap of bit values 110 ``ETHTOOL_A_BITSET_MASK`` binary bitmap of valid bits 111 ============================ ====== ============================ 112 113Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits 114rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte 115order, words ordered from least significant to most significant (i.e. the same 116way as bitmaps are passed with ioctl interface). 117 118For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are 119mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if 120``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair); 121if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not 122allowed (bitset represents a single bitmap. 123 124Kernel bit set length may differ from userspace length if older application is 125used on newer kernel or vice versa. If userspace bitmap is longer, an error is 126issued only if the request actually tries to set values of some bits not 127recognized by kernel. 128 129Bit-by-bit form: nested (bitset) attribute contents: 130 131 +------------------------------------+--------+-----------------------------+ 132 | ``ETHTOOL_A_BITSET_NOMASK`` | flag | no mask, only a list | 133 +------------------------------------+--------+-----------------------------+ 134 | ``ETHTOOL_A_BITSET_SIZE`` | u32 | number of significant bits | 135 +------------------------------------+--------+-----------------------------+ 136 | ``ETHTOOL_A_BITSET_BITS`` | nested | array of bits | 137 +-+----------------------------------+--------+-----------------------------+ 138 | | ``ETHTOOL_A_BITSET_BITS_BIT+`` | nested | one bit | 139 +-+-+--------------------------------+--------+-----------------------------+ 140 | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32 | bit index (0 for LSB) | 141 +-+-+--------------------------------+--------+-----------------------------+ 142 | | | ``ETHTOOL_A_BITSET_BIT_NAME`` | string | bit name | 143 +-+-+--------------------------------+--------+-----------------------------+ 144 | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag | present if bit is set | 145 +-+-+--------------------------------+--------+-----------------------------+ 146 147Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can 148only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an 149arbitrary number of them. A bit may be identified by its index or by its 150name. When used in requests, listed bits are set to 0 or 1 according to 151``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if 152index exceeds kernel bit length or if name is not recognized. 153 154When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as 155a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in 156such case. Such bitset represents a bitmap with listed bits set and the rest 157zero. 158 159In requests, application can use either form. Form used by kernel in reply is 160determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request 161header. Semantics of value and mask depends on the attribute. 162 163 164List of message types 165===================== 166 167All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix 168according to message purpose: 169 170 ============== ====================================== 171 ``_GET`` userspace request to retrieve data 172 ``_SET`` userspace request to set data 173 ``_ACT`` userspace request to perform an action 174 ``_GET_REPLY`` kernel reply to a ``GET`` request 175 ``_SET_REPLY`` kernel reply to a ``SET`` request 176 ``_ACT_REPLY`` kernel reply to an ``ACT`` request 177 ``_NTF`` kernel notification 178 ============== ====================================== 179 180Userspace to kernel: 181 182 ===================================== ================================ 183 ``ETHTOOL_MSG_STRSET_GET`` get string set 184 ``ETHTOOL_MSG_LINKINFO_GET`` get link settings 185 ``ETHTOOL_MSG_LINKINFO_SET`` set link settings 186 ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info 187 ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info 188 ``ETHTOOL_MSG_LINKSTATE_GET`` get link state 189 ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings 190 ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings 191 ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings 192 ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings 193 ``ETHTOOL_MSG_FEATURES_GET`` get device features 194 ``ETHTOOL_MSG_FEATURES_SET`` set device features 195 ``ETHTOOL_MSG_PRIVFLAGS_GET`` get private flags 196 ``ETHTOOL_MSG_PRIVFLAGS_SET`` set private flags 197 ``ETHTOOL_MSG_RINGS_GET`` get ring sizes 198 ``ETHTOOL_MSG_RINGS_SET`` set ring sizes 199 ``ETHTOOL_MSG_CHANNELS_GET`` get channel counts 200 ``ETHTOOL_MSG_CHANNELS_SET`` set channel counts 201 ``ETHTOOL_MSG_COALESCE_GET`` get coalescing parameters 202 ``ETHTOOL_MSG_COALESCE_SET`` set coalescing parameters 203 ``ETHTOOL_MSG_PAUSE_GET`` get pause parameters 204 ``ETHTOOL_MSG_PAUSE_SET`` set pause parameters 205 ``ETHTOOL_MSG_EEE_GET`` get EEE settings 206 ``ETHTOOL_MSG_EEE_SET`` set EEE settings 207 ``ETHTOOL_MSG_TSINFO_GET`` get timestamping info 208 ``ETHTOOL_MSG_CABLE_TEST_ACT`` action start cable test 209 ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT`` action start raw TDR cable test 210 ``ETHTOOL_MSG_TUNNEL_INFO_GET`` get tunnel offload info 211 ``ETHTOOL_MSG_FEC_GET`` get FEC settings 212 ``ETHTOOL_MSG_FEC_SET`` set FEC settings 213 ``ETHTOOL_MSG_MODULE_EEPROM_GET`` read SFP module EEPROM 214 ``ETHTOOL_MSG_STATS_GET`` get standard statistics 215 ===================================== ================================ 216 217Kernel to userspace: 218 219 ======================================== ================================= 220 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents 221 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings 222 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification 223 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info 224 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification 225 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info 226 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings 227 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification 228 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings 229 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification 230 ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features 231 ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET 232 ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification 233 ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags 234 ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags 235 ``ETHTOOL_MSG_RINGS_GET_REPLY`` ring sizes 236 ``ETHTOOL_MSG_RINGS_NTF`` ring sizes 237 ``ETHTOOL_MSG_CHANNELS_GET_REPLY`` channel counts 238 ``ETHTOOL_MSG_CHANNELS_NTF`` channel counts 239 ``ETHTOOL_MSG_COALESCE_GET_REPLY`` coalescing parameters 240 ``ETHTOOL_MSG_COALESCE_NTF`` coalescing parameters 241 ``ETHTOOL_MSG_PAUSE_GET_REPLY`` pause parameters 242 ``ETHTOOL_MSG_PAUSE_NTF`` pause parameters 243 ``ETHTOOL_MSG_EEE_GET_REPLY`` EEE settings 244 ``ETHTOOL_MSG_EEE_NTF`` EEE settings 245 ``ETHTOOL_MSG_TSINFO_GET_REPLY`` timestamping info 246 ``ETHTOOL_MSG_CABLE_TEST_NTF`` Cable test results 247 ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF`` Cable test TDR results 248 ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY`` tunnel offload info 249 ``ETHTOOL_MSG_FEC_GET_REPLY`` FEC settings 250 ``ETHTOOL_MSG_FEC_NTF`` FEC settings 251 ``ETHTOOL_MSG_MODULE_EEPROM_GET_REPLY`` read SFP module EEPROM 252 ``ETHTOOL_MSG_STATS_GET_REPLY`` standard statistics 253 ======================================== ================================= 254 255``GET`` requests are sent by userspace applications to retrieve device 256information. They usually do not contain any message specific attributes. 257Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET`` 258request with ``NLM_F_DUMP`` and no device identification can be used to query 259the information for all devices supporting the request. 260 261If the data can be also modified, corresponding ``SET`` message with the same 262layout as corresponding ``GET_REPLY`` is used to request changes. Only 263attributes where a change is requested are included in such request (also, not 264all attributes may be changed). Replies to most ``SET`` request consist only 265of error code and extack; if kernel provides additional data, it is sent in 266the form of corresponding ``SET_REPLY`` message which can be suppressed by 267setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header. 268 269Data modification also triggers sending a ``NTF`` message with a notification. 270These usually bear only a subset of attributes which was affected by the 271change. The same notification is issued if the data is modified using other 272means (mostly ioctl ethtool interface). Unlike notifications from ethtool 273netlink code which are only sent if something actually changed, notifications 274triggered by ioctl interface may be sent even if the request did not actually 275change any data. 276 277``ACT`` messages request kernel (driver) to perform a specific action. If some 278information is reported by kernel (which can be suppressed by setting 279``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of 280an ``ACT_REPLY`` message. Performing an action also triggers a notification 281(``NTF`` message). 282 283Later sections describe the format and semantics of these messages. 284 285 286STRSET_GET 287========== 288 289Requests contents of a string set as provided by ioctl commands 290``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user 291writeable so that the corresponding ``STRSET_SET`` message is only used in 292kernel replies. There are two types of string sets: global (independent of 293a device, e.g. device feature names) and device specific (e.g. device private 294flags). 295 296Request contents: 297 298 +---------------------------------------+--------+------------------------+ 299 | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header | 300 +---------------------------------------+--------+------------------------+ 301 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request | 302 +-+-------------------------------------+--------+------------------------+ 303 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | 304 +-+-+-----------------------------------+--------+------------------------+ 305 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | 306 +-+-+-----------------------------------+--------+------------------------+ 307 308Kernel response contents: 309 310 +---------------------------------------+--------+-----------------------+ 311 | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header | 312 +---------------------------------------+--------+-----------------------+ 313 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets | 314 +-+-------------------------------------+--------+-----------------------+ 315 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | 316 +-+-+-----------------------------------+--------+-----------------------+ 317 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | 318 +-+-+-----------------------------------+--------+-----------------------+ 319 | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings | 320 +-+-+-----------------------------------+--------+-----------------------+ 321 | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings | 322 +-+-+-+---------------------------------+--------+-----------------------+ 323 | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string | 324 +-+-+-+-+-------------------------------+--------+-----------------------+ 325 | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index | 326 +-+-+-+-+-------------------------------+--------+-----------------------+ 327 | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value | 328 +-+-+-+-+-------------------------------+--------+-----------------------+ 329 | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts | 330 +---------------------------------------+--------+-----------------------+ 331 332Device identification in request header is optional. Depending on its presence 333a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests: 334 335 - no ``NLM_F_DUMP,`` no device: get "global" stringsets 336 - no ``NLM_F_DUMP``, with device: get string sets related to the device 337 - ``NLM_F_DUMP``, no device: get device related string sets for all devices 338 339If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of 340requested type are returned, otherwise only those specified in the request. 341Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string 342counts of the sets, not the actual strings. 343 344 345LINKINFO_GET 346============ 347 348Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for 349link modes and autonegotiation related information. The request does not use 350any attributes. 351 352Request contents: 353 354 ==================================== ====== ========================== 355 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header 356 ==================================== ====== ========================== 357 358Kernel response contents: 359 360 ==================================== ====== ========================== 361 ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header 362 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port 363 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address 364 ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status 365 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control 366 ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver 367 ==================================== ====== ========================== 368 369Attributes and their values have the same meaning as matching members of the 370corresponding ioctl structures. 371 372``LINKINFO_GET`` allows dump requests (kernel returns reply message for all 373devices supporting the request). 374 375 376LINKINFO_SET 377============ 378 379``LINKINFO_SET`` request allows setting some of the attributes reported by 380``LINKINFO_GET``. 381 382Request contents: 383 384 ==================================== ====== ========================== 385 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header 386 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port 387 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address 388 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control 389 ==================================== ====== ========================== 390 391MDI(-X) status and transceiver cannot be set, request with the corresponding 392attributes is rejected. 393 394 395LINKMODES_GET 396============= 397 398Requests link modes (supported, advertised and peer advertised) and related 399information (autonegotiation status, link speed and duplex) as provided by 400``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes. 401 402Request contents: 403 404 ==================================== ====== ========================== 405 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header 406 ==================================== ====== ========================== 407 408Kernel response contents: 409 410 ========================================== ====== ========================== 411 ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header 412 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status 413 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes 414 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes 415 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) 416 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode 417 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode 418 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE`` u8 Master/slave port state 419 ========================================== ====== ========================== 420 421For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask 422represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit 423list. 424 425``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all 426devices supporting the request). 427 428 429LINKMODES_SET 430============= 431 432Request contents: 433 434 ========================================== ====== ========================== 435 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header 436 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status 437 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes 438 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes 439 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) 440 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode 441 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode 442 ``ETHTOOL_A_LINKMODES_LANES`` u32 lanes 443 ========================================== ====== ========================== 444 445``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If 446autonegotiation is on (either set now or kept from before), advertised modes 447are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one 448of speed, duplex and lanes is specified, kernel adjusts advertised modes to all 449supported modes matching speed, duplex, lanes or all (whatever is specified). 450This autoselection is done on ethtool side with ioctl interface, netlink 451interface is supposed to allow requesting changes without knowing what exactly 452kernel supports. 453 454 455LINKSTATE_GET 456============= 457 458Requests link state information. Link up/down flag (as provided by 459``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might 460be provided as well. In general, extended state describes reasons for why a port 461is down, or why it operates in some non-obvious mode. This request does not have 462any attributes. 463 464Request contents: 465 466 ==================================== ====== ========================== 467 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header 468 ==================================== ====== ========================== 469 470Kernel response contents: 471 472 ==================================== ====== ============================ 473 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header 474 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down) 475 ``ETHTOOL_A_LINKSTATE_SQI`` u32 Current Signal Quality Index 476 ``ETHTOOL_A_LINKSTATE_SQI_MAX`` u32 Max support SQI value 477 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state 478 ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate 479 ==================================== ====== ============================ 480 481For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns 482carrier flag provided by ``netif_carrier_ok()`` but there are drivers which 483define their own handler. 484 485``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are 486optional values. ethtool core can provide either both 487``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``, 488or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them. 489 490``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all 491devices supporting the request). 492 493 494Link extended states: 495 496 ================================================ ============================================ 497 ``ETHTOOL_LINK_EXT_STATE_AUTONEG`` States relating to the autonegotiation or 498 issues therein 499 500 ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE`` Failure during link training 501 502 ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH`` Logical mismatch in physical coding sublayer 503 or forward error correction sublayer 504 505 ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY`` Signal integrity issues 506 507 ``ETHTOOL_LINK_EXT_STATE_NO_CABLE`` No cable connected 508 509 ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE`` Failure is related to cable, 510 e.g., unsupported cable 511 512 ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE`` Failure is related to EEPROM, e.g., failure 513 during reading or parsing the data 514 515 ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE`` Failure during calibration algorithm 516 517 ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED`` The hardware is not able to provide the 518 power required from cable or module 519 520 ``ETHTOOL_LINK_EXT_STATE_OVERHEAT`` The module is overheated 521 ================================================ ============================================ 522 523Link extended substates: 524 525 Autoneg substates: 526 527 =============================================================== ================================ 528 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED`` Peer side is down 529 530 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED`` Ack not received from peer side 531 532 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED`` Next page exchange failed 533 534 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE`` Peer side is down during force 535 mode or there is no agreement of 536 speed 537 538 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE`` Forward error correction modes 539 in both sides are mismatched 540 541 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD`` No Highest Common Denominator 542 =============================================================== ================================ 543 544 Link training substates: 545 546 =========================================================================== ==================== 547 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED`` Frames were not 548 recognized, the 549 lock failed 550 551 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT`` The lock did not 552 occur before 553 timeout 554 555 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY`` Peer side did not 556 send ready signal 557 after training 558 process 559 560 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT`` Remote side is not 561 ready yet 562 =========================================================================== ==================== 563 564 Link logical mismatch substates: 565 566 ================================================================ =============================== 567 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK`` Physical coding sublayer was 568 not locked in first phase - 569 block lock 570 571 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK`` Physical coding sublayer was 572 not locked in second phase - 573 alignment markers lock 574 575 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS`` Physical coding sublayer did 576 not get align status 577 578 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED`` FC forward error correction is 579 not locked 580 581 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED`` RS forward error correction is 582 not locked 583 ================================================================ =============================== 584 585 Bad signal integrity substates: 586 587 ================================================================= ============================= 588 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS`` Large number of physical 589 errors 590 591 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE`` The system attempted to 592 operate the cable at a rate 593 that is not formally 594 supported, which led to 595 signal integrity issues 596 ================================================================= ============================= 597 598 Cable issue substates: 599 600 =================================================== ============================================ 601 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE`` Unsupported cable 602 603 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE`` Cable test failure 604 =================================================== ============================================ 605 606DEBUG_GET 607========= 608 609Requests debugging settings of a device. At the moment, only message mask is 610provided. 611 612Request contents: 613 614 ==================================== ====== ========================== 615 ``ETHTOOL_A_DEBUG_HEADER`` nested request header 616 ==================================== ====== ========================== 617 618Kernel response contents: 619 620 ==================================== ====== ========================== 621 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header 622 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask 623 ==================================== ====== ========================== 624 625The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as 626provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl 627interface. While it is called message level there for historical reasons, most 628drivers and almost all newer drivers use it as a mask of enabled message 629classes (represented by ``NETIF_MSG_*`` constants); therefore netlink 630interface follows its actual use in practice. 631 632``DEBUG_GET`` allows dump requests (kernel returns reply messages for all 633devices supporting the request). 634 635 636DEBUG_SET 637========= 638 639Set or update debugging settings of a device. At the moment, only message mask 640is supported. 641 642Request contents: 643 644 ==================================== ====== ========================== 645 ``ETHTOOL_A_DEBUG_HEADER`` nested request header 646 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask 647 ==================================== ====== ========================== 648 649``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of 650enabled debugging message types for the device. 651 652 653WOL_GET 654======= 655 656Query device wake-on-lan settings. Unlike most "GET" type requests, 657``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it 658(potentially) provides SecureOn(tm) password which is confidential. 659 660Request contents: 661 662 ==================================== ====== ========================== 663 ``ETHTOOL_A_WOL_HEADER`` nested request header 664 ==================================== ====== ========================== 665 666Kernel response contents: 667 668 ==================================== ====== ========================== 669 ``ETHTOOL_A_WOL_HEADER`` nested reply header 670 ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes 671 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password 672 ==================================== ====== ========================== 673 674In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the 675device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only 676included in reply if ``WAKE_MAGICSECURE`` mode is supported. 677 678 679WOL_SET 680======= 681 682Set or update wake-on-lan settings. 683 684Request contents: 685 686 ==================================== ====== ========================== 687 ``ETHTOOL_A_WOL_HEADER`` nested request header 688 ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes 689 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password 690 ==================================== ====== ========================== 691 692``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting 693``WAKE_MAGICSECURE`` mode. 694 695 696FEATURES_GET 697============ 698 699Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request. 700 701Request contents: 702 703 ==================================== ====== ========================== 704 ``ETHTOOL_A_FEATURES_HEADER`` nested request header 705 ==================================== ====== ========================== 706 707Kernel response contents: 708 709 ==================================== ====== ========================== 710 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header 711 ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features 712 ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features 713 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features 714 ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE 715 ==================================== ====== ========================== 716 717Bitmaps in kernel response have the same meaning as bitmaps used in ioctl 718interference but attribute names are different (they are based on 719corresponding members of struct net_device). Legacy "flags" are not provided, 720if userspace needs them (most likely only ethtool for backward compatibility), 721it can calculate their values from related feature bits itself. 722ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to 723provide all names when using verbose bitmap format), the other three use no 724mask (simple bit lists). 725 726 727FEATURES_SET 728============ 729 730Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request. 731 732Request contents: 733 734 ==================================== ====== ========================== 735 ``ETHTOOL_A_FEATURES_HEADER`` nested request header 736 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features 737 ==================================== ====== ========================== 738 739Kernel response contents: 740 741 ==================================== ====== ========================== 742 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header 743 ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result 744 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active 745 ==================================== ====== ========================== 746 747Request constains only one bitset which can be either value/mask pair (request 748to change specific feature bits and leave the rest) or only a value (request 749to set all features to specified set). 750 751As request is subject to netdev_change_features() sanity checks, optional 752kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request 753header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED`` 754reports the difference between client request and actual result: mask consists 755of bits which differ between requested features and result (dev->features 756after the operation), value consists of values of these bits in the request 757(i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE`` 758reports the difference between old and new dev->features: mask consists of 759bits which have changed, values are their values in new dev->features (after 760the operation). 761 762``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features 763are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl 764request but also each time features are modified with netdev_update_features() 765or netdev_change_features(). 766 767 768PRIVFLAGS_GET 769============= 770 771Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request. 772 773Request contents: 774 775 ==================================== ====== ========================== 776 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header 777 ==================================== ====== ========================== 778 779Kernel response contents: 780 781 ==================================== ====== ========================== 782 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header 783 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags 784 ==================================== ====== ========================== 785 786``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags. 787These flags are defined by driver, their number and names (and also meaning) 788are device dependent. For compact bitset format, names can be retrieved as 789``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested, 790response uses all private flags supported by the device as mask so that client 791gets the full information without having to fetch the string set with names. 792 793 794PRIVFLAGS_SET 795============= 796 797Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS`` 798ioctl request. 799 800Request contents: 801 802 ==================================== ====== ========================== 803 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header 804 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags 805 ==================================== ====== ========================== 806 807``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or 808modify only values of some of them. 809 810 811RINGS_GET 812========= 813 814Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request. 815 816Request contents: 817 818 ==================================== ====== ========================== 819 ``ETHTOOL_A_RINGS_HEADER`` nested request header 820 ==================================== ====== ========================== 821 822Kernel response contents: 823 824 ==================================== ====== ========================== 825 ``ETHTOOL_A_RINGS_HEADER`` nested reply header 826 ``ETHTOOL_A_RINGS_RX_MAX`` u32 max size of RX ring 827 ``ETHTOOL_A_RINGS_RX_MINI_MAX`` u32 max size of RX mini ring 828 ``ETHTOOL_A_RINGS_RX_JUMBO_MAX`` u32 max size of RX jumbo ring 829 ``ETHTOOL_A_RINGS_TX_MAX`` u32 max size of TX ring 830 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring 831 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring 832 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring 833 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring 834 ==================================== ====== ========================== 835 836 837RINGS_SET 838========= 839 840Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request. 841 842Request contents: 843 844 ==================================== ====== ========================== 845 ``ETHTOOL_A_RINGS_HEADER`` nested reply header 846 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring 847 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring 848 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring 849 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring 850 ==================================== ====== ========================== 851 852Kernel checks that requested ring sizes do not exceed limits reported by 853driver. Driver may impose additional constraints and may not suspport all 854attributes. 855 856 857CHANNELS_GET 858============ 859 860Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request. 861 862Request contents: 863 864 ==================================== ====== ========================== 865 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header 866 ==================================== ====== ========================== 867 868Kernel response contents: 869 870 ===================================== ====== ========================== 871 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header 872 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels 873 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels 874 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels 875 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels 876 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count 877 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count 878 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count 879 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count 880 ===================================== ====== ========================== 881 882 883CHANNELS_SET 884============ 885 886Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request. 887 888Request contents: 889 890 ===================================== ====== ========================== 891 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header 892 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count 893 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count 894 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count 895 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count 896 ===================================== ====== ========================== 897 898Kernel checks that requested channel counts do not exceed limits reported by 899driver. Driver may impose additional constraints and may not suspport all 900attributes. 901 902 903COALESCE_GET 904============ 905 906Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request. 907 908Request contents: 909 910 ==================================== ====== ========================== 911 ``ETHTOOL_A_COALESCE_HEADER`` nested request header 912 ==================================== ====== ========================== 913 914Kernel response contents: 915 916 =========================================== ====== ======================= 917 ``ETHTOOL_A_COALESCE_HEADER`` nested reply header 918 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx 919 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx 920 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ 921 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ 922 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx 923 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx 924 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ 925 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ 926 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update 927 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce 928 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce 929 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate 930 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx 931 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx 932 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx 933 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx 934 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate 935 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx 936 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx 937 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx 938 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx 939 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval 940 =========================================== ====== ======================= 941 942Attributes are only included in reply if their value is not zero or the 943corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e. 944they are declared as supported by driver). 945 946 947COALESCE_SET 948============ 949 950Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request. 951 952Request contents: 953 954 =========================================== ====== ======================= 955 ``ETHTOOL_A_COALESCE_HEADER`` nested request header 956 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx 957 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx 958 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ 959 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ 960 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx 961 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx 962 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ 963 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ 964 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update 965 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce 966 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce 967 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate 968 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx 969 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx 970 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx 971 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx 972 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate 973 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx 974 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx 975 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx 976 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx 977 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval 978 =========================================== ====== ======================= 979 980Request is rejected if it attributes declared as unsupported by driver (i.e. 981such that the corresponding bit in ``ethtool_ops::supported_coalesce_params`` 982is not set), regardless of their values. Driver may impose additional 983constraints on coalescing parameters and their values. 984 985 986PAUSE_GET 987========= 988 989Gets pause frame settings like ``ETHTOOL_GPAUSEPARAM`` ioctl request. 990 991Request contents: 992 993 ===================================== ====== ========================== 994 ``ETHTOOL_A_PAUSE_HEADER`` nested request header 995 ===================================== ====== ========================== 996 997Kernel response contents: 998 999 ===================================== ====== ========================== 1000 ``ETHTOOL_A_PAUSE_HEADER`` nested request header 1001 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation 1002 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames 1003 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames 1004 ``ETHTOOL_A_PAUSE_STATS`` nested pause statistics 1005 ===================================== ====== ========================== 1006 1007``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set 1008in ``ETHTOOL_A_HEADER_FLAGS``. 1009It will be empty if driver did not report any statistics. Drivers fill in 1010the statistics in the following structure: 1011 1012.. kernel-doc:: include/linux/ethtool.h 1013 :identifiers: ethtool_pause_stats 1014 1015Each member has a corresponding attribute defined. 1016 1017PAUSE_SET 1018========= 1019 1020Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request. 1021 1022Request contents: 1023 1024 ===================================== ====== ========================== 1025 ``ETHTOOL_A_PAUSE_HEADER`` nested request header 1026 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation 1027 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames 1028 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames 1029 ===================================== ====== ========================== 1030 1031 1032EEE_GET 1033======= 1034 1035Gets Energy Efficient Ethernet settings like ``ETHTOOL_GEEE`` ioctl request. 1036 1037Request contents: 1038 1039 ===================================== ====== ========================== 1040 ``ETHTOOL_A_EEE_HEADER`` nested request header 1041 ===================================== ====== ========================== 1042 1043Kernel response contents: 1044 1045 ===================================== ====== ========================== 1046 ``ETHTOOL_A_EEE_HEADER`` nested request header 1047 ``ETHTOOL_A_EEE_MODES_OURS`` bool supported/advertised modes 1048 ``ETHTOOL_A_EEE_MODES_PEER`` bool peer advertised link modes 1049 ``ETHTOOL_A_EEE_ACTIVE`` bool EEE is actively used 1050 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled 1051 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled 1052 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us) 1053 ===================================== ====== ========================== 1054 1055In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is 1056enabled, value of link modes for which EEE is advertised. Link modes for which 1057peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The 1058netlink interface allows reporting EEE status for all link modes but only 1059first 32 are provided by the ``ethtool_ops`` callback. 1060 1061 1062EEE_SET 1063======= 1064 1065Sets Energy Efficient Ethernet parameters like ``ETHTOOL_SEEE`` ioctl request. 1066 1067Request contents: 1068 1069 ===================================== ====== ========================== 1070 ``ETHTOOL_A_EEE_HEADER`` nested request header 1071 ``ETHTOOL_A_EEE_MODES_OURS`` bool advertised modes 1072 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled 1073 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled 1074 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us) 1075 ===================================== ====== ========================== 1076 1077``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise 1078EEE for (if there is no mask) or specify changes to the list (if there is 1079a mask). The netlink interface allows reporting EEE status for all link modes 1080but only first 32 can be set at the moment as that is what the ``ethtool_ops`` 1081callback supports. 1082 1083 1084TSINFO_GET 1085========== 1086 1087Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request. 1088 1089Request contents: 1090 1091 ===================================== ====== ========================== 1092 ``ETHTOOL_A_TSINFO_HEADER`` nested request header 1093 ===================================== ====== ========================== 1094 1095Kernel response contents: 1096 1097 ===================================== ====== ========================== 1098 ``ETHTOOL_A_TSINFO_HEADER`` nested request header 1099 ``ETHTOOL_A_TSINFO_TIMESTAMPING`` bitset SO_TIMESTAMPING flags 1100 ``ETHTOOL_A_TSINFO_TX_TYPES`` bitset supported Tx types 1101 ``ETHTOOL_A_TSINFO_RX_FILTERS`` bitset supported Rx filters 1102 ``ETHTOOL_A_TSINFO_PHC_INDEX`` u32 PTP hw clock index 1103 ===================================== ====== ========================== 1104 1105``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there 1106is no special value for this case). The bitset attributes are omitted if they 1107would be empty (no bit set). 1108 1109CABLE_TEST 1110========== 1111 1112Start a cable test. 1113 1114Request contents: 1115 1116 ==================================== ====== ========================== 1117 ``ETHTOOL_A_CABLE_TEST_HEADER`` nested request header 1118 ==================================== ====== ========================== 1119 1120Notification contents: 1121 1122An Ethernet cable typically contains 1, 2 or 4 pairs. The length of 1123the pair can only be measured when there is a fault in the pair and 1124hence a reflection. Information about the fault may not be available, 1125depending on the specific hardware. Hence the contents of the notify 1126message are mostly optional. The attributes can be repeated an 1127arbitrary number of times, in an arbitrary order, for an arbitrary 1128number of pairs. 1129 1130The example shows the notification sent when the test is completed for 1131a T2 cable, i.e. two pairs. One pair is OK and hence has no length 1132information. The second pair has a fault and does have length 1133information. 1134 1135 +---------------------------------------------+--------+---------------------+ 1136 | ``ETHTOOL_A_CABLE_TEST_HEADER`` | nested | reply header | 1137 +---------------------------------------------+--------+---------------------+ 1138 | ``ETHTOOL_A_CABLE_TEST_STATUS`` | u8 | completed | 1139 +---------------------------------------------+--------+---------------------+ 1140 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST`` | nested | all the results | 1141 +-+-------------------------------------------+--------+---------------------+ 1142 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test result | 1143 +-+-+-----------------------------------------+--------+---------------------+ 1144 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1145 +-+-+-----------------------------------------+--------+---------------------+ 1146 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code | 1147 +-+-+-----------------------------------------+--------+---------------------+ 1148 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test results | 1149 +-+-+-----------------------------------------+--------+---------------------+ 1150 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1151 +-+-+-----------------------------------------+--------+---------------------+ 1152 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code | 1153 +-+-+-----------------------------------------+--------+---------------------+ 1154 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH`` | nested | cable length | 1155 +-+-+-----------------------------------------+--------+---------------------+ 1156 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR`` | u8 | pair number | 1157 +-+-+-----------------------------------------+--------+---------------------+ 1158 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM`` | u32 | length in cm | 1159 +-+-+-----------------------------------------+--------+---------------------+ 1160 1161CABLE_TEST TDR 1162============== 1163 1164Start a cable test and report raw TDR data 1165 1166Request contents: 1167 1168 +--------------------------------------------+--------+-----------------------+ 1169 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header | 1170 +--------------------------------------------+--------+-----------------------+ 1171 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG`` | nested | test configuration | 1172 +-+------------------------------------------+--------+-----------------------+ 1173 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | first data distance | 1174 +-+-+----------------------------------------+--------+-----------------------+ 1175 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | last data distance | 1176 +-+-+----------------------------------------+--------+-----------------------+ 1177 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step | 1178 +-+-+----------------------------------------+--------+-----------------------+ 1179 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR`` | u8 | pair to test | 1180 +-+-+----------------------------------------+--------+-----------------------+ 1181 1182The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members 1183of the nest. All distances are expressed in centimeters. The PHY takes 1184the distances as a guide, and rounds to the nearest distance it 1185actually supports. If a pair is passed, only that one pair will be 1186tested. Otherwise all pairs are tested. 1187 1188Notification contents: 1189 1190Raw TDR data is gathered by sending a pulse down the cable and 1191recording the amplitude of the reflected pulse for a given distance. 1192 1193It can take a number of seconds to collect TDR data, especial if the 1194full 100 meters is probed at 1 meter intervals. When the test is 1195started a notification will be sent containing just 1196ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value 1197ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED. 1198 1199When the test has completed a second notification will be sent 1200containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value 1201ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data. 1202 1203The message may optionally contain the amplitude of the pulse send 1204down the cable. This is measured in mV. A reflection should not be 1205bigger than transmitted pulse. 1206 1207Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP 1208nest containing information about the distance along the cable for the 1209first reading, the last reading, and the step between each 1210reading. Distances are measured in centimeters. These should be the 1211exact values the PHY used. These may be different to what the user 1212requested, if the native measurement resolution is greater than 1 cm. 1213 1214For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is 1215used to report the amplitude of the reflection for a given pair. 1216 1217 +---------------------------------------------+--------+----------------------+ 1218 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header | 1219 +---------------------------------------------+--------+----------------------+ 1220 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS`` | u8 | completed | 1221 +---------------------------------------------+--------+----------------------+ 1222 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST`` | nested | all the results | 1223 +-+-------------------------------------------+--------+----------------------+ 1224 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE`` | nested | TX Pulse amplitude | 1225 +-+-+-----------------------------------------+--------+----------------------+ 1226 | | | ``ETHTOOL_A_CABLE_PULSE_mV`` | s16 | Pulse amplitude | 1227 +-+-+-----------------------------------------+--------+----------------------+ 1228 | | ``ETHTOOL_A_CABLE_NEST_STEP`` | nested | TDR step info | 1229 +-+-+-----------------------------------------+--------+----------------------+ 1230 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | First data distance | 1231 +-+-+-----------------------------------------+--------+----------------------+ 1232 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | Last data distance | 1233 +-+-+-----------------------------------------+--------+----------------------+ 1234 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step| 1235 +-+-+-----------------------------------------+--------+----------------------+ 1236 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude | 1237 +-+-+-----------------------------------------+--------+----------------------+ 1238 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1239 +-+-+-----------------------------------------+--------+----------------------+ 1240 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude | 1241 +-+-+-----------------------------------------+--------+----------------------+ 1242 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude | 1243 +-+-+-----------------------------------------+--------+----------------------+ 1244 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1245 +-+-+-----------------------------------------+--------+----------------------+ 1246 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude | 1247 +-+-+-----------------------------------------+--------+----------------------+ 1248 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude | 1249 +-+-+-----------------------------------------+--------+----------------------+ 1250 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1251 +-+-+-----------------------------------------+--------+----------------------+ 1252 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude | 1253 +-+-+-----------------------------------------+--------+----------------------+ 1254 1255TUNNEL_INFO 1256=========== 1257 1258Gets information about the tunnel state NIC is aware of. 1259 1260Request contents: 1261 1262 ===================================== ====== ========================== 1263 ``ETHTOOL_A_TUNNEL_INFO_HEADER`` nested request header 1264 ===================================== ====== ========================== 1265 1266Kernel response contents: 1267 1268 +---------------------------------------------+--------+---------------------+ 1269 | ``ETHTOOL_A_TUNNEL_INFO_HEADER`` | nested | reply header | 1270 +---------------------------------------------+--------+---------------------+ 1271 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS`` | nested | all UDP port tables | 1272 +-+-------------------------------------------+--------+---------------------+ 1273 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE`` | nested | one UDP port table | 1274 +-+-+-----------------------------------------+--------+---------------------+ 1275 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE`` | u32 | max size of the | 1276 | | | | | table | 1277 +-+-+-----------------------------------------+--------+---------------------+ 1278 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` | bitset | tunnel types which | 1279 | | | | | table can hold | 1280 +-+-+-----------------------------------------+--------+---------------------+ 1281 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY`` | nested | offloaded UDP port | 1282 +-+-+-+---------------------------------------+--------+---------------------+ 1283 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT`` | be16 | UDP port | 1284 +-+-+-+---------------------------------------+--------+---------------------+ 1285 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE`` | u32 | tunnel type | 1286 +-+-+-+---------------------------------------+--------+---------------------+ 1287 1288For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that 1289the table contains static entries, hard-coded by the NIC. 1290 1291FEC_GET 1292======= 1293 1294Gets FEC configuration and state like ``ETHTOOL_GFECPARAM`` ioctl request. 1295 1296Request contents: 1297 1298 ===================================== ====== ========================== 1299 ``ETHTOOL_A_FEC_HEADER`` nested request header 1300 ===================================== ====== ========================== 1301 1302Kernel response contents: 1303 1304 ===================================== ====== ========================== 1305 ``ETHTOOL_A_FEC_HEADER`` nested request header 1306 ``ETHTOOL_A_FEC_MODES`` bitset configured modes 1307 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection 1308 ``ETHTOOL_A_FEC_ACTIVE`` u32 index of active FEC mode 1309 ``ETHTOOL_A_FEC_STATS`` nested FEC statistics 1310 ===================================== ====== ========================== 1311 1312``ETHTOOL_A_FEC_ACTIVE`` is the bit index of the FEC link mode currently 1313active on the interface. This attribute may not be present if device does 1314not support FEC. 1315 1316``ETHTOOL_A_FEC_MODES`` and ``ETHTOOL_A_FEC_AUTO`` are only meaningful when 1317autonegotiation is disabled. If ``ETHTOOL_A_FEC_AUTO`` is non-zero driver will 1318select the FEC mode automatically based on the parameters of the SFP module. 1319This is equivalent to the ``ETHTOOL_FEC_AUTO`` bit of the ioctl interface. 1320``ETHTOOL_A_FEC_MODES`` carry the current FEC configuration using link mode 1321bits (rather than old ``ETHTOOL_FEC_*`` bits). 1322 1323``ETHTOOL_A_FEC_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in 1324``ETHTOOL_A_HEADER_FLAGS``. 1325Each attribute carries an array of 64bit statistics. First entry in the array 1326contains the total number of events on the port, while the following entries 1327are counters corresponding to lanes/PCS instances. The number of entries in 1328the array will be: 1329 1330+--------------+---------------------------------------------+ 1331| `0` | device does not support FEC statistics | 1332+--------------+---------------------------------------------+ 1333| `1` | device does not support per-lane break down | 1334+--------------+---------------------------------------------+ 1335| `1 + #lanes` | device has full support for FEC stats | 1336+--------------+---------------------------------------------+ 1337 1338Drivers fill in the statistics in the following structure: 1339 1340.. kernel-doc:: include/linux/ethtool.h 1341 :identifiers: ethtool_fec_stats 1342 1343FEC_SET 1344======= 1345 1346Sets FEC parameters like ``ETHTOOL_SFECPARAM`` ioctl request. 1347 1348Request contents: 1349 1350 ===================================== ====== ========================== 1351 ``ETHTOOL_A_FEC_HEADER`` nested request header 1352 ``ETHTOOL_A_FEC_MODES`` bitset configured modes 1353 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection 1354 ===================================== ====== ========================== 1355 1356``FEC_SET`` is only meaningful when autonegotiation is disabled. Otherwise 1357FEC mode is selected as part of autonegotiation. 1358 1359``ETHTOOL_A_FEC_MODES`` selects which FEC mode should be used. It's recommended 1360to set only one bit, if multiple bits are set driver may choose between them 1361in an implementation specific way. 1362 1363``ETHTOOL_A_FEC_AUTO`` requests the driver to choose FEC mode based on SFP 1364module parameters. This does not mean autonegotiation. 1365 1366MODULE_EEPROM 1367============= 1368 1369Fetch module EEPROM data dump. 1370This interface is designed to allow dumps of at most 1/2 page at once. This 1371means only dumps of 128 (or less) bytes are allowed, without crossing half page 1372boundary located at offset 128. For pages other than 0 only high 128 bytes are 1373accessible. 1374 1375Request contents: 1376 1377 ======================================= ====== ========================== 1378 ``ETHTOOL_A_MODULE_EEPROM_HEADER`` nested request header 1379 ``ETHTOOL_A_MODULE_EEPROM_OFFSET`` u32 offset within a page 1380 ``ETHTOOL_A_MODULE_EEPROM_LENGTH`` u32 amount of bytes to read 1381 ``ETHTOOL_A_MODULE_EEPROM_PAGE`` u8 page number 1382 ``ETHTOOL_A_MODULE_EEPROM_BANK`` u8 bank number 1383 ``ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS`` u8 page I2C address 1384 ======================================= ====== ========================== 1385 1386Kernel response contents: 1387 1388 +---------------------------------------------+--------+---------------------+ 1389 | ``ETHTOOL_A_MODULE_EEPROM_HEADER`` | nested | reply header | 1390 +---------------------------------------------+--------+---------------------+ 1391 | ``ETHTOOL_A_MODULE_EEPROM_DATA`` | nested | array of bytes from | 1392 | | | module EEPROM | 1393 +---------------------------------------------+--------+---------------------+ 1394 1395``ETHTOOL_A_MODULE_EEPROM_DATA`` has an attribute length equal to the amount of 1396bytes driver actually read. 1397 1398STATS_GET 1399========= 1400 1401Get standard statistics for the interface. Note that this is not 1402a re-implementation of ``ETHTOOL_GSTATS`` which exposed driver-defined 1403stats. 1404 1405Request contents: 1406 1407 ======================================= ====== ========================== 1408 ``ETHTOOL_A_STATS_HEADER`` nested request header 1409 ``ETHTOOL_A_STATS_GROUPS`` bitset requested groups of stats 1410 ======================================= ====== ========================== 1411 1412Kernel response contents: 1413 1414 +-----------------------------------+--------+--------------------------------+ 1415 | ``ETHTOOL_A_STATS_HEADER`` | nested | reply header | 1416 +-----------------------------------+--------+--------------------------------+ 1417 | ``ETHTOOL_A_STATS_GRP`` | nested | one or more group of stats | 1418 +-+---------------------------------+--------+--------------------------------+ 1419 | | ``ETHTOOL_A_STATS_GRP_ID`` | u32 | group ID - ``ETHTOOL_STATS_*`` | 1420 +-+---------------------------------+--------+--------------------------------+ 1421 | | ``ETHTOOL_A_STATS_GRP_SS_ID`` | u32 | string set ID for names | 1422 +-+---------------------------------+--------+--------------------------------+ 1423 | | ``ETHTOOL_A_STATS_GRP_STAT`` | nested | nest containing a statistic | 1424 +-+---------------------------------+--------+--------------------------------+ 1425 | | ``ETHTOOL_A_STATS_GRP_HIST_RX`` | nested | histogram statistic (Rx) | 1426 +-+---------------------------------+--------+--------------------------------+ 1427 | | ``ETHTOOL_A_STATS_GRP_HIST_TX`` | nested | histogram statistic (Tx) | 1428 +-+---------------------------------+--------+--------------------------------+ 1429 1430Users specify which groups of statistics they are requesting via 1431the ``ETHTOOL_A_STATS_GROUPS`` bitset. Currently defined values are: 1432 1433 ====================== ======== =============================================== 1434 ETHTOOL_STATS_ETH_MAC eth-mac Basic IEEE 802.3 MAC statistics (30.3.1.1.*) 1435 ETHTOOL_STATS_ETH_PHY eth-phy Basic IEEE 802.3 PHY statistics (30.3.2.1.*) 1436 ETHTOOL_STATS_ETH_CTRL eth-ctrl Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*) 1437 ETHTOOL_STATS_RMON rmon RMON (RFC 2819) statistics 1438 ====================== ======== =============================================== 1439 1440Each group should have a corresponding ``ETHTOOL_A_STATS_GRP`` in the reply. 1441``ETHTOOL_A_STATS_GRP_ID`` identifies which group's statistics nest contains. 1442``ETHTOOL_A_STATS_GRP_SS_ID`` identifies the string set ID for the names of 1443the statistics in the group, if available. 1444 1445Statistics are added to the ``ETHTOOL_A_STATS_GRP`` nest under 1446``ETHTOOL_A_STATS_GRP_STAT``. ``ETHTOOL_A_STATS_GRP_STAT`` should contain 1447single 8 byte (u64) attribute inside - the type of that attribute is 1448the statistic ID and the value is the value of the statistic. 1449Each group has its own interpretation of statistic IDs. 1450Attribute IDs correspond to strings from the string set identified 1451by ``ETHTOOL_A_STATS_GRP_SS_ID``. Complex statistics (such as RMON histogram 1452entries) are also listed inside ``ETHTOOL_A_STATS_GRP`` and do not have 1453a string defined in the string set. 1454 1455RMON "histogram" counters count number of packets within given size range. 1456Because RFC does not specify the ranges beyond the standard 1518 MTU devices 1457differ in definition of buckets. For this reason the definition of packet ranges 1458is left to each driver. 1459 1460``ETHTOOL_A_STATS_GRP_HIST_RX`` and ``ETHTOOL_A_STATS_GRP_HIST_TX`` nests 1461contain the following attributes: 1462 1463 ================================= ====== =================================== 1464 ETHTOOL_A_STATS_RMON_HIST_BKT_LOW u32 low bound of the packet size bucket 1465 ETHTOOL_A_STATS_RMON_HIST_BKT_HI u32 high bound of the bucket 1466 ETHTOOL_A_STATS_RMON_HIST_VAL u64 packet counter 1467 ================================= ====== =================================== 1468 1469Low and high bounds are inclusive, for example: 1470 1471 ============================= ==== ==== 1472 RFC statistic low high 1473 ============================= ==== ==== 1474 etherStatsPkts64Octets 0 64 1475 etherStatsPkts512to1023Octets 512 1023 1476 ============================= ==== ==== 1477 1478Request translation 1479=================== 1480 1481The following table maps ioctl commands to netlink commands providing their 1482functionality. Entries with "n/a" in right column are commands which do not 1483have their netlink replacement yet. Entries which "n/a" in the left column 1484are netlink only. 1485 1486 =================================== ===================================== 1487 ioctl command netlink command 1488 =================================== ===================================== 1489 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET`` 1490 ``ETHTOOL_MSG_LINKMODES_GET`` 1491 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET`` 1492 ``ETHTOOL_MSG_LINKMODES_SET`` 1493 ``ETHTOOL_GDRVINFO`` n/a 1494 ``ETHTOOL_GREGS`` n/a 1495 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET`` 1496 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET`` 1497 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET`` 1498 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET`` 1499 ``ETHTOOL_NWAY_RST`` n/a 1500 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET`` 1501 ``ETHTOOL_GEEPROM`` n/a 1502 ``ETHTOOL_SEEPROM`` n/a 1503 ``ETHTOOL_GCOALESCE`` ``ETHTOOL_MSG_COALESCE_GET`` 1504 ``ETHTOOL_SCOALESCE`` ``ETHTOOL_MSG_COALESCE_SET`` 1505 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET`` 1506 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET`` 1507 ``ETHTOOL_GPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_GET`` 1508 ``ETHTOOL_SPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_SET`` 1509 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` 1510 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` 1511 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` 1512 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` 1513 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET`` 1514 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET`` 1515 ``ETHTOOL_TEST`` n/a 1516 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET`` 1517 ``ETHTOOL_PHYS_ID`` n/a 1518 ``ETHTOOL_GSTATS`` n/a 1519 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET`` 1520 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET`` 1521 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK`` 1522 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET`` 1523 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET`` 1524 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET`` 1525 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET`` 1526 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET`` 1527 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET`` 1528 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET`` 1529 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET`` 1530 ``ETHTOOL_GRXFH`` n/a 1531 ``ETHTOOL_SRXFH`` n/a 1532 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET`` 1533 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET`` 1534 ``ETHTOOL_GRXRINGS`` n/a 1535 ``ETHTOOL_GRXCLSRLCNT`` n/a 1536 ``ETHTOOL_GRXCLSRULE`` n/a 1537 ``ETHTOOL_GRXCLSRLALL`` n/a 1538 ``ETHTOOL_SRXCLSRLDEL`` n/a 1539 ``ETHTOOL_SRXCLSRLINS`` n/a 1540 ``ETHTOOL_FLASHDEV`` n/a 1541 ``ETHTOOL_RESET`` n/a 1542 ``ETHTOOL_SRXNTUPLE`` n/a 1543 ``ETHTOOL_GRXNTUPLE`` n/a 1544 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET`` 1545 ``ETHTOOL_GRXFHINDIR`` n/a 1546 ``ETHTOOL_SRXFHINDIR`` n/a 1547 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET`` 1548 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET`` 1549 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET`` 1550 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET`` 1551 ``ETHTOOL_SET_DUMP`` n/a 1552 ``ETHTOOL_GET_DUMP_FLAG`` n/a 1553 ``ETHTOOL_GET_DUMP_DATA`` n/a 1554 ``ETHTOOL_GET_TS_INFO`` ``ETHTOOL_MSG_TSINFO_GET`` 1555 ``ETHTOOL_GMODULEINFO`` ``ETHTOOL_MSG_MODULE_EEPROM_GET`` 1556 ``ETHTOOL_GMODULEEEPROM`` ``ETHTOOL_MSG_MODULE_EEPROM_GET`` 1557 ``ETHTOOL_GEEE`` ``ETHTOOL_MSG_EEE_GET`` 1558 ``ETHTOOL_SEEE`` ``ETHTOOL_MSG_EEE_SET`` 1559 ``ETHTOOL_GRSSH`` n/a 1560 ``ETHTOOL_SRSSH`` n/a 1561 ``ETHTOOL_GTUNABLE`` n/a 1562 ``ETHTOOL_STUNABLE`` n/a 1563 ``ETHTOOL_GPHYSTATS`` n/a 1564 ``ETHTOOL_PERQUEUE`` n/a 1565 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET`` 1566 ``ETHTOOL_MSG_LINKMODES_GET`` 1567 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET`` 1568 ``ETHTOOL_MSG_LINKMODES_SET`` 1569 ``ETHTOOL_PHY_GTUNABLE`` n/a 1570 ``ETHTOOL_PHY_STUNABLE`` n/a 1571 ``ETHTOOL_GFECPARAM`` ``ETHTOOL_MSG_FEC_GET`` 1572 ``ETHTOOL_SFECPARAM`` ``ETHTOOL_MSG_FEC_SET`` 1573 n/a ``ETHTOOL_MSG_CABLE_TEST_ACT`` 1574 n/a ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT`` 1575 n/a ``ETHTOOL_MSG_TUNNEL_INFO_GET`` 1576 =================================== ===================================== 1577