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