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