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