Documentation/networking/ethtool-netlink.rst

   1 =============================
   2 Netlink interface for ethtool
   3 =============================
   4
   5
   6 Basic information
   7 =================
   8
   9 Netlink 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
  12 header). This family does not use a specific header, all information in
  13 requests and replies is passed using netlink attributes.
  14
  15 The ethtool netlink interface uses extended ACK for error and warning
  16 reporting, userspace application developers are encouraged to make these
  17 messages available to user in a suitable way.
  18
  19 Requests can be divided into three categories: "get" (retrieving information),
  20 "set" (setting parameters) and "action" (invoking an action).
  21
  22 All "set" and "action" type requests require admin privileges
  23 (``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for
  24 anyone but there are exceptions (where the response contains sensitive
  25 information). In some cases, the request as such is allowed for anyone but
  26 unprivileged users have attributes with sensitive information (e.g.
  27 wake-on-lan password) omitted.
  28
  29
  30 Conventions
  31 ===========
  32
  33 Attributes which represent a boolean value usually use NLA_U8 type so that we
  34 can distinguish three states: "on", "off" and "not present" (meaning the
  35 information is not available in "get" requests or value is not to be changed
  36 in "set" requests). For these attributes, the "true" value should be passed as
  37 number 1 but any non-zero value should be understood as "true" by recipient.
  38 In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way.
  39
  40 In the message structure descriptions below, if an attribute name is suffixed
  41 with "+", parent nest can contain multiple attributes of the same type. This
  42 implements an array of entries.
  43
  44
  45 Request header
  46 ==============
  47
  48 Each request or reply message contains a nested attribute with common header.
  49 Structure of this header is
  50
  51   ==============================  ======  =============================
  52   ``ETHTOOL_A_HEADER_DEV_INDEX``  u32     device ifindex
  53   ``ETHTOOL_A_HEADER_DEV_NAME``   string  device name
  54   ``ETHTOOL_A_HEADER_FLAGS``      u32     flags common for all requests
  55   ==============================  ======  =============================
  56
  57 ``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
  58 device message relates to. One of them is sufficient in requests, if both are
  59 used, they must identify the same device. Some requests, e.g. global string
  60 sets, do not require device identification. Most ``GET`` requests also allow
  61 dump requests without device identification to query the same information for
  62 all devices providing it (each device in a separate message).
  63
  64 ``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request
  65 types. The interpretation of these flags is the same for all request types but
  66 the flags may not apply to requests. Recognized flags are:
  67
  68   =================================  ===================================
  69   ``ETHTOOL_FLAG_COMPACT_BITSETS``   use compact format bitsets in reply
  70   ``ETHTOOL_FLAG_OMIT_REPLY``        omit optional reply (_SET and _ACT)
  71   =================================  ===================================
  72
  73 New request flags should follow the general idea that if the flag is not set,
  74 the behaviour is backward compatible, i.e. requests from old clients not aware
  75 of the flag should be interpreted the way the client expects. A client must
  76 not set flags it does not understand.
  77
  78
  79 Bit sets
  80 ========
  81
  82 For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
  83 type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
  84 attribute with contents of one of two forms: compact (two binary bitmaps
  85 representing bit values and mask of affected bits) and bit-by-bit (list of
  86 bits identified by either index or name).
  87
  88 Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
  89 with their values which saves a round trip (when the bitset is passed in a
  90 request) or at least a second request (when the bitset is in a reply). This is
  91 useful for one shot applications like traditional ethtool command. On the
  92 other hand, long running applications like ethtool monitor (displaying
  93 notifications) or network management daemons may prefer fetching the names
  94 only once and using compact form to save message size. Notifications from
  95 ethtool netlink interface always use compact form for bitsets.
  96
  97 A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
  98 not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
  99 modifying a bitmap, the former changes the bit set in mask to values set in
 100 value and preserves the rest; the latter sets the bits set in the bitmap and
 101 clears the rest.
 102
 103 Compact form: nested (bitset) atrribute contents:
 104
 105   ============================  ======  ============================
 106   ``ETHTOOL_A_BITSET_NOMASK``   flag    no mask, only a list
 107   ``ETHTOOL_A_BITSET_SIZE``     u32     number of significant bits
 108   ``ETHTOOL_A_BITSET_VALUE``    binary  bitmap of bit values
 109   ``ETHTOOL_A_BITSET_MASK``     binary  bitmap of valid bits
 110   ============================  ======  ============================
 111
 112 Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
 113 rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
 114 order, words ordered from least significant to most significant (i.e. the same
 115 way as bitmaps are passed with ioctl interface).
 116
 117 For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
 118 mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
 119 ``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
 120 if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
 121 allowed (bitset represents a single bitmap.
 122
 123 Kernel bit set length may differ from userspace length if older application is
 124 used on newer kernel or vice versa. If userspace bitmap is longer, an error is
 125 issued only if the request actually tries to set values of some bits not
 126 recognized by kernel.
 127
 128 Bit-by-bit form: nested (bitset) attribute contents:
 129
 130  +------------------------------------+--------+-----------------------------+
 131  | ``ETHTOOL_A_BITSET_NOMASK``        | flag   | no mask, only a list        |
 132  +------------------------------------+--------+-----------------------------+
 133  | ``ETHTOOL_A_BITSET_SIZE``          | u32    | number of significant bits  |
 134  +------------------------------------+--------+-----------------------------+
 135  | ``ETHTOOL_A_BITSET_BITS``          | nested | array of bits               |
 136  +-+----------------------------------+--------+-----------------------------+
 137  | | ``ETHTOOL_A_BITSET_BITS_BIT+``   | nested | one bit                     |
 138  +-+-+--------------------------------+--------+-----------------------------+
 139  | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32    | bit index (0 for LSB)       |
 140  +-+-+--------------------------------+--------+-----------------------------+
 141  | | | ``ETHTOOL_A_BITSET_BIT_NAME``  | string | bit name                    |
 142  +-+-+--------------------------------+--------+-----------------------------+
 143  | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag   | present if bit is set       |
 144  +-+-+--------------------------------+--------+-----------------------------+
 145
 146 Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
 147 only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
 148 arbitrary number of them.  A bit may be identified by its index or by its
 149 name. When used in requests, listed bits are set to 0 or 1 according to
 150 ``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if
 151 index exceeds kernel bit length or if name is not recognized.
 152
 153 When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
 154 a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
 155 such case. Such bitset represents a bitmap with listed bits set and the rest
 156 zero.
 157
 158 In requests, application can use either form. Form used by kernel in reply is
 159 determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
 160 header. Semantics of value and mask depends on the attribute.
 161
 162
 163 List of message types
 164 =====================
 165
 166 All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
 167 according to message purpose:
 168
 169   ==============    ======================================
 170   ``_GET``          userspace request to retrieve data
 171   ``_SET``          userspace request to set data
 172   ``_ACT``          userspace request to perform an action
 173   ``_GET_REPLY``    kernel reply to a ``GET`` request
 174   ``_SET_REPLY``    kernel reply to a ``SET`` request
 175   ``_ACT_REPLY``    kernel reply to an ``ACT`` request
 176   ``_NTF``          kernel notification
 177   ==============    ======================================
 178
 179 Userspace to kernel:
 180
 181   ===================================== ================================
 182   ``ETHTOOL_MSG_STRSET_GET``            get string set
 183   ``ETHTOOL_MSG_LINKINFO_GET``          get link settings
 184   ``ETHTOOL_MSG_LINKINFO_SET``          set link settings
 185   ``ETHTOOL_MSG_LINKMODES_GET``         get link modes info
 186   ``ETHTOOL_MSG_LINKMODES_SET``         set link modes info
 187   ``ETHTOOL_MSG_LINKSTATE_GET``         get link state
 188   ``ETHTOOL_MSG_DEBUG_GET``             get debugging settings
 189   ``ETHTOOL_MSG_DEBUG_SET``             set debugging settings
 190   ``ETHTOOL_MSG_WOL_GET``               get wake-on-lan settings
 191   ``ETHTOOL_MSG_WOL_SET``               set wake-on-lan settings
 192   ``ETHTOOL_MSG_FEATURES_GET``          get device features
 193   ``ETHTOOL_MSG_FEATURES_SET``          set device features
 194   ``ETHTOOL_MSG_PRIVFLAGS_GET``         get private flags
 195   ``ETHTOOL_MSG_PRIVFLAGS_SET``         set private flags
 196   ``ETHTOOL_MSG_RINGS_GET``             get ring sizes
 197   ``ETHTOOL_MSG_RINGS_SET``             set ring sizes
 198   ``ETHTOOL_MSG_CHANNELS_GET``          get channel counts
 199   ``ETHTOOL_MSG_CHANNELS_SET``          set channel counts
 200   ``ETHTOOL_MSG_COALESCE_GET``          get coalescing parameters
 201   ``ETHTOOL_MSG_COALESCE_SET``          set coalescing parameters
 202   ``ETHTOOL_MSG_PAUSE_GET``             get pause parameters
 203   ``ETHTOOL_MSG_PAUSE_SET``             set pause parameters
 204   ``ETHTOOL_MSG_EEE_GET``               get EEE settings
 205   ``ETHTOOL_MSG_EEE_SET``               set EEE settings
 206   ``ETHTOOL_MSG_TSINFO_GET``            get timestamping info
 207   ``ETHTOOL_MSG_CABLE_TEST_ACT``        action start cable test
 208   ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT``    action start raw TDR cable test
 209   ``ETHTOOL_MSG_TUNNEL_INFO_GET``       get tunnel offload info
 210   ===================================== ================================
 211
 212 Kernel to userspace:
 213
 214   ===================================== =================================
 215   ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents
 216   ``ETHTOOL_MSG_LINKINFO_GET_REPLY``    link settings
 217   ``ETHTOOL_MSG_LINKINFO_NTF``          link settings notification
 218   ``ETHTOOL_MSG_LINKMODES_GET_REPLY``   link modes info
 219   ``ETHTOOL_MSG_LINKMODES_NTF``         link modes notification
 220   ``ETHTOOL_MSG_LINKSTATE_GET_REPLY``   link state info
 221   ``ETHTOOL_MSG_DEBUG_GET_REPLY``       debugging settings
 222   ``ETHTOOL_MSG_DEBUG_NTF``             debugging settings notification
 223   ``ETHTOOL_MSG_WOL_GET_REPLY``         wake-on-lan settings
 224   ``ETHTOOL_MSG_WOL_NTF``               wake-on-lan settings notification
 225   ``ETHTOOL_MSG_FEATURES_GET_REPLY``    device features
 226   ``ETHTOOL_MSG_FEATURES_SET_REPLY``    optional reply to FEATURES_SET
 227   ``ETHTOOL_MSG_FEATURES_NTF``          netdev features notification
 228   ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY``   private flags
 229   ``ETHTOOL_MSG_PRIVFLAGS_NTF``         private flags
 230   ``ETHTOOL_MSG_RINGS_GET_REPLY``       ring sizes
 231   ``ETHTOOL_MSG_RINGS_NTF``             ring sizes
 232   ``ETHTOOL_MSG_CHANNELS_GET_REPLY``    channel counts
 233   ``ETHTOOL_MSG_CHANNELS_NTF``          channel counts
 234   ``ETHTOOL_MSG_COALESCE_GET_REPLY``    coalescing parameters
 235   ``ETHTOOL_MSG_COALESCE_NTF``          coalescing parameters
 236   ``ETHTOOL_MSG_PAUSE_GET_REPLY``       pause parameters
 237   ``ETHTOOL_MSG_PAUSE_NTF``             pause parameters
 238   ``ETHTOOL_MSG_EEE_GET_REPLY``         EEE settings
 239   ``ETHTOOL_MSG_EEE_NTF``               EEE settings
 240   ``ETHTOOL_MSG_TSINFO_GET_REPLY``      timestamping info
 241   ``ETHTOOL_MSG_CABLE_TEST_NTF``        Cable test results
 242   ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF``    Cable test TDR results
 243   ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY`` tunnel offload info
 244   ===================================== =================================
 245
 246 ``GET`` requests are sent by userspace applications to retrieve device
 247 information. They usually do not contain any message specific attributes.
 248 Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
 249 request with ``NLM_F_DUMP`` and no device identification can be used to query
 250 the information for all devices supporting the request.
 251
 252 If the data can be also modified, corresponding ``SET`` message with the same
 253 layout as corresponding ``GET_REPLY`` is used to request changes. Only
 254 attributes where a change is requested are included in such request (also, not
 255 all attributes may be changed). Replies to most ``SET`` request consist only
 256 of error code and extack; if kernel provides additional data, it is sent in
 257 the form of corresponding ``SET_REPLY`` message which can be suppressed by
 258 setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
 259
 260 Data modification also triggers sending a ``NTF`` message with a notification.
 261 These usually bear only a subset of attributes which was affected by the
 262 change. The same notification is issued if the data is modified using other
 263 means (mostly ioctl ethtool interface). Unlike notifications from ethtool
 264 netlink code which are only sent if something actually changed, notifications
 265 triggered by ioctl interface may be sent even if the request did not actually
 266 change any data.
 267
 268 ``ACT`` messages request kernel (driver) to perform a specific action. If some
 269 information is reported by kernel (which can be suppressed by setting
 270 ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
 271 an ``ACT_REPLY`` message. Performing an action also triggers a notification
 272 (``NTF`` message).
 273
 274 Later sections describe the format and semantics of these messages.
 275
 276
 277 STRSET_GET
 278 ==========
 279
 280 Requests contents of a string set as provided by ioctl commands
 281 ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
 282 writeable so that the corresponding ``STRSET_SET`` message is only used in
 283 kernel replies. There are two types of string sets: global (independent of
 284 a device, e.g. device feature names) and device specific (e.g. device private
 285 flags).
 286
 287 Request contents:
 288
 289  +---------------------------------------+--------+------------------------+
 290  | ``ETHTOOL_A_STRSET_HEADER``           | nested | request header         |
 291  +---------------------------------------+--------+------------------------+
 292  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | string set to request  |
 293  +-+-------------------------------------+--------+------------------------+
 294  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set         |
 295  +-+-+-----------------------------------+--------+------------------------+
 296  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                 |
 297  +-+-+-----------------------------------+--------+------------------------+
 298
 299 Kernel response contents:
 300
 301  +---------------------------------------+--------+-----------------------+
 302  | ``ETHTOOL_A_STRSET_HEADER``           | nested | reply header          |
 303  +---------------------------------------+--------+-----------------------+
 304  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | array of string sets  |
 305  +-+-------------------------------------+--------+-----------------------+
 306  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set        |
 307  +-+-+-----------------------------------+--------+-----------------------+
 308  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                |
 309  +-+-+-----------------------------------+--------+-----------------------+
 310  | | | ``ETHTOOL_A_STRINGSET_COUNT``     | u32    | number of strings     |
 311  +-+-+-----------------------------------+--------+-----------------------+
 312  | | | ``ETHTOOL_A_STRINGSET_STRINGS``   | nested | array of strings      |
 313  +-+-+-+---------------------------------+--------+-----------------------+
 314  | | | | ``ETHTOOL_A_STRINGS_STRING+``   | nested | one string            |
 315  +-+-+-+-+-------------------------------+--------+-----------------------+
 316  | | | | | ``ETHTOOL_A_STRING_INDEX``    | u32    | string index          |
 317  +-+-+-+-+-------------------------------+--------+-----------------------+
 318  | | | | | ``ETHTOOL_A_STRING_VALUE``    | string | string value          |
 319  +-+-+-+-+-------------------------------+--------+-----------------------+
 320  | ``ETHTOOL_A_STRSET_COUNTS_ONLY``      | flag   | return only counts    |
 321  +---------------------------------------+--------+-----------------------+
 322
 323 Device identification in request header is optional. Depending on its presence
 324 a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
 325
 326  - no ``NLM_F_DUMP,`` no device: get "global" stringsets
 327  - no ``NLM_F_DUMP``, with device: get string sets related to the device
 328  - ``NLM_F_DUMP``, no device: get device related string sets for all devices
 329
 330 If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
 331 requested type are returned, otherwise only those specified in the request.
 332 Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
 333 counts of the sets, not the actual strings.
 334
 335
 336 LINKINFO_GET
 337 ============
 338
 339 Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
 340 link modes and autonegotiation related information. The request does not use
 341 any attributes.
 342
 343 Request contents:
 344
 345   ====================================  ======  ==========================
 346   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 347   ====================================  ======  ==========================
 348
 349 Kernel response contents:
 350
 351   ====================================  ======  ==========================
 352   ``ETHTOOL_A_LINKINFO_HEADER``         nested  reply header
 353   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 354   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 355   ``ETHTOOL_A_LINKINFO_TP_MDIX``        u8      MDI(-X) status
 356   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 357   ``ETHTOOL_A_LINKINFO_TRANSCEIVER``    u8      transceiver
 358   ====================================  ======  ==========================
 359
 360 Attributes and their values have the same meaning as matching members of the
 361 corresponding ioctl structures.
 362
 363 ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
 364 devices supporting the request).
 365
 366
 367 LINKINFO_SET
 368 ============
 369
 370 ``LINKINFO_SET`` request allows setting some of the attributes reported by
 371 ``LINKINFO_GET``.
 372
 373 Request contents:
 374
 375   ====================================  ======  ==========================
 376   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 377   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 378   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 379   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 380   ====================================  ======  ==========================
 381
 382 MDI(-X) status and transceiver cannot be set, request with the corresponding
 383 attributes is rejected.
 384
 385
 386 LINKMODES_GET
 387 =============
 388
 389 Requests link modes (supported, advertised and peer advertised) and related
 390 information (autonegotiation status, link speed and duplex) as provided by
 391 ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
 392
 393 Request contents:
 394
 395   ====================================  ======  ==========================
 396   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 397   ====================================  ======  ==========================
 398
 399 Kernel response contents:
 400
 401   ==========================================  ======  ==========================
 402   ``ETHTOOL_A_LINKMODES_HEADER``              nested  reply header
 403   ``ETHTOOL_A_LINKMODES_AUTONEG``             u8      autonegotiation status
 404   ``ETHTOOL_A_LINKMODES_OURS``                bitset  advertised link modes
 405   ``ETHTOOL_A_LINKMODES_PEER``                bitset  partner link modes
 406   ``ETHTOOL_A_LINKMODES_SPEED``               u32     link speed (Mb/s)
 407   ``ETHTOOL_A_LINKMODES_DUPLEX``              u8      duplex mode
 408   ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG``    u8      Master/slave port mode
 409   ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE``  u8      Master/slave port state
 410   ==========================================  ======  ==========================
 411
 412 For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
 413 represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
 414 list.
 415
 416 ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
 417 devices supporting the request).
 418
 419
 420 LINKMODES_SET
 421 =============
 422
 423 Request contents:
 424
 425   ==========================================  ======  ==========================
 426   ``ETHTOOL_A_LINKMODES_HEADER``              nested  request header
 427   ``ETHTOOL_A_LINKMODES_AUTONEG``             u8      autonegotiation status
 428   ``ETHTOOL_A_LINKMODES_OURS``                bitset  advertised link modes
 429   ``ETHTOOL_A_LINKMODES_PEER``                bitset  partner link modes
 430   ``ETHTOOL_A_LINKMODES_SPEED``               u32     link speed (Mb/s)
 431   ``ETHTOOL_A_LINKMODES_DUPLEX``              u8      duplex mode
 432   ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG``    u8      Master/slave port mode
 433   ==========================================  ======  ==========================
 434
 435 ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
 436 autonegotiation is on (either set now or kept from before), advertised modes
 437 are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
 438 of speed and duplex is specified, kernel adjusts advertised modes to all
 439 supported modes matching speed, duplex or both (whatever is specified). This
 440 autoselection is done on ethtool side with ioctl interface, netlink interface
 441 is supposed to allow requesting changes without knowing what exactly kernel
 442 supports.
 443
 444
 445 LINKSTATE_GET
 446 =============
 447
 448 Requests link state information. Link up/down flag (as provided by
 449 ``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
 450 be provided as well. In general, extended state describes reasons for why a port
 451 is down, or why it operates in some non-obvious mode. This request does not have
 452 any attributes.
 453
 454 Request contents:
 455
 456   ====================================  ======  ==========================
 457   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  request header
 458   ====================================  ======  ==========================
 459
 460 Kernel response contents:
 461
 462   ====================================  ======  ============================
 463   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  reply header
 464   ``ETHTOOL_A_LINKSTATE_LINK``          bool    link state (up/down)
 465   ``ETHTOOL_A_LINKSTATE_SQI``           u32     Current Signal Quality Index
 466   ``ETHTOOL_A_LINKSTATE_SQI_MAX``       u32     Max support SQI value
 467   ``ETHTOOL_A_LINKSTATE_EXT_STATE``     u8      link extended state
 468   ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``  u8      link extended substate
 469   ====================================  ======  ============================
 470
 471 For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
 472 carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
 473 define their own handler.
 474
 475 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
 476 optional values. ethtool core can provide either both
 477 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
 478 or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
 479
 480 ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
 481 devices supporting the request).
 482
 483
 484 Link extended states:
 485
 486   ================================================      ============================================
 487   ``ETHTOOL_LINK_EXT_STATE_AUTONEG``                    States relating to the autonegotiation or
 488                                                         issues therein
 489
 490   ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE``      Failure during link training
 491
 492   ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH``      Logical mismatch in physical coding sublayer
 493                                                         or forward error correction sublayer
 494
 495   ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY``       Signal integrity issues
 496
 497   ``ETHTOOL_LINK_EXT_STATE_NO_CABLE``                   No cable connected
 498
 499   ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE``                Failure is related to cable,
 500                                                         e.g., unsupported cable
 501
 502   ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE``               Failure is related to EEPROM, e.g., failure
 503                                                         during reading or parsing the data
 504
 505   ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE``        Failure during calibration algorithm
 506
 507   ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED``      The hardware is not able to provide the
 508                                                         power required from cable or module
 509
 510   ``ETHTOOL_LINK_EXT_STATE_OVERHEAT``                   The module is overheated
 511   ================================================      ============================================
 512
 513 Link extended substates:
 514
 515   Autoneg substates:
 516
 517   ===============================================================   ================================
 518   ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED``              Peer side is down
 519
 520   ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED``                 Ack not received from peer side
 521
 522   ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED``        Next page exchange failed
 523
 524   ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE``   Peer side is down during force
 525                                                                     mode or there is no agreement of
 526                                                                     speed
 527
 528   ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE``     Forward error correction modes
 529                                                                     in both sides are mismatched
 530
 531   ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD``                           No Highest Common Denominator
 532   ===============================================================   ================================
 533
 534   Link training substates:
 535
 536   ===========================================================================   ====================
 537   ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED``                    Frames were not
 538                                                                                  recognized, the
 539                                                                                  lock failed
 540
 541   ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT``                       The lock did not
 542                                                                                  occur before
 543                                                                                  timeout
 544
 545   ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY``    Peer side did not
 546                                                                                  send ready signal
 547                                                                                  after training
 548                                                                                  process
 549
 550   ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT``                                  Remote side is not
 551                                                                                  ready yet
 552   ===========================================================================   ====================
 553
 554   Link logical mismatch substates:
 555
 556   ================================================================   ===============================
 557   ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK``   Physical coding sublayer was
 558                                                                      not locked in first phase -
 559                                                                      block lock
 560
 561   ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK``      Physical coding sublayer was
 562                                                                      not locked in second phase -
 563                                                                      alignment markers lock
 564
 565   ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS``     Physical coding sublayer did
 566                                                                      not get align status
 567
 568   ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED``             FC forward error correction is
 569                                                                      not locked
 570
 571   ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED``             RS forward error correction is
 572                                                                      not locked
 573   ================================================================   ===============================
 574
 575   Bad signal integrity substates:
 576
 577   =================================================================    =============================
 578   ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS``    Large number of physical
 579                                                                        errors
 580
 581   ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE``                   The system attempted to
 582                                                                        operate the cable at a rate
 583                                                                        that is not formally
 584                                                                        supported, which led to
 585                                                                        signal integrity issues
 586   =================================================================    =============================
 587
 588   Cable issue substates:
 589
 590   ===================================================   ============================================
 591   ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE``    Unsupported cable
 592
 593   ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE``   Cable test failure
 594   ===================================================   ============================================
 595
 596 DEBUG_GET
 597 =========
 598
 599 Requests debugging settings of a device. At the moment, only message mask is
 600 provided.
 601
 602 Request contents:
 603
 604   ====================================  ======  ==========================
 605   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 606   ====================================  ======  ==========================
 607
 608 Kernel response contents:
 609
 610   ====================================  ======  ==========================
 611   ``ETHTOOL_A_DEBUG_HEADER``            nested  reply header
 612   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 613   ====================================  ======  ==========================
 614
 615 The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
 616 provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
 617 interface. While it is called message level there for historical reasons, most
 618 drivers and almost all newer drivers use it as a mask of enabled message
 619 classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
 620 interface follows its actual use in practice.
 621
 622 ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
 623 devices supporting the request).
 624
 625
 626 DEBUG_SET
 627 =========
 628
 629 Set or update debugging settings of a device. At the moment, only message mask
 630 is supported.
 631
 632 Request contents:
 633
 634   ====================================  ======  ==========================
 635   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 636   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 637   ====================================  ======  ==========================
 638
 639 ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
 640 enabled debugging message types for the device.
 641
 642
 643 WOL_GET
 644 =======
 645
 646 Query device wake-on-lan settings. Unlike most "GET" type requests,
 647 ``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
 648 (potentially) provides SecureOn(tm) password which is confidential.
 649
 650 Request contents:
 651
 652   ====================================  ======  ==========================
 653   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 654   ====================================  ======  ==========================
 655
 656 Kernel response contents:
 657
 658   ====================================  ======  ==========================
 659   ``ETHTOOL_A_WOL_HEADER``              nested  reply header
 660   ``ETHTOOL_A_WOL_MODES``               bitset  mask of enabled WoL modes
 661   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 662   ====================================  ======  ==========================
 663
 664 In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
 665 device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
 666 included in reply if ``WAKE_MAGICSECURE`` mode is supported.
 667
 668
 669 WOL_SET
 670 =======
 671
 672 Set or update wake-on-lan settings.
 673
 674 Request contents:
 675
 676   ====================================  ======  ==========================
 677   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 678   ``ETHTOOL_A_WOL_MODES``               bitset  enabled WoL modes
 679   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 680   ====================================  ======  ==========================
 681
 682 ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
 683 ``WAKE_MAGICSECURE`` mode.
 684
 685
 686 FEATURES_GET
 687 ============
 688
 689 Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
 690
 691 Request contents:
 692
 693   ====================================  ======  ==========================
 694   ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
 695   ====================================  ======  ==========================
 696
 697 Kernel response contents:
 698
 699   ====================================  ======  ==========================
 700   ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
 701   ``ETHTOOL_A_FEATURES_HW``             bitset  dev->hw_features
 702   ``ETHTOOL_A_FEATURES_WANTED``         bitset  dev->wanted_features
 703   ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  dev->features
 704   ``ETHTOOL_A_FEATURES_NOCHANGE``       bitset  NETIF_F_NEVER_CHANGE
 705   ====================================  ======  ==========================
 706
 707 Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
 708 interference but attribute names are different (they are based on
 709 corresponding members of struct net_device). Legacy "flags" are not provided,
 710 if userspace needs them (most likely only ethtool for backward compatibility),
 711 it can calculate their values from related feature bits itself.
 712 ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
 713 provide all names when using verbose bitmap format), the other three use no
 714 mask (simple bit lists).
 715
 716
 717 FEATURES_SET
 718 ============
 719
 720 Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
 721
 722 Request contents:
 723
 724   ====================================  ======  ==========================
 725   ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
 726   ``ETHTOOL_A_FEATURES_WANTED``         bitset  requested features
 727   ====================================  ======  ==========================
 728
 729 Kernel response contents:
 730
 731   ====================================  ======  ==========================
 732   ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
 733   ``ETHTOOL_A_FEATURES_WANTED``         bitset  diff wanted vs. result
 734   ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  diff old vs. new active
 735   ====================================  ======  ==========================
 736
 737 Request constains only one bitset which can be either value/mask pair (request
 738 to change specific feature bits and leave the rest) or only a value (request
 739 to set all features to specified set).
 740
 741 As request is subject to netdev_change_features() sanity checks, optional
 742 kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
 743 header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
 744 reports the difference between client request and actual result: mask consists
 745 of bits which differ between requested features and result (dev->features
 746 after the operation), value consists of values of these bits in the request
 747 (i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
 748 reports the difference between old and new dev->features: mask consists of
 749 bits which have changed, values are their values in new dev->features (after
 750 the operation).
 751
 752 ``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
 753 are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
 754 request but also each time features are modified with netdev_update_features()
 755 or netdev_change_features().
 756
 757
 758 PRIVFLAGS_GET
 759 =============
 760
 761 Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
 762
 763 Request contents:
 764
 765   ====================================  ======  ==========================
 766   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
 767   ====================================  ======  ==========================
 768
 769 Kernel response contents:
 770
 771   ====================================  ======  ==========================
 772   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  reply header
 773   ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
 774   ====================================  ======  ==========================
 775
 776 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
 777 These flags are defined by driver, their number and names (and also meaning)
 778 are device dependent. For compact bitset format, names can be retrieved as
 779 ``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
 780 response uses all private flags supported by the device as mask so that client
 781 gets the full information without having to fetch the string set with names.
 782
 783
 784 PRIVFLAGS_SET
 785 =============
 786
 787 Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
 788 ioctl request.
 789
 790 Request contents:
 791
 792   ====================================  ======  ==========================
 793   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
 794   ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
 795   ====================================  ======  ==========================
 796
 797 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
 798 modify only values of some of them.
 799
 800
 801 RINGS_GET
 802 =========
 803
 804 Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
 805
 806 Request contents:
 807
 808   ====================================  ======  ==========================
 809   ``ETHTOOL_A_RINGS_HEADER``            nested  request header
 810   ====================================  ======  ==========================
 811
 812 Kernel response contents:
 813
 814   ====================================  ======  ==========================
 815   ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
 816   ``ETHTOOL_A_RINGS_RX_MAX``            u32     max size of RX ring
 817   ``ETHTOOL_A_RINGS_RX_MINI_MAX``       u32     max size of RX mini ring
 818   ``ETHTOOL_A_RINGS_RX_JUMBO_MAX``      u32     max size of RX jumbo ring
 819   ``ETHTOOL_A_RINGS_TX_MAX``            u32     max size of TX ring
 820   ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
 821   ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
 822   ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
 823   ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
 824   ====================================  ======  ==========================
 825
 826
 827 RINGS_SET
 828 =========
 829
 830 Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
 831
 832 Request contents:
 833
 834   ====================================  ======  ==========================
 835   ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
 836   ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
 837   ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
 838   ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
 839   ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
 840   ====================================  ======  ==========================
 841
 842 Kernel checks that requested ring sizes do not exceed limits reported by
 843 driver. Driver may impose additional constraints and may not suspport all
 844 attributes.
 845
 846
 847 CHANNELS_GET
 848 ============
 849
 850 Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
 851
 852 Request contents:
 853
 854   ====================================  ======  ==========================
 855   ``ETHTOOL_A_CHANNELS_HEADER``         nested  request header
 856   ====================================  ======  ==========================
 857
 858 Kernel response contents:
 859
 860   =====================================  ======  ==========================
 861   ``ETHTOOL_A_CHANNELS_HEADER``          nested  reply header
 862   ``ETHTOOL_A_CHANNELS_RX_MAX``          u32     max receive channels
 863   ``ETHTOOL_A_CHANNELS_TX_MAX``          u32     max transmit channels
 864   ``ETHTOOL_A_CHANNELS_OTHER_MAX``       u32     max other channels
 865   ``ETHTOOL_A_CHANNELS_COMBINED_MAX``    u32     max combined channels
 866   ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
 867   ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
 868   ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
 869   ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
 870   =====================================  ======  ==========================
 871
 872
 873 CHANNELS_SET
 874 ============
 875
 876 Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
 877
 878 Request contents:
 879
 880   =====================================  ======  ==========================
 881   ``ETHTOOL_A_CHANNELS_HEADER``          nested  request header
 882   ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
 883   ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
 884   ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
 885   ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
 886   =====================================  ======  ==========================
 887
 888 Kernel checks that requested channel counts do not exceed limits reported by
 889 driver. Driver may impose additional constraints and may not suspport all
 890 attributes.
 891
 892
 893 COALESCE_GET
 894 ============
 895
 896 Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
 897
 898 Request contents:
 899
 900   ====================================  ======  ==========================
 901   ``ETHTOOL_A_COALESCE_HEADER``         nested  request header
 902   ====================================  ======  ==========================
 903
 904 Kernel response contents:
 905
 906   ===========================================  ======  =======================
 907   ``ETHTOOL_A_COALESCE_HEADER``                nested  reply header
 908   ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
 909   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
 910   ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
 911   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
 912   ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
 913   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
 914   ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
 915   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
 916   ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
 917   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
 918   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
 919   ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
 920   ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
 921   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
 922   ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
 923   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
 924   ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
 925   ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
 926   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
 927   ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
 928   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
 929   ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
 930   ===========================================  ======  =======================
 931
 932 Attributes are only included in reply if their value is not zero or the
 933 corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
 934 they are declared as supported by driver).
 935
 936
 937 COALESCE_SET
 938 ============
 939
 940 Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
 941
 942 Request contents:
 943
 944   ===========================================  ======  =======================
 945   ``ETHTOOL_A_COALESCE_HEADER``                nested  request header
 946   ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
 947   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
 948   ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
 949   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
 950   ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
 951   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
 952   ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
 953   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
 954   ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
 955   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
 956   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
 957   ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
 958   ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
 959   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
 960   ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
 961   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
 962   ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
 963   ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
 964   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
 965   ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
 966   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
 967   ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
 968   ===========================================  ======  =======================
 969
 970 Request is rejected if it attributes declared as unsupported by driver (i.e.
 971 such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
 972 is not set), regardless of their values. Driver may impose additional
 973 constraints on coalescing parameters and their values.
 974
 975
 976 PAUSE_GET
 977 ============
 978
 979 Gets channel counts like ``ETHTOOL_GPAUSE`` ioctl request.
 980
 981 Request contents:
 982
 983   =====================================  ======  ==========================
 984   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
 985   =====================================  ======  ==========================
 986
 987 Kernel response contents:
 988
 989   =====================================  ======  ==========================
 990   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
 991   ``ETHTOOL_A_PAUSE_AUTONEG``            bool    pause autonegotiation
 992   ``ETHTOOL_A_PAUSE_RX``                 bool    receive pause frames
 993   ``ETHTOOL_A_PAUSE_TX``                 bool    transmit pause frames
 994   =====================================  ======  ==========================
 995
 996
 997 PAUSE_SET
 998 ============
 999
