Documentation/networking/ethtool-netlink.rst

   1 =============================
   2 Netlink interface for ethtool
   3 =============================
   4
   5
   6 Basic information
   7 =================
   8
   9 Netlink interface for ethtool uses generic netlink family ``ethtool``
  10 (userspace application should use macros ``ETHTOOL_GENL_NAME`` and
  11 ``ETHTOOL_GENL_VERSION`` defined in ``<linux/ethtool_netlink.h>`` uapi
  12 header). This family does not use a specific header, all information in
  13 requests and replies is passed using netlink attributes.
  14
  15 The ethtool netlink interface uses extended ACK for error and warning
  16 reporting, userspace application developers are encouraged to make these
  17 messages available to user in a suitable way.
  18
  19 Requests can be divided into three categories: "get" (retrieving information),
  20 "set" (setting parameters) and "action" (invoking an action).
  21
  22 All "set" and "action" type requests require admin privileges
  23 (``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for
  24 anyone but there are exceptions (where the response contains sensitive
  25 information). In some cases, the request as such is allowed for anyone but
  26 unprivileged users have attributes with sensitive information (e.g.
  27 wake-on-lan password) omitted.
  28
  29
  30 Conventions
  31 ===========
  32
  33 Attributes which represent a boolean value usually use NLA_U8 type so that we
  34 can distinguish three states: "on", "off" and "not present" (meaning the
  35 information is not available in "get" requests or value is not to be changed
  36 in "set" requests). For these attributes, the "true" value should be passed as
  37 number 1 but any non-zero value should be understood as "true" by recipient.
  38 In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way.
  39
  40 In the message structure descriptions below, if an attribute name is suffixed
  41 with "+", parent nest can contain multiple attributes of the same type. This
  42 implements an array of entries.
  43
  44
  45 Request header
  46 ==============
  47
  48 Each request or reply message contains a nested attribute with common header.
  49 Structure of this header is
  50
  51   ==============================  ======  =============================
  52   ``ETHTOOL_A_HEADER_DEV_INDEX``  u32     device ifindex
  53   ``ETHTOOL_A_HEADER_DEV_NAME``   string  device name
  54   ``ETHTOOL_A_HEADER_FLAGS``      u32     flags common for all requests
  55   ==============================  ======  =============================
  56
  57 ``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
  58 device message relates to. One of them is sufficient in requests, if both are
  59 used, they must identify the same device. Some requests, e.g. global string
  60 sets, do not require device identification. Most ``GET`` requests also allow
  61 dump requests without device identification to query the same information for
  62 all devices providing it (each device in a separate message).
  63
  64 ``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request
  65 types. The interpretation of these flags is the same for all request types but
  66 the flags may not apply to requests. Recognized flags are:
  67
  68   =================================  ===================================
  69   ``ETHTOOL_FLAG_COMPACT_BITSETS``   use compact format bitsets in reply
  70   ``ETHTOOL_FLAG_OMIT_REPLY``        omit optional reply (_SET and _ACT)
  71   =================================  ===================================
  72
  73 New request flags should follow the general idea that if the flag is not set,
  74 the behaviour is backward compatible, i.e. requests from old clients not aware
  75 of the flag should be interpreted the way the client expects. A client must
  76 not set flags it does not understand.
  77
  78
  79 Bit sets
  80 ========
  81
  82 For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
  83 type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
  84 attribute with contents of one of two forms: compact (two binary bitmaps
  85 representing bit values and mask of affected bits) and bit-by-bit (list of
  86 bits identified by either index or name).
  87
  88 Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
  89 with their values which saves a round trip (when the bitset is passed in a
  90 request) or at least a second request (when the bitset is in a reply). This is
  91 useful for one shot applications like traditional ethtool command. On the
  92 other hand, long running applications like ethtool monitor (displaying
  93 notifications) or network management daemons may prefer fetching the names
  94 only once and using compact form to save message size. Notifications from
  95 ethtool netlink interface always use compact form for bitsets.
  96
  97 A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
  98 not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
  99 modifying a bitmap, the former changes the bit set in mask to values set in
 100 value and preserves the rest; the latter sets the bits set in the bitmap and
 101 clears the rest.
 102
 103 Compact form: nested (bitset) atrribute contents:
 104
 105   ============================  ======  ============================
 106   ``ETHTOOL_A_BITSET_NOMASK``   flag    no mask, only a list
 107   ``ETHTOOL_A_BITSET_SIZE``     u32     number of significant bits
 108   ``ETHTOOL_A_BITSET_VALUE``    binary  bitmap of bit values
 109   ``ETHTOOL_A_BITSET_MASK``     binary  bitmap of valid bits
 110   ============================  ======  ============================
 111
 112 Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
 113 rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
 114 order, words ordered from least significant to most significant (i.e. the same
 115 way as bitmaps are passed with ioctl interface).
 116
 117 For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
 118 mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
 119 ``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
 120 if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
 121 allowed (bitset represents a single bitmap.
 122
 123 Kernel bit set length may differ from userspace length if older application is
 124 used on newer kernel or vice versa. If userspace bitmap is longer, an error is
 125 issued only if the request actually tries to set values of some bits not
 126 recognized by kernel.
 127
 128 Bit-by-bit form: nested (bitset) attribute contents:
 129
 130  +------------------------------------+--------+-----------------------------+
 131  | ``ETHTOOL_A_BITSET_NOMASK``        | flag   | no mask, only a list        |
 132  +------------------------------------+--------+-----------------------------+
 133  | ``ETHTOOL_A_BITSET_SIZE``          | u32    | number of significant bits  |
 134  +------------------------------------+--------+-----------------------------+
 135  | ``ETHTOOL_A_BITSET_BITS``          | nested | array of bits               |
 136  +-+----------------------------------+--------+-----------------------------+
 137  | | ``ETHTOOL_A_BITSET_BITS_BIT+``   | nested | one bit                     |
 138  +-+-+--------------------------------+--------+-----------------------------+
 139  | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32    | bit index (0 for LSB)       |
 140  +-+-+--------------------------------+--------+-----------------------------+
 141  | | | ``ETHTOOL_A_BITSET_BIT_NAME``  | string | bit name                    |
 142  +-+-+--------------------------------+--------+-----------------------------+
 143  | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag   | present if bit is set       |
 144  +-+-+--------------------------------+--------+-----------------------------+
 145
 146 Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
 147 only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
 148 arbitrary number of them.  A bit may be identified by its index or by its
 149 name. When used in requests, listed bits are set to 0 or 1 according to
 150 ``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if
 151 index exceeds kernel bit length or if name is not recognized.
 152
 153 When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
 154 a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
 155 such case. Such bitset represents a bitmap with listed bits set and the rest
 156 zero.
 157
 158 In requests, application can use either form. Form used by kernel in reply is
 159 determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
 160 header. Semantics of value and mask depends on the attribute.
 161
 162
 163 List of message types
 164 =====================
 165
 166 All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
 167 according to message purpose:
 168
 169   ==============    ======================================
 170   ``_GET``          userspace request to retrieve data
 171   ``_SET``          userspace request to set data
 172   ``_ACT``          userspace request to perform an action
 173   ``_GET_REPLY``    kernel reply to a ``GET`` request
 174   ``_SET_REPLY``    kernel reply to a ``SET`` request
 175   ``_ACT_REPLY``    kernel reply to an ``ACT`` request
 176   ``_NTF``          kernel notification
 177   ==============    ======================================
 178
 179 Userspace to kernel:
 180
 181   ===================================== ================================
 182   ``ETHTOOL_MSG_STRSET_GET``            get string set
 183   ``ETHTOOL_MSG_LINKINFO_GET``          get link settings
 184   ``ETHTOOL_MSG_LINKINFO_SET``          set link settings
 185   ``ETHTOOL_MSG_LINKMODES_GET``         get link modes info
 186   ``ETHTOOL_MSG_LINKMODES_SET``         set link modes info
 187   ``ETHTOOL_MSG_LINKSTATE_GET``         get link state
 188   ``ETHTOOL_MSG_DEBUG_GET``             get debugging settings
 189   ``ETHTOOL_MSG_DEBUG_SET``             set debugging settings
 190   ``ETHTOOL_MSG_WOL_GET``               get wake-on-lan settings
 191   ``ETHTOOL_MSG_WOL_SET``               set wake-on-lan settings
 192   ``ETHTOOL_MSG_FEATURES_GET``          get device features
 193   ``ETHTOOL_MSG_FEATURES_SET``          set device features
 194   ``ETHTOOL_MSG_PRIVFLAGS_GET``         get private flags
 195   ``ETHTOOL_MSG_PRIVFLAGS_SET``         set private flags
 196   ``ETHTOOL_MSG_RINGS_GET``             get ring sizes
 197   ``ETHTOOL_MSG_RINGS_SET``             set ring sizes
 198   ``ETHTOOL_MSG_CHANNELS_GET``          get channel counts
 199   ``ETHTOOL_MSG_CHANNELS_SET``          set channel counts
 200   ``ETHTOOL_MSG_COALESCE_GET``          get coalescing parameters
 201   ``ETHTOOL_MSG_COALESCE_SET``          set coalescing parameters
 202   ``ETHTOOL_MSG_PAUSE_GET``             get pause parameters
 203   ``ETHTOOL_MSG_PAUSE_SET``             set pause parameters
 204   ``ETHTOOL_MSG_EEE_GET``               get EEE settings
 205   ``ETHTOOL_MSG_EEE_SET``               set EEE settings
 206   ``ETHTOOL_MSG_TSINFO_GET``            get timestamping info
 207   ===================================== ================================
 208
 209 Kernel to userspace:
 210
 211   ===================================== =================================
 212   ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents
 213   ``ETHTOOL_MSG_LINKINFO_GET_REPLY``    link settings
 214   ``ETHTOOL_MSG_LINKINFO_NTF``          link settings notification
 215   ``ETHTOOL_MSG_LINKMODES_GET_REPLY``   link modes info
 216   ``ETHTOOL_MSG_LINKMODES_NTF``         link modes notification
 217   ``ETHTOOL_MSG_LINKSTATE_GET_REPLY``   link state info
 218   ``ETHTOOL_MSG_DEBUG_GET_REPLY``       debugging settings
 219   ``ETHTOOL_MSG_DEBUG_NTF``             debugging settings notification
 220   ``ETHTOOL_MSG_WOL_GET_REPLY``         wake-on-lan settings
 221   ``ETHTOOL_MSG_WOL_NTF``               wake-on-lan settings notification
 222   ``ETHTOOL_MSG_FEATURES_GET_REPLY``    device features
 223   ``ETHTOOL_MSG_FEATURES_SET_REPLY``    optional reply to FEATURES_SET
 224   ``ETHTOOL_MSG_FEATURES_NTF``          netdev features notification
 225   ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY``   private flags
 226   ``ETHTOOL_MSG_PRIVFLAGS_NTF``         private flags
 227   ``ETHTOOL_MSG_RINGS_GET_REPLY``       ring sizes
 228   ``ETHTOOL_MSG_RINGS_NTF``             ring sizes
 229   ``ETHTOOL_MSG_CHANNELS_GET_REPLY``    channel counts
 230   ``ETHTOOL_MSG_CHANNELS_NTF``          channel counts
 231   ``ETHTOOL_MSG_COALESCE_GET_REPLY``    coalescing parameters
 232   ``ETHTOOL_MSG_COALESCE_NTF``          coalescing parameters
 233   ``ETHTOOL_MSG_PAUSE_GET_REPLY``       pause parameters
 234   ``ETHTOOL_MSG_PAUSE_NTF``             pause parameters
 235   ``ETHTOOL_MSG_EEE_GET_REPLY``         EEE settings
 236   ``ETHTOOL_MSG_EEE_NTF``               EEE settings
 237   ``ETHTOOL_MSG_TSINFO_GET_REPLY``      timestamping info
 238   ===================================== =================================
 239
 240 ``GET`` requests are sent by userspace applications to retrieve device
 241 information. They usually do not contain any message specific attributes.
 242 Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
 243 request with ``NLM_F_DUMP`` and no device identification can be used to query
 244 the information for all devices supporting the request.
 245
 246 If the data can be also modified, corresponding ``SET`` message with the same
 247 layout as corresponding ``GET_REPLY`` is used to request changes. Only
 248 attributes where a change is requested are included in such request (also, not
 249 all attributes may be changed). Replies to most ``SET`` request consist only
 250 of error code and extack; if kernel provides additional data, it is sent in
 251 the form of corresponding ``SET_REPLY`` message which can be suppressed by
 252 setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
 253
 254 Data modification also triggers sending a ``NTF`` message with a notification.
 255 These usually bear only a subset of attributes which was affected by the
 256 change. The same notification is issued if the data is modified using other
 257 means (mostly ioctl ethtool interface). Unlike notifications from ethtool
 258 netlink code which are only sent if something actually changed, notifications
 259 triggered by ioctl interface may be sent even if the request did not actually
 260 change any data.
 261
 262 ``ACT`` messages request kernel (driver) to perform a specific action. If some
 263 information is reported by kernel (which can be suppressed by setting
 264 ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
 265 an ``ACT_REPLY`` message. Performing an action also triggers a notification
 266 (``NTF`` message).
 267
 268 Later sections describe the format and semantics of these messages.
 269
 270
 271 STRSET_GET
 272 ==========
 273
 274 Requests contents of a string set as provided by ioctl commands
 275 ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
 276 writeable so that the corresponding ``STRSET_SET`` message is only used in
 277 kernel replies. There are two types of string sets: global (independent of
 278 a device, e.g. device feature names) and device specific (e.g. device private
 279 flags).
 280
 281 Request contents:
 282
 283  +---------------------------------------+--------+------------------------+
 284  | ``ETHTOOL_A_STRSET_HEADER``           | nested | request header         |
 285  +---------------------------------------+--------+------------------------+
 286  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | string set to request  |
 287  +-+-------------------------------------+--------+------------------------+
 288  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set         |
 289  +-+-+-----------------------------------+--------+------------------------+
 290  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                 |
 291  +-+-+-----------------------------------+--------+------------------------+
 292
 293 Kernel response contents:
 294
 295  +---------------------------------------+--------+-----------------------+
 296  | ``ETHTOOL_A_STRSET_HEADER``           | nested | reply header          |
 297  +---------------------------------------+--------+-----------------------+
 298  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | array of string sets  |
 299  +-+-------------------------------------+--------+-----------------------+
 300  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set        |
 301  +-+-+-----------------------------------+--------+-----------------------+
 302  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                |
 303  +-+-+-----------------------------------+--------+-----------------------+
 304  | | | ``ETHTOOL_A_STRINGSET_COUNT``     | u32    | number of strings     |
 305  +-+-+-----------------------------------+--------+-----------------------+
 306  | | | ``ETHTOOL_A_STRINGSET_STRINGS``   | nested | array of strings      |
 307  +-+-+-+---------------------------------+--------+-----------------------+
 308  | | | | ``ETHTOOL_A_STRINGS_STRING+``   | nested | one string            |
 309  +-+-+-+-+-------------------------------+--------+-----------------------+
 310  | | | | | ``ETHTOOL_A_STRING_INDEX``    | u32    | string index          |
 311  +-+-+-+-+-------------------------------+--------+-----------------------+
 312  | | | | | ``ETHTOOL_A_STRING_VALUE``    | string | string value          |
 313  +-+-+-+-+-------------------------------+--------+-----------------------+
 314  | ``ETHTOOL_A_STRSET_COUNTS_ONLY``      | flag   | return only counts    |
 315  +---------------------------------------+--------+-----------------------+
 316
 317 Device identification in request header is optional. Depending on its presence
 318 a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
 319
 320  - no ``NLM_F_DUMP,`` no device: get "global" stringsets
 321  - no ``NLM_F_DUMP``, with device: get string sets related to the device
 322  - ``NLM_F_DUMP``, no device: get device related string sets for all devices
 323
 324 If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
 325 requested type are returned, otherwise only those specified in the request.
 326 Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
 327 counts of the sets, not the actual strings.
 328
 329
 330 LINKINFO_GET
 331 ============
 332
 333 Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
 334 link modes and autonegotiation related information. The request does not use
 335 any attributes.
 336
 337 Request contents:
 338
 339   ====================================  ======  ==========================
 340   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 341   ====================================  ======  ==========================
 342
 343 Kernel response contents:
 344
 345   ====================================  ======  ==========================
 346   ``ETHTOOL_A_LINKINFO_HEADER``         nested  reply header
 347   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 348   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 349   ``ETHTOOL_A_LINKINFO_TP_MDIX``        u8      MDI(-X) status
 350   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 351   ``ETHTOOL_A_LINKINFO_TRANSCEIVER``    u8      transceiver
 352   ====================================  ======  ==========================
 353
 354 Attributes and their values have the same meaning as matching members of the
 355 corresponding ioctl structures.
 356
 357 ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
 358 devices supporting the request).
 359
 360
 361 LINKINFO_SET
 362 ============
 363
 364 ``LINKINFO_SET`` request allows setting some of the attributes reported by
 365 ``LINKINFO_GET``.
 366
 367 Request contents:
 368
 369   ====================================  ======  ==========================
 370   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 371   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 372   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 373   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 374   ====================================  ======  ==========================
 375
 376 MDI(-X) status and transceiver cannot be set, request with the corresponding
 377 attributes is rejected.
 378
 379
 380 LINKMODES_GET
 381 =============
 382
 383 Requests link modes (supported, advertised and peer advertised) and related
 384 information (autonegotiation status, link speed and duplex) as provided by
 385 ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
 386
 387 Request contents:
 388
 389   ====================================  ======  ==========================
 390   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 391   ====================================  ======  ==========================
 392
 393 Kernel response contents:
 394
 395   ====================================  ======  ==========================
 396   ``ETHTOOL_A_LINKMODES_HEADER``        nested  reply header
 397   ``ETHTOOL_A_LINKMODES_AUTONEG``       u8      autonegotiation status
 398   ``ETHTOOL_A_LINKMODES_OURS``          bitset  advertised link modes
 399   ``ETHTOOL_A_LINKMODES_PEER``          bitset  partner link modes
 400   ``ETHTOOL_A_LINKMODES_SPEED``         u32     link speed (Mb/s)
 401   ``ETHTOOL_A_LINKMODES_DUPLEX``        u8      duplex mode
 402   ====================================  ======  ==========================
 403
 404 For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
 405 represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
 406 list.
 407
 408 ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
 409 devices supporting the request).
 410
 411
 412 LINKMODES_SET
 413 =============
 414
 415 Request contents:
 416
 417   ====================================  ======  ==========================
 418   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 419   ``ETHTOOL_A_LINKMODES_AUTONEG``       u8      autonegotiation status
 420   ``ETHTOOL_A_LINKMODES_OURS``          bitset  advertised link modes
 421   ``ETHTOOL_A_LINKMODES_PEER``          bitset  partner link modes
 422   ``ETHTOOL_A_LINKMODES_SPEED``         u32     link speed (Mb/s)
 423   ``ETHTOOL_A_LINKMODES_DUPLEX``        u8      duplex mode
 424   ====================================  ======  ==========================
 425
 426 ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
 427 autonegotiation is on (either set now or kept from before), advertised modes
 428 are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
 429 of speed and duplex is specified, kernel adjusts advertised modes to all
 430 supported modes matching speed, duplex or both (whatever is specified). This
 431 autoselection is done on ethtool side with ioctl interface, netlink interface
 432 is supposed to allow requesting changes without knowing what exactly kernel
 433 supports.
 434
 435
 436 LINKSTATE_GET
 437 =============
 438
 439 Requests link state information. At the moment, only link up/down flag (as
 440 provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future
 441 extensions are planned (e.g. link down reason). This request does not have any
 442 attributes.
 443
 444 Request contents:
 445
 446   ====================================  ======  ==========================
 447   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  request header
 448   ====================================  ======  ==========================
 449
 450 Kernel response contents:
 451
 452   ====================================  ======  ==========================
 453   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  reply header
 454   ``ETHTOOL_A_LINKSTATE_LINK``          bool    link state (up/down)
 455   ====================================  ======  ==========================
 456
 457 For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
 458 carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
 459 define their own handler.
 460
 461 ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
 462 devices supporting the request).
 463
 464
 465 DEBUG_GET
 466 =========
 467
 468 Requests debugging settings of a device. At the moment, only message mask is
 469 provided.
 470
 471 Request contents:
 472
 473   ====================================  ======  ==========================
 474   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 475   ====================================  ======  ==========================
 476
 477 Kernel response contents:
 478
 479   ====================================  ======  ==========================
 480   ``ETHTOOL_A_DEBUG_HEADER``            nested  reply header
 481   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 482   ====================================  ======  ==========================
 483
 484 The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
 485 provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
 486 interface. While it is called message level there for historical reasons, most
 487 drivers and almost all newer drivers use it as a mask of enabled message
 488 classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
 489 interface follows its actual use in practice.
 490
 491 ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
 492 devices supporting the request).
 493
 494
 495 DEBUG_SET
 496 =========
 497
 498 Set or update debugging settings of a device. At the moment, only message mask
 499 is supported.
 500
 501 Request contents:
 502
 503   ====================================  ======  ==========================
 504   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 505   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 506   ====================================  ======  ==========================
 507
 508 ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
 509 enabled debugging message types for the device.
 510
 511
 512 WOL_GET
 513 =======
 514
 515 Query device wake-on-lan settings. Unlike most "GET" type requests,
 516 ``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
 517 (potentially) provides SecureOn(tm) password which is confidential.
 518
 519 Request contents:
 520
 521   ====================================  ======  ==========================
 522   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 523   ====================================  ======  ==========================
 524
 525 Kernel response contents:
 526
 527   ====================================  ======  ==========================
 528   ``ETHTOOL_A_WOL_HEADER``              nested  reply header
 529   ``ETHTOOL_A_WOL_MODES``               bitset  mask of enabled WoL modes
 530   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 531   ====================================  ======  ==========================
 532
 533 In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
 534 device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
 535 included in reply if ``WAKE_MAGICSECURE`` mode is supported.
 536
 537
 538 WOL_SET
 539 =======
 540
 541 Set or update wake-on-lan settings.
 542
 543 Request contents:
 544
 545   ====================================  ======  ==========================
 546   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 547   ``ETHTOOL_A_WOL_MODES``               bitset  enabled WoL modes
 548   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 549   ====================================  ======  ==========================
 550
 551 ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
 552 ``WAKE_MAGICSECURE`` mode.
 553
 554
 555 FEATURES_GET
 556 ============
 557
 558 Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
 559
 560 Request contents:
 561
 562   ====================================  ======  ==========================
 563   ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
 564   ====================================  ======  ==========================
 565
 566 Kernel response contents:
 567
 568   ====================================  ======  ==========================
 569   ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
 570   ``ETHTOOL_A_FEATURES_HW``             bitset  dev->hw_features
 571   ``ETHTOOL_A_FEATURES_WANTED``         bitset  dev->wanted_features
 572   ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  dev->features
 573   ``ETHTOOL_A_FEATURES_NOCHANGE``       bitset  NETIF_F_NEVER_CHANGE
 574   ====================================  ======  ==========================
 575
 576 Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
 577 interference but attribute names are different (they are based on
 578 corresponding members of struct net_device). Legacy "flags" are not provided,
 579 if userspace needs them (most likely only ethtool for backward compatibility),
 580 it can calculate their values from related feature bits itself.
 581 ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
 582 provide all names when using verbose bitmap format), the other three use no
 583 mask (simple bit lists).
 584
 585
 586 FEATURES_SET
 587 ============
 588
 589 Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
 590
 591 Request contents:
 592
 593   ====================================  ======  ==========================
 594   ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
 595   ``ETHTOOL_A_FEATURES_WANTED``         bitset  requested features
 596   ====================================  ======  ==========================
 597
 598 Kernel response contents:
 599
 600   ====================================  ======  ==========================
 601   ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
 602   ``ETHTOOL_A_FEATURES_WANTED``         bitset  diff wanted vs. result
 603   ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  diff old vs. new active
 604   ====================================  ======  ==========================
 605
 606 Request constains only one bitset which can be either value/mask pair (request
 607 to change specific feature bits and leave the rest) or only a value (request
 608 to set all features to specified set).
 609
 610 As request is subject to netdev_change_features() sanity checks, optional
 611 kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
 612 header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
 613 reports the difference between client request and actual result: mask consists
 614 of bits which differ between requested features and result (dev->features
 615 after the operation), value consists of values of these bits in the request
 616 (i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
 617 reports the difference between old and new dev->features: mask consists of
 618 bits which have changed, values are their values in new dev->features (after
 619 the operation).
 620
 621 ``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
 622 are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
 623 request but also each time features are modified with netdev_update_features()
 624 or netdev_change_features().
 625
 626
 627 PRIVFLAGS_GET
 628 =============
 629
 630 Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
 631
 632 Request contents:
 633
 634   ====================================  ======  ==========================
 635   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
 636   ====================================  ======  ==========================
 637
 638 Kernel response contents:
 639
 640   ====================================  ======  ==========================
 641   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  reply header
 642   ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
 643   ====================================  ======  ==========================
 644
 645 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
 646 These flags are defined by driver, their number and names (and also meaning)
 647 are device dependent. For compact bitset format, names can be retrieved as
 648 ``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
 649 response uses all private flags supported by the device as mask so that client
 650 gets the full information without having to fetch the string set with names.
 651
 652
 653 PRIVFLAGS_SET
 654 =============
 655
 656 Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
 657 ioctl request.
 658
 659 Request contents:
 660
 661   ====================================  ======  ==========================
 662   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
 663   ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
 664   ====================================  ======  ==========================
 665
 666 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
 667 modify only values of some of them.
 668
 669
 670 RINGS_GET
 671 =========
 672
 673 Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
 674
 675 Request contents:
 676
 677   ====================================  ======  ==========================
 678   ``ETHTOOL_A_RINGS_HEADER``            nested  request header
 679   ====================================  ======  ==========================
 680
 681 Kernel response contents:
 682
 683   ====================================  ======  ==========================
 684   ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
 685   ``ETHTOOL_A_RINGS_RX_MAX``            u32     max size of RX ring
 686   ``ETHTOOL_A_RINGS_RX_MINI_MAX``       u32     max size of RX mini ring
 687   ``ETHTOOL_A_RINGS_RX_JUMBO_MAX``      u32     max size of RX jumbo ring
 688   ``ETHTOOL_A_RINGS_TX_MAX``            u32     max size of TX ring
 689   ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
 690   ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
 691   ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
 692   ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
 693   ====================================  ======  ==========================
 694
 695
 696 RINGS_SET
 697 =========
 698
 699 Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
 700
 701 Request contents:
 702
 703   ====================================  ======  ==========================
 704   ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
 705   ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
 706   ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
 707   ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
 708   ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
 709   ====================================  ======  ==========================
 710
 711 Kernel checks that requested ring sizes do not exceed limits reported by
 712 driver. Driver may impose additional constraints and may not suspport all
 713 attributes.
 714
 715
 716 CHANNELS_GET
 717 ============
 718
 719 Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
 720
 721 Request contents:
 722
 723   ====================================  ======  ==========================
 724   ``ETHTOOL_A_CHANNELS_HEADER``         nested  request header
 725   ====================================  ======  ==========================
 726
 727 Kernel response contents:
 728
 729   =====================================  ======  ==========================
 730   ``ETHTOOL_A_CHANNELS_HEADER``          nested  reply header
 731   ``ETHTOOL_A_CHANNELS_RX_MAX``          u32     max receive channels
 732   ``ETHTOOL_A_CHANNELS_TX_MAX``          u32     max transmit channels
 733   ``ETHTOOL_A_CHANNELS_OTHER_MAX``       u32     max other channels
 734   ``ETHTOOL_A_CHANNELS_COMBINED_MAX``    u32     max combined channels
 735   ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
 736   ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
 737   ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
 738   ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
 739   =====================================  ======  ==========================
 740
 741
 742 CHANNELS_SET
 743 ============
 744
 745 Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
 746
 747 Request contents:
 748
 749   =====================================  ======  ==========================
 750   ``ETHTOOL_A_CHANNELS_HEADER``          nested  request header
 751   ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
 752   ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
 753   ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
 754   ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
 755   =====================================  ======  ==========================
 756
 757 Kernel checks that requested channel counts do not exceed limits reported by
 758 driver. Driver may impose additional constraints and may not suspport all
 759 attributes.
 760
 761
 762 COALESCE_GET
 763 ============
 764
 765 Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
 766
 767 Request contents:
 768
 769   ====================================  ======  ==========================
 770   ``ETHTOOL_A_COALESCE_HEADER``         nested  request header
 771   ====================================  ======  ==========================
 772
 773 Kernel response contents:
 774
 775   ===========================================  ======  =======================
 776   ``ETHTOOL_A_COALESCE_HEADER``                nested  reply header
 777   ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
 778   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
 779   ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
 780   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
 781   ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
 782   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
 783   ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
 784   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
 785   ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
 786   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
 787   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
 788   ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
 789   ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
 790   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
 791   ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
 792   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
 793   ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
 794   ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
 795   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
 796   ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
 797   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
 798   ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
 799   ===========================================  ======  =======================
 800
 801 Attributes are only included in reply if their value is not zero or the
 802 corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
 803 they are declared as supported by driver).
 804
 805
 806 COALESCE_SET
 807 ============
 808
 809 Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
 810
 811 Request contents:
 812
 813   ===========================================  ======  =======================
 814   ``ETHTOOL_A_COALESCE_HEADER``                nested  request header
 815   ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
 816   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
 817   ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
 818   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
 819   ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
 820   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
 821   ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
 822   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
 823   ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
 824   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
 825   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
 826   ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
 827   ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
 828   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
 829   ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
 830   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
 831   ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
 832   ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
 833   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
 834   ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
 835   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
 836   ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
 837   ===========================================  ======  =======================
 838
 839 Request is rejected if it attributes declared as unsupported by driver (i.e.
 840 such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
 841 is not set), regardless of their values. Driver may impose additional
 842 constraints on coalescing parameters and their values.
 843
 844
 845 PAUSE_GET
 846 ============
 847
 848 Gets channel counts like ``ETHTOOL_GPAUSE`` ioctl request.
 849
 850 Request contents:
 851
 852   =====================================  ======  ==========================
 853   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
 854   =====================================  ======  ==========================
 855
 856 Kernel response contents:
 857
 858   =====================================  ======  ==========================
 859   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
 860   ``ETHTOOL_A_PAUSE_AUTONEG``            bool    pause autonegotiation
 861   ``ETHTOOL_A_PAUSE_RX``                 bool    receive pause frames
 862   ``ETHTOOL_A_PAUSE_TX``                 bool    transmit pause frames
 863   =====================================  ======  ==========================
 864
 865
 866 PAUSE_SET
 867 ============
 868
 869 Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
 870
 871 Request contents:
 872
 873   =====================================  ======  ==========================
 874   ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
 875   ``ETHTOOL_A_PAUSE_AUTONEG``            bool    pause autonegotiation
 876   ``ETHTOOL_A_PAUSE_RX``                 bool    receive pause frames
 877   ``ETHTOOL_A_PAUSE_TX``                 bool    transmit pause frames
 878   =====================================  ======  ==========================
 879
 880
 881 EEE_GET
 882 =======
 883
 884 Gets channel counts like ``ETHTOOL_GEEE`` ioctl request.
 885
 886 Request contents:
 887
 888   =====================================  ======  ==========================
 889   ``ETHTOOL_A_EEE_HEADER``               nested  request header
 890   =====================================  ======  ==========================
 891
 892 Kernel response contents:
 893
 894   =====================================  ======  ==========================
 895   ``ETHTOOL_A_EEE_HEADER``               nested  request header
 896   ``ETHTOOL_A_EEE_MODES_OURS``           bool    supported/advertised modes
 897   ``ETHTOOL_A_EEE_MODES_PEER``           bool    peer advertised link modes
 898   ``ETHTOOL_A_EEE_ACTIVE``               bool    EEE is actively used
 899   ``ETHTOOL_A_EEE_ENABLED``              bool    EEE is enabled
 900   ``ETHTOOL_A_EEE_TX_LPI_ENABLED``       bool    Tx lpi enabled
 901   ``ETHTOOL_A_EEE_TX_LPI_TIMER``         u32     Tx lpi timeout (in us)
 902   =====================================  ======  ==========================
 903
 904 In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
 905 enabled, value of link modes for which EEE is advertised. Link modes for which
 906 peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
 907 netlink interface allows reporting EEE status for all link modes but only
 908 first 32 are provided by the ``ethtool_ops`` callback.
 909
 910
 911 EEE_SET
 912 =======
 913
 914 Sets pause parameters like ``ETHTOOL_GEEEPARAM`` ioctl request.
 915
 916 Request contents:
 917
 918   =====================================  ======  ==========================
 919   ``ETHTOOL_A_EEE_HEADER``               nested  request header
 920   ``ETHTOOL_A_EEE_MODES_OURS``           bool    advertised modes
 921   ``ETHTOOL_A_EEE_ENABLED``              bool    EEE is enabled
 922   ``ETHTOOL_A_EEE_TX_LPI_ENABLED``       bool    Tx lpi enabled
 923   ``ETHTOOL_A_EEE_TX_LPI_TIMER``         u32     Tx lpi timeout (in us)
 924   =====================================  ======  ==========================
 925
 926 ``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
 927 EEE for (if there is no mask) or specify changes to the list (if there is
 928 a mask). The netlink interface allows reporting EEE status for all link modes
 929 but only first 32 can be set at the moment as that is what the ``ethtool_ops``
 930 callback supports.
 931
 932
 933 TSINFO_GET
 934 ==========
 935
 936 Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
 937
 938 Request contents:
 939
 940   =====================================  ======  ==========================
 941   ``ETHTOOL_A_TSINFO_HEADER``            nested  request header
 942   =====================================  ======  ==========================
 943
 944 Kernel response contents:
 945
 946   =====================================  ======  ==========================
 947   ``ETHTOOL_A_TSINFO_HEADER``            nested  request header
 948   ``ETHTOOL_A_TSINFO_TIMESTAMPING``      bitset  SO_TIMESTAMPING flags
 949   ``ETHTOOL_A_TSINFO_TX_TYPES``          bitset  supported Tx types
 950   ``ETHTOOL_A_TSINFO_RX_FILTERS``        bitset  supported Rx filters
 951   ``ETHTOOL_A_TSINFO_PHC_INDEX``         u32     PTP hw clock index
 952   =====================================  ======  ==========================
 953
 954 ``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
 955 is no special value for this case). The bitset attributes are omitted if they
 956 would be empty (no bit set).
 957
 958
 959 Request translation
 960 ===================
 961
 962 The following table maps ioctl commands to netlink commands providing their
 963 functionality. Entries with "n/a" in right column are commands which do not
 964 have their netlink replacement yet.
 965
 966   =================================== =====================================
 967   ioctl command                       netlink command
 968   =================================== =====================================
 969   ``ETHTOOL_GSET``                    ``ETHTOOL_MSG_LINKINFO_GET``
 970                                       ``ETHTOOL_MSG_LINKMODES_GET``
 971   ``ETHTOOL_SSET``                    ``ETHTOOL_MSG_LINKINFO_SET``
 972                                       ``ETHTOOL_MSG_LINKMODES_SET``
 973   ``ETHTOOL_GDRVINFO``                n/a
 974   ``ETHTOOL_GREGS``                   n/a
 975   ``ETHTOOL_GWOL``                    ``ETHTOOL_MSG_WOL_GET``
 976   ``ETHTOOL_SWOL``                    ``ETHTOOL_MSG_WOL_SET``
 977   ``ETHTOOL_GMSGLVL``                 ``ETHTOOL_MSG_DEBUG_GET``
 978   ``ETHTOOL_SMSGLVL``                 ``ETHTOOL_MSG_DEBUG_SET``
 979   ``ETHTOOL_NWAY_RST``                n/a
 980   ``ETHTOOL_GLINK``                   ``ETHTOOL_MSG_LINKSTATE_GET``
 981   ``ETHTOOL_GEEPROM``                 n/a
 982   ``ETHTOOL_SEEPROM``                 n/a
 983   ``ETHTOOL_GCOALESCE``               ``ETHTOOL_MSG_COALESCE_GET``
 984   ``ETHTOOL_SCOALESCE``               ``ETHTOOL_MSG_COALESCE_SET``
 985   ``ETHTOOL_GRINGPARAM``              ``ETHTOOL_MSG_RINGS_GET``
 986   ``ETHTOOL_SRINGPARAM``              ``ETHTOOL_MSG_RINGS_SET``
 987   ``ETHTOOL_GPAUSEPARAM``             ``ETHTOOL_MSG_PAUSE_GET``
 988   ``ETHTOOL_SPAUSEPARAM``             ``ETHTOOL_MSG_PAUSE_SET``
 989   ``ETHTOOL_GRXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
 990   ``ETHTOOL_SRXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
 991   ``ETHTOOL_GTXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
 992   ``ETHTOOL_STXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
 993   ``ETHTOOL_GSG``                     ``ETHTOOL_MSG_FEATURES_GET``
 994   ``ETHTOOL_SSG``                     ``ETHTOOL_MSG_FEATURES_SET``
 995   ``ETHTOOL_TEST``                    n/a
 996   ``ETHTOOL_GSTRINGS``                ``ETHTOOL_MSG_STRSET_GET``
 997   ``ETHTOOL_PHYS_ID``                 n/a
 998   ``ETHTOOL_GSTATS``                  n/a
 999   ``ETHTOOL_GTSO``                    ``ETHTOOL_MSG_FEATURES_GET``
