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