1000 Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1001
1002 Request contents:
1003
1004   =====================================  ======  ==========================
1005   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
1006   ``ETHTOOL_A_PAUSE_AUTONEG``            bool    pause autonegotiation
1007   ``ETHTOOL_A_PAUSE_RX``                 bool    receive pause frames
1008   ``ETHTOOL_A_PAUSE_TX``                 bool    transmit pause frames
1009   =====================================  ======  ==========================
1010
1011
1012 EEE_GET
1013 =======
1014
1015 Gets channel counts like ``ETHTOOL_GEEE`` ioctl request.
1016
1017 Request contents:
1018
1019   =====================================  ======  ==========================
1020   ``ETHTOOL_A_EEE_HEADER``               nested  request header
1021   =====================================  ======  ==========================
1022
1023 Kernel response contents:
1024
1025   =====================================  ======  ==========================
1026   ``ETHTOOL_A_EEE_HEADER``               nested  request header
1027   ``ETHTOOL_A_EEE_MODES_OURS``           bool    supported/advertised modes
1028   ``ETHTOOL_A_EEE_MODES_PEER``           bool    peer advertised link modes
1029   ``ETHTOOL_A_EEE_ACTIVE``               bool    EEE is actively used
1030   ``ETHTOOL_A_EEE_ENABLED``              bool    EEE is enabled
1031   ``ETHTOOL_A_EEE_TX_LPI_ENABLED``       bool    Tx lpi enabled
1032   ``ETHTOOL_A_EEE_TX_LPI_TIMER``         u32     Tx lpi timeout (in us)
1033   =====================================  ======  ==========================
1034
1035 In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
1036 enabled, value of link modes for which EEE is advertised. Link modes for which
1037 peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
1038 netlink interface allows reporting EEE status for all link modes but only
1039 first 32 are provided by the ``ethtool_ops`` callback.
1040
1041
1042 EEE_SET
1043 =======
1044
1045 Sets pause parameters like ``ETHTOOL_GEEEPARAM`` ioctl request.
1046
1047 Request contents:
1048
1049   =====================================  ======  ==========================
1050   ``ETHTOOL_A_EEE_HEADER``               nested  request header
1051   ``ETHTOOL_A_EEE_MODES_OURS``           bool    advertised modes
1052   ``ETHTOOL_A_EEE_ENABLED``              bool    EEE is enabled
1053   ``ETHTOOL_A_EEE_TX_LPI_ENABLED``       bool    Tx lpi enabled
1054   ``ETHTOOL_A_EEE_TX_LPI_TIMER``         u32     Tx lpi timeout (in us)
1055   =====================================  ======  ==========================
1056
1057 ``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
1058 EEE for (if there is no mask) or specify changes to the list (if there is
1059 a mask). The netlink interface allows reporting EEE status for all link modes
1060 but only first 32 can be set at the moment as that is what the ``ethtool_ops``
1061 callback supports.
1062
1063
1064 TSINFO_GET
1065 ==========
1066
1067 Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
1068
1069 Request contents:
1070
1071   =====================================  ======  ==========================
1072   ``ETHTOOL_A_TSINFO_HEADER``            nested  request header
1073   =====================================  ======  ==========================
1074
1075 Kernel response contents:
1076
1077   =====================================  ======  ==========================
1078   ``ETHTOOL_A_TSINFO_HEADER``            nested  request header
1079   ``ETHTOOL_A_TSINFO_TIMESTAMPING``      bitset  SO_TIMESTAMPING flags
1080   ``ETHTOOL_A_TSINFO_TX_TYPES``          bitset  supported Tx types
1081   ``ETHTOOL_A_TSINFO_RX_FILTERS``        bitset  supported Rx filters
1082   ``ETHTOOL_A_TSINFO_PHC_INDEX``         u32     PTP hw clock index
1083   =====================================  ======  ==========================
1084
1085 ``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
1086 is no special value for this case). The bitset attributes are omitted if they
1087 would be empty (no bit set).
1088
1089 CABLE_TEST
1090 ==========
1091
1092 Start a cable test.
1093
1094 Request contents:
1095
1096   ====================================  ======  ==========================
1097   ``ETHTOOL_A_CABLE_TEST_HEADER``       nested  request header
1098   ====================================  ======  ==========================
1099
1100 Notification contents:
1101
1102 An Ethernet cable typically contains 1, 2 or 4 pairs. The length of
1103 the pair can only be measured when there is a fault in the pair and
1104 hence a reflection. Information about the fault may not be available,
1105 depending on the specific hardware. Hence the contents of the notify
1106 message are mostly optional. The attributes can be repeated an
1107 arbitrary number of times, in an arbitrary order, for an arbitrary
1108 number of pairs.
1109
1110 The example shows the notification sent when the test is completed for
1111 a T2 cable, i.e. two pairs. One pair is OK and hence has no length
1112 information. The second pair has a fault and does have length
1113 information.
1114
1115  +---------------------------------------------+--------+---------------------+
1116  | ``ETHTOOL_A_CABLE_TEST_HEADER``             | nested | reply header        |
1117  +---------------------------------------------+--------+---------------------+
1118  | ``ETHTOOL_A_CABLE_TEST_STATUS``             | u8     | completed           |
1119  +---------------------------------------------+--------+---------------------+
1120  | ``ETHTOOL_A_CABLE_TEST_NTF_NEST``           | nested | all the results     |
1121  +-+-------------------------------------------+--------+---------------------+
1122  | | ``ETHTOOL_A_CABLE_NEST_RESULT``           | nested | cable test result   |
1123  +-+-+-----------------------------------------+--------+---------------------+
1124  | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number         |
1125  +-+-+-----------------------------------------+--------+---------------------+
1126  | | | ``ETHTOOL_A_CABLE_RESULTS_CODE``        | u8     | result code         |
1127  +-+-+-----------------------------------------+--------+---------------------+
1128  | | ``ETHTOOL_A_CABLE_NEST_RESULT``           | nested | cable test results  |
1129  +-+-+-----------------------------------------+--------+---------------------+
1130  | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number         |
1131  +-+-+-----------------------------------------+--------+---------------------+
1132  | | | ``ETHTOOL_A_CABLE_RESULTS_CODE``        | u8     | result code         |
1133  +-+-+-----------------------------------------+--------+---------------------+
1134  | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH``     | nested | cable length        |
1135  +-+-+-----------------------------------------+--------+---------------------+
1136  | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR``   | u8     | pair number         |
1137  +-+-+-----------------------------------------+--------+---------------------+
1138  | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM``     | u32    | length in cm        |
1139  +-+-+-----------------------------------------+--------+---------------------+
1140
1141 CABLE_TEST TDR
1142 ==============
1143
1144 Start a cable test and report raw TDR data
1145
1146 Request contents:
1147
1148  +--------------------------------------------+--------+-----------------------+
1149  | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER``        | nested | reply header          |
1150  +--------------------------------------------+--------+-----------------------+
1151  | ``ETHTOOL_A_CABLE_TEST_TDR_CFG``           | nested | test configuration    |
1152  +-+------------------------------------------+--------+-----------------------+
1153  | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE``  | u32    | first data distance   |
1154  +-+-+----------------------------------------+--------+-----------------------+
1155  | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE``   | u32    | last data distance    |
1156  +-+-+----------------------------------------+--------+-----------------------+
1157  | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE``   | u32    | distance of each step |
1158  +-+-+----------------------------------------+--------+-----------------------+
1159  | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR``    | u8     | pair to test          |
1160  +-+-+----------------------------------------+--------+-----------------------+
1161
1162 The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members
1163 of the nest. All distances are expressed in centimeters. The PHY takes
1164 the distances as a guide, and rounds to the nearest distance it
1165 actually supports. If a pair is passed, only that one pair will be
1166 tested. Otherwise all pairs are tested.
1167
1168 Notification contents:
1169
1170 Raw TDR data is gathered by sending a pulse down the cable and
1171 recording the amplitude of the reflected pulse for a given distance.
1172
1173 It can take a number of seconds to collect TDR data, especial if the
1174 full 100 meters is probed at 1 meter intervals. When the test is
1175 started a notification will be sent containing just
1176 ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1177 ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED.
1178
1179 When the test has completed a second notification will be sent
1180 containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1181 ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data.
1182
1183 The message may optionally contain the amplitude of the pulse send
1184 down the cable. This is measured in mV. A reflection should not be
1185 bigger than transmitted pulse.
1186
1187 Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP
1188 nest containing information about the distance along the cable for the
1189 first reading, the last reading, and the step between each
1190 reading. Distances are measured in centimeters. These should be the
1191 exact values the PHY used. These may be different to what the user
1192 requested, if the native measurement resolution is greater than 1 cm.
1193
1194 For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is
1195 used to report the amplitude of the reflection for a given pair.
1196
1197  +---------------------------------------------+--------+----------------------+
1198  | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER``         | nested | reply header         |
1199  +---------------------------------------------+--------+----------------------+
1200  | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS``         | u8     | completed            |
1201  +---------------------------------------------+--------+----------------------+
1202  | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST``       | nested | all the results      |
1203  +-+-------------------------------------------+--------+----------------------+
1204  | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE``        | nested | TX Pulse amplitude   |
1205  +-+-+-----------------------------------------+--------+----------------------+
1206  | | | ``ETHTOOL_A_CABLE_PULSE_mV``            | s16    | Pulse amplitude      |
1207  +-+-+-----------------------------------------+--------+----------------------+
1208  | | ``ETHTOOL_A_CABLE_NEST_STEP``             | nested | TDR step info        |
1209  +-+-+-----------------------------------------+--------+----------------------+
1210  | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32    | First data distance  |
1211  +-+-+-----------------------------------------+--------+----------------------+
1212  | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE``  | u32    | Last data distance   |
1213  +-+-+-----------------------------------------+--------+----------------------+
1214  | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE``  | u32    | distance of each step|
1215  +-+-+-----------------------------------------+--------+----------------------+
1216  | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE``    | nested | Reflection amplitude |
1217  +-+-+-----------------------------------------+--------+----------------------+
1218  | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number          |
1219  +-+-+-----------------------------------------+--------+----------------------+
1220  | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV``        | s16    | Reflection amplitude |
1221  +-+-+-----------------------------------------+--------+----------------------+
1222  | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE``    | nested | Reflection amplitude |
1223  +-+-+-----------------------------------------+--------+----------------------+
1224  | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number          |
1225  +-+-+-----------------------------------------+--------+----------------------+
1226  | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV``        | s16    | Reflection amplitude |
1227  +-+-+-----------------------------------------+--------+----------------------+
1228  | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE``    | nested | Reflection amplitude |
1229  +-+-+-----------------------------------------+--------+----------------------+
1230  | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number          |
1231  +-+-+-----------------------------------------+--------+----------------------+
1232  | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV``        | s16    | Reflection amplitude |
1233  +-+-+-----------------------------------------+--------+----------------------+
1234
1235 TUNNEL_INFO
1236 ===========
1237
1238 Gets information about the tunnel state NIC is aware of.
1239
1240 Request contents:
1241
1242   =====================================  ======  ==========================
1243   ``ETHTOOL_A_TUNNEL_INFO_HEADER``       nested  request header
1244   =====================================  ======  ==========================
1245
1246 Kernel response contents:
1247
1248  +---------------------------------------------+--------+---------------------+
1249  | ``ETHTOOL_A_TUNNEL_INFO_HEADER``            | nested | reply header        |
1250  +---------------------------------------------+--------+---------------------+
1251  | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS``         | nested | all UDP port tables |
1252  +-+-------------------------------------------+--------+---------------------+
1253  | | ``ETHTOOL_A_TUNNEL_UDP_TABLE``            | nested | one UDP port table  |
1254  +-+-+-----------------------------------------+--------+---------------------+
1255  | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE``     | u32    | max size of the     |
1256  | | |                                         |        | table               |
1257  +-+-+-----------------------------------------+--------+---------------------+
1258  | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES``    | bitset | tunnel types which  |
1259  | | |                                         |        | table can hold      |
1260  +-+-+-----------------------------------------+--------+---------------------+
1261  | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY``    | nested | offloaded UDP port  |
1262  +-+-+-+---------------------------------------+--------+---------------------+
1263  | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT``   | be16   | UDP port            |
1264  +-+-+-+---------------------------------------+--------+---------------------+
1265  | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE``   | u32    | tunnel type         |
1266  +-+-+-+---------------------------------------+--------+---------------------+
1267
1268 For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that
1269 the table contains static entries, hard-coded by the NIC.
1270
1271 Request translation
1272 ===================
1273
1274 The following table maps ioctl commands to netlink commands providing their
1275 functionality. Entries with "n/a" in right column are commands which do not
1276 have their netlink replacement yet. Entries which "n/a" in the left column
1277 are netlink only.
1278
1279   =================================== =====================================
1280   ioctl command                       netlink command
1281   =================================== =====================================
1282   ``ETHTOOL_GSET``                    ``ETHTOOL_MSG_LINKINFO_GET``
1283                                       ``ETHTOOL_MSG_LINKMODES_GET``
1284   ``ETHTOOL_SSET``                    ``ETHTOOL_MSG_LINKINFO_SET``
1285                                       ``ETHTOOL_MSG_LINKMODES_SET``
1286   ``ETHTOOL_GDRVINFO``                n/a
1287   ``ETHTOOL_GREGS``                   n/a
1288   ``ETHTOOL_GWOL``                    ``ETHTOOL_MSG_WOL_GET``
1289   ``ETHTOOL_SWOL``                    ``ETHTOOL_MSG_WOL_SET``
1290   ``ETHTOOL_GMSGLVL``                 ``ETHTOOL_MSG_DEBUG_GET``
1291   ``ETHTOOL_SMSGLVL``                 ``ETHTOOL_MSG_DEBUG_SET``
1292   ``ETHTOOL_NWAY_RST``                n/a
1293   ``ETHTOOL_GLINK``                   ``ETHTOOL_MSG_LINKSTATE_GET``
1294   ``ETHTOOL_GEEPROM``                 n/a
1295   ``ETHTOOL_SEEPROM``                 n/a
1296   ``ETHTOOL_GCOALESCE``               ``ETHTOOL_MSG_COALESCE_GET``
1297   ``ETHTOOL_SCOALESCE``               ``ETHTOOL_MSG_COALESCE_SET``
1298   ``ETHTOOL_GRINGPARAM``              ``ETHTOOL_MSG_RINGS_GET``
1299   ``ETHTOOL_SRINGPARAM``              ``ETHTOOL_MSG_RINGS_SET``
1300   ``ETHTOOL_GPAUSEPARAM``             ``ETHTOOL_MSG_PAUSE_GET``
1301   ``ETHTOOL_SPAUSEPARAM``             ``ETHTOOL_MSG_PAUSE_SET``
1302   ``ETHTOOL_GRXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
1303   ``ETHTOOL_SRXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
1304   ``ETHTOOL_GTXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
1305   ``ETHTOOL_STXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
1306   ``ETHTOOL_GSG``                     ``ETHTOOL_MSG_FEATURES_GET``
1307   ``ETHTOOL_SSG``                     ``ETHTOOL_MSG_FEATURES_SET``
1308   ``ETHTOOL_TEST``                    n/a
1309   ``ETHTOOL_GSTRINGS``                ``ETHTOOL_MSG_STRSET_GET``
1310   ``ETHTOOL_PHYS_ID``                 n/a
1311   ``ETHTOOL_GSTATS``                  n/a
1312   ``ETHTOOL_GTSO``                    ``ETHTOOL_MSG_FEATURES_GET``
1313   ``ETHTOOL_STSO``                    ``ETHTOOL_MSG_FEATURES_SET``
1314   ``ETHTOOL_GPERMADDR``               rtnetlink ``RTM_GETLINK``
1315   ``ETHTOOL_GUFO``                    ``ETHTOOL_MSG_FEATURES_GET``
1316   ``ETHTOOL_SUFO``                    ``ETHTOOL_MSG_FEATURES_SET``
1317   ``ETHTOOL_GGSO``                    ``ETHTOOL_MSG_FEATURES_GET``
1318   ``ETHTOOL_SGSO``                    ``ETHTOOL_MSG_FEATURES_SET``
1319   ``ETHTOOL_GFLAGS``                  ``ETHTOOL_MSG_FEATURES_GET``
1320   ``ETHTOOL_SFLAGS``                  ``ETHTOOL_MSG_FEATURES_SET``
1321   ``ETHTOOL_GPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_GET``
1322   ``ETHTOOL_SPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_SET``
1323   ``ETHTOOL_GRXFH``                   n/a
1324   ``ETHTOOL_SRXFH``                   n/a
1325   ``ETHTOOL_GGRO``                    ``ETHTOOL_MSG_FEATURES_GET``
1326   ``ETHTOOL_SGRO``                    ``ETHTOOL_MSG_FEATURES_SET``
1327   ``ETHTOOL_GRXRINGS``                n/a
1328   ``ETHTOOL_GRXCLSRLCNT``             n/a
1329   ``ETHTOOL_GRXCLSRULE``              n/a
1330   ``ETHTOOL_GRXCLSRLALL``             n/a
1331   ``ETHTOOL_SRXCLSRLDEL``             n/a
1332   ``ETHTOOL_SRXCLSRLINS``             n/a
1333   ``ETHTOOL_FLASHDEV``                n/a
1334   ``ETHTOOL_RESET``                   n/a
1335   ``ETHTOOL_SRXNTUPLE``               n/a
1336   ``ETHTOOL_GRXNTUPLE``               n/a
1337   ``ETHTOOL_GSSET_INFO``              ``ETHTOOL_MSG_STRSET_GET``
1338   ``ETHTOOL_GRXFHINDIR``              n/a
1339   ``ETHTOOL_SRXFHINDIR``              n/a
1340   ``ETHTOOL_GFEATURES``               ``ETHTOOL_MSG_FEATURES_GET``
1341   ``ETHTOOL_SFEATURES``               ``ETHTOOL_MSG_FEATURES_SET``
1342   ``ETHTOOL_GCHANNELS``               ``ETHTOOL_MSG_CHANNELS_GET``
1343   ``ETHTOOL_SCHANNELS``               ``ETHTOOL_MSG_CHANNELS_SET``
1344   ``ETHTOOL_SET_DUMP``                n/a
1345   ``ETHTOOL_GET_DUMP_FLAG``           n/a
1346   ``ETHTOOL_GET_DUMP_DATA``           n/a
1347   ``ETHTOOL_GET_TS_INFO``             ``ETHTOOL_MSG_TSINFO_GET``
1348   ``ETHTOOL_GMODULEINFO``             n/a
1349   ``ETHTOOL_GMODULEEEPROM``           n/a
1350   ``ETHTOOL_GEEE``                    ``ETHTOOL_MSG_EEE_GET``
1351   ``ETHTOOL_SEEE``                    ``ETHTOOL_MSG_EEE_SET``
1352   ``ETHTOOL_GRSSH``                   n/a
1353   ``ETHTOOL_SRSSH``                   n/a
1354   ``ETHTOOL_GTUNABLE``                n/a
1355   ``ETHTOOL_STUNABLE``                n/a
1356   ``ETHTOOL_GPHYSTATS``               n/a
1357   ``ETHTOOL_PERQUEUE``                n/a
1358   ``ETHTOOL_GLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_GET``
1359                                       ``ETHTOOL_MSG_LINKMODES_GET``
1360   ``ETHTOOL_SLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_SET``
1361                                       ``ETHTOOL_MSG_LINKMODES_SET``
1362   ``ETHTOOL_PHY_GTUNABLE``            n/a
1363   ``ETHTOOL_PHY_STUNABLE``            n/a
1364   ``ETHTOOL_GFECPARAM``               n/a
1365   ``ETHTOOL_SFECPARAM``               n/a
1366   n/a                                 ''ETHTOOL_MSG_CABLE_TEST_ACT''
1367   n/a                                 ''ETHTOOL_MSG_CABLE_TEST_TDR_ACT''
1368   n/a                                 ``ETHTOOL_MSG_TUNNEL_INFO_GET``
1369   =================================== =====================================