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