1000   ``ETHTOOL_STSO``                    ``ETHTOOL_MSG_FEATURES_SET``
1001   ``ETHTOOL_GPERMADDR``               rtnetlink ``RTM_GETLINK``
1002   ``ETHTOOL_GUFO``                    ``ETHTOOL_MSG_FEATURES_GET``
1003   ``ETHTOOL_SUFO``                    ``ETHTOOL_MSG_FEATURES_SET``
1004   ``ETHTOOL_GGSO``                    ``ETHTOOL_MSG_FEATURES_GET``
1005   ``ETHTOOL_SGSO``                    ``ETHTOOL_MSG_FEATURES_SET``
1006   ``ETHTOOL_GFLAGS``                  ``ETHTOOL_MSG_FEATURES_GET``
1007   ``ETHTOOL_SFLAGS``                  ``ETHTOOL_MSG_FEATURES_SET``
1008   ``ETHTOOL_GPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_GET``
1009   ``ETHTOOL_SPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_SET``
1010   ``ETHTOOL_GRXFH``                   n/a
1011   ``ETHTOOL_SRXFH``                   n/a
1012   ``ETHTOOL_GGRO``                    ``ETHTOOL_MSG_FEATURES_GET``
1013   ``ETHTOOL_SGRO``                    ``ETHTOOL_MSG_FEATURES_SET``
1014   ``ETHTOOL_GRXRINGS``                n/a
1015   ``ETHTOOL_GRXCLSRLCNT``             n/a
1016   ``ETHTOOL_GRXCLSRULE``              n/a
1017   ``ETHTOOL_GRXCLSRLALL``             n/a
1018   ``ETHTOOL_SRXCLSRLDEL``             n/a
1019   ``ETHTOOL_SRXCLSRLINS``             n/a
1020   ``ETHTOOL_FLASHDEV``                n/a
1021   ``ETHTOOL_RESET``                   n/a
1022   ``ETHTOOL_SRXNTUPLE``               n/a
1023   ``ETHTOOL_GRXNTUPLE``               n/a
1024   ``ETHTOOL_GSSET_INFO``              ``ETHTOOL_MSG_STRSET_GET``
1025   ``ETHTOOL_GRXFHINDIR``              n/a
1026   ``ETHTOOL_SRXFHINDIR``              n/a
1027   ``ETHTOOL_GFEATURES``               ``ETHTOOL_MSG_FEATURES_GET``
1028   ``ETHTOOL_SFEATURES``               ``ETHTOOL_MSG_FEATURES_SET``
1029   ``ETHTOOL_GCHANNELS``               ``ETHTOOL_MSG_CHANNELS_GET``
1030   ``ETHTOOL_SCHANNELS``               ``ETHTOOL_MSG_CHANNELS_SET``
1031   ``ETHTOOL_SET_DUMP``                n/a
1032   ``ETHTOOL_GET_DUMP_FLAG``           n/a
1033   ``ETHTOOL_GET_DUMP_DATA``           n/a
1034   ``ETHTOOL_GET_TS_INFO``             ``ETHTOOL_MSG_TSINFO_GET``
1035   ``ETHTOOL_GMODULEINFO``             n/a
1036   ``ETHTOOL_GMODULEEEPROM``           n/a
1037   ``ETHTOOL_GEEE``                    ``ETHTOOL_MSG_EEE_GET``
1038   ``ETHTOOL_SEEE``                    ``ETHTOOL_MSG_EEE_SET``
1039   ``ETHTOOL_GRSSH``                   n/a
1040   ``ETHTOOL_SRSSH``                   n/a
1041   ``ETHTOOL_GTUNABLE``                n/a
1042   ``ETHTOOL_STUNABLE``                n/a
1043   ``ETHTOOL_GPHYSTATS``               n/a
1044   ``ETHTOOL_PERQUEUE``                n/a
1045   ``ETHTOOL_GLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_GET``
1046                                       ``ETHTOOL_MSG_LINKMODES_GET``
1047   ``ETHTOOL_SLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_SET``
1048                                       ``ETHTOOL_MSG_LINKMODES_SET``
1049   ``ETHTOOL_PHY_GTUNABLE``            n/a
1050   ``ETHTOOL_PHY_STUNABLE``            n/a
1051   ``ETHTOOL_GFECPARAM``               n/a
1052   ``ETHTOOL_SFECPARAM``               n/a
1053   =================================== =====================================