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