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   ===================================== ================================
 193
 194 Kernel to userspace:
 195
 196   ===================================== =================================
 197   ``ETHTOOL_MSG_STRSET_GET_REPLY``      string set contents
 198   ``ETHTOOL_MSG_LINKINFO_GET_REPLY``    link settings
 199   ``ETHTOOL_MSG_LINKINFO_NTF``          link settings notification
 200   ``ETHTOOL_MSG_LINKMODES_GET_REPLY``   link modes info
 201   ``ETHTOOL_MSG_LINKMODES_NTF``         link modes notification
 202   ``ETHTOOL_MSG_LINKSTATE_GET_REPLY``   link state info
 203   ``ETHTOOL_MSG_DEBUG_GET_REPLY``       debugging settings
 204   ``ETHTOOL_MSG_DEBUG_NTF``             debugging settings notification
 205   ``ETHTOOL_MSG_WOL_GET_REPLY``         wake-on-lan settings
 206   ``ETHTOOL_MSG_WOL_NTF``               wake-on-lan settings notification
 207   ===================================== =================================
 208
 209 ``GET`` requests are sent by userspace applications to retrieve device
 210 information. They usually do not contain any message specific attributes.
 211 Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
 212 request with ``NLM_F_DUMP`` and no device identification can be used to query
 213 the information for all devices supporting the request.
 214
 215 If the data can be also modified, corresponding ``SET`` message with the same
 216 layout as corresponding ``GET_REPLY`` is used to request changes. Only
 217 attributes where a change is requested are included in such request (also, not
 218 all attributes may be changed). Replies to most ``SET`` request consist only
 219 of error code and extack; if kernel provides additional data, it is sent in
 220 the form of corresponding ``SET_REPLY`` message which can be suppressed by
 221 setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
 222
 223 Data modification also triggers sending a ``NTF`` message with a notification.
 224 These usually bear only a subset of attributes which was affected by the
 225 change. The same notification is issued if the data is modified using other
 226 means (mostly ioctl ethtool interface). Unlike notifications from ethtool
 227 netlink code which are only sent if something actually changed, notifications
 228 triggered by ioctl interface may be sent even if the request did not actually
 229 change any data.
 230
 231 ``ACT`` messages request kernel (driver) to perform a specific action. If some
 232 information is reported by kernel (which can be suppressed by setting
 233 ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
 234 an ``ACT_REPLY`` message. Performing an action also triggers a notification
 235 (``NTF`` message).
 236
 237 Later sections describe the format and semantics of these messages.
 238
 239
 240 STRSET_GET
 241 ==========
 242
 243 Requests contents of a string set as provided by ioctl commands
 244 ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
 245 writeable so that the corresponding ``STRSET_SET`` message is only used in
 246 kernel replies. There are two types of string sets: global (independent of
 247 a device, e.g. device feature names) and device specific (e.g. device private
 248 flags).
 249
 250 Request contents:
 251
 252  +---------------------------------------+--------+------------------------+
 253  | ``ETHTOOL_A_STRSET_HEADER``           | nested | request header         |
 254  +---------------------------------------+--------+------------------------+
 255  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | string set to request  |
 256  +-+-------------------------------------+--------+------------------------+
 257  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set         |
 258  +-+-+-----------------------------------+--------+------------------------+
 259  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                 |
 260  +-+-+-----------------------------------+--------+------------------------+
 261
 262 Kernel response contents:
 263
 264  +---------------------------------------+--------+-----------------------+
 265  | ``ETHTOOL_A_STRSET_HEADER``           | nested | reply header          |
 266  +---------------------------------------+--------+-----------------------+
 267  | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | array of string sets  |
 268  +-+-------------------------------------+--------+-----------------------+
 269  | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set        |
 270  +-+-+-----------------------------------+--------+-----------------------+
 271  | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                |
 272  +-+-+-----------------------------------+--------+-----------------------+
 273  | | | ``ETHTOOL_A_STRINGSET_COUNT``     | u32    | number of strings     |
 274  +-+-+-----------------------------------+--------+-----------------------+
 275  | | | ``ETHTOOL_A_STRINGSET_STRINGS``   | nested | array of strings      |
 276  +-+-+-+---------------------------------+--------+-----------------------+
 277  | | | | ``ETHTOOL_A_STRINGS_STRING+``   | nested | one string            |
 278  +-+-+-+-+-------------------------------+--------+-----------------------+
 279  | | | | | ``ETHTOOL_A_STRING_INDEX``    | u32    | string index          |
 280  +-+-+-+-+-------------------------------+--------+-----------------------+
 281  | | | | | ``ETHTOOL_A_STRING_VALUE``    | string | string value          |
 282  +-+-+-+-+-------------------------------+--------+-----------------------+
 283  | ``ETHTOOL_A_STRSET_COUNTS_ONLY``      | flag   | return only counts    |
 284  +---------------------------------------+--------+-----------------------+
 285
 286 Device identification in request header is optional. Depending on its presence
 287 a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
 288
 289  - no ``NLM_F_DUMP,`` no device: get "global" stringsets
 290  - no ``NLM_F_DUMP``, with device: get string sets related to the device
 291  - ``NLM_F_DUMP``, no device: get device related string sets for all devices
 292
 293 If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
 294 requested type are returned, otherwise only those specified in the request.
 295 Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
 296 counts of the sets, not the actual strings.
 297
 298
 299 LINKINFO_GET
 300 ============
 301
 302 Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
 303 link modes and autonegotiation related information. The request does not use
 304 any attributes.
 305
 306 Request contents:
 307
 308   ====================================  ======  ==========================
 309   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 310   ====================================  ======  ==========================
 311
 312 Kernel response contents:
 313
 314   ====================================  ======  ==========================
 315   ``ETHTOOL_A_LINKINFO_HEADER``         nested  reply header
 316   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 317   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 318   ``ETHTOOL_A_LINKINFO_TP_MDIX``        u8      MDI(-X) status
 319   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 320   ``ETHTOOL_A_LINKINFO_TRANSCEIVER``    u8      transceiver
 321   ====================================  ======  ==========================
 322
 323 Attributes and their values have the same meaning as matching members of the
 324 corresponding ioctl structures.
 325
 326 ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
 327 devices supporting the request).
 328
 329
 330 LINKINFO_SET
 331 ============
 332
 333 ``LINKINFO_SET`` request allows setting some of the attributes reported by
 334 ``LINKINFO_GET``.
 335
 336 Request contents:
 337
 338   ====================================  ======  ==========================
 339   ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
 340   ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
 341   ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
 342   ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
 343   ====================================  ======  ==========================
 344
 345 MDI(-X) status and transceiver cannot be set, request with the corresponding
 346 attributes is rejected.
 347
 348
 349 LINKMODES_GET
 350 =============
 351
 352 Requests link modes (supported, advertised and peer advertised) and related
 353 information (autonegotiation status, link speed and duplex) as provided by
 354 ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
 355
 356 Request contents:
 357
 358   ====================================  ======  ==========================
 359   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 360   ====================================  ======  ==========================
 361
 362 Kernel response contents:
 363
 364   ====================================  ======  ==========================
 365   ``ETHTOOL_A_LINKMODES_HEADER``        nested  reply header
 366   ``ETHTOOL_A_LINKMODES_AUTONEG``       u8      autonegotiation status
 367   ``ETHTOOL_A_LINKMODES_OURS``          bitset  advertised link modes
 368   ``ETHTOOL_A_LINKMODES_PEER``          bitset  partner link modes
 369   ``ETHTOOL_A_LINKMODES_SPEED``         u32     link speed (Mb/s)
 370   ``ETHTOOL_A_LINKMODES_DUPLEX``        u8      duplex mode
 371   ====================================  ======  ==========================
 372
 373 For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
 374 represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
 375 list.
 376
 377 ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
 378 devices supporting the request).
 379
 380
 381 LINKMODES_SET
 382 =============
 383
 384 Request contents:
 385
 386   ====================================  ======  ==========================
 387   ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
 388   ``ETHTOOL_A_LINKMODES_AUTONEG``       u8      autonegotiation status
 389   ``ETHTOOL_A_LINKMODES_OURS``          bitset  advertised link modes
 390   ``ETHTOOL_A_LINKMODES_PEER``          bitset  partner link modes
 391   ``ETHTOOL_A_LINKMODES_SPEED``         u32     link speed (Mb/s)
 392   ``ETHTOOL_A_LINKMODES_DUPLEX``        u8      duplex mode
 393   ====================================  ======  ==========================
 394
 395 ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
 396 autonegotiation is on (either set now or kept from before), advertised modes
 397 are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
 398 of speed and duplex is specified, kernel adjusts advertised modes to all
 399 supported modes matching speed, duplex or both (whatever is specified). This
 400 autoselection is done on ethtool side with ioctl interface, netlink interface
 401 is supposed to allow requesting changes without knowing what exactly kernel
 402 supports.
 403
 404
 405 LINKSTATE_GET
 406 =============
 407
 408 Requests link state information. At the moment, only link up/down flag (as
 409 provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future
 410 extensions are planned (e.g. link down reason). This request does not have any
 411 attributes.
 412
 413 Request contents:
 414
 415   ====================================  ======  ==========================
 416   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  request header
 417   ====================================  ======  ==========================
 418
 419 Kernel response contents:
 420
 421   ====================================  ======  ==========================
 422   ``ETHTOOL_A_LINKSTATE_HEADER``        nested  reply header
 423   ``ETHTOOL_A_LINKSTATE_LINK``          bool    link state (up/down)
 424   ====================================  ======  ==========================
 425
 426 For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
 427 carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
 428 define their own handler.
 429
 430 ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
 431 devices supporting the request).
 432
 433
 434 DEBUG_GET
 435 =========
 436
 437 Requests debugging settings of a device. At the moment, only message mask is
 438 provided.
 439
 440 Request contents:
 441
 442   ====================================  ======  ==========================
 443   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 444   ====================================  ======  ==========================
 445
 446 Kernel response contents:
 447
 448   ====================================  ======  ==========================
 449   ``ETHTOOL_A_DEBUG_HEADER``            nested  reply header
 450   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 451   ====================================  ======  ==========================
 452
 453 The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
 454 provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
 455 interface. While it is called message level there for historical reasons, most
 456 drivers and almost all newer drivers use it as a mask of enabled message
 457 classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
 458 interface follows its actual use in practice.
 459
 460 ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
 461 devices supporting the request).
 462
 463
 464 DEBUG_SET
 465 =========
 466
 467 Set or update debugging settings of a device. At the moment, only message mask
 468 is supported.
 469
 470 Request contents:
 471
 472   ====================================  ======  ==========================
 473   ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
 474   ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
 475   ====================================  ======  ==========================
 476
 477 ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
 478 enabled debugging message types for the device.
 479
 480
 481 WOL_GET
 482 =======
 483
 484 Query device wake-on-lan settings. Unlike most "GET" type requests,
 485 ``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
 486 (potentially) provides SecureOn(tm) password which is confidential.
 487
 488 Request contents:
 489
 490   ====================================  ======  ==========================
 491   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 492   ====================================  ======  ==========================
 493
 494 Kernel response contents:
 495
 496   ====================================  ======  ==========================
 497   ``ETHTOOL_A_WOL_HEADER``              nested  reply header
 498   ``ETHTOOL_A_WOL_MODES``               bitset  mask of enabled WoL modes
 499   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 500   ====================================  ======  ==========================
 501
 502 In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
 503 device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
 504 included in reply if ``WAKE_MAGICSECURE`` mode is supported.
 505
 506
 507 WOL_SET
 508 =======
 509
 510 Set or update wake-on-lan settings.
 511
 512 Request contents:
 513
 514   ====================================  ======  ==========================
 515   ``ETHTOOL_A_WOL_HEADER``              nested  request header
 516   ``ETHTOOL_A_WOL_MODES``               bitset  enabled WoL modes
 517   ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
 518   ====================================  ======  ==========================
 519
 520 ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
 521 ``WAKE_MAGICSECURE`` mode.
 522
 523
 524 Request translation
 525 ===================
 526
 527 The following table maps ioctl commands to netlink commands providing their
 528 functionality. Entries with "n/a" in right column are commands which do not
 529 have their netlink replacement yet.
 530
 531   =================================== =====================================
 532   ioctl command                       netlink command
 533   =================================== =====================================
 534   ``ETHTOOL_GSET``                    ``ETHTOOL_MSG_LINKINFO_GET``
 535                                       ``ETHTOOL_MSG_LINKMODES_GET``
 536   ``ETHTOOL_SSET``                    ``ETHTOOL_MSG_LINKINFO_SET``
 537                                       ``ETHTOOL_MSG_LINKMODES_SET``
 538   ``ETHTOOL_GDRVINFO``                n/a
 539   ``ETHTOOL_GREGS``                   n/a
 540   ``ETHTOOL_GWOL``                    ``ETHTOOL_MSG_WOL_GET``
 541   ``ETHTOOL_SWOL``                    ``ETHTOOL_MSG_WOL_SET``
 542   ``ETHTOOL_GMSGLVL``                 ``ETHTOOL_MSG_DEBUG_GET``
 543   ``ETHTOOL_SMSGLVL``                 ``ETHTOOL_MSG_DEBUG_SET``
 544   ``ETHTOOL_NWAY_RST``                n/a
 545   ``ETHTOOL_GLINK``                   ``ETHTOOL_MSG_LINKSTATE_GET``
 546   ``ETHTOOL_GEEPROM``                 n/a
 547   ``ETHTOOL_SEEPROM``                 n/a
 548   ``ETHTOOL_GCOALESCE``               n/a
 549   ``ETHTOOL_SCOALESCE``               n/a
 550   ``ETHTOOL_GRINGPARAM``              n/a
 551   ``ETHTOOL_SRINGPARAM``              n/a
 552   ``ETHTOOL_GPAUSEPARAM``             n/a
 553   ``ETHTOOL_SPAUSEPARAM``             n/a
 554   ``ETHTOOL_GRXCSUM``                 n/a
 555   ``ETHTOOL_SRXCSUM``                 n/a
 556   ``ETHTOOL_GTXCSUM``                 n/a
 557   ``ETHTOOL_STXCSUM``                 n/a
 558   ``ETHTOOL_GSG``                     n/a
 559   ``ETHTOOL_SSG``                     n/a
 560   ``ETHTOOL_TEST``                    n/a
 561   ``ETHTOOL_GSTRINGS``                ``ETHTOOL_MSG_STRSET_GET``
 562   ``ETHTOOL_PHYS_ID``                 n/a
 563   ``ETHTOOL_GSTATS``                  n/a
 564   ``ETHTOOL_GTSO``                    n/a
 565   ``ETHTOOL_STSO``                    n/a
 566   ``ETHTOOL_GPERMADDR``               rtnetlink ``RTM_GETLINK``
 567   ``ETHTOOL_GUFO``                    n/a
 568   ``ETHTOOL_SUFO``                    n/a
 569   ``ETHTOOL_GGSO``                    n/a
 570   ``ETHTOOL_SGSO``                    n/a
 571   ``ETHTOOL_GFLAGS``                  n/a
 572   ``ETHTOOL_SFLAGS``                  n/a
 573   ``ETHTOOL_GPFLAGS``                 n/a
 574   ``ETHTOOL_SPFLAGS``                 n/a
 575   ``ETHTOOL_GRXFH``                   n/a
 576   ``ETHTOOL_SRXFH``                   n/a
 577   ``ETHTOOL_GGRO``                    n/a
 578   ``ETHTOOL_SGRO``                    n/a
 579   ``ETHTOOL_GRXRINGS``                n/a
 580   ``ETHTOOL_GRXCLSRLCNT``             n/a
 581   ``ETHTOOL_GRXCLSRULE``              n/a
 582   ``ETHTOOL_GRXCLSRLALL``             n/a
 583   ``ETHTOOL_SRXCLSRLDEL``             n/a
 584   ``ETHTOOL_SRXCLSRLINS``             n/a
 585   ``ETHTOOL_FLASHDEV``                n/a
 586   ``ETHTOOL_RESET``                   n/a
 587   ``ETHTOOL_SRXNTUPLE``               n/a
 588   ``ETHTOOL_GRXNTUPLE``               n/a
 589   ``ETHTOOL_GSSET_INFO``              ``ETHTOOL_MSG_STRSET_GET``
 590   ``ETHTOOL_GRXFHINDIR``              n/a
 591   ``ETHTOOL_SRXFHINDIR``              n/a
 592   ``ETHTOOL_GFEATURES``               n/a
 593   ``ETHTOOL_SFEATURES``               n/a
 594   ``ETHTOOL_GCHANNELS``               n/a
 595   ``ETHTOOL_SCHANNELS``               n/a
 596   ``ETHTOOL_SET_DUMP``                n/a
 597   ``ETHTOOL_GET_DUMP_FLAG``           n/a
 598   ``ETHTOOL_GET_DUMP_DATA``           n/a
 599   ``ETHTOOL_GET_TS_INFO``             n/a
 600   ``ETHTOOL_GMODULEINFO``             n/a
 601   ``ETHTOOL_GMODULEEEPROM``           n/a
 602   ``ETHTOOL_GEEE``                    n/a
 603   ``ETHTOOL_SEEE``                    n/a
 604   ``ETHTOOL_GRSSH``                   n/a
 605   ``ETHTOOL_SRSSH``                   n/a
 606   ``ETHTOOL_GTUNABLE``                n/a
 607   ``ETHTOOL_STUNABLE``                n/a
 608   ``ETHTOOL_GPHYSTATS``               n/a
 609   ``ETHTOOL_PERQUEUE``                n/a
 610   ``ETHTOOL_GLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_GET``
 611                                       ``ETHTOOL_MSG_LINKMODES_GET``
 612   ``ETHTOOL_SLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_SET``
 613                                       ``ETHTOOL_MSG_LINKMODES_SET``
 614   ``ETHTOOL_PHY_GTUNABLE``            n/a
 615   ``ETHTOOL_PHY_STUNABLE``            n/a
 616   ``ETHTOOL_GFECPARAM``               n/a
 617   ``ETHTOOL_SFECPARAM``               n/a
 618   =================================== =====================================