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