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