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) attribute 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 ``ETHTOOL_MSG_PSE_SET`` set PSE parameters 224 ``ETHTOOL_MSG_PSE_GET`` get PSE parameters 225 ``ETHTOOL_MSG_RSS_GET`` get RSS settings 226 ``ETHTOOL_MSG_PLCA_GET_CFG`` get PLCA RS parameters 227 ``ETHTOOL_MSG_PLCA_SET_CFG`` set PLCA RS parameters 228 ``ETHTOOL_MSG_PLCA_GET_STATUS`` get PLCA RS status 229 ``ETHTOOL_MSG_MM_GET`` get MAC merge layer state 230 ``ETHTOOL_MSG_MM_SET`` set MAC merge layer parameters 231 ===================================== ================================= 232 233Kernel to userspace: 234 235 ======================================== ================================= 236 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents 237 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings 238 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification 239 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info 240 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification 241 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info 242 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings 243 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification 244 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings 245 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification 246 ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features 247 ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET 248 ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification 249 ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags 250 ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags 251 ``ETHTOOL_MSG_RINGS_GET_REPLY`` ring sizes 252 ``ETHTOOL_MSG_RINGS_NTF`` ring sizes 253 ``ETHTOOL_MSG_CHANNELS_GET_REPLY`` channel counts 254 ``ETHTOOL_MSG_CHANNELS_NTF`` channel counts 255 ``ETHTOOL_MSG_COALESCE_GET_REPLY`` coalescing parameters 256 ``ETHTOOL_MSG_COALESCE_NTF`` coalescing parameters 257 ``ETHTOOL_MSG_PAUSE_GET_REPLY`` pause parameters 258 ``ETHTOOL_MSG_PAUSE_NTF`` pause parameters 259 ``ETHTOOL_MSG_EEE_GET_REPLY`` EEE settings 260 ``ETHTOOL_MSG_EEE_NTF`` EEE settings 261 ``ETHTOOL_MSG_TSINFO_GET_REPLY`` timestamping info 262 ``ETHTOOL_MSG_CABLE_TEST_NTF`` Cable test results 263 ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF`` Cable test TDR results 264 ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY`` tunnel offload info 265 ``ETHTOOL_MSG_FEC_GET_REPLY`` FEC settings 266 ``ETHTOOL_MSG_FEC_NTF`` FEC settings 267 ``ETHTOOL_MSG_MODULE_EEPROM_GET_REPLY`` read SFP module EEPROM 268 ``ETHTOOL_MSG_STATS_GET_REPLY`` standard statistics 269 ``ETHTOOL_MSG_PHC_VCLOCKS_GET_REPLY`` PHC virtual clocks info 270 ``ETHTOOL_MSG_MODULE_GET_REPLY`` transceiver module parameters 271 ``ETHTOOL_MSG_PSE_GET_REPLY`` PSE parameters 272 ``ETHTOOL_MSG_RSS_GET_REPLY`` RSS settings 273 ``ETHTOOL_MSG_PLCA_GET_CFG_REPLY`` PLCA RS parameters 274 ``ETHTOOL_MSG_PLCA_GET_STATUS_REPLY`` PLCA RS status 275 ``ETHTOOL_MSG_PLCA_NTF`` PLCA RS parameters 276 ``ETHTOOL_MSG_MM_GET_REPLY`` MAC merge layer status 277 ======================================== ================================= 278 279``GET`` requests are sent by userspace applications to retrieve device 280information. They usually do not contain any message specific attributes. 281Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET`` 282request with ``NLM_F_DUMP`` and no device identification can be used to query 283the information for all devices supporting the request. 284 285If the data can be also modified, corresponding ``SET`` message with the same 286layout as corresponding ``GET_REPLY`` is used to request changes. Only 287attributes where a change is requested are included in such request (also, not 288all attributes may be changed). Replies to most ``SET`` request consist only 289of error code and extack; if kernel provides additional data, it is sent in 290the form of corresponding ``SET_REPLY`` message which can be suppressed by 291setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header. 292 293Data modification also triggers sending a ``NTF`` message with a notification. 294These usually bear only a subset of attributes which was affected by the 295change. The same notification is issued if the data is modified using other 296means (mostly ioctl ethtool interface). Unlike notifications from ethtool 297netlink code which are only sent if something actually changed, notifications 298triggered by ioctl interface may be sent even if the request did not actually 299change any data. 300 301``ACT`` messages request kernel (driver) to perform a specific action. If some 302information is reported by kernel (which can be suppressed by setting 303``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of 304an ``ACT_REPLY`` message. Performing an action also triggers a notification 305(``NTF`` message). 306 307Later sections describe the format and semantics of these messages. 308 309 310STRSET_GET 311========== 312 313Requests contents of a string set as provided by ioctl commands 314``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user 315writeable so that the corresponding ``STRSET_SET`` message is only used in 316kernel replies. There are two types of string sets: global (independent of 317a device, e.g. device feature names) and device specific (e.g. device private 318flags). 319 320Request contents: 321 322 +---------------------------------------+--------+------------------------+ 323 | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header | 324 +---------------------------------------+--------+------------------------+ 325 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request | 326 +-+-------------------------------------+--------+------------------------+ 327 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | 328 +-+-+-----------------------------------+--------+------------------------+ 329 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | 330 +-+-+-----------------------------------+--------+------------------------+ 331 332Kernel response contents: 333 334 +---------------------------------------+--------+-----------------------+ 335 | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header | 336 +---------------------------------------+--------+-----------------------+ 337 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets | 338 +-+-------------------------------------+--------+-----------------------+ 339 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | 340 +-+-+-----------------------------------+--------+-----------------------+ 341 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | 342 +-+-+-----------------------------------+--------+-----------------------+ 343 | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings | 344 +-+-+-----------------------------------+--------+-----------------------+ 345 | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings | 346 +-+-+-+---------------------------------+--------+-----------------------+ 347 | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string | 348 +-+-+-+-+-------------------------------+--------+-----------------------+ 349 | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index | 350 +-+-+-+-+-------------------------------+--------+-----------------------+ 351 | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value | 352 +-+-+-+-+-------------------------------+--------+-----------------------+ 353 | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts | 354 +---------------------------------------+--------+-----------------------+ 355 356Device identification in request header is optional. Depending on its presence 357a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests: 358 359 - no ``NLM_F_DUMP,`` no device: get "global" stringsets 360 - no ``NLM_F_DUMP``, with device: get string sets related to the device 361 - ``NLM_F_DUMP``, no device: get device related string sets for all devices 362 363If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of 364requested type are returned, otherwise only those specified in the request. 365Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string 366counts of the sets, not the actual strings. 367 368 369LINKINFO_GET 370============ 371 372Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for 373link modes and autonegotiation related information. The request does not use 374any attributes. 375 376Request contents: 377 378 ==================================== ====== ========================== 379 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header 380 ==================================== ====== ========================== 381 382Kernel response contents: 383 384 ==================================== ====== ========================== 385 ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header 386 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port 387 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address 388 ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status 389 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control 390 ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver 391 ==================================== ====== ========================== 392 393Attributes and their values have the same meaning as matching members of the 394corresponding ioctl structures. 395 396``LINKINFO_GET`` allows dump requests (kernel returns reply message for all 397devices supporting the request). 398 399 400LINKINFO_SET 401============ 402 403``LINKINFO_SET`` request allows setting some of the attributes reported by 404``LINKINFO_GET``. 405 406Request contents: 407 408 ==================================== ====== ========================== 409 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header 410 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port 411 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address 412 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control 413 ==================================== ====== ========================== 414 415MDI(-X) status and transceiver cannot be set, request with the corresponding 416attributes is rejected. 417 418 419LINKMODES_GET 420============= 421 422Requests link modes (supported, advertised and peer advertised) and related 423information (autonegotiation status, link speed and duplex) as provided by 424``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes. 425 426Request contents: 427 428 ==================================== ====== ========================== 429 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header 430 ==================================== ====== ========================== 431 432Kernel response contents: 433 434 ========================================== ====== ========================== 435 ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header 436 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status 437 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes 438 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes 439 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) 440 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode 441 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode 442 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE`` u8 Master/slave port state 443 ``ETHTOOL_A_LINKMODES_RATE_MATCHING`` u8 PHY rate matching 444 ========================================== ====== ========================== 445 446For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask 447represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit 448list. 449 450``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all 451devices supporting the request). 452 453 454LINKMODES_SET 455============= 456 457Request contents: 458 459 ========================================== ====== ========================== 460 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header 461 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status 462 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes 463 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes 464 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) 465 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode 466 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode 467 ``ETHTOOL_A_LINKMODES_RATE_MATCHING`` u8 PHY rate matching 468 ``ETHTOOL_A_LINKMODES_LANES`` u32 lanes 469 ========================================== ====== ========================== 470 471``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If 472autonegotiation is on (either set now or kept from before), advertised modes 473are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one 474of speed, duplex and lanes is specified, kernel adjusts advertised modes to all 475supported modes matching speed, duplex, lanes or all (whatever is specified). 476This autoselection is done on ethtool side with ioctl interface, netlink 477interface is supposed to allow requesting changes without knowing what exactly 478kernel supports. 479 480 481LINKSTATE_GET 482============= 483 484Requests link state information. Link up/down flag (as provided by 485``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might 486be provided as well. In general, extended state describes reasons for why a port 487is down, or why it operates in some non-obvious mode. This request does not have 488any attributes. 489 490Request contents: 491 492 ==================================== ====== ========================== 493 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header 494 ==================================== ====== ========================== 495 496Kernel response contents: 497 498 ==================================== ====== ============================ 499 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header 500 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down) 501 ``ETHTOOL_A_LINKSTATE_SQI`` u32 Current Signal Quality Index 502 ``ETHTOOL_A_LINKSTATE_SQI_MAX`` u32 Max support SQI value 503 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state 504 ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate 505 ``ETHTOOL_A_LINKSTATE_EXT_DOWN_CNT`` u32 count of link down events 506 ==================================== ====== ============================ 507 508For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns 509carrier flag provided by ``netif_carrier_ok()`` but there are drivers which 510define their own handler. 511 512``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are 513optional values. ethtool core can provide either both 514``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``, 515or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them. 516 517``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all 518devices supporting the request). 519 520 521Link extended states: 522 523 ================================================ ============================================ 524 ``ETHTOOL_LINK_EXT_STATE_AUTONEG`` States relating to the autonegotiation or 525 issues therein 526 527 ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE`` Failure during link training 528 529 ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH`` Logical mismatch in physical coding sublayer 530 or forward error correction sublayer 531 532 ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY`` Signal integrity issues 533 534 ``ETHTOOL_LINK_EXT_STATE_NO_CABLE`` No cable connected 535 536 ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE`` Failure is related to cable, 537 e.g., unsupported cable 538 539 ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE`` Failure is related to EEPROM, e.g., failure 540 during reading or parsing the data 541 542 ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE`` Failure during calibration algorithm 543 544 ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED`` The hardware is not able to provide the 545 power required from cable or module 546 547 ``ETHTOOL_LINK_EXT_STATE_OVERHEAT`` The module is overheated 548 549 ``ETHTOOL_LINK_EXT_STATE_MODULE`` Transceiver module issue 550 ================================================ ============================================ 551 552Link extended substates: 553 554 Autoneg substates: 555 556 =============================================================== ================================ 557 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED`` Peer side is down 558 559 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED`` Ack not received from peer side 560 561 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED`` Next page exchange failed 562 563 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE`` Peer side is down during force 564 mode or there is no agreement of 565 speed 566 567 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE`` Forward error correction modes 568 in both sides are mismatched 569 570 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD`` No Highest Common Denominator 571 =============================================================== ================================ 572 573 Link training substates: 574 575 =========================================================================== ==================== 576 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED`` Frames were not 577 recognized, the 578 lock failed 579 580 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT`` The lock did not 581 occur before 582 timeout 583 584 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY`` Peer side did not 585 send ready signal 586 after training 587 process 588 589 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT`` Remote side is not 590 ready yet 591 =========================================================================== ==================== 592 593 Link logical mismatch substates: 594 595 ================================================================ =============================== 596 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK`` Physical coding sublayer was 597 not locked in first phase - 598 block lock 599 600 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK`` Physical coding sublayer was 601 not locked in second phase - 602 alignment markers lock 603 604 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS`` Physical coding sublayer did 605 not get align status 606 607 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED`` FC forward error correction is 608 not locked 609 610 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED`` RS forward error correction is 611 not locked 612 ================================================================ =============================== 613 614 Bad signal integrity substates: 615 616 ================================================================= ============================= 617 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS`` Large number of physical 618 errors 619 620 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE`` The system attempted to 621 operate the cable at a rate 622 that is not formally 623 supported, which led to 624 signal integrity issues 625 626 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST`` The external clock signal for 627 SerDes is too weak or 628 unavailable. 629 630 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS`` The received signal for 631 SerDes is too weak because 632 analog loss of signal. 633 ================================================================= ============================= 634 635 Cable issue substates: 636 637 =================================================== ============================================ 638 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE`` Unsupported cable 639 640 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE`` Cable test failure 641 =================================================== ============================================ 642 643 Transceiver module issue substates: 644 645 =================================================== ============================================ 646 ``ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY`` The CMIS Module State Machine did not reach 647 the ModuleReady state. For example, if the 648 module is stuck at ModuleFault state 649 =================================================== ============================================ 650 651DEBUG_GET 652========= 653 654Requests debugging settings of a device. At the moment, only message mask is 655provided. 656 657Request contents: 658 659 ==================================== ====== ========================== 660 ``ETHTOOL_A_DEBUG_HEADER`` nested request header 661 ==================================== ====== ========================== 662 663Kernel response contents: 664 665 ==================================== ====== ========================== 666 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header 667 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask 668 ==================================== ====== ========================== 669 670The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as 671provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl 672interface. While it is called message level there for historical reasons, most 673drivers and almost all newer drivers use it as a mask of enabled message 674classes (represented by ``NETIF_MSG_*`` constants); therefore netlink 675interface follows its actual use in practice. 676 677``DEBUG_GET`` allows dump requests (kernel returns reply messages for all 678devices supporting the request). 679 680 681DEBUG_SET 682========= 683 684Set or update debugging settings of a device. At the moment, only message mask 685is supported. 686 687Request contents: 688 689 ==================================== ====== ========================== 690 ``ETHTOOL_A_DEBUG_HEADER`` nested request header 691 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask 692 ==================================== ====== ========================== 693 694``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of 695enabled debugging message types for the device. 696 697 698WOL_GET 699======= 700 701Query device wake-on-lan settings. Unlike most "GET" type requests, 702``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it 703(potentially) provides SecureOn(tm) password which is confidential. 704 705Request contents: 706 707 ==================================== ====== ========================== 708 ``ETHTOOL_A_WOL_HEADER`` nested request header 709 ==================================== ====== ========================== 710 711Kernel response contents: 712 713 ==================================== ====== ========================== 714 ``ETHTOOL_A_WOL_HEADER`` nested reply header 715 ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes 716 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password 717 ==================================== ====== ========================== 718 719In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the 720device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only 721included in reply if ``WAKE_MAGICSECURE`` mode is supported. 722 723 724WOL_SET 725======= 726 727Set or update wake-on-lan settings. 728 729Request contents: 730 731 ==================================== ====== ========================== 732 ``ETHTOOL_A_WOL_HEADER`` nested request header 733 ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes 734 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password 735 ==================================== ====== ========================== 736 737``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting 738``WAKE_MAGICSECURE`` mode. 739 740 741FEATURES_GET 742============ 743 744Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request. 745 746Request contents: 747 748 ==================================== ====== ========================== 749 ``ETHTOOL_A_FEATURES_HEADER`` nested request header 750 ==================================== ====== ========================== 751 752Kernel response contents: 753 754 ==================================== ====== ========================== 755 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header 756 ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features 757 ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features 758 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features 759 ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE 760 ==================================== ====== ========================== 761 762Bitmaps in kernel response have the same meaning as bitmaps used in ioctl 763interference but attribute names are different (they are based on 764corresponding members of struct net_device). Legacy "flags" are not provided, 765if userspace needs them (most likely only ethtool for backward compatibility), 766it can calculate their values from related feature bits itself. 767ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to 768provide all names when using verbose bitmap format), the other three use no 769mask (simple bit lists). 770 771 772FEATURES_SET 773============ 774 775Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request. 776 777Request contents: 778 779 ==================================== ====== ========================== 780 ``ETHTOOL_A_FEATURES_HEADER`` nested request header 781 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features 782 ==================================== ====== ========================== 783 784Kernel response contents: 785 786 ==================================== ====== ========================== 787 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header 788 ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result 789 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active 790 ==================================== ====== ========================== 791 792Request contains only one bitset which can be either value/mask pair (request 793to change specific feature bits and leave the rest) or only a value (request 794to set all features to specified set). 795 796As request is subject to netdev_change_features() sanity checks, optional 797kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request 798header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED`` 799reports the difference between client request and actual result: mask consists 800of bits which differ between requested features and result (dev->features 801after the operation), value consists of values of these bits in the request 802(i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE`` 803reports the difference between old and new dev->features: mask consists of 804bits which have changed, values are their values in new dev->features (after 805the operation). 806 807``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features 808are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl 809request but also each time features are modified with netdev_update_features() 810or netdev_change_features(). 811 812 813PRIVFLAGS_GET 814============= 815 816Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request. 817 818Request contents: 819 820 ==================================== ====== ========================== 821 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header 822 ==================================== ====== ========================== 823 824Kernel response contents: 825 826 ==================================== ====== ========================== 827 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header 828 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags 829 ==================================== ====== ========================== 830 831``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags. 832These flags are defined by driver, their number and names (and also meaning) 833are device dependent. For compact bitset format, names can be retrieved as 834``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested, 835response uses all private flags supported by the device as mask so that client 836gets the full information without having to fetch the string set with names. 837 838 839PRIVFLAGS_SET 840============= 841 842Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS`` 843ioctl request. 844 845Request contents: 846 847 ==================================== ====== ========================== 848 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header 849 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags 850 ==================================== ====== ========================== 851 852``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or 853modify only values of some of them. 854 855 856RINGS_GET 857========= 858 859Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request. 860 861Request contents: 862 863 ==================================== ====== ========================== 864 ``ETHTOOL_A_RINGS_HEADER`` nested request header 865 ==================================== ====== ========================== 866 867Kernel response contents: 868 869 ======================================= ====== =========================== 870 ``ETHTOOL_A_RINGS_HEADER`` nested reply header 871 ``ETHTOOL_A_RINGS_RX_MAX`` u32 max size of RX ring 872 ``ETHTOOL_A_RINGS_RX_MINI_MAX`` u32 max size of RX mini ring 873 ``ETHTOOL_A_RINGS_RX_JUMBO_MAX`` u32 max size of RX jumbo ring 874 ``ETHTOOL_A_RINGS_TX_MAX`` u32 max size of TX ring 875 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring 876 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring 877 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring 878 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring 879 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring 880 ``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` u8 TCP header / data split 881 ``ETHTOOL_A_RINGS_CQE_SIZE`` u32 Size of TX/RX CQE 882 ``ETHTOOL_A_RINGS_TX_PUSH`` u8 flag of TX Push mode 883 ``ETHTOOL_A_RINGS_RX_PUSH`` u8 flag of RX Push mode 884 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` u32 size of TX push buffer 885 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN_MAX`` u32 max size of TX push buffer 886 ======================================= ====== =========================== 887 888``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` indicates whether the device is usable with 889page-flipping TCP zero-copy receive (``getsockopt(TCP_ZEROCOPY_RECEIVE)``). 890If enabled the device is configured to place frame headers and data into 891separate buffers. The device configuration must make it possible to receive 892full memory pages of data, for example because MTU is high enough or through 893HW-GRO. 894 895``ETHTOOL_A_RINGS_[RX|TX]_PUSH`` flag is used to enable descriptor fast 896path to send or receive packets. In ordinary path, driver fills descriptors in DRAM and 897notifies NIC hardware. In fast path, driver pushes descriptors to the device 898through MMIO writes, thus reducing the latency. However, enabling this feature 899may increase the CPU cost. Drivers may enforce additional per-packet 900eligibility checks (e.g. on packet size). 901 902``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` specifies the maximum number of bytes of a 903transmitted packet a driver can push directly to the underlying device 904('push' mode). Pushing some of the payload bytes to the device has the 905advantages of reducing latency for small packets by avoiding DMA mapping (same 906as ``ETHTOOL_A_RINGS_TX_PUSH`` parameter) as well as allowing the underlying 907device to process packet headers ahead of fetching its payload. 908This can help the device to make fast actions based on the packet's headers. 909This is similar to the "tx-copybreak" parameter, which copies the packet to a 910preallocated DMA memory area instead of mapping new memory. However, 911tx-push-buff parameter copies the packet directly to the device to allow the 912device to take faster actions on the packet. 913 914RINGS_SET 915========= 916 917Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request. 918 919Request contents: 920 921 ==================================== ====== =========================== 922 ``ETHTOOL_A_RINGS_HEADER`` nested reply header 923 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring 924 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring 925 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring 926 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring 927 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring 928 ``ETHTOOL_A_RINGS_CQE_SIZE`` u32 Size of TX/RX CQE 929 ``ETHTOOL_A_RINGS_TX_PUSH`` u8 flag of TX Push mode 930 ``ETHTOOL_A_RINGS_RX_PUSH`` u8 flag of RX Push mode 931 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` u32 size of TX push buffer 932 ==================================== ====== =========================== 933 934Kernel checks that requested ring sizes do not exceed limits reported by 935driver. Driver may impose additional constraints and may not suspport all 936attributes. 937 938 939``ETHTOOL_A_RINGS_CQE_SIZE`` specifies the completion queue event size. 940Completion queue events(CQE) are the events posted by NIC to indicate the 941completion status of a packet when the packet is sent(like send success or 942error) or received(like pointers to packet fragments). The CQE size parameter 943enables to modify the CQE size other than default size if NIC supports it. 944A bigger CQE can have more receive buffer pointers inturn NIC can transfer 945a bigger frame from wire. Based on the NIC hardware, the overall completion 946queue size can be adjusted in the driver if CQE size is modified. 947 948CHANNELS_GET 949============ 950 951Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request. 952 953Request contents: 954 955 ==================================== ====== ========================== 956 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header 957 ==================================== ====== ========================== 958 959Kernel response contents: 960 961 ===================================== ====== ========================== 962 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header 963 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels 964 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels 965 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels 966 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels 967 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count 968 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count 969 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count 970 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count 971 ===================================== ====== ========================== 972 973 974CHANNELS_SET 975============ 976 977Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request. 978 979Request contents: 980 981 ===================================== ====== ========================== 982 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header 983 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count 984 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count 985 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count 986 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count 987 ===================================== ====== ========================== 988 989Kernel checks that requested channel counts do not exceed limits reported by 990driver. Driver may impose additional constraints and may not suspport all 991attributes. 992 993 994COALESCE_GET 995============ 996 997Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request. 998 999Request contents: 1000 1001 ==================================== ====== ========================== 1002 ``ETHTOOL_A_COALESCE_HEADER`` nested request header 1003 ==================================== ====== ========================== 1004 1005Kernel response contents: 1006 1007 =========================================== ====== ======================= 1008 ``ETHTOOL_A_COALESCE_HEADER`` nested reply header 1009 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx 1010 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx 1011 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ 1012 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ 1013 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx 1014 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx 1015 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ 1016 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ 1017 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update 1018 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce 1019 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce 1020 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate 1021 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx 1022 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx 1023 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx 1024 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx 1025 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate 1026 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx 1027 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx 1028 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx 1029 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx 1030 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval 1031 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx 1032 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx 1033 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` u32 max aggr size, Tx 1034 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` u32 max aggr packets, Tx 1035 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` u32 time (us), aggr, Tx 1036 =========================================== ====== ======================= 1037 1038Attributes are only included in reply if their value is not zero or the 1039corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e. 1040they are declared as supported by driver). 1041 1042Timer reset mode (``ETHTOOL_A_COALESCE_USE_CQE_TX`` and 1043``ETHTOOL_A_COALESCE_USE_CQE_RX``) controls the interaction between packet 1044arrival and the various time based delay parameters. By default timers are 1045expected to limit the max delay between any packet arrival/departure and a 1046corresponding interrupt. In this mode timer should be started by packet 1047arrival (sometimes delivery of previous interrupt) and reset when interrupt 1048is delivered. 1049Setting the appropriate attribute to 1 will enable ``CQE`` mode, where 1050each packet event resets the timer. In this mode timer is used to force 1051the interrupt if queue goes idle, while busy queues depend on the packet 1052limit to trigger interrupts. 1053 1054Tx aggregation consists of copying frames into a contiguous buffer so that they 1055can be submitted as a single IO operation. ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` 1056describes the maximum size in bytes for the submitted buffer. 1057``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` describes the maximum number of frames 1058that can be aggregated into a single buffer. 1059``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` describes the amount of time in usecs, 1060counted since the first packet arrival in an aggregated block, after which the 1061block should be sent. 1062This feature is mainly of interest for specific USB devices which does not cope 1063well with frequent small-sized URBs transmissions. 1064 1065COALESCE_SET 1066============ 1067 1068Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request. 1069 1070Request contents: 1071 1072 =========================================== ====== ======================= 1073 ``ETHTOOL_A_COALESCE_HEADER`` nested request header 1074 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx 1075 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx 1076 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ 1077 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ 1078 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx 1079 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx 1080 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ 1081 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ 1082 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update 1083 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce 1084 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce 1085 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate 1086 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx 1087 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx 1088 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx 1089 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx 1090 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate 1091 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx 1092 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx 1093 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx 1094 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx 1095 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval 1096 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx 1097 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx 1098 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` u32 max aggr size, Tx 1099 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` u32 max aggr packets, Tx 1100 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` u32 time (us), aggr, Tx 1101 =========================================== ====== ======================= 1102 1103Request is rejected if it attributes declared as unsupported by driver (i.e. 1104such that the corresponding bit in ``ethtool_ops::supported_coalesce_params`` 1105is not set), regardless of their values. Driver may impose additional 1106constraints on coalescing parameters and their values. 1107 1108Compared to requests issued via the ``ioctl()`` netlink version of this request 1109will try harder to make sure that values specified by the user have been applied 1110and may call the driver twice. 1111 1112 1113PAUSE_GET 1114========= 1115 1116Gets pause frame settings like ``ETHTOOL_GPAUSEPARAM`` ioctl request. 1117 1118Request contents: 1119 1120 ===================================== ====== ========================== 1121 ``ETHTOOL_A_PAUSE_HEADER`` nested request header 1122 ``ETHTOOL_A_PAUSE_STATS_SRC`` u32 source of statistics 1123 ===================================== ====== ========================== 1124 1125``ETHTOOL_A_PAUSE_STATS_SRC`` is optional. It takes values from: 1126 1127.. kernel-doc:: include/uapi/linux/ethtool.h 1128 :identifiers: ethtool_mac_stats_src 1129 1130If absent from the request, stats will be provided with 1131an ``ETHTOOL_A_PAUSE_STATS_SRC`` attribute in the response equal to 1132``ETHTOOL_MAC_STATS_SRC_AGGREGATE``. 1133 1134Kernel response contents: 1135 1136 ===================================== ====== ========================== 1137 ``ETHTOOL_A_PAUSE_HEADER`` nested request header 1138 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation 1139 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames 1140 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames 1141 ``ETHTOOL_A_PAUSE_STATS`` nested pause statistics 1142 ===================================== ====== ========================== 1143 1144``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set 1145in ``ETHTOOL_A_HEADER_FLAGS``. 1146It will be empty if driver did not report any statistics. Drivers fill in 1147the statistics in the following structure: 1148 1149.. kernel-doc:: include/linux/ethtool.h 1150 :identifiers: ethtool_pause_stats 1151 1152Each member has a corresponding attribute defined. 1153 1154PAUSE_SET 1155========= 1156 1157Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request. 1158 1159Request contents: 1160 1161 ===================================== ====== ========================== 1162 ``ETHTOOL_A_PAUSE_HEADER`` nested request header 1163 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation 1164 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames 1165 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames 1166 ===================================== ====== ========================== 1167 1168 1169EEE_GET 1170======= 1171 1172Gets Energy Efficient Ethernet settings like ``ETHTOOL_GEEE`` ioctl request. 1173 1174Request contents: 1175 1176 ===================================== ====== ========================== 1177 ``ETHTOOL_A_EEE_HEADER`` nested request header 1178 ===================================== ====== ========================== 1179 1180Kernel response contents: 1181 1182 ===================================== ====== ========================== 1183 ``ETHTOOL_A_EEE_HEADER`` nested request header 1184 ``ETHTOOL_A_EEE_MODES_OURS`` bool supported/advertised modes 1185 ``ETHTOOL_A_EEE_MODES_PEER`` bool peer advertised link modes 1186 ``ETHTOOL_A_EEE_ACTIVE`` bool EEE is actively used 1187 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled 1188 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled 1189 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us) 1190 ===================================== ====== ========================== 1191 1192In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is 1193enabled, value of link modes for which EEE is advertised. Link modes for which 1194peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The 1195netlink interface allows reporting EEE status for all link modes but only 1196first 32 are provided by the ``ethtool_ops`` callback. 1197 1198 1199EEE_SET 1200======= 1201 1202Sets Energy Efficient Ethernet parameters like ``ETHTOOL_SEEE`` ioctl request. 1203 1204Request contents: 1205 1206 ===================================== ====== ========================== 1207 ``ETHTOOL_A_EEE_HEADER`` nested request header 1208 ``ETHTOOL_A_EEE_MODES_OURS`` bool advertised modes 1209 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled 1210 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled 1211 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us) 1212 ===================================== ====== ========================== 1213 1214``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise 1215EEE for (if there is no mask) or specify changes to the list (if there is 1216a mask). The netlink interface allows reporting EEE status for all link modes 1217but only first 32 can be set at the moment as that is what the ``ethtool_ops`` 1218callback supports. 1219 1220 1221TSINFO_GET 1222========== 1223 1224Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request. 1225 1226Request contents: 1227 1228 ===================================== ====== ========================== 1229 ``ETHTOOL_A_TSINFO_HEADER`` nested request header 1230 ===================================== ====== ========================== 1231 1232Kernel response contents: 1233 1234 ===================================== ====== ========================== 1235 ``ETHTOOL_A_TSINFO_HEADER`` nested request header 1236 ``ETHTOOL_A_TSINFO_TIMESTAMPING`` bitset SO_TIMESTAMPING flags 1237 ``ETHTOOL_A_TSINFO_TX_TYPES`` bitset supported Tx types 1238 ``ETHTOOL_A_TSINFO_RX_FILTERS`` bitset supported Rx filters 1239 ``ETHTOOL_A_TSINFO_PHC_INDEX`` u32 PTP hw clock index 1240 ``ETHTOOL_A_TSINFO_STATS`` nested HW timestamping statistics 1241 ===================================== ====== ========================== 1242 1243``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there 1244is no special value for this case). The bitset attributes are omitted if they 1245would be empty (no bit set). 1246 1247Additional hardware timestamping statistics response contents: 1248 1249 ===================================== ====== =================================== 1250 ``ETHTOOL_A_TS_STAT_TX_PKTS`` uint Packets with Tx HW timestamps 1251 ``ETHTOOL_A_TS_STAT_TX_LOST`` uint Tx HW timestamp not arrived count 1252 ``ETHTOOL_A_TS_STAT_TX_ERR`` uint HW error request Tx timestamp count 1253 ===================================== ====== =================================== 1254 1255CABLE_TEST 1256========== 1257 1258Start a cable test. 1259 1260Request contents: 1261 1262 ==================================== ====== ========================== 1263 ``ETHTOOL_A_CABLE_TEST_HEADER`` nested request header 1264 ==================================== ====== ========================== 1265 1266Notification contents: 1267 1268An Ethernet cable typically contains 1, 2 or 4 pairs. The length of 1269the pair can only be measured when there is a fault in the pair and 1270hence a reflection. Information about the fault may not be available, 1271depending on the specific hardware. Hence the contents of the notify 1272message are mostly optional. The attributes can be repeated an 1273arbitrary number of times, in an arbitrary order, for an arbitrary 1274number of pairs. 1275 1276The example shows the notification sent when the test is completed for 1277a T2 cable, i.e. two pairs. One pair is OK and hence has no length 1278information. The second pair has a fault and does have length 1279information. 1280 1281 +---------------------------------------------+--------+---------------------+ 1282 | ``ETHTOOL_A_CABLE_TEST_HEADER`` | nested | reply header | 1283 +---------------------------------------------+--------+---------------------+ 1284 | ``ETHTOOL_A_CABLE_TEST_STATUS`` | u8 | completed | 1285 +---------------------------------------------+--------+---------------------+ 1286 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST`` | nested | all the results | 1287 +-+-------------------------------------------+--------+---------------------+ 1288 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test result | 1289 +-+-+-----------------------------------------+--------+---------------------+ 1290 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1291 +-+-+-----------------------------------------+--------+---------------------+ 1292 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code | 1293 +-+-+-----------------------------------------+--------+---------------------+ 1294 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test results | 1295 +-+-+-----------------------------------------+--------+---------------------+ 1296 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1297 +-+-+-----------------------------------------+--------+---------------------+ 1298 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code | 1299 +-+-+-----------------------------------------+--------+---------------------+ 1300 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH`` | nested | cable length | 1301 +-+-+-----------------------------------------+--------+---------------------+ 1302 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR`` | u8 | pair number | 1303 +-+-+-----------------------------------------+--------+---------------------+ 1304 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM`` | u32 | length in cm | 1305 +-+-+-----------------------------------------+--------+---------------------+ 1306 1307CABLE_TEST TDR 1308============== 1309 1310Start a cable test and report raw TDR data 1311 1312Request contents: 1313 1314 +--------------------------------------------+--------+-----------------------+ 1315 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header | 1316 +--------------------------------------------+--------+-----------------------+ 1317 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG`` | nested | test configuration | 1318 +-+------------------------------------------+--------+-----------------------+ 1319 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | first data distance | 1320 +-+-+----------------------------------------+--------+-----------------------+ 1321 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | last data distance | 1322 +-+-+----------------------------------------+--------+-----------------------+ 1323 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step | 1324 +-+-+----------------------------------------+--------+-----------------------+ 1325 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR`` | u8 | pair to test | 1326 +-+-+----------------------------------------+--------+-----------------------+ 1327 1328The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members 1329of the nest. All distances are expressed in centimeters. The PHY takes 1330the distances as a guide, and rounds to the nearest distance it 1331actually supports. If a pair is passed, only that one pair will be 1332tested. Otherwise all pairs are tested. 1333 1334Notification contents: 1335 1336Raw TDR data is gathered by sending a pulse down the cable and 1337recording the amplitude of the reflected pulse for a given distance. 1338 1339It can take a number of seconds to collect TDR data, especial if the 1340full 100 meters is probed at 1 meter intervals. When the test is 1341started a notification will be sent containing just 1342ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value 1343ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED. 1344 1345When the test has completed a second notification will be sent 1346containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value 1347ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data. 1348 1349The message may optionally contain the amplitude of the pulse send 1350down the cable. This is measured in mV. A reflection should not be 1351bigger than transmitted pulse. 1352 1353Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP 1354nest containing information about the distance along the cable for the 1355first reading, the last reading, and the step between each 1356reading. Distances are measured in centimeters. These should be the 1357exact values the PHY used. These may be different to what the user 1358requested, if the native measurement resolution is greater than 1 cm. 1359 1360For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is 1361used to report the amplitude of the reflection for a given pair. 1362 1363 +---------------------------------------------+--------+----------------------+ 1364 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header | 1365 +---------------------------------------------+--------+----------------------+ 1366 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS`` | u8 | completed | 1367 +---------------------------------------------+--------+----------------------+ 1368 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST`` | nested | all the results | 1369 +-+-------------------------------------------+--------+----------------------+ 1370 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE`` | nested | TX Pulse amplitude | 1371 +-+-+-----------------------------------------+--------+----------------------+ 1372 | | | ``ETHTOOL_A_CABLE_PULSE_mV`` | s16 | Pulse amplitude | 1373 +-+-+-----------------------------------------+--------+----------------------+ 1374 | | ``ETHTOOL_A_CABLE_NEST_STEP`` | nested | TDR step info | 1375 +-+-+-----------------------------------------+--------+----------------------+ 1376 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | First data distance | 1377 +-+-+-----------------------------------------+--------+----------------------+ 1378 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | Last data distance | 1379 +-+-+-----------------------------------------+--------+----------------------+ 1380 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step| 1381 +-+-+-----------------------------------------+--------+----------------------+ 1382 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude | 1383 +-+-+-----------------------------------------+--------+----------------------+ 1384 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1385 +-+-+-----------------------------------------+--------+----------------------+ 1386 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude | 1387 +-+-+-----------------------------------------+--------+----------------------+ 1388 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude | 1389 +-+-+-----------------------------------------+--------+----------------------+ 1390 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1391 +-+-+-----------------------------------------+--------+----------------------+ 1392 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude | 1393 +-+-+-----------------------------------------+--------+----------------------+ 1394 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude | 1395 +-+-+-----------------------------------------+--------+----------------------+ 1396 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number | 1397 +-+-+-----------------------------------------+--------+----------------------+ 1398 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude | 1399 +-+-+-----------------------------------------+--------+----------------------+ 1400 1401TUNNEL_INFO 1402=========== 1403 1404Gets information about the tunnel state NIC is aware of. 1405 1406Request contents: 1407 1408 ===================================== ====== ========================== 1409 ``ETHTOOL_A_TUNNEL_INFO_HEADER`` nested request header 1410 ===================================== ====== ========================== 1411 1412Kernel response contents: 1413 1414 +---------------------------------------------+--------+---------------------+ 1415 | ``ETHTOOL_A_TUNNEL_INFO_HEADER`` | nested | reply header | 1416 +---------------------------------------------+--------+---------------------+ 1417 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS`` | nested | all UDP port tables | 1418 +-+-------------------------------------------+--------+---------------------+ 1419 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE`` | nested | one UDP port table | 1420 +-+-+-----------------------------------------+--------+---------------------+ 1421 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE`` | u32 | max size of the | 1422 | | | | | table | 1423 +-+-+-----------------------------------------+--------+---------------------+ 1424 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` | bitset | tunnel types which | 1425 | | | | | table can hold | 1426 +-+-+-----------------------------------------+--------+---------------------+ 1427 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY`` | nested | offloaded UDP port | 1428 +-+-+-+---------------------------------------+--------+---------------------+ 1429 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT`` | be16 | UDP port | 1430 +-+-+-+---------------------------------------+--------+---------------------+ 1431 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE`` | u32 | tunnel type | 1432 +-+-+-+---------------------------------------+--------+---------------------+ 1433 1434For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that 1435the table contains static entries, hard-coded by the NIC. 1436 1437FEC_GET 1438======= 1439 1440Gets FEC configuration and state like ``ETHTOOL_GFECPARAM`` ioctl request. 1441 1442Request contents: 1443 1444 ===================================== ====== ========================== 1445 ``ETHTOOL_A_FEC_HEADER`` nested request header 1446 ===================================== ====== ========================== 1447 1448Kernel response contents: 1449 1450 ===================================== ====== ========================== 1451 ``ETHTOOL_A_FEC_HEADER`` nested request header 1452 ``ETHTOOL_A_FEC_MODES`` bitset configured modes 1453 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection 1454 ``ETHTOOL_A_FEC_ACTIVE`` u32 index of active FEC mode 1455 ``ETHTOOL_A_FEC_STATS`` nested FEC statistics 1456 ===================================== ====== ========================== 1457 1458``ETHTOOL_A_FEC_ACTIVE`` is the bit index of the FEC link mode currently 1459active on the interface. This attribute may not be present if device does 1460not support FEC. 1461 1462``ETHTOOL_A_FEC_MODES`` and ``ETHTOOL_A_FEC_AUTO`` are only meaningful when 1463autonegotiation is disabled. If ``ETHTOOL_A_FEC_AUTO`` is non-zero driver will 1464select the FEC mode automatically based on the parameters of the SFP module. 1465This is equivalent to the ``ETHTOOL_FEC_AUTO`` bit of the ioctl interface. 1466``ETHTOOL_A_FEC_MODES`` carry the current FEC configuration using link mode 1467bits (rather than old ``ETHTOOL_FEC_*`` bits). 1468 1469``ETHTOOL_A_FEC_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in 1470``ETHTOOL_A_HEADER_FLAGS``. 1471Each attribute carries an array of 64bit statistics. First entry in the array 1472contains the total number of events on the port, while the following entries 1473are counters corresponding to lanes/PCS instances. The number of entries in 1474the array will be: 1475 1476+--------------+---------------------------------------------+ 1477| `0` | device does not support FEC statistics | 1478+--------------+---------------------------------------------+ 1479| `1` | device does not support per-lane break down | 1480+--------------+---------------------------------------------+ 1481| `1 + #lanes` | device has full support for FEC stats | 1482+--------------+---------------------------------------------+ 1483 1484Drivers fill in the statistics in the following structure: 1485 1486.. kernel-doc:: include/linux/ethtool.h 1487 :identifiers: ethtool_fec_stats 1488 1489FEC_SET 1490======= 1491 1492Sets FEC parameters like ``ETHTOOL_SFECPARAM`` ioctl request. 1493 1494Request contents: 1495 1496 ===================================== ====== ========================== 1497 ``ETHTOOL_A_FEC_HEADER`` nested request header 1498 ``ETHTOOL_A_FEC_MODES`` bitset configured modes 1499 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection 1500 ===================================== ====== ========================== 1501 1502``FEC_SET`` is only meaningful when autonegotiation is disabled. Otherwise 1503FEC mode is selected as part of autonegotiation. 1504 1505``ETHTOOL_A_FEC_MODES`` selects which FEC mode should be used. It's recommended 1506to set only one bit, if multiple bits are set driver may choose between them 1507in an implementation specific way. 1508 1509``ETHTOOL_A_FEC_AUTO`` requests the driver to choose FEC mode based on SFP 1510module parameters. This does not mean autonegotiation. 1511 1512MODULE_EEPROM_GET 1513================= 1514 1515Fetch module EEPROM data dump. 1516This interface is designed to allow dumps of at most 1/2 page at once. This 1517means only dumps of 128 (or less) bytes are allowed, without crossing half page 1518boundary located at offset 128. For pages other than 0 only high 128 bytes are 1519accessible. 1520 1521Request contents: 1522 1523 ======================================= ====== ========================== 1524 ``ETHTOOL_A_MODULE_EEPROM_HEADER`` nested request header 1525 ``ETHTOOL_A_MODULE_EEPROM_OFFSET`` u32 offset within a page 1526 ``ETHTOOL_A_MODULE_EEPROM_LENGTH`` u32 amount of bytes to read 1527 ``ETHTOOL_A_MODULE_EEPROM_PAGE`` u8 page number 1528 ``ETHTOOL_A_MODULE_EEPROM_BANK`` u8 bank number 1529 ``ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS`` u8 page I2C address 1530 ======================================= ====== ========================== 1531 1532If ``ETHTOOL_A_MODULE_EEPROM_BANK`` is not specified, bank 0 is assumed. 1533 1534Kernel response contents: 1535 1536 +---------------------------------------------+--------+---------------------+ 1537 | ``ETHTOOL_A_MODULE_EEPROM_HEADER`` | nested | reply header | 1538 +---------------------------------------------+--------+---------------------+ 1539 | ``ETHTOOL_A_MODULE_EEPROM_DATA`` | binary | array of bytes from | 1540 | | | module EEPROM | 1541 +---------------------------------------------+--------+---------------------+ 1542 1543``ETHTOOL_A_MODULE_EEPROM_DATA`` has an attribute length equal to the amount of 1544bytes driver actually read. 1545 1546STATS_GET 1547========= 1548 1549Get standard statistics for the interface. Note that this is not 1550a re-implementation of ``ETHTOOL_GSTATS`` which exposed driver-defined 1551stats. 1552 1553Request contents: 1554 1555 ======================================= ====== ========================== 1556 ``ETHTOOL_A_STATS_HEADER`` nested request header 1557 ``ETHTOOL_A_STATS_SRC`` u32 source of statistics 1558 ``ETHTOOL_A_STATS_GROUPS`` bitset requested groups of stats 1559 ======================================= ====== ========================== 1560 1561Kernel response contents: 1562 1563 +-----------------------------------+--------+--------------------------------+ 1564 | ``ETHTOOL_A_STATS_HEADER`` | nested | reply header | 1565 +-----------------------------------+--------+--------------------------------+ 1566 | ``ETHTOOL_A_STATS_SRC`` | u32 | source of statistics | 1567 +-----------------------------------+--------+--------------------------------+ 1568 | ``ETHTOOL_A_STATS_GRP`` | nested | one or more group of stats | 1569 +-+---------------------------------+--------+--------------------------------+ 1570 | | ``ETHTOOL_A_STATS_GRP_ID`` | u32 | group ID - ``ETHTOOL_STATS_*`` | 1571 +-+---------------------------------+--------+--------------------------------+ 1572 | | ``ETHTOOL_A_STATS_GRP_SS_ID`` | u32 | string set ID for names | 1573 +-+---------------------------------+--------+--------------------------------+ 1574 | | ``ETHTOOL_A_STATS_GRP_STAT`` | nested | nest containing a statistic | 1575 +-+---------------------------------+--------+--------------------------------+ 1576 | | ``ETHTOOL_A_STATS_GRP_HIST_RX`` | nested | histogram statistic (Rx) | 1577 +-+---------------------------------+--------+--------------------------------+ 1578 | | ``ETHTOOL_A_STATS_GRP_HIST_TX`` | nested | histogram statistic (Tx) | 1579 +-+---------------------------------+--------+--------------------------------+ 1580 1581Users specify which groups of statistics they are requesting via 1582the ``ETHTOOL_A_STATS_GROUPS`` bitset. Currently defined values are: 1583 1584 ====================== ======== =============================================== 1585 ETHTOOL_STATS_ETH_MAC eth-mac Basic IEEE 802.3 MAC statistics (30.3.1.1.*) 1586 ETHTOOL_STATS_ETH_PHY eth-phy Basic IEEE 802.3 PHY statistics (30.3.2.1.*) 1587 ETHTOOL_STATS_ETH_CTRL eth-ctrl Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*) 1588 ETHTOOL_STATS_RMON rmon RMON (RFC 2819) statistics 1589 ====================== ======== =============================================== 1590 1591Each group should have a corresponding ``ETHTOOL_A_STATS_GRP`` in the reply. 1592``ETHTOOL_A_STATS_GRP_ID`` identifies which group's statistics nest contains. 1593``ETHTOOL_A_STATS_GRP_SS_ID`` identifies the string set ID for the names of 1594the statistics in the group, if available. 1595 1596Statistics are added to the ``ETHTOOL_A_STATS_GRP`` nest under 1597``ETHTOOL_A_STATS_GRP_STAT``. ``ETHTOOL_A_STATS_GRP_STAT`` should contain 1598single 8 byte (u64) attribute inside - the type of that attribute is 1599the statistic ID and the value is the value of the statistic. 1600Each group has its own interpretation of statistic IDs. 1601Attribute IDs correspond to strings from the string set identified 1602by ``ETHTOOL_A_STATS_GRP_SS_ID``. Complex statistics (such as RMON histogram 1603entries) are also listed inside ``ETHTOOL_A_STATS_GRP`` and do not have 1604a string defined in the string set. 1605 1606RMON "histogram" counters count number of packets within given size range. 1607Because RFC does not specify the ranges beyond the standard 1518 MTU devices 1608differ in definition of buckets. For this reason the definition of packet ranges 1609is left to each driver. 1610 1611``ETHTOOL_A_STATS_GRP_HIST_RX`` and ``ETHTOOL_A_STATS_GRP_HIST_TX`` nests 1612contain the following attributes: 1613 1614 ================================= ====== =================================== 1615 ETHTOOL_A_STATS_RMON_HIST_BKT_LOW u32 low bound of the packet size bucket 1616 ETHTOOL_A_STATS_RMON_HIST_BKT_HI u32 high bound of the bucket 1617 ETHTOOL_A_STATS_RMON_HIST_VAL u64 packet counter 1618 ================================= ====== =================================== 1619 1620Low and high bounds are inclusive, for example: 1621 1622 ============================= ==== ==== 1623 RFC statistic low high 1624 ============================= ==== ==== 1625 etherStatsPkts64Octets 0 64 1626 etherStatsPkts512to1023Octets 512 1023 1627 ============================= ==== ==== 1628 1629``ETHTOOL_A_STATS_SRC`` is optional. Similar to ``PAUSE_GET``, it takes values 1630from ``enum ethtool_mac_stats_src``. If absent from the request, stats will be 1631provided with an ``ETHTOOL_A_STATS_SRC`` attribute in the response equal to 1632``ETHTOOL_MAC_STATS_SRC_AGGREGATE``. 1633 1634PHC_VCLOCKS_GET 1635=============== 1636 1637Query device PHC virtual clocks information. 1638 1639Request contents: 1640 1641 ==================================== ====== ========================== 1642 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested request header 1643 ==================================== ====== ========================== 1644 1645Kernel response contents: 1646 1647 ==================================== ====== ========================== 1648 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested reply header 1649 ``ETHTOOL_A_PHC_VCLOCKS_NUM`` u32 PHC virtual clocks number 1650 ``ETHTOOL_A_PHC_VCLOCKS_INDEX`` s32 PHC index array 1651 ==================================== ====== ========================== 1652 1653MODULE_GET 1654========== 1655 1656Gets transceiver module parameters. 1657 1658Request contents: 1659 1660 ===================================== ====== ========================== 1661 ``ETHTOOL_A_MODULE_HEADER`` nested request header 1662 ===================================== ====== ========================== 1663 1664Kernel response contents: 1665 1666 ====================================== ====== ========================== 1667 ``ETHTOOL_A_MODULE_HEADER`` nested reply header 1668 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy 1669 ``ETHTOOL_A_MODULE_POWER_MODE`` u8 operational power mode 1670 ====================================== ====== ========================== 1671 1672The optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute encodes the 1673transceiver module power mode policy enforced by the host. The default policy 1674is driver-dependent, but "auto" is the recommended default and it should be 1675implemented by new drivers and drivers where conformance to a legacy behavior 1676is not critical. 1677 1678The optional ``ETHTHOOL_A_MODULE_POWER_MODE`` attribute encodes the operational 1679power mode policy of the transceiver module. It is only reported when a module 1680is plugged-in. Possible values are: 1681 1682.. kernel-doc:: include/uapi/linux/ethtool.h 1683 :identifiers: ethtool_module_power_mode 1684 1685MODULE_SET 1686========== 1687 1688Sets transceiver module parameters. 1689 1690Request contents: 1691 1692 ====================================== ====== ========================== 1693 ``ETHTOOL_A_MODULE_HEADER`` nested request header 1694 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy 1695 ====================================== ====== ========================== 1696 1697When set, the optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute is used 1698to set the transceiver module power policy enforced by the host. Possible 1699values are: 1700 1701.. kernel-doc:: include/uapi/linux/ethtool.h 1702 :identifiers: ethtool_module_power_mode_policy 1703 1704For SFF-8636 modules, low power mode is forced by the host according to table 17056-10 in revision 2.10a of the specification. 1706 1707For CMIS modules, low power mode is forced by the host according to table 6-12 1708in revision 5.0 of the specification. 1709 1710PSE_GET 1711======= 1712 1713Gets PSE attributes. 1714 1715Request contents: 1716 1717 ===================================== ====== ========================== 1718 ``ETHTOOL_A_PSE_HEADER`` nested request header 1719 ===================================== ====== ========================== 1720 1721Kernel response contents: 1722 1723 ====================================== ====== ============================= 1724 ``ETHTOOL_A_PSE_HEADER`` nested reply header 1725 ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` u32 Operational state of the PoDL 1726 PSE functions 1727 ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` u32 power detection status of the 1728 PoDL PSE. 1729 ``ETHTOOL_A_C33_PSE_ADMIN_STATE`` u32 Operational state of the PoE 1730 PSE functions. 1731 ``ETHTOOL_A_C33_PSE_PW_D_STATUS`` u32 power detection status of the 1732 PoE PSE. 1733 ====================================== ====== ============================= 1734 1735When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` attribute identifies 1736the operational state of the PoDL PSE functions. The operational state of the 1737PSE function can be changed using the ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` 1738action. This option is corresponding to ``IEEE 802.3-2018`` 30.15.1.1.2 1739aPoDLPSEAdminState. Possible values are: 1740 1741.. kernel-doc:: include/uapi/linux/ethtool.h 1742 :identifiers: ethtool_podl_pse_admin_state 1743 1744The same goes for ``ETHTOOL_A_C33_PSE_ADMIN_STATE`` implementing 1745``IEEE 802.3-2022`` 30.9.1.1.2 aPSEAdminState. 1746 1747.. kernel-doc:: include/uapi/linux/ethtool.h 1748 :identifiers: ethtool_c33_pse_admin_state 1749 1750When set, the optional ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` attribute identifies 1751the power detection status of the PoDL PSE. The status depend on internal PSE 1752state machine and automatic PD classification support. This option is 1753corresponding to ``IEEE 802.3-2018`` 30.15.1.1.3 aPoDLPSEPowerDetectionStatus. 1754Possible values are: 1755 1756.. kernel-doc:: include/uapi/linux/ethtool.h 1757 :identifiers: ethtool_podl_pse_pw_d_status 1758 1759The same goes for ``ETHTOOL_A_C33_PSE_ADMIN_PW_D_STATUS`` implementing 1760``IEEE 802.3-2022`` 30.9.1.1.5 aPSEPowerDetectionStatus. 1761 1762.. kernel-doc:: include/uapi/linux/ethtool.h 1763 :identifiers: ethtool_c33_pse_pw_d_status 1764 1765PSE_SET 1766======= 1767 1768Sets PSE parameters. 1769 1770Request contents: 1771 1772 ====================================== ====== ============================= 1773 ``ETHTOOL_A_PSE_HEADER`` nested request header 1774 ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` u32 Control PoDL PSE Admin state 1775 ``ETHTOOL_A_C33_PSE_ADMIN_CONTROL`` u32 Control PSE Admin state 1776 ====================================== ====== ============================= 1777 1778When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` attribute is used 1779to control PoDL PSE Admin functions. This option is implementing 1780``IEEE 802.3-2018`` 30.15.1.2.1 acPoDLPSEAdminControl. See 1781``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` for supported values. 1782 1783The same goes for ``ETHTOOL_A_C33_PSE_ADMIN_CONTROL`` implementing 1784``IEEE 802.3-2022`` 30.9.1.2.1 acPSEAdminControl. 1785 1786RSS_GET 1787======= 1788 1789Get indirection table, hash key and hash function info associated with a 1790RSS context of an interface similar to ``ETHTOOL_GRSSH`` ioctl request. 1791 1792Request contents: 1793 1794===================================== ====== ========================== 1795 ``ETHTOOL_A_RSS_HEADER`` nested request header 1796 ``ETHTOOL_A_RSS_CONTEXT`` u32 context number 1797===================================== ====== ========================== 1798 1799Kernel response contents: 1800 1801===================================== ====== ========================== 1802 ``ETHTOOL_A_RSS_HEADER`` nested reply header 1803 ``ETHTOOL_A_RSS_HFUNC`` u32 RSS hash func 1804 ``ETHTOOL_A_RSS_INDIR`` binary Indir table bytes 1805 ``ETHTOOL_A_RSS_HKEY`` binary Hash key bytes 1806 ``ETHTOOL_A_RSS_INPUT_XFRM`` u32 RSS input data transformation 1807===================================== ====== ========================== 1808 1809ETHTOOL_A_RSS_HFUNC attribute is bitmap indicating the hash function 1810being used. Current supported options are toeplitz, xor or crc32. 1811ETHTOOL_A_RSS_INDIR attribute returns RSS indirection table where each byte 1812indicates queue number. 1813ETHTOOL_A_RSS_INPUT_XFRM attribute is a bitmap indicating the type of 1814transformation applied to the input protocol fields before given to the RSS 1815hfunc. Current supported option is symmetric-xor. 1816 1817PLCA_GET_CFG 1818============ 1819 1820Gets the IEEE 802.3cg-2019 Clause 148 Physical Layer Collision Avoidance 1821(PLCA) Reconciliation Sublayer (RS) attributes. 1822 1823Request contents: 1824 1825 ===================================== ====== ========================== 1826 ``ETHTOOL_A_PLCA_HEADER`` nested request header 1827 ===================================== ====== ========================== 1828 1829Kernel response contents: 1830 1831 ====================================== ====== ============================= 1832 ``ETHTOOL_A_PLCA_HEADER`` nested reply header 1833 ``ETHTOOL_A_PLCA_VERSION`` u16 Supported PLCA management 1834 interface standard/version 1835 ``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State 1836 ``ETHTOOL_A_PLCA_NODE_ID`` u32 PLCA unique local node ID 1837 ``ETHTOOL_A_PLCA_NODE_CNT`` u32 Number of PLCA nodes on the 1838 network, including the 1839 coordinator 1840 ``ETHTOOL_A_PLCA_TO_TMR`` u32 Transmit Opportunity Timer 1841 value in bit-times (BT) 1842 ``ETHTOOL_A_PLCA_BURST_CNT`` u32 Number of additional packets 1843 the node is allowed to send 1844 within a single TO 1845 ``ETHTOOL_A_PLCA_BURST_TMR`` u32 Time to wait for the MAC to 1846 transmit a new frame before 1847 terminating the burst 1848 ====================================== ====== ============================= 1849 1850When set, the optional ``ETHTOOL_A_PLCA_VERSION`` attribute indicates which 1851standard and version the PLCA management interface complies to. When not set, 1852the interface is vendor-specific and (possibly) supplied by the driver. 1853The OPEN Alliance SIG specifies a standard register map for 10BASE-T1S PHYs 1854embedding the PLCA Reconcialiation Sublayer. See "10BASE-T1S PLCA Management 1855Registers" at https://www.opensig.org/about/specifications/. 1856 1857When set, the optional ``ETHTOOL_A_PLCA_ENABLED`` attribute indicates the 1858administrative state of the PLCA RS. When not set, the node operates in "plain" 1859CSMA/CD mode. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.1 1860aPLCAAdminState / 30.16.1.2.1 acPLCAAdminControl. 1861 1862When set, the optional ``ETHTOOL_A_PLCA_NODE_ID`` attribute indicates the 1863configured local node ID of the PHY. This ID determines which transmit 1864opportunity (TO) is reserved for the node to transmit into. This option is 1865corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.4 aPLCALocalNodeID. The valid 1866range for this attribute is [0 .. 255] where 255 means "not configured". 1867 1868When set, the optional ``ETHTOOL_A_PLCA_NODE_CNT`` attribute indicates the 1869configured maximum number of PLCA nodes on the mixing-segment. This number 1870determines the total number of transmit opportunities generated during a 1871PLCA cycle. This attribute is relevant only for the PLCA coordinator, which is 1872the node with aPLCALocalNodeID set to 0. Follower nodes ignore this setting. 1873This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.3 1874aPLCANodeCount. The valid range for this attribute is [1 .. 255]. 1875 1876When set, the optional ``ETHTOOL_A_PLCA_TO_TMR`` attribute indicates the 1877configured value of the transmit opportunity timer in bit-times. This value 1878must be set equal across all nodes sharing the medium for PLCA to work 1879correctly. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.5 1880aPLCATransmitOpportunityTimer. The valid range for this attribute is 1881[0 .. 255]. 1882 1883When set, the optional ``ETHTOOL_A_PLCA_BURST_CNT`` attribute indicates the 1884configured number of extra packets that the node is allowed to send during a 1885single transmit opportunity. By default, this attribute is 0, meaning that 1886the node can only send a single frame per TO. When greater than 0, the PLCA RS 1887keeps the TO after any transmission, waiting for the MAC to send a new frame 1888for up to aPLCABurstTimer BTs. This can only happen a number of times per PLCA 1889cycle up to the value of this parameter. After that, the burst is over and the 1890normal counting of TOs resumes. This option is corresponding to 1891``IEEE 802.3cg-2019`` 30.16.1.1.6 aPLCAMaxBurstCount. The valid range for this 1892attribute is [0 .. 255]. 1893 1894When set, the optional ``ETHTOOL_A_PLCA_BURST_TMR`` attribute indicates how 1895many bit-times the PLCA RS waits for the MAC to initiate a new transmission 1896when aPLCAMaxBurstCount is greater than 0. If the MAC fails to send a new 1897frame within this time, the burst ends and the counting of TOs resumes. 1898Otherwise, the new frame is sent as part of the current burst. This option 1899is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.7 aPLCABurstTimer. The 1900valid range for this attribute is [0 .. 255]. Although, the value should be 1901set greater than the Inter-Frame-Gap (IFG) time of the MAC (plus some margin) 1902for PLCA burst mode to work as intended. 1903 1904PLCA_SET_CFG 1905============ 1906 1907Sets PLCA RS parameters. 1908 1909Request contents: 1910 1911 ====================================== ====== ============================= 1912 ``ETHTOOL_A_PLCA_HEADER`` nested request header 1913 ``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State 1914 ``ETHTOOL_A_PLCA_NODE_ID`` u8 PLCA unique local node ID 1915 ``ETHTOOL_A_PLCA_NODE_CNT`` u8 Number of PLCA nodes on the 1916 netkork, including the 1917 coordinator 1918 ``ETHTOOL_A_PLCA_TO_TMR`` u8 Transmit Opportunity Timer 1919 value in bit-times (BT) 1920 ``ETHTOOL_A_PLCA_BURST_CNT`` u8 Number of additional packets 1921 the node is allowed to send 1922 within a single TO 1923 ``ETHTOOL_A_PLCA_BURST_TMR`` u8 Time to wait for the MAC to 1924 transmit a new frame before 1925 terminating the burst 1926 ====================================== ====== ============================= 1927 1928For a description of each attribute, see ``PLCA_GET_CFG``. 1929 1930PLCA_GET_STATUS 1931=============== 1932 1933Gets PLCA RS status information. 1934 1935Request contents: 1936 1937 ===================================== ====== ========================== 1938 ``ETHTOOL_A_PLCA_HEADER`` nested request header 1939 ===================================== ====== ========================== 1940 1941Kernel response contents: 1942 1943 ====================================== ====== ============================= 1944 ``ETHTOOL_A_PLCA_HEADER`` nested reply header 1945 ``ETHTOOL_A_PLCA_STATUS`` u8 PLCA RS operational status 1946 ====================================== ====== ============================= 1947 1948When set, the ``ETHTOOL_A_PLCA_STATUS`` attribute indicates whether the node is 1949detecting the presence of the BEACON on the network. This flag is 1950corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.2 aPLCAStatus. 1951 1952MM_GET 1953====== 1954 1955Retrieve 802.3 MAC Merge parameters. 1956 1957Request contents: 1958 1959 ==================================== ====== ========================== 1960 ``ETHTOOL_A_MM_HEADER`` nested request header 1961 ==================================== ====== ========================== 1962 1963Kernel response contents: 1964 1965 ================================= ====== =================================== 1966 ``ETHTOOL_A_MM_HEADER`` nested request header 1967 ``ETHTOOL_A_MM_PMAC_ENABLED`` bool set if RX of preemptible and SMD-V 1968 frames is enabled 1969 ``ETHTOOL_A_MM_TX_ENABLED`` bool set if TX of preemptible frames is 1970 administratively enabled (might be 1971 inactive if verification failed) 1972 ``ETHTOOL_A_MM_TX_ACTIVE`` bool set if TX of preemptible frames is 1973 operationally enabled 1974 ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE`` u32 minimum size of transmitted 1975 non-final fragments, in octets 1976 ``ETHTOOL_A_MM_RX_MIN_FRAG_SIZE`` u32 minimum size of received non-final 1977 fragments, in octets 1978 ``ETHTOOL_A_MM_VERIFY_ENABLED`` bool set if TX of SMD-V frames is 1979 administratively enabled 1980 ``ETHTOOL_A_MM_VERIFY_STATUS`` u8 state of the verification function 1981 ``ETHTOOL_A_MM_VERIFY_TIME`` u32 delay between verification attempts 1982 ``ETHTOOL_A_MM_MAX_VERIFY_TIME``` u32 maximum verification interval 1983 supported by device 1984 ``ETHTOOL_A_MM_STATS`` nested IEEE 802.3-2018 subclause 30.14.1 1985 oMACMergeEntity statistics counters 1986 ================================= ====== =================================== 1987 1988The attributes are populated by the device driver through the following 1989structure: 1990 1991.. kernel-doc:: include/linux/ethtool.h 1992 :identifiers: ethtool_mm_state 1993 1994The ``ETHTOOL_A_MM_VERIFY_STATUS`` will report one of the values from 1995 1996.. kernel-doc:: include/uapi/linux/ethtool.h 1997 :identifiers: ethtool_mm_verify_status 1998 1999If ``ETHTOOL_A_MM_VERIFY_ENABLED`` was passed as false in the ``MM_SET`` 2000command, ``ETHTOOL_A_MM_VERIFY_STATUS`` will report either 2001``ETHTOOL_MM_VERIFY_STATUS_INITIAL`` or ``ETHTOOL_MM_VERIFY_STATUS_DISABLED``, 2002otherwise it should report one of the other states. 2003 2004It is recommended that drivers start with the pMAC disabled, and enable it upon 2005user space request. It is also recommended that user space does not depend upon 2006the default values from ``ETHTOOL_MSG_MM_GET`` requests. 2007 2008``ETHTOOL_A_MM_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in 2009``ETHTOOL_A_HEADER_FLAGS``. The attribute will be empty if driver did not 2010report any statistics. Drivers fill in the statistics in the following 2011structure: 2012 2013.. kernel-doc:: include/linux/ethtool.h 2014 :identifiers: ethtool_mm_stats 2015 2016MM_SET 2017====== 2018 2019Modifies the configuration of the 802.3 MAC Merge layer. 2020 2021Request contents: 2022 2023 ================================= ====== ========================== 2024 ``ETHTOOL_A_MM_VERIFY_TIME`` u32 see MM_GET description 2025 ``ETHTOOL_A_MM_VERIFY_ENABLED`` bool see MM_GET description 2026 ``ETHTOOL_A_MM_TX_ENABLED`` bool see MM_GET description 2027 ``ETHTOOL_A_MM_PMAC_ENABLED`` bool see MM_GET description 2028 ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE`` u32 see MM_GET description 2029 ================================= ====== ========================== 2030 2031The attributes are propagated to the driver through the following structure: 2032 2033.. kernel-doc:: include/linux/ethtool.h 2034 :identifiers: ethtool_mm_cfg 2035 2036Request translation 2037=================== 2038 2039The following table maps ioctl commands to netlink commands providing their 2040functionality. Entries with "n/a" in right column are commands which do not 2041have their netlink replacement yet. Entries which "n/a" in the left column 2042are netlink only. 2043 2044 =================================== ===================================== 2045 ioctl command netlink command 2046 =================================== ===================================== 2047 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET`` 2048 ``ETHTOOL_MSG_LINKMODES_GET`` 2049 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET`` 2050 ``ETHTOOL_MSG_LINKMODES_SET`` 2051 ``ETHTOOL_GDRVINFO`` n/a 2052 ``ETHTOOL_GREGS`` n/a 2053 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET`` 2054 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET`` 2055 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET`` 2056 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET`` 2057 ``ETHTOOL_NWAY_RST`` n/a 2058 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET`` 2059 ``ETHTOOL_GEEPROM`` n/a 2060 ``ETHTOOL_SEEPROM`` n/a 2061 ``ETHTOOL_GCOALESCE`` ``ETHTOOL_MSG_COALESCE_GET`` 2062 ``ETHTOOL_SCOALESCE`` ``ETHTOOL_MSG_COALESCE_SET`` 2063 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET`` 2064 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET`` 2065 ``ETHTOOL_GPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_GET`` 2066 ``ETHTOOL_SPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_SET`` 2067 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` 2068 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` 2069 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` 2070 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` 2071 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET`` 2072 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET`` 2073 ``ETHTOOL_TEST`` n/a 2074 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET`` 2075 ``ETHTOOL_PHYS_ID`` n/a 2076 ``ETHTOOL_GSTATS`` n/a 2077 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET`` 2078 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET`` 2079 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK`` 2080 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET`` 2081 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET`` 2082 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET`` 2083 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET`` 2084 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET`` 2085 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET`` 2086 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET`` 2087 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET`` 2088 ``ETHTOOL_GRXFH`` n/a 2089 ``ETHTOOL_SRXFH`` n/a 2090 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET`` 2091 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET`` 2092 ``ETHTOOL_GRXRINGS`` n/a 2093 ``ETHTOOL_GRXCLSRLCNT`` n/a 2094 ``ETHTOOL_GRXCLSRULE`` n/a 2095 ``ETHTOOL_GRXCLSRLALL`` n/a 2096 ``ETHTOOL_SRXCLSRLDEL`` n/a 2097 ``ETHTOOL_SRXCLSRLINS`` n/a 2098 ``ETHTOOL_FLASHDEV`` n/a 2099 ``ETHTOOL_RESET`` n/a 2100 ``ETHTOOL_SRXNTUPLE`` n/a 2101 ``ETHTOOL_GRXNTUPLE`` n/a 2102 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET`` 2103 ``ETHTOOL_GRXFHINDIR`` n/a 2104 ``ETHTOOL_SRXFHINDIR`` n/a 2105 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET`` 2106 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET`` 2107 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET`` 2108 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET`` 2109 ``ETHTOOL_SET_DUMP`` n/a 2110 ``ETHTOOL_GET_DUMP_FLAG`` n/a 2111 ``ETHTOOL_GET_DUMP_DATA`` n/a 2112 ``ETHTOOL_GET_TS_INFO`` ``ETHTOOL_MSG_TSINFO_GET`` 2113 ``ETHTOOL_GMODULEINFO`` ``ETHTOOL_MSG_MODULE_EEPROM_GET`` 2114 ``ETHTOOL_GMODULEEEPROM`` ``ETHTOOL_MSG_MODULE_EEPROM_GET`` 2115 ``ETHTOOL_GEEE`` ``ETHTOOL_MSG_EEE_GET`` 2116 ``ETHTOOL_SEEE`` ``ETHTOOL_MSG_EEE_SET`` 2117 ``ETHTOOL_GRSSH`` ``ETHTOOL_MSG_RSS_GET`` 2118 ``ETHTOOL_SRSSH`` n/a 2119 ``ETHTOOL_GTUNABLE`` n/a 2120 ``ETHTOOL_STUNABLE`` n/a 2121 ``ETHTOOL_GPHYSTATS`` n/a 2122 ``ETHTOOL_PERQUEUE`` n/a 2123 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET`` 2124 ``ETHTOOL_MSG_LINKMODES_GET`` 2125 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET`` 2126 ``ETHTOOL_MSG_LINKMODES_SET`` 2127 ``ETHTOOL_PHY_GTUNABLE`` n/a 2128 ``ETHTOOL_PHY_STUNABLE`` n/a 2129 ``ETHTOOL_GFECPARAM`` ``ETHTOOL_MSG_FEC_GET`` 2130 ``ETHTOOL_SFECPARAM`` ``ETHTOOL_MSG_FEC_SET`` 2131 n/a ``ETHTOOL_MSG_CABLE_TEST_ACT`` 2132 n/a ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT`` 2133 n/a ``ETHTOOL_MSG_TUNNEL_INFO_GET`` 2134 n/a ``ETHTOOL_MSG_PHC_VCLOCKS_GET`` 2135 n/a ``ETHTOOL_MSG_MODULE_GET`` 2136 n/a ``ETHTOOL_MSG_MODULE_SET`` 2137 n/a ``ETHTOOL_MSG_PLCA_GET_CFG`` 2138 n/a ``ETHTOOL_MSG_PLCA_SET_CFG`` 2139 n/a ``ETHTOOL_MSG_PLCA_GET_STATUS`` 2140 n/a ``ETHTOOL_MSG_MM_GET`` 2141 n/a ``ETHTOOL_MSG_MM_SET`` 2142 =================================== ===================================== 2143