Documentation/networking/ethtool-netlink.rst

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