Merge tag 'kconfig-v5.6' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy...
[linux-block.git] / Documentation / networking / ethtool-netlink.rst
CommitLineData
2b4a8990
MK
1=============================
2Netlink interface for ethtool
3=============================
4
5
6Basic information
7=================
8
9Netlink 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
12header). This family does not use a specific header, all information in
13requests and replies is passed using netlink attributes.
14
15The ethtool netlink interface uses extended ACK for error and warning
16reporting, userspace application developers are encouraged to make these
17messages available to user in a suitable way.
18
19Requests can be divided into three categories: "get" (retrieving information),
20"set" (setting parameters) and "action" (invoking an action).
21
22All "set" and "action" type requests require admin privileges
23(``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for
24anyone but there are exceptions (where the response contains sensitive
25information). In some cases, the request as such is allowed for anyone but
26unprivileged users have attributes with sensitive information (e.g.
27wake-on-lan password) omitted.
28
29
30Conventions
31===========
32
33Attributes which represent a boolean value usually use NLA_U8 type so that we
34can distinguish three states: "on", "off" and "not present" (meaning the
35information is not available in "get" requests or value is not to be changed
36in "set" requests). For these attributes, the "true" value should be passed as
37number 1 but any non-zero value should be understood as "true" by recipient.
38In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way.
39
40In the message structure descriptions below, if an attribute name is suffixed
41with "+", parent nest can contain multiple attributes of the same type. This
42implements an array of entries.
43
44
45Request header
46==============
47
48Each request or reply message contains a nested attribute with common header.
49Structure 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
58device message relates to. One of them is sufficient in requests, if both are
59used, they must identify the same device. Some requests, e.g. global string
60sets, do not require device identification. Most ``GET`` requests also allow
61dump requests without device identification to query the same information for
62all 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
65types. The interpretation of these flags is the same for all request types but
66the 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
73New request flags should follow the general idea that if the flag is not set,
74the behaviour is backward compatible, i.e. requests from old clients not aware
75of the flag should be interpreted the way the client expects. A client must
76not set flags it does not understand.
77
78
10b518d4
MK
79Bit sets
80========
81
82For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
83type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
84attribute with contents of one of two forms: compact (two binary bitmaps
85representing bit values and mask of affected bits) and bit-by-bit (list of
86bits identified by either index or name).
87
88Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
89with their values which saves a round trip (when the bitset is passed in a
90request) or at least a second request (when the bitset is in a reply). This is
91useful for one shot applications like traditional ethtool command. On the
92other hand, long running applications like ethtool monitor (displaying
93notifications) or network management daemons may prefer fetching the names
94only once and using compact form to save message size. Notifications from
95ethtool netlink interface always use compact form for bitsets.
96
97A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
98not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
99modifying a bitmap, the former changes the bit set in mask to values set in
100value and preserves the rest; the latter sets the bits set in the bitmap and
101clears the rest.
102
103Compact 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
112Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
113rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
114order, words ordered from least significant to most significant (i.e. the same
115way as bitmaps are passed with ioctl interface).
116
117For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
118mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
119``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
120if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
121allowed (bitset represents a single bitmap.
122
123Kernel bit set length may differ from userspace length if older application is
124used on newer kernel or vice versa. If userspace bitmap is longer, an error is
125issued only if the request actually tries to set values of some bits not
126recognized by kernel.
127
128Bit-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
146Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
147only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
148arbitrary number of them. A bit may be identified by its index or by its
149name. 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
151index exceeds kernel bit length or if name is not recognized.
152
153When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
154a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
155such case. Such bitset represents a bitmap with listed bits set and the rest
156zero.
157
158In requests, application can use either form. Form used by kernel in reply is
159determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
160header. Semantics of value and mask depends on the attribute.
161
162
2b4a8990
MK
163List of message types
164=====================
165
166All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
167according 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
71921690
MK
179Userspace to kernel:
180
181 ===================================== ================================
182 ``ETHTOOL_MSG_STRSET_GET`` get string set
459e0b81 183 ``ETHTOOL_MSG_LINKINFO_GET`` get link settings
a53f3d41 184 ``ETHTOOL_MSG_LINKINFO_SET`` set link settings
f625aa9b 185 ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info
bfbcfe20 186 ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info
3d2b847f 187 ``ETHTOOL_MSG_LINKSTATE_GET`` get link state
6a94b8cc 188 ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings
e54d04e3 189 ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings
51ea22b0 190 ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings
8d425b19 191 ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings
71921690
MK
192 ===================================== ================================
193
194Kernel to userspace:
195
67bffa79 196 ===================================== =================================
71921690 197 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents
459e0b81 198 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings
73286734 199 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification
f625aa9b 200 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info
1b1b1847 201 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification
3d2b847f 202 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info
6a94b8cc 203 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings
0bda7af3 204 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification
51ea22b0 205 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings
67bffa79
MK
206 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification
207 ===================================== =================================
71921690 208
2b4a8990
MK
209``GET`` requests are sent by userspace applications to retrieve device
210information. They usually do not contain any message specific attributes.
211Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
212request with ``NLM_F_DUMP`` and no device identification can be used to query
213the information for all devices supporting the request.
214
215If the data can be also modified, corresponding ``SET`` message with the same
216layout as corresponding ``GET_REPLY`` is used to request changes. Only
217attributes where a change is requested are included in such request (also, not
218all attributes may be changed). Replies to most ``SET`` request consist only
219of error code and extack; if kernel provides additional data, it is sent in
220the form of corresponding ``SET_REPLY`` message which can be suppressed by
221setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
222
223Data modification also triggers sending a ``NTF`` message with a notification.
224These usually bear only a subset of attributes which was affected by the
225change. The same notification is issued if the data is modified using other
226means (mostly ioctl ethtool interface). Unlike notifications from ethtool
227netlink code which are only sent if something actually changed, notifications
228triggered by ioctl interface may be sent even if the request did not actually
229change any data.
230
231``ACT`` messages request kernel (driver) to perform a specific action. If some
232information is reported by kernel (which can be suppressed by setting
233``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
234an ``ACT_REPLY`` message. Performing an action also triggers a notification
235(``NTF`` message).
236
237Later sections describe the format and semantics of these messages.
238
239
71921690
MK
240STRSET_GET
241==========
242
243Requests contents of a string set as provided by ioctl commands
244``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
245writeable so that the corresponding ``STRSET_SET`` message is only used in
246kernel replies. There are two types of string sets: global (independent of
247a device, e.g. device feature names) and device specific (e.g. device private
248flags).
249
250Request 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
262Kernel 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
286Device identification in request header is optional. Depending on its presence
287a 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
293If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
294requested type are returned, otherwise only those specified in the request.
295Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
296counts of the sets, not the actual strings.
297
298
459e0b81
MK
299LINKINFO_GET
300============
301
302Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
303link modes and autonegotiation related information. The request does not use
304any attributes.
305
306Request contents:
307
308 ==================================== ====== ==========================
309 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
310 ==================================== ====== ==========================
311
312Kernel 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
323Attributes and their values have the same meaning as matching members of the
324corresponding ioctl structures.
325
326``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
327devices supporting the request).
328
329
a53f3d41
MK
330LINKINFO_SET
331============
332
333``LINKINFO_SET`` request allows setting some of the attributes reported by
334``LINKINFO_GET``.
335
336Request 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
345MDI(-X) status and transceiver cannot be set, request with the corresponding
346attributes is rejected.
347
348
f625aa9b
MK
349LINKMODES_GET
350=============
351
352Requests link modes (supported, advertised and peer advertised) and related
353information (autonegotiation status, link speed and duplex) as provided by
354``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
355
356Request contents:
357
358 ==================================== ====== ==========================
359 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
360 ==================================== ====== ==========================
361
362Kernel 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
373For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
374represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
375list.
376
377``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
378devices supporting the request).
379
380
bfbcfe20
MK
381LINKMODES_SET
382=============
383
384Request 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
396autonegotiation is on (either set now or kept from before), advertised modes
397are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
398of speed and duplex is specified, kernel adjusts advertised modes to all
399supported modes matching speed, duplex or both (whatever is specified). This
400autoselection is done on ethtool side with ioctl interface, netlink interface
401is supposed to allow requesting changes without knowing what exactly kernel
402supports.
403
404
3d2b847f
MK
405LINKSTATE_GET
406=============
407
408Requests link state information. At the moment, only link up/down flag (as
409provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future
410extensions are planned (e.g. link down reason). This request does not have any
411attributes.
412
413Request contents:
414
415 ==================================== ====== ==========================
416 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header
417 ==================================== ====== ==========================
418
419Kernel response contents:
420
421 ==================================== ====== ==========================
422 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header
423 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down)
424 ==================================== ====== ==========================
425
426For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
427carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
428define their own handler.
429
430``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
431devices supporting the request).
432
433
6a94b8cc
MK
434DEBUG_GET
435=========
436
437Requests debugging settings of a device. At the moment, only message mask is
438provided.
439
440Request contents:
441
442 ==================================== ====== ==========================
443 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
444 ==================================== ====== ==========================
445
446Kernel response contents:
447
448 ==================================== ====== ==========================
449 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header
450 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
451 ==================================== ====== ==========================
452
453The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
454provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
455interface. While it is called message level there for historical reasons, most
456drivers and almost all newer drivers use it as a mask of enabled message
457classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
458interface follows its actual use in practice.
459
460``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
461devices supporting the request).
462
463
e54d04e3
MK
464DEBUG_SET
465=========
466
467Set or update debugging settings of a device. At the moment, only message mask
468is supported.
469
470Request 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
478enabled debugging message types for the device.
479
480
51ea22b0
MK
481WOL_GET
482=======
483
484Query 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
488Request contents:
489
490 ==================================== ====== ==========================
491 ``ETHTOOL_A_WOL_HEADER`` nested request header
492 ==================================== ====== ==========================
493
494Kernel 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
502In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
503device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
504included in reply if ``WAKE_MAGICSECURE`` mode is supported.
505
506
8d425b19
MK
507WOL_SET
508=======
509
510Set or update wake-on-lan settings.
511
512Request 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
2b4a8990
MK
524Request translation
525===================
526
527The following table maps ioctl commands to netlink commands providing their
528functionality. Entries with "n/a" in right column are commands which do not
529have their netlink replacement yet.
530
531 =================================== =====================================
532 ioctl command netlink command
533 =================================== =====================================
459e0b81 534 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET``
f625aa9b 535 ``ETHTOOL_MSG_LINKMODES_GET``
a53f3d41 536 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET``
bfbcfe20 537 ``ETHTOOL_MSG_LINKMODES_SET``
2b4a8990
MK
538 ``ETHTOOL_GDRVINFO`` n/a
539 ``ETHTOOL_GREGS`` n/a
51ea22b0 540 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET``
8d425b19 541 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET``
6a94b8cc 542 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET``
e54d04e3 543 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET``
2b4a8990 544 ``ETHTOOL_NWAY_RST`` n/a
3d2b847f 545 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET``
2b4a8990
MK
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
71921690 561 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET``
2b4a8990
MK
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
71921690 589 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET``
2b4a8990
MK
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
459e0b81 610 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET``
f625aa9b 611 ``ETHTOOL_MSG_LINKMODES_GET``
a53f3d41 612 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET``
bfbcfe20 613 ``ETHTOOL_MSG_LINKMODES_SET``
2b4a8990
MK
614 ``ETHTOOL_PHY_GTUNABLE`` n/a
615 ``ETHTOOL_PHY_STUNABLE`` n/a
616 ``ETHTOOL_GFECPARAM`` n/a
617 ``ETHTOOL_SFECPARAM`` n/a
618 =================================== =====================================