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   ===================================== ================================
 202
 203 Kernel to userspace:
 204
 205   ===================================== =================================
 206   ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents
 207   ``ETHTOOL_MSG_LINKINFO_GET_REPLY``    link settings
 208   ``ETHTOOL_MSG_LINKINFO_NTF``          link settings notification
 209   ``ETHTOOL_MSG_LINKMODES_GET_REPLY``   link modes info
 210   ``ETHTOOL_MSG_LINKMODES_NTF``         link modes notification
 211   ``ETHTOOL_MSG_LINKSTATE_GET_REPLY``   link state info
 212   ``ETHTOOL_MSG_DEBUG_GET_REPLY``       debugging settings
 213   ``ETHTOOL_MSG_DEBUG_NTF``             debugging settings notification
 214   ``ETHTOOL_MSG_WOL_GET_REPLY``         wake-on-lan settings
 215   ``ETHTOOL_MSG_WOL_NTF``               wake-on-lan settings notification
 216   ``ETHTOOL_MSG_FEATURES_GET_REPLY``    device features
 217   ``ETHTOOL_MSG_FEATURES_SET_REPLY``    optional reply to FEATURES_SET
 218   ``ETHTOOL_MSG_FEATURES_NTF``          netdev features notification
 219   ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY``   private flags
 220   ``ETHTOOL_MSG_PRIVFLAGS_NTF``         private flags
 221   ``ETHTOOL_MSG_RINGS_GET_REPLY``       ring sizes
 222   ``ETHTOOL_MSG_RINGS_NTF``             ring sizes
 223   ``ETHTOOL_MSG_CHANNELS_GET_REPLY``    channel counts
 224   ``ETHTOOL_MSG_CHANNELS_NTF``          channel counts
 225   ``ETHTOOL_MSG_COALESCE_GET_REPLY``    coalescing parameters
 226   ===================================== =================================
 227
 228 ``GET`` requests are sent by userspace applications to retrieve device
 229 information. They usually do not contain any message specific attributes.
 230 Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
 231 request with ``NLM_F_DUMP`` and no device identification can be used to query
 232 the information for all devices supporting the request.
 233
 234 If the data can be also modified, corresponding ``SET`` message with the same
 235 layout as corresponding ``GET_REPLY`` is used to request changes. Only
 236 attributes where a change is requested are included in such request (also, not
 237 all attributes may be changed). Replies to most ``SET`` request consist only
 238 of error code and extack; if kernel provides additional data, it is sent in
 239 the form of corresponding ``SET_REPLY`` message which can be suppressed by
 240 setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
 241
 242 Data modification also triggers sending a ``NTF`` message with a notification.
 243 These usually bear only a subset of attributes which was affected by the
 244 change. The same notification is issued if the data is modified using other
 245 means (mostly ioctl ethtool interface). Unlike notifications from ethtool
 246 netlink code which are only sent if something actually changed, notifications
 247 triggered by ioctl interface may be sent even if the request did not actually
 248 change any data.
 249
 250 ``ACT`` messages request kernel (driver) to perform a specific action. If some
 251 information is reported by kernel (which can be suppressed by setting
 252 ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
 253 an ``ACT_REPLY`` message. Performing an action also triggers a notification
 254 (``NTF`` message).
 255
 256 Later sections describe the format and semantics of these messages.
 257
 258
 259 STRSET_GET
 260 ==========
 261
 262 Requests contents of a string set as provided by ioctl commands
 263 ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
 264 writeable so that the corresponding ``STRSET_SET`` message is only used in
 265 kernel replies. There are two types of string sets: global (independent of
 266 a device, e.g. device feature names) and device specific (e.g. device private
 267 flags).
 268
 269 Request contents:
 270
 271  +---------------------------------------+--------+------------------------+
 272  | ``ETHTOOL_A_STRSET_HEADER``           | nested | request header         |
 273  +---------------------------------------+--------+------------------------+
 274  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | string set to request  |
 275  +-+-------------------------------------+--------+------------------------+
 276  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set         |
 277  +-+-+-----------------------------------+--------+------------------------+
 278  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                 |
 279  +-+-+-----------------------------------+--------+------------------------+
 280
 281 Kernel response contents:
 282
 283  +---------------------------------------+--------+-----------------------+
 284  | ``ETHTOOL_A_STRSET_HEADER``           | nested | reply header          |
 285  +---------------------------------------+--------+-----------------------+
 286  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | array of string sets  |
 287  +-+-------------------------------------+--------+-----------------------+
 288  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set        |
 289  +-+-+-----------------------------------+--------+-----------------------+
 290  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                |
 291  +-+-+-----------------------------------+--------+-----------------------+
 292  | | | ``ETHTOOL_A_STRINGSET_COUNT``     | u32    | number of strings     |
 293  +-+-+-----------------------------------+--------+-----------------------+
 294  | | | ``ETHTOOL_A_STRINGSET_STRINGS``   | nested | array of strings      |
 295  +-+-+-+---------------------------------+--------+-----------------------+
 296  | | | | ``ETHTOOL_A_STRINGS_STRING+``   | nested | one string            |
 297  +-+-+-+-+-------------------------------+--------+-----------------------+
 298  | | | | | ``ETHTOOL_A_STRING_INDEX``    | u32    | string index          |
 299  +-+-+-+-+-------------------------------+--------+-----------------------+
 300  | | | | | ``ETHTOOL_A_STRING_VALUE``    | string | string value          |
 301  +-+-+-+-+-------------------------------+--------+-----------------------+
 302  | ``ETHTOOL_A_STRSET_COUNTS_ONLY``      | flag   | return only counts    |
 303  +---------------------------------------+--------+-----------------------+
 304
 305 Device identification in request header is optional. Depending on its presence
 306 a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
 307
 308  - no ``NLM_F_DUMP,`` no device: get "global" stringsets
 309  - no ``NLM_F_DUMP``, with device: get string sets related to the device
 310  - ``NLM_F_DUMP``, no device: get device related string sets for all devices
 311
 312 If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
 313 requested type are returned, otherwise only those specified in the request.
 314 Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
 315 counts of the sets, not the actual strings.
 316
 317
 318 LINKINFO_GET
 319 ============
 320
 321 Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
 322 link modes and autonegotiation related information. The request does not use
 323 any attributes.
 324
 325 Request contents:
 326
 327   ====================================  ======  ==========================
 328   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 329   ====================================  ======  ==========================
 330
 331 Kernel response contents:
 332
 333   ====================================  ======  ==========================
 334   ``ETHTOOL_A_LINKINFO_HEADER``         nested  reply header
 335   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 336   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 337   ``ETHTOOL_A_LINKINFO_TP_MDIX``        u8      MDI(-X) status
 338   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 339   ``ETHTOOL_A_LINKINFO_TRANSCEIVER``    u8      transceiver
 340   ====================================  ======  ==========================
 341
 342 Attributes and their values have the same meaning as matching members of the
 343 corresponding ioctl structures.
 344
 345 ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
 346 devices supporting the request).
 347
 348
 349 LINKINFO_SET
 350 ============
 351
 352 ``LINKINFO_SET`` request allows setting some of the attributes reported by
 353 ``LINKINFO_GET``.
 354
 355 Request contents:
 356
 357   ====================================  ======  ==========================
 358   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 359   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 360   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 361   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 362   ====================================  ======  ==========================
 363
 364 MDI(-X) status and transceiver cannot be set, request with the corresponding
 365 attributes is rejected.
 366
 367
 368 LINKMODES_GET
 369 =============
 370
 371 Requests link modes (supported, advertised and peer advertised) and related
 372 information (autonegotiation status, link speed and duplex) as provided by
 373 ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
 374
 375 Request contents:
 376
 377   ====================================  ======  ==========================
 378   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 379   ====================================  ======  ==========================
 380
 381 Kernel response contents:
 382
 383   ====================================  ======  ==========================
 384   ``ETHTOOL_A_LINKMODES_HEADER``        nested  reply header
 385   ``ETHTOOL_A_LINKMODES_AUTONEG``       u8      autonegotiation status
 386   ``ETHTOOL_A_LINKMODES_OURS``          bitset  advertised link modes
 387   ``ETHTOOL_A_LINKMODES_PEER``          bitset  partner link modes
 388   ``ETHTOOL_A_LINKMODES_SPEED``         u32     link speed (Mb/s)
 389   ``ETHTOOL_A_LINKMODES_DUPLEX``        u8      duplex mode
 390   ====================================  ======  ==========================
 391
 392 For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
 393 represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
 394 list.
 395
 396 ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
 397 devices supporting the request).
 398
 399
 400 LINKMODES_SET
 401 =============
 402
 403 Request contents:
 404
 405   ====================================  ======  ==========================
 406   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 407   ``ETHTOOL_A_LINKMODES_AUTONEG``       u8      autonegotiation status
 408   ``ETHTOOL_A_LINKMODES_OURS``          bitset  advertised link modes
 409   ``ETHTOOL_A_LINKMODES_PEER``          bitset  partner link modes
 410   ``ETHTOOL_A_LINKMODES_SPEED``         u32     link speed (Mb/s)
 411   ``ETHTOOL_A_LINKMODES_DUPLEX``        u8      duplex mode
 412   ====================================  ======  ==========================
 413
 414 ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
 415 autonegotiation is on (either set now or kept from before), advertised modes
 416 are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
 417 of speed and duplex is specified, kernel adjusts advertised modes to all
 418 supported modes matching speed, duplex or both (whatever is specified). This
 419 autoselection is done on ethtool side with ioctl interface, netlink interface
 420 is supposed to allow requesting changes without knowing what exactly kernel
 421 supports.
 422
 423
 424 LINKSTATE_GET
 425 =============
 426
 427 Requests link state information. At the moment, only link up/down flag (as
 428 provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future
 429 extensions are planned (e.g. link down reason). This request does not have any
 430 attributes.
 431
 432 Request contents:
 433
 434   ====================================  ======  ==========================
 435   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  request header
 436   ====================================  ======  ==========================
 437
 438 Kernel response contents:
 439
 440   ====================================  ======  ==========================
 441   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  reply header
 442   ``ETHTOOL_A_LINKSTATE_LINK``          bool    link state (up/down)
 443   ====================================  ======  ==========================
 444
 445 For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
 446 carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
 447 define their own handler.
 448
 449 ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
 450 devices supporting the request).
 451
 452
 453 DEBUG_GET
 454 =========
 455
 456 Requests debugging settings of a device. At the moment, only message mask is
 457 provided.
 458
 459 Request contents:
 460
 461   ====================================  ======  ==========================
 462   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 463   ====================================  ======  ==========================
 464
 465 Kernel response contents:
 466
 467   ====================================  ======  ==========================
 468   ``ETHTOOL_A_DEBUG_HEADER``            nested  reply header
 469   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 470   ====================================  ======  ==========================
 471
 472 The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
 473 provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
 474 interface. While it is called message level there for historical reasons, most
 475 drivers and almost all newer drivers use it as a mask of enabled message
 476 classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
 477 interface follows its actual use in practice.
 478
 479 ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
 480 devices supporting the request).
 481
 482
 483 DEBUG_SET
 484 =========
 485
 486 Set or update debugging settings of a device. At the moment, only message mask
 487 is supported.
 488
 489 Request contents:
 490
 491   ====================================  ======  ==========================
 492   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 493   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 494   ====================================  ======  ==========================
 495
 496 ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
 497 enabled debugging message types for the device.
 498
 499
 500 WOL_GET
 501 =======
 502
 503 Query device wake-on-lan settings. Unlike most "GET" type requests,
 504 ``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
 505 (potentially) provides SecureOn(tm) password which is confidential.
 506
 507 Request contents:
 508
 509   ====================================  ======  ==========================
 510   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 511   ====================================  ======  ==========================
 512
 513 Kernel response contents:
 514
 515   ====================================  ======  ==========================
 516   ``ETHTOOL_A_WOL_HEADER``              nested  reply header
 517   ``ETHTOOL_A_WOL_MODES``               bitset  mask of enabled WoL modes
 518   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 519   ====================================  ======  ==========================
 520
 521 In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
 522 device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
 523 included in reply if ``WAKE_MAGICSECURE`` mode is supported.
 524
 525
 526 WOL_SET
 527 =======
 528
 529 Set or update wake-on-lan settings.
 530
 531 Request contents:
 532
 533   ====================================  ======  ==========================
 534   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 535   ``ETHTOOL_A_WOL_MODES``               bitset  enabled WoL modes
 536   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 537   ====================================  ======  ==========================
 538
 539 ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
 540 ``WAKE_MAGICSECURE`` mode.
 541
 542
 543 FEATURES_GET
 544 ============
 545
 546 Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
 547
 548 Request contents:
 549
 550   ====================================  ======  ==========================
 551   ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
 552   ====================================  ======  ==========================
 553
 554 Kernel response contents:
 555
 556   ====================================  ======  ==========================
 557   ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
 558   ``ETHTOOL_A_FEATURES_HW``             bitset  dev->hw_features
 559   ``ETHTOOL_A_FEATURES_WANTED``         bitset  dev->wanted_features
 560   ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  dev->features
 561   ``ETHTOOL_A_FEATURES_NOCHANGE``       bitset  NETIF_F_NEVER_CHANGE
 562   ====================================  ======  ==========================
 563
 564 Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
 565 interference but attribute names are different (they are based on
 566 corresponding members of struct net_device). Legacy "flags" are not provided,
 567 if userspace needs them (most likely only ethtool for backward compatibility),
 568 it can calculate their values from related feature bits itself.
 569 ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
 570 provide all names when using verbose bitmap format), the other three use no
 571 mask (simple bit lists).
 572
 573
 574 FEATURES_SET
 575 ============
 576
 577 Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
 578
 579 Request contents:
 580
 581   ====================================  ======  ==========================
 582   ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
 583   ``ETHTOOL_A_FEATURES_WANTED``         bitset  requested features
 584   ====================================  ======  ==========================
 585
 586 Kernel response contents:
 587
 588   ====================================  ======  ==========================
 589   ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
 590   ``ETHTOOL_A_FEATURES_WANTED``         bitset  diff wanted vs. result
 591   ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  diff old vs. new active
 592   ====================================  ======  ==========================
 593
 594 Request constains only one bitset which can be either value/mask pair (request
 595 to change specific feature bits and leave the rest) or only a value (request
 596 to set all features to specified set).
 597
 598 As request is subject to netdev_change_features() sanity checks, optional
 599 kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
 600 header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
 601 reports the difference between client request and actual result: mask consists
 602 of bits which differ between requested features and result (dev->features
 603 after the operation), value consists of values of these bits in the request
 604 (i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
 605 reports the difference between old and new dev->features: mask consists of
 606 bits which have changed, values are their values in new dev->features (after
 607 the operation).
 608
 609 ``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
 610 are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
 611 request but also each time features are modified with netdev_update_features()
 612 or netdev_change_features().
 613
 614
 615 PRIVFLAGS_GET
 616 =============
 617
 618 Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
 619
 620 Request contents:
 621
 622   ====================================  ======  ==========================
 623   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
 624   ====================================  ======  ==========================
 625
 626 Kernel response contents:
 627
 628   ====================================  ======  ==========================
 629   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  reply header
 630   ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
 631   ====================================  ======  ==========================
 632
 633 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
 634 These flags are defined by driver, their number and names (and also meaning)
 635 are device dependent. For compact bitset format, names can be retrieved as
 636 ``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
 637 response uses all private flags supported by the device as mask so that client
 638 gets the full information without having to fetch the string set with names.
 639
 640
 641 PRIVFLAGS_SET
 642 =============
 643
 644 Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
 645 ioctl request.
 646
 647 Request contents:
 648
 649   ====================================  ======  ==========================
 650   ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
 651   ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
 652   ====================================  ======  ==========================
 653
 654 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
 655 modify only values of some of them.
 656
 657
 658 RINGS_GET
 659 =========
 660
 661 Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
 662
 663 Request contents:
 664
 665   ====================================  ======  ==========================
 666   ``ETHTOOL_A_RINGS_HEADER``            nested  request header
 667   ====================================  ======  ==========================
 668
 669 Kernel response contents:
 670
 671   ====================================  ======  ==========================
 672   ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
 673   ``ETHTOOL_A_RINGS_RX_MAX``            u32     max size of RX ring
 674   ``ETHTOOL_A_RINGS_RX_MINI_MAX``       u32     max size of RX mini ring
 675   ``ETHTOOL_A_RINGS_RX_JUMBO_MAX``      u32     max size of RX jumbo ring
 676   ``ETHTOOL_A_RINGS_TX_MAX``            u32     max size of TX ring
 677   ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
 678   ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
 679   ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
 680   ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
 681   ====================================  ======  ==========================
 682
 683
 684 RINGS_SET
 685 =========
 686
 687 Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
 688
 689 Request contents:
 690
 691   ====================================  ======  ==========================
 692   ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
 693   ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
 694   ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
 695   ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
 696   ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
 697   ====================================  ======  ==========================
 698
 699 Kernel checks that requested ring sizes do not exceed limits reported by
 700 driver. Driver may impose additional constraints and may not suspport all
 701 attributes.
 702
 703
 704 CHANNELS_GET
 705 ============
 706
 707 Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
 708
 709 Request contents:
 710
 711   ====================================  ======  ==========================
 712   ``ETHTOOL_A_CHANNELS_HEADER``         nested  request header
 713   ====================================  ======  ==========================
 714
 715 Kernel response contents:
 716
 717   =====================================  ======  ==========================
 718   ``ETHTOOL_A_CHANNELS_HEADER``          nested  reply header
 719   ``ETHTOOL_A_CHANNELS_RX_MAX``          u32     max receive channels
 720   ``ETHTOOL_A_CHANNELS_TX_MAX``          u32     max transmit channels
 721   ``ETHTOOL_A_CHANNELS_OTHER_MAX``       u32     max other channels
 722   ``ETHTOOL_A_CHANNELS_COMBINED_MAX``    u32     max combined channels
 723   ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
 724   ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
 725   ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
 726   ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
 727   =====================================  ======  ==========================
 728
 729
 730 CHANNELS_SET
 731 ============
 732
 733 Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
 734
 735 Request contents:
 736
 737   =====================================  ======  ==========================
 738   ``ETHTOOL_A_CHANNELS_HEADER``          nested  request header
 739   ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
 740   ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
 741   ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
 742   ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
 743   =====================================  ======  ==========================
 744
 745 Kernel checks that requested channel counts do not exceed limits reported by
 746 driver. Driver may impose additional constraints and may not suspport all
 747 attributes.
 748
 749
 750 COALESCE_GET
 751 ============
 752
 753 Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
 754
 755 Request contents:
 756
 757   ====================================  ======  ==========================
 758   ``ETHTOOL_A_COALESCE_HEADER``         nested  request header
 759   ====================================  ======  ==========================
 760
 761 Kernel response contents:
 762
 763   ===========================================  ======  =======================
 764   ``ETHTOOL_A_COALESCE_HEADER``                nested  reply header
 765   ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
 766   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
 767   ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
 768   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
 769   ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
 770   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
 771   ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
 772   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
 773   ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
 774   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
 775   ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
 776   ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
 777   ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
 778   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
 779   ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
 780   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
 781   ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
 782   ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
 783   ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
 784   ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
 785   ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
 786   ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
 787   ===========================================  ======  =======================
 788
 789 Attributes are only included in reply if their value is not zero or the
 790 corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
 791 they are declared as supported by driver).
 792
 793
 794 Request translation
 795 ===================
 796
 797 The following table maps ioctl commands to netlink commands providing their
 798 functionality. Entries with "n/a" in right column are commands which do not
 799 have their netlink replacement yet.
 800
 801   =================================== =====================================
 802   ioctl command                       netlink command
 803   =================================== =====================================
 804   ``ETHTOOL_GSET``                    ``ETHTOOL_MSG_LINKINFO_GET``
 805                                       ``ETHTOOL_MSG_LINKMODES_GET``
 806   ``ETHTOOL_SSET``                    ``ETHTOOL_MSG_LINKINFO_SET``
 807                                       ``ETHTOOL_MSG_LINKMODES_SET``
 808   ``ETHTOOL_GDRVINFO``                n/a
 809   ``ETHTOOL_GREGS``                   n/a
 810   ``ETHTOOL_GWOL``                    ``ETHTOOL_MSG_WOL_GET``
 811   ``ETHTOOL_SWOL``                    ``ETHTOOL_MSG_WOL_SET``
 812   ``ETHTOOL_GMSGLVL``                 ``ETHTOOL_MSG_DEBUG_GET``
 813   ``ETHTOOL_SMSGLVL``                 ``ETHTOOL_MSG_DEBUG_SET``
 814   ``ETHTOOL_NWAY_RST``                n/a
 815   ``ETHTOOL_GLINK``                   ``ETHTOOL_MSG_LINKSTATE_GET``
 816   ``ETHTOOL_GEEPROM``                 n/a
 817   ``ETHTOOL_SEEPROM``                 n/a
 818   ``ETHTOOL_GCOALESCE``               ``ETHTOOL_MSG_COALESCE_GET``
 819   ``ETHTOOL_SCOALESCE``               n/a
 820   ``ETHTOOL_GRINGPARAM``              ``ETHTOOL_MSG_RINGS_GET``
 821   ``ETHTOOL_SRINGPARAM``              ``ETHTOOL_MSG_RINGS_SET``
 822   ``ETHTOOL_GPAUSEPARAM``             n/a
 823   ``ETHTOOL_SPAUSEPARAM``             n/a
 824   ``ETHTOOL_GRXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
 825   ``ETHTOOL_SRXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
 826   ``ETHTOOL_GTXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
 827   ``ETHTOOL_STXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
 828   ``ETHTOOL_GSG``                     ``ETHTOOL_MSG_FEATURES_GET``
 829   ``ETHTOOL_SSG``                     ``ETHTOOL_MSG_FEATURES_SET``
 830   ``ETHTOOL_TEST``                    n/a
 831   ``ETHTOOL_GSTRINGS``                ``ETHTOOL_MSG_STRSET_GET``
 832   ``ETHTOOL_PHYS_ID``                 n/a
 833   ``ETHTOOL_GSTATS``                  n/a
 834   ``ETHTOOL_GTSO``                    ``ETHTOOL_MSG_FEATURES_GET``
 835   ``ETHTOOL_STSO``                    ``ETHTOOL_MSG_FEATURES_SET``
 836   ``ETHTOOL_GPERMADDR``               rtnetlink ``RTM_GETLINK``
 837   ``ETHTOOL_GUFO``                    ``ETHTOOL_MSG_FEATURES_GET``
 838   ``ETHTOOL_SUFO``                    ``ETHTOOL_MSG_FEATURES_SET``
 839   ``ETHTOOL_GGSO``                    ``ETHTOOL_MSG_FEATURES_GET``
 840   ``ETHTOOL_SGSO``                    ``ETHTOOL_MSG_FEATURES_SET``
 841   ``ETHTOOL_GFLAGS``                  ``ETHTOOL_MSG_FEATURES_GET``
 842   ``ETHTOOL_SFLAGS``                  ``ETHTOOL_MSG_FEATURES_SET``
 843   ``ETHTOOL_GPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_GET``
 844   ``ETHTOOL_SPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_SET``
 845   ``ETHTOOL_GRXFH``                   n/a
 846   ``ETHTOOL_SRXFH``                   n/a
 847   ``ETHTOOL_GGRO``                    ``ETHTOOL_MSG_FEATURES_GET``
 848   ``ETHTOOL_SGRO``                    ``ETHTOOL_MSG_FEATURES_SET``
 849   ``ETHTOOL_GRXRINGS``                n/a
 850   ``ETHTOOL_GRXCLSRLCNT``             n/a
 851   ``ETHTOOL_GRXCLSRULE``              n/a
 852   ``ETHTOOL_GRXCLSRLALL``             n/a
 853   ``ETHTOOL_SRXCLSRLDEL``             n/a
 854   ``ETHTOOL_SRXCLSRLINS``             n/a
 855   ``ETHTOOL_FLASHDEV``                n/a
 856   ``ETHTOOL_RESET``                   n/a
 857   ``ETHTOOL_SRXNTUPLE``               n/a
 858   ``ETHTOOL_GRXNTUPLE``               n/a
 859   ``ETHTOOL_GSSET_INFO``              ``ETHTOOL_MSG_STRSET_GET``
 860   ``ETHTOOL_GRXFHINDIR``              n/a
 861   ``ETHTOOL_SRXFHINDIR``              n/a
 862   ``ETHTOOL_GFEATURES``               ``ETHTOOL_MSG_FEATURES_GET``
 863   ``ETHTOOL_SFEATURES``               ``ETHTOOL_MSG_FEATURES_SET``
 864   ``ETHTOOL_GCHANNELS``               ``ETHTOOL_MSG_CHANNELS_GET``
 865   ``ETHTOOL_SCHANNELS``               ``ETHTOOL_MSG_CHANNELS_SET``
 866   ``ETHTOOL_SET_DUMP``                n/a
 867   ``ETHTOOL_GET_DUMP_FLAG``           n/a
 868   ``ETHTOOL_GET_DUMP_DATA``           n/a
 869   ``ETHTOOL_GET_TS_INFO``             n/a
 870   ``ETHTOOL_GMODULEINFO``             n/a
 871   ``ETHTOOL_GMODULEEEPROM``           n/a
 872   ``ETHTOOL_GEEE``                    n/a
 873   ``ETHTOOL_SEEE``                    n/a
 874   ``ETHTOOL_GRSSH``                   n/a
 875   ``ETHTOOL_SRSSH``                   n/a
 876   ``ETHTOOL_GTUNABLE``                n/a
 877   ``ETHTOOL_STUNABLE``                n/a
 878   ``ETHTOOL_GPHYSTATS``               n/a
 879   ``ETHTOOL_PERQUEUE``                n/a
 880   ``ETHTOOL_GLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_GET``
 881                                       ``ETHTOOL_MSG_LINKMODES_GET``
 882   ``ETHTOOL_SLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_SET``
 883                                       ``ETHTOOL_MSG_LINKMODES_SET``
 884   ``ETHTOOL_PHY_GTUNABLE``            n/a
 885   ``ETHTOOL_PHY_STUNABLE``            n/a
 886   ``ETHTOOL_GFECPARAM``               n/a
 887   ``ETHTOOL_SFECPARAM``               n/a
 888   =================================== =====================================