projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Revert "vlan: move dev_put into vlan_dev_uninit"
[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
353407d9
IS		 44Attributes that need to be filled-in by device drivers and that are dumped to
45user space based on whether they are valid or not should not use zero as a
46valid value. This avoids the need to explicitly signal the validity of the
47attribute in the device driver API.
48
2b4a8990
MK		 49
50Request header
51==============
52
53Each request or reply message contains a nested attribute with common header.
54Structure of this header is
55
56 ============================== ====== =============================
57 ``ETHTOOL_A_HEADER_DEV_INDEX`` u32 device ifindex
58 ``ETHTOOL_A_HEADER_DEV_NAME`` string device name
59 ``ETHTOOL_A_HEADER_FLAGS`` u32 flags common for all requests
60 ============================== ====== =============================
61
62``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
63device message relates to. One of them is sufficient in requests, if both are
64used, they must identify the same device. Some requests, e.g. global string
65sets, do not require device identification. Most ``GET`` requests also allow
66dump requests without device identification to query the same information for
67all devices providing it (each device in a separate message).
68
69``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request
70types. The interpretation of these flags is the same for all request types but
71the flags may not apply to requests. Recognized flags are:
72
73 ================================= ===================================
74 ``ETHTOOL_FLAG_COMPACT_BITSETS`` use compact format bitsets in reply
75 ``ETHTOOL_FLAG_OMIT_REPLY`` omit optional reply (_SET and _ACT)
9a27a330 76 ``ETHTOOL_FLAG_STATS`` include optional device statistics
2b4a8990
MK		 77 ================================= ===================================
78
79New request flags should follow the general idea that if the flag is not set,
80the behaviour is backward compatible, i.e. requests from old clients not aware
81of the flag should be interpreted the way the client expects. A client must
82not set flags it does not understand.
83
84
10b518d4
MK		 85Bit sets
86========
87
88For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
89type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
90attribute with contents of one of two forms: compact (two binary bitmaps
91representing bit values and mask of affected bits) and bit-by-bit (list of
92bits identified by either index or name).
93
94Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
95with their values which saves a round trip (when the bitset is passed in a
96request) or at least a second request (when the bitset is in a reply). This is
97useful for one shot applications like traditional ethtool command. On the
98other hand, long running applications like ethtool monitor (displaying
99notifications) or network management daemons may prefer fetching the names
100only once and using compact form to save message size. Notifications from
101ethtool netlink interface always use compact form for bitsets.
102
103A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
104not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
105modifying a bitmap, the former changes the bit set in mask to values set in
106value and preserves the rest; the latter sets the bits set in the bitmap and
107clears the rest.
108
109Compact form: nested (bitset) atrribute contents:
110
111 ============================ ====== ============================
112 ``ETHTOOL_A_BITSET_NOMASK`` flag no mask, only a list
113 ``ETHTOOL_A_BITSET_SIZE`` u32 number of significant bits
114 ``ETHTOOL_A_BITSET_VALUE`` binary bitmap of bit values
115 ``ETHTOOL_A_BITSET_MASK`` binary bitmap of valid bits
116 ============================ ====== ============================
117
118Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
119rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
120order, words ordered from least significant to most significant (i.e. the same
121way as bitmaps are passed with ioctl interface).
122
123For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
124mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
125``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
126if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
127allowed (bitset represents a single bitmap.
128
129Kernel bit set length may differ from userspace length if older application is
130used on newer kernel or vice versa. If userspace bitmap is longer, an error is
131issued only if the request actually tries to set values of some bits not
132recognized by kernel.
133
134Bit-by-bit form: nested (bitset) attribute contents:
135
136 +------------------------------------+--------+-----------------------------+
137 | ``ETHTOOL_A_BITSET_NOMASK`` | flag | no mask, only a list |
138 +------------------------------------+--------+-----------------------------+
139 | ``ETHTOOL_A_BITSET_SIZE`` | u32 | number of significant bits |
140 +------------------------------------+--------+-----------------------------+
141 | ``ETHTOOL_A_BITSET_BITS`` | nested | array of bits |
142 +-+----------------------------------+--------+-----------------------------+
143 | | ``ETHTOOL_A_BITSET_BITS_BIT+`` | nested | one bit |
144 +-+-+--------------------------------+--------+-----------------------------+
145 | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32 | bit index (0 for LSB) |
146 +-+-+--------------------------------+--------+-----------------------------+
147 | | | ``ETHTOOL_A_BITSET_BIT_NAME`` | string | bit name |
148 +-+-+--------------------------------+--------+-----------------------------+
149 | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag | present if bit is set |
150 +-+-+--------------------------------+--------+-----------------------------+
151
152Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
153only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
154arbitrary number of them. A bit may be identified by its index or by its
155name. When used in requests, listed bits are set to 0 or 1 according to
156``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if
157index exceeds kernel bit length or if name is not recognized.
158
159When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
160a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
161such case. Such bitset represents a bitmap with listed bits set and the rest
162zero.
163
164In requests, application can use either form. Form used by kernel in reply is
165determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
166header. Semantics of value and mask depends on the attribute.
167
168
2b4a8990
MK		 169List of message types
170=====================
171
172All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
173according to message purpose:
174
175 ============== ======================================
176 ``_GET`` userspace request to retrieve data
177 ``_SET`` userspace request to set data
178 ``_ACT`` userspace request to perform an action
179 ``_GET_REPLY`` kernel reply to a ``GET`` request
180 ``_SET_REPLY`` kernel reply to a ``SET`` request
181 ``_ACT_REPLY`` kernel reply to an ``ACT`` request
182 ``_NTF`` kernel notification
183 ============== ======================================
184
71921690
MK		 185Userspace to kernel:
186
353407d9 187 ===================================== =================================
71921690 188 ``ETHTOOL_MSG_STRSET_GET`` get string set
459e0b81 189 ``ETHTOOL_MSG_LINKINFO_GET`` get link settings
a53f3d41 190 ``ETHTOOL_MSG_LINKINFO_SET`` set link settings
f625aa9b 191 ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info
bfbcfe20 192 ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info
3d2b847f 193 ``ETHTOOL_MSG_LINKSTATE_GET`` get link state
6a94b8cc 194 ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings
e54d04e3 195 ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings
51ea22b0 196 ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings
8d425b19 197 ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings
0524399d 198 ``ETHTOOL_MSG_FEATURES_GET`` get device features
0980bfcd 199 ``ETHTOOL_MSG_FEATURES_SET`` set device features
e16c3386 200 ``ETHTOOL_MSG_PRIVFLAGS_GET`` get private flags
f265d799 201 ``ETHTOOL_MSG_PRIVFLAGS_SET`` set private flags
e4a1717b 202 ``ETHTOOL_MSG_RINGS_GET`` get ring sizes
2fc2929e 203 ``ETHTOOL_MSG_RINGS_SET`` set ring sizes
0c84979c 204 ``ETHTOOL_MSG_CHANNELS_GET`` get channel counts
e19c591e 205 ``ETHTOOL_MSG_CHANNELS_SET`` set channel counts
21727545 206 ``ETHTOOL_MSG_COALESCE_GET`` get coalescing parameters
9881418c 207 ``ETHTOOL_MSG_COALESCE_SET`` set coalescing parameters
7f59fb32 208 ``ETHTOOL_MSG_PAUSE_GET`` get pause parameters
3ab87993 209 ``ETHTOOL_MSG_PAUSE_SET`` set pause parameters
b7eeefe7 210 ``ETHTOOL_MSG_EEE_GET`` get EEE settings
fd77be7b 211 ``ETHTOOL_MSG_EEE_SET`` set EEE settings
5b071c59 212 ``ETHTOOL_MSG_TSINFO_GET`` get timestamping info
11ca3c42 213 ``ETHTOOL_MSG_CABLE_TEST_ACT`` action start cable test
a331172b 214 ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT`` action start raw TDR cable test
19a83d36 215 ``ETHTOOL_MSG_TUNNEL_INFO_GET`` get tunnel offload info
1e5d1f69
JK		 216 ``ETHTOOL_MSG_FEC_GET`` get FEC settings
217 ``ETHTOOL_MSG_FEC_SET`` set FEC settings
e9377a91 218 ``ETHTOOL_MSG_MODULE_EEPROM_GET`` read SFP module EEPROM
ddc78b36 219 ``ETHTOOL_MSG_STATS_GET`` get standard statistics
c156174a 220 ``ETHTOOL_MSG_PHC_VCLOCKS_GET`` get PHC virtual clocks info
353407d9
IS		 221 ``ETHTOOL_MSG_MODULE_SET`` set transceiver module parameters
222 ``ETHTOOL_MSG_MODULE_GET`` get transceiver module parameters
223 ===================================== =================================
71921690
MK		 224
225Kernel to userspace:
226
e9377a91
JK		 227 ======================================== =================================
228 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents
229 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings
230 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification
231 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info
232 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification
233 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info
234 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings
235 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification
236 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings
237 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification
238 ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features
239 ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET
240 ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification
241 ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags
242 ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags
243 ``ETHTOOL_MSG_RINGS_GET_REPLY`` ring sizes
244 ``ETHTOOL_MSG_RINGS_NTF`` ring sizes
245 ``ETHTOOL_MSG_CHANNELS_GET_REPLY`` channel counts
246 ``ETHTOOL_MSG_CHANNELS_NTF`` channel counts
247 ``ETHTOOL_MSG_COALESCE_GET_REPLY`` coalescing parameters
248 ``ETHTOOL_MSG_COALESCE_NTF`` coalescing parameters
249 ``ETHTOOL_MSG_PAUSE_GET_REPLY`` pause parameters
250 ``ETHTOOL_MSG_PAUSE_NTF`` pause parameters
251 ``ETHTOOL_MSG_EEE_GET_REPLY`` EEE settings
252 ``ETHTOOL_MSG_EEE_NTF`` EEE settings
253 ``ETHTOOL_MSG_TSINFO_GET_REPLY`` timestamping info
254 ``ETHTOOL_MSG_CABLE_TEST_NTF`` Cable test results
255 ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF`` Cable test TDR results
256 ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY`` tunnel offload info
257 ``ETHTOOL_MSG_FEC_GET_REPLY`` FEC settings
258 ``ETHTOOL_MSG_FEC_NTF`` FEC settings
259 ``ETHTOOL_MSG_MODULE_EEPROM_GET_REPLY`` read SFP module EEPROM
260 ``ETHTOOL_MSG_STATS_GET_REPLY`` standard statistics
c156174a 261 ``ETHTOOL_MSG_PHC_VCLOCKS_GET_REPLY`` PHC virtual clocks info
353407d9 262 ``ETHTOOL_MSG_MODULE_GET_REPLY`` transceiver module parameters
e9377a91 263 ======================================== =================================
71921690 264
2b4a8990
MK		 265``GET`` requests are sent by userspace applications to retrieve device
266information. They usually do not contain any message specific attributes.
267Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
268request with ``NLM_F_DUMP`` and no device identification can be used to query
269the information for all devices supporting the request.
270
271If the data can be also modified, corresponding ``SET`` message with the same
272layout as corresponding ``GET_REPLY`` is used to request changes. Only
273attributes where a change is requested are included in such request (also, not
274all attributes may be changed). Replies to most ``SET`` request consist only
275of error code and extack; if kernel provides additional data, it is sent in
276the form of corresponding ``SET_REPLY`` message which can be suppressed by
277setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
278
279Data modification also triggers sending a ``NTF`` message with a notification.
280These usually bear only a subset of attributes which was affected by the
281change. The same notification is issued if the data is modified using other
282means (mostly ioctl ethtool interface). Unlike notifications from ethtool
283netlink code which are only sent if something actually changed, notifications
284triggered by ioctl interface may be sent even if the request did not actually
285change any data.
286
287``ACT`` messages request kernel (driver) to perform a specific action. If some
288information is reported by kernel (which can be suppressed by setting
289``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
290an ``ACT_REPLY`` message. Performing an action also triggers a notification
291(``NTF`` message).
292
293Later sections describe the format and semantics of these messages.
294
295
71921690
MK		 296STRSET_GET
297==========
298
299Requests contents of a string set as provided by ioctl commands
300``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
301writeable so that the corresponding ``STRSET_SET`` message is only used in
302kernel replies. There are two types of string sets: global (independent of
303a device, e.g. device feature names) and device specific (e.g. device private
304flags).
305
306Request contents:
307
308 +---------------------------------------+--------+------------------------+
309 | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header |
310 +---------------------------------------+--------+------------------------+
311 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request |
312 +-+-------------------------------------+--------+------------------------+
313 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set |
314 +-+-+-----------------------------------+--------+------------------------+
315 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id |
316 +-+-+-----------------------------------+--------+------------------------+
317
318Kernel response contents:
319
320 +---------------------------------------+--------+-----------------------+
321 | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header |
322 +---------------------------------------+--------+-----------------------+
323 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets |
324 +-+-------------------------------------+--------+-----------------------+
325 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set |
326 +-+-+-----------------------------------+--------+-----------------------+
327 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id |
328 +-+-+-----------------------------------+--------+-----------------------+
329 | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings |
330 +-+-+-----------------------------------+--------+-----------------------+
331 | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings |
332 +-+-+-+---------------------------------+--------+-----------------------+
333 | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string |
334 +-+-+-+-+-------------------------------+--------+-----------------------+
335 | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index |
336 +-+-+-+-+-------------------------------+--------+-----------------------+
337 | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value |
338 +-+-+-+-+-------------------------------+--------+-----------------------+
339 | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts |
340 +---------------------------------------+--------+-----------------------+
341
342Device identification in request header is optional. Depending on its presence
343a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
344
345 - no ``NLM_F_DUMP,`` no device: get "global" stringsets
346 - no ``NLM_F_DUMP``, with device: get string sets related to the device
347 - ``NLM_F_DUMP``, no device: get device related string sets for all devices
348
349If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
350requested type are returned, otherwise only those specified in the request.
351Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
352counts of the sets, not the actual strings.
353
354
459e0b81
MK		 355LINKINFO_GET
356============
357
358Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
359link modes and autonegotiation related information. The request does not use
360any attributes.
361
362Request contents:
363
364 ==================================== ====== ==========================
365 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
366 ==================================== ====== ==========================
367
368Kernel response contents:
369
370 ==================================== ====== ==========================
371 ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header
372 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port
373 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address
374 ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status
375 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control
376 ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver
377 ==================================== ====== ==========================
378
379Attributes and their values have the same meaning as matching members of the
380corresponding ioctl structures.
381
382``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
383devices supporting the request).
384
385
a53f3d41
MK		 386LINKINFO_SET
387============
388
389``LINKINFO_SET`` request allows setting some of the attributes reported by
390``LINKINFO_GET``.
391
392Request contents:
393
394 ==================================== ====== ==========================
395 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
396 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port
397 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address
398 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control
399 ==================================== ====== ==========================
400
401MDI(-X) status and transceiver cannot be set, request with the corresponding
402attributes is rejected.
403
404
f625aa9b
MK		 405LINKMODES_GET
406=============
407
408Requests link modes (supported, advertised and peer advertised) and related
409information (autonegotiation status, link speed and duplex) as provided by
410``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
411
412Request contents:
413
414 ==================================== ====== ==========================
415 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
416 ==================================== ====== ==========================
417
418Kernel response contents:
419
bdbdac76
OR		 420 ========================================== ====== ==========================
421 ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header
422 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status
423 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes
424 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes
425 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s)
426 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode
427 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode
428 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE`` u8 Master/slave port state
429 ========================================== ====== ==========================
f625aa9b
MK		 430
431For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
432represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
433list.
434
435``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
436devices supporting the request).
437
438
bfbcfe20
MK		 439LINKMODES_SET
440=============
441
442Request contents:
443
bdbdac76
OR		 444 ========================================== ====== ==========================
445 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
446 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status
447 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes
448 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes
449 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s)
450 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode
451 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode
012ce4dd 452 ``ETHTOOL_A_LINKMODES_LANES`` u32 lanes
bdbdac76 453 ========================================== ====== ==========================
bfbcfe20
MK		 454
455``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
456autonegotiation is on (either set now or kept from before), advertised modes
457are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
012ce4dd
DR		 458of speed, duplex and lanes is specified, kernel adjusts advertised modes to all
459supported modes matching speed, duplex, lanes or all (whatever is specified).
460This autoselection is done on ethtool side with ioctl interface, netlink
461interface is supposed to allow requesting changes without knowing what exactly
462kernel supports.
bfbcfe20
MK		 463
464
3d2b847f
MK		 465LINKSTATE_GET
466=============
467
e120c801
AC		 468Requests link state information. Link up/down flag (as provided by
469``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
470be provided as well. In general, extended state describes reasons for why a port
471is down, or why it operates in some non-obvious mode. This request does not have
472any attributes.
3d2b847f
MK		 473
474Request contents:
475
476 ==================================== ====== ==========================
477 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header
478 ==================================== ====== ==========================
479
480Kernel response contents:
481
80660219 482 ==================================== ====== ============================
3d2b847f
MK		 483 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header
484 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down)
80660219
OR		 485 ``ETHTOOL_A_LINKSTATE_SQI`` u32 Current Signal Quality Index
486 ``ETHTOOL_A_LINKSTATE_SQI_MAX`` u32 Max support SQI value
e120c801
AC		 487 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state
488 ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate
80660219 489 ==================================== ====== ============================
3d2b847f
MK		 490
491For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
492carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
493define their own handler.
494
e120c801
AC		 495``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
496optional values. ethtool core can provide either both
497``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
498or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
499
3d2b847f
MK		 500``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
501devices supporting the request).
502
503
e120c801
AC		 504Link extended states:
505
506 ================================================ ============================================
507 ``ETHTOOL_LINK_EXT_STATE_AUTONEG`` States relating to the autonegotiation or
508 issues therein
509
510 ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE`` Failure during link training
511
512 ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH`` Logical mismatch in physical coding sublayer
513 or forward error correction sublayer
514
515 ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY`` Signal integrity issues
516
517 ``ETHTOOL_LINK_EXT_STATE_NO_CABLE`` No cable connected
518
519 ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE`` Failure is related to cable,
520 e.g., unsupported cable
521
522 ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE`` Failure is related to EEPROM, e.g., failure
523 during reading or parsing the data
524
525 ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE`` Failure during calibration algorithm
526
527 ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED`` The hardware is not able to provide the
528 power required from cable or module
529
530 ``ETHTOOL_LINK_EXT_STATE_OVERHEAT`` The module is overheated
3dfb5112
IS		 531
532 ``ETHTOOL_LINK_EXT_STATE_MODULE`` Transceiver module issue
1a4d6816 533 ================================================ ============================================
e120c801
AC		 534
535Link extended substates:
536
537 Autoneg substates:
538
1a4d6816 539 =============================================================== ================================
e120c801
AC		 540 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED`` Peer side is down
541
542 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED`` Ack not received from peer side
543
544 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED`` Next page exchange failed
545
546 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE`` Peer side is down during force
547 mode or there is no agreement of
548 speed
549
550 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE`` Forward error correction modes
551 in both sides are mismatched
552
553 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD`` No Highest Common Denominator
1a4d6816 554 =============================================================== ================================
e120c801
AC		 555
556 Link training substates:
557
1a4d6816 558 =========================================================================== ====================
e120c801
AC		 559 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED`` Frames were not
560 recognized, the
561 lock failed
562
563 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT`` The lock did not
564 occur before
565 timeout
566
567 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY`` Peer side did not
568 send ready signal
569 after training
570 process
571
572 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT`` Remote side is not
573 ready yet
1a4d6816 574 =========================================================================== ====================
e120c801
AC		 575
576 Link logical mismatch substates:
577
1a4d6816 578 ================================================================ ===============================
e120c801
AC		 579 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK`` Physical coding sublayer was
580 not locked in first phase -
581 block lock
582
583 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK`` Physical coding sublayer was
584 not locked in second phase -
585 alignment markers lock
586
587 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS`` Physical coding sublayer did
588 not get align status
589
590 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED`` FC forward error correction is
591 not locked
592
593 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED`` RS forward error correction is
594 not locked
1a4d6816 595 ================================================================ ===============================
e120c801
AC		 596
597 Bad signal integrity substates:
598
599 ================================================================= =============================
600 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS`` Large number of physical
601 errors
602
603 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE`` The system attempted to
604 operate the cable at a rate
605 that is not formally
606 supported, which led to
607 signal integrity issues
958ab281
GH		 608
609 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST`` The external clock signal for
610 SerDes is too weak or
611 unavailable.
612
613 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS`` The received signal for
614 SerDes is too weak because
615 analog loss of signal.
e120c801
AC		 616 ================================================================= =============================
617
618 Cable issue substates:
619
1a4d6816 620 =================================================== ============================================
e120c801
AC		 621 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE`` Unsupported cable
622
623 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE`` Cable test failure
1a4d6816 624 =================================================== ============================================
3dfb5112
IS		 625
626 Transceiver module issue substates:
627
628 =================================================== ============================================
629 ``ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY`` The CMIS Module State Machine did not reach
630 the ModuleReady state. For example, if the
631 module is stuck at ModuleFault state
632 =================================================== ============================================
e120c801 633
6a94b8cc
MK		 634DEBUG_GET
635=========
636
637Requests debugging settings of a device. At the moment, only message mask is
638provided.
639
640Request contents:
641
642 ==================================== ====== ==========================
643 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
644 ==================================== ====== ==========================
645
646Kernel response contents:
647
648 ==================================== ====== ==========================
649 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header
650 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
651 ==================================== ====== ==========================
652
653The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
654provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
655interface. While it is called message level there for historical reasons, most
656drivers and almost all newer drivers use it as a mask of enabled message
657classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
658interface follows its actual use in practice.
659
660``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
661devices supporting the request).
662
663
e54d04e3
MK		 664DEBUG_SET
665=========
666
667Set or update debugging settings of a device. At the moment, only message mask
668is supported.
669
670Request contents:
671
672 ==================================== ====== ==========================
673 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
674 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
675 ==================================== ====== ==========================
676
677``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
678enabled debugging message types for the device.
679
680
51ea22b0
MK		 681WOL_GET
682=======
683
684Query device wake-on-lan settings. Unlike most "GET" type requests,
685``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
686(potentially) provides SecureOn(tm) password which is confidential.
687
688Request contents:
689
690 ==================================== ====== ==========================
691 ``ETHTOOL_A_WOL_HEADER`` nested request header
692 ==================================== ====== ==========================
693
694Kernel response contents:
695
696 ==================================== ====== ==========================
697 ``ETHTOOL_A_WOL_HEADER`` nested reply header
698 ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes
699 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password
700 ==================================== ====== ==========================
701
702In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
703device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
704included in reply if ``WAKE_MAGICSECURE`` mode is supported.
705
706
8d425b19
MK		 707WOL_SET
708=======
709
710Set or update wake-on-lan settings.
711
712Request contents:
713
714 ==================================== ====== ==========================
715 ``ETHTOOL_A_WOL_HEADER`` nested request header
716 ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes
717 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password
718 ==================================== ====== ==========================
719
720``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
721``WAKE_MAGICSECURE`` mode.
722
723
0524399d
MK		 724FEATURES_GET
725============
726
727Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
728
729Request contents:
730
731 ==================================== ====== ==========================
732 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
733 ==================================== ====== ==========================
734
735Kernel response contents:
736
737 ==================================== ====== ==========================
738 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header
739 ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features
740 ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features
741 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features
742 ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE
743 ==================================== ====== ==========================
744
745Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
746interference but attribute names are different (they are based on
747corresponding members of struct net_device). Legacy "flags" are not provided,
748if userspace needs them (most likely only ethtool for backward compatibility),
749it can calculate their values from related feature bits itself.
750ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
751provide all names when using verbose bitmap format), the other three use no
752mask (simple bit lists).
753
754
0980bfcd
MK		 755FEATURES_SET
756============
757
758Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
759
760Request contents:
761
762 ==================================== ====== ==========================
763 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
764 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features
765 ==================================== ====== ==========================
766
767Kernel response contents:
768
769 ==================================== ====== ==========================
770 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header
771 ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result
772 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active
773 ==================================== ====== ==========================
774
775Request constains only one bitset which can be either value/mask pair (request
776to change specific feature bits and leave the rest) or only a value (request
777to set all features to specified set).
778
779As request is subject to netdev_change_features() sanity checks, optional
780kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
781header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
782reports the difference between client request and actual result: mask consists
783of bits which differ between requested features and result (dev->features
784after the operation), value consists of values of these bits in the request
785(i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
786reports the difference between old and new dev->features: mask consists of
787bits which have changed, values are their values in new dev->features (after
788the operation).
789
9c6451ef
MK		 790``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
791are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
792request but also each time features are modified with netdev_update_features()
793or netdev_change_features().
794
0980bfcd 795
e16c3386
MK		 796PRIVFLAGS_GET
797=============
798
799Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
800
801Request contents:
802
803 ==================================== ====== ==========================
804 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
805 ==================================== ====== ==========================
806
807Kernel response contents:
808
809 ==================================== ====== ==========================
810 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header
811 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
812 ==================================== ====== ==========================
813
814``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
815These flags are defined by driver, their number and names (and also meaning)
816are device dependent. For compact bitset format, names can be retrieved as
817``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
818response uses all private flags supported by the device as mask so that client
819gets the full information without having to fetch the string set with names.
820
821
f265d799
MK		 822PRIVFLAGS_SET
823=============
824
825Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
826ioctl request.
827
828Request contents:
829
830 ==================================== ====== ==========================
831 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
832 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
833 ==================================== ====== ==========================
834
835``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
836modify only values of some of them.
837
838
e4a1717b
MK		 839RINGS_GET
840=========
841
842Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
843
844Request contents:
845
846 ==================================== ====== ==========================
847 ``ETHTOOL_A_RINGS_HEADER`` nested request header
848 ==================================== ====== ==========================
849
850Kernel response contents:
851
0b70c256 852 ==================================== ====== ===========================
e4a1717b
MK		 853 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
854 ``ETHTOOL_A_RINGS_RX_MAX`` u32 max size of RX ring
855 ``ETHTOOL_A_RINGS_RX_MINI_MAX`` u32 max size of RX mini ring
856 ``ETHTOOL_A_RINGS_RX_JUMBO_MAX`` u32 max size of RX jumbo ring
857 ``ETHTOOL_A_RINGS_TX_MAX`` u32 max size of TX ring
858 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
859 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
860 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
861 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
0b70c256 862 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring
9690ae60 863 ``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` u8 TCP header / data split
0b70c256 864 ==================================== ====== ===========================
e4a1717b 865
9690ae60
JK		 866``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` indicates whether the device is usable with
867page-flipping TCP zero-copy receive (``getsockopt(TCP_ZEROCOPY_RECEIVE)``).
868If enabled the device is configured to place frame headers and data into
869separate buffers. The device configuration must make it possible to receive
870full memory pages of data, for example because MTU is high enough or through
871HW-GRO.
872
e4a1717b 873
2fc2929e
MK		 874RINGS_SET
875=========
876
877Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
878
879Request contents:
880
0b70c256 881 ==================================== ====== ===========================
2fc2929e
MK		 882 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
883 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
884 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
885 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
886 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
0b70c256
HC		 887 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring
888 ==================================== ====== ===========================
2fc2929e
MK		 889
890Kernel checks that requested ring sizes do not exceed limits reported by
891driver. Driver may impose additional constraints and may not suspport all
892attributes.
893
894
0c84979c
MK		 895CHANNELS_GET
896============
897
898Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
899
900Request contents:
901
902 ==================================== ====== ==========================
903 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
904 ==================================== ====== ==========================
905
906Kernel response contents:
907
908 ===================================== ====== ==========================
909 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header
910 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels
911 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels
912 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels
913 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels
914 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
915 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
916 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
917 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
918 ===================================== ====== ==========================
919
920
e19c591e
MK		 921CHANNELS_SET
922============
923
924Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
925
926Request contents:
927
928 ===================================== ====== ==========================
929 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
930 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
931 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
932 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
933 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
934 ===================================== ====== ==========================
935
936Kernel checks that requested channel counts do not exceed limits reported by
937driver. Driver may impose additional constraints and may not suspport all
938attributes.
939
940
21727545
MK		 941COALESCE_GET
942============
943
944Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
945
946Request contents:
947
948 ==================================== ====== ==========================
949 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
950 ==================================== ====== ==========================
951
952Kernel response contents:
953
954 =========================================== ====== =======================
955 ``ETHTOOL_A_COALESCE_HEADER`` nested reply header
956 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
957 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
958 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
959 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
960 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
961 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
962 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
963 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
964 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
965 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
966 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
967 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
968 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
969 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
970 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
971 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
972 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
973 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
974 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
975 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
976 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
977 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
029ee6b1
YM		 978 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx
979 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx
21727545
MK		 980 =========================================== ====== =======================
981
982Attributes are only included in reply if their value is not zero or the
983corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
984they are declared as supported by driver).
985
029ee6b1
YM		 986Timer reset mode (``ETHTOOL_A_COALESCE_USE_CQE_TX`` and
987``ETHTOOL_A_COALESCE_USE_CQE_RX``) controls the interaction between packet
988arrival and the various time based delay parameters. By default timers are
989expected to limit the max delay between any packet arrival/departure and a
990corresponding interrupt. In this mode timer should be started by packet
991arrival (sometimes delivery of previous interrupt) and reset when interrupt
992is delivered.
993Setting the appropriate attribute to 1 will enable ``CQE`` mode, where
994each packet event resets the timer. In this mode timer is used to force
995the interrupt if queue goes idle, while busy queues depend on the packet
996limit to trigger interrupts.
21727545 997
9881418c
MK		 998COALESCE_SET
999============
1000
1001Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
1002
1003Request contents:
1004
1005 =========================================== ====== =======================
1006 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
1007 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
1008 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
1009 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
1010 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
1011 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
1012 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
1013 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
1014 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
1015 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
1016 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
1017 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
1018 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
1019 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
1020 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
1021 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
1022 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
1023 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
1024 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
1025 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
1026 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
1027 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
1028 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
029ee6b1
YM		 1029 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx
1030 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx
9881418c
MK		 1031 =========================================== ====== =======================
1032
1033Request is rejected if it attributes declared as unsupported by driver (i.e.
1034such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
1035is not set), regardless of their values. Driver may impose additional
1036constraints on coalescing parameters and their values.
1037
1038
7f59fb32 1039PAUSE_GET
5219d601 1040=========
7f59fb32 1041
5219d601 1042Gets pause frame settings like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
7f59fb32
MK		 1043
1044Request contents:
1045
1046 ===================================== ====== ==========================
1047 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1048 ===================================== ====== ==========================
1049
1050Kernel response contents:
1051
1052 ===================================== ====== ==========================
1053 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1054 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1055 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1056 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
9a27a330 1057 ``ETHTOOL_A_PAUSE_STATS`` nested pause statistics
7f59fb32
MK		 1058 ===================================== ====== ==========================
1059
9a27a330
JK		 1060``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set
1061in ``ETHTOOL_A_HEADER_FLAGS``.
1062It will be empty if driver did not report any statistics. Drivers fill in
1063the statistics in the following structure:
1064
1065.. kernel-doc:: include/linux/ethtool.h
1066 :identifiers: ethtool_pause_stats
1067
1068Each member has a corresponding attribute defined.
7f59fb32
MK		 1069
1070PAUSE_SET
5219d601 1071=========
7f59fb32
MK		 1072
1073Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1074
1075Request contents:
1076
1077 ===================================== ====== ==========================
1078 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1079 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1080 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1081 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
1082 ===================================== ====== ==========================
1083
1084
b7eeefe7
MK		 1085EEE_GET
1086=======
1087
5219d601 1088Gets Energy Efficient Ethernet settings like ``ETHTOOL_GEEE`` ioctl request.
b7eeefe7
MK		 1089
1090Request contents:
1091
1092 ===================================== ====== ==========================
1093 ``ETHTOOL_A_EEE_HEADER`` nested request header
1094 ===================================== ====== ==========================
1095
1096Kernel response contents:
1097
1098 ===================================== ====== ==========================
1099 ``ETHTOOL_A_EEE_HEADER`` nested request header
1100 ``ETHTOOL_A_EEE_MODES_OURS`` bool supported/advertised modes
1101 ``ETHTOOL_A_EEE_MODES_PEER`` bool peer advertised link modes
1102 ``ETHTOOL_A_EEE_ACTIVE`` bool EEE is actively used
1103 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1104 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1105 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1106 ===================================== ====== ==========================
1107
1108In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
1109enabled, value of link modes for which EEE is advertised. Link modes for which
1110peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
1111netlink interface allows reporting EEE status for all link modes but only
1112first 32 are provided by the ``ethtool_ops`` callback.
1113
1114
fd77be7b
MK		 1115EEE_SET
1116=======
1117
5219d601 1118Sets Energy Efficient Ethernet parameters like ``ETHTOOL_SEEE`` ioctl request.
fd77be7b
MK		 1119
1120Request contents:
1121
1122 ===================================== ====== ==========================
1123 ``ETHTOOL_A_EEE_HEADER`` nested request header
1124 ``ETHTOOL_A_EEE_MODES_OURS`` bool advertised modes
1125 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1126 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1127 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1128 ===================================== ====== ==========================
1129
1130``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
1131EEE for (if there is no mask) or specify changes to the list (if there is
1132a mask). The netlink interface allows reporting EEE status for all link modes
1133but only first 32 can be set at the moment as that is what the ``ethtool_ops``
1134callback supports.
1135
1136
5b071c59
MK		 1137TSINFO_GET
1138==========
1139
1140Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
1141
1142Request contents:
1143
1144 ===================================== ====== ==========================
1145 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1146 ===================================== ====== ==========================
1147
1148Kernel response contents:
1149
1150 ===================================== ====== ==========================
1151 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1152 ``ETHTOOL_A_TSINFO_TIMESTAMPING`` bitset SO_TIMESTAMPING flags
1153 ``ETHTOOL_A_TSINFO_TX_TYPES`` bitset supported Tx types
1154 ``ETHTOOL_A_TSINFO_RX_FILTERS`` bitset supported Rx filters
1155 ``ETHTOOL_A_TSINFO_PHC_INDEX`` u32 PTP hw clock index
1156 ===================================== ====== ==========================
1157
1158``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
1159is no special value for this case). The bitset attributes are omitted if they
1160would be empty (no bit set).
1161
11ca3c42
AL		 1162CABLE_TEST
1163==========
1164
1165Start a cable test.
1166
1167Request contents:
1168
1169 ==================================== ====== ==========================
1170 ``ETHTOOL_A_CABLE_TEST_HEADER`` nested request header
1171 ==================================== ====== ==========================
1172
b28efb93
AL		 1173Notification contents:
1174
1175An Ethernet cable typically contains 1, 2 or 4 pairs. The length of
1176the pair can only be measured when there is a fault in the pair and
1177hence a reflection. Information about the fault may not be available,
1178depending on the specific hardware. Hence the contents of the notify
1179message are mostly optional. The attributes can be repeated an
1180arbitrary number of times, in an arbitrary order, for an arbitrary
1181number of pairs.
1182
1183The example shows the notification sent when the test is completed for
1184a T2 cable, i.e. two pairs. One pair is OK and hence has no length
1185information. The second pair has a fault and does have length
1186information.
1187
1188 +---------------------------------------------+--------+---------------------+
1189 | ``ETHTOOL_A_CABLE_TEST_HEADER`` | nested | reply header |
1190 +---------------------------------------------+--------+---------------------+
1191 | ``ETHTOOL_A_CABLE_TEST_STATUS`` | u8 | completed |
1192 +---------------------------------------------+--------+---------------------+
1193 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST`` | nested | all the results |
1194 +-+-------------------------------------------+--------+---------------------+
1195 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test result |
1196 +-+-+-----------------------------------------+--------+---------------------+
1197 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1198 +-+-+-----------------------------------------+--------+---------------------+
1199 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1200 +-+-+-----------------------------------------+--------+---------------------+
1201 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test results |
1202 +-+-+-----------------------------------------+--------+---------------------+
1203 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1204 +-+-+-----------------------------------------+--------+---------------------+
1205 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1206 +-+-+-----------------------------------------+--------+---------------------+
1207 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH`` | nested | cable length |
1208 +-+-+-----------------------------------------+--------+---------------------+
1209 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR`` | u8 | pair number |
1210 +-+-+-----------------------------------------+--------+---------------------+
1211 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM`` | u32 | length in cm |
1212 +-+-+-----------------------------------------+--------+---------------------+
5b071c59 1213
a331172b
AL		 1214CABLE_TEST TDR
1215==============
1216
1217Start a cable test and report raw TDR data
1218
1219Request contents:
1220
f2bc8ad3
AL		 1221 +--------------------------------------------+--------+-----------------------+
1222 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1223 +--------------------------------------------+--------+-----------------------+
1224 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG`` | nested | test configuration |
1225 +-+------------------------------------------+--------+-----------------------+
58e898a0 1226 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | first data distance |
f2bc8ad3 1227 +-+-+----------------------------------------+--------+-----------------------+
58e898a0 1228 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | last data distance |
f2bc8ad3 1229 +-+-+----------------------------------------+--------+-----------------------+
58e898a0 1230 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step |
f2bc8ad3
AL		 1231 +-+-+----------------------------------------+--------+-----------------------+
1232 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR`` | u8 | pair to test |
1233 +-+-+----------------------------------------+--------+-----------------------+
1234
1235The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members
1236of the nest. All distances are expressed in centimeters. The PHY takes
1237the distances as a guide, and rounds to the nearest distance it
1238actually supports. If a pair is passed, only that one pair will be
1239tested. Otherwise all pairs are tested.
a331172b
AL		 1240
1241Notification contents:
1242
1243Raw TDR data is gathered by sending a pulse down the cable and
1244recording the amplitude of the reflected pulse for a given distance.
1245
1246It can take a number of seconds to collect TDR data, especial if the
1247full 100 meters is probed at 1 meter intervals. When the test is
1248started a notification will be sent containing just
1249ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1250ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED.
1251
1252When the test has completed a second notification will be sent
1253containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1254ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data.
1255
1256The message may optionally contain the amplitude of the pulse send
1257down the cable. This is measured in mV. A reflection should not be
1258bigger than transmitted pulse.
1259
1260Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP
1261nest containing information about the distance along the cable for the
1262first reading, the last reading, and the step between each
1263reading. Distances are measured in centimeters. These should be the
1264exact values the PHY used. These may be different to what the user
1265requested, if the native measurement resolution is greater than 1 cm.
1266
1267For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is
1268used to report the amplitude of the reflection for a given pair.
1269
1270 +---------------------------------------------+--------+----------------------+
1271 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1272 +---------------------------------------------+--------+----------------------+
1273 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS`` | u8 | completed |
1274 +---------------------------------------------+--------+----------------------+
1275 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST`` | nested | all the results |
1276 +-+-------------------------------------------+--------+----------------------+
1277 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE`` | nested | TX Pulse amplitude |
1278 +-+-+-----------------------------------------+--------+----------------------+
1279 | | | ``ETHTOOL_A_CABLE_PULSE_mV`` | s16 | Pulse amplitude |
1280 +-+-+-----------------------------------------+--------+----------------------+
1281 | | ``ETHTOOL_A_CABLE_NEST_STEP`` | nested | TDR step info |
1282 +-+-+-----------------------------------------+--------+----------------------+
58e898a0 1283 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | First data distance |
a331172b 1284 +-+-+-----------------------------------------+--------+----------------------+
58e898a0 1285 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | Last data distance |
a331172b 1286 +-+-+-----------------------------------------+--------+----------------------+
58e898a0 1287 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step|
a331172b
AL		 1288 +-+-+-----------------------------------------+--------+----------------------+
1289 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1290 +-+-+-----------------------------------------+--------+----------------------+
1291 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1292 +-+-+-----------------------------------------+--------+----------------------+
1293 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1294 +-+-+-----------------------------------------+--------+----------------------+
1295 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1296 +-+-+-----------------------------------------+--------+----------------------+
1297 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1298 +-+-+-----------------------------------------+--------+----------------------+
1299 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1300 +-+-+-----------------------------------------+--------+----------------------+
1301 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1302 +-+-+-----------------------------------------+--------+----------------------+
1303 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1304 +-+-+-----------------------------------------+--------+----------------------+
1305 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1306 +-+-+-----------------------------------------+--------+----------------------+
1307
c7d759eb
JK		 1308TUNNEL_INFO
1309===========
1310
1311Gets information about the tunnel state NIC is aware of.
1312
1313Request contents:
1314
1315 ===================================== ====== ==========================
1316 ``ETHTOOL_A_TUNNEL_INFO_HEADER`` nested request header
1317 ===================================== ====== ==========================
1318
1319Kernel response contents:
1320
1321 +---------------------------------------------+--------+---------------------+
1322 | ``ETHTOOL_A_TUNNEL_INFO_HEADER`` | nested | reply header |
1323 +---------------------------------------------+--------+---------------------+
1324 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS`` | nested | all UDP port tables |
1325 +-+-------------------------------------------+--------+---------------------+
1326 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE`` | nested | one UDP port table |
1327 +-+-+-----------------------------------------+--------+---------------------+
1328 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE`` | u32 | max size of the |
1329 | | | | | table |
1330 +-+-+-----------------------------------------+--------+---------------------+
1331 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` | bitset | tunnel types which |
1332 | | | | | table can hold |
1333 +-+-+-----------------------------------------+--------+---------------------+
1334 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY`` | nested | offloaded UDP port |
1335 +-+-+-+---------------------------------------+--------+---------------------+
1336 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT`` | be16 | UDP port |
1337 +-+-+-+---------------------------------------+--------+---------------------+
1338 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE`` | u32 | tunnel type |
1339 +-+-+-+---------------------------------------+--------+---------------------+
1340
966e5059
JK		 1341For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that
1342the table contains static entries, hard-coded by the NIC.
1343
1e5d1f69
JK		 1344FEC_GET
1345=======
1346
1347Gets FEC configuration and state like ``ETHTOOL_GFECPARAM`` ioctl request.
1348
1349Request contents:
1350
1351 ===================================== ====== ==========================
1352 ``ETHTOOL_A_FEC_HEADER`` nested request header
1353 ===================================== ====== ==========================
1354
1355Kernel response contents:
1356
1357 ===================================== ====== ==========================
1358 ``ETHTOOL_A_FEC_HEADER`` nested request header
1359 ``ETHTOOL_A_FEC_MODES`` bitset configured modes
1360 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection
1361 ``ETHTOOL_A_FEC_ACTIVE`` u32 index of active FEC mode
be85dbfe 1362 ``ETHTOOL_A_FEC_STATS`` nested FEC statistics
1e5d1f69
JK		 1363 ===================================== ====== ==========================
1364
1365``ETHTOOL_A_FEC_ACTIVE`` is the bit index of the FEC link mode currently
1366active on the interface. This attribute may not be present if device does
1367not support FEC.
1368
1369``ETHTOOL_A_FEC_MODES`` and ``ETHTOOL_A_FEC_AUTO`` are only meaningful when
1370autonegotiation is disabled. If ``ETHTOOL_A_FEC_AUTO`` is non-zero driver will
1371select the FEC mode automatically based on the parameters of the SFP module.
1372This is equivalent to the ``ETHTOOL_FEC_AUTO`` bit of the ioctl interface.
1373``ETHTOOL_A_FEC_MODES`` carry the current FEC configuration using link mode
1374bits (rather than old ``ETHTOOL_FEC_*`` bits).
1375
be85dbfe
JK		 1376``ETHTOOL_A_FEC_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
1377``ETHTOOL_A_HEADER_FLAGS``.
1378Each attribute carries an array of 64bit statistics. First entry in the array
1379contains the total number of events on the port, while the following entries
1380are counters corresponding to lanes/PCS instances. The number of entries in
1381the array will be:
1382
1383+--------------+---------------------------------------------+
1384| `0` | device does not support FEC statistics |
1385+--------------+---------------------------------------------+
1386| `1` | device does not support per-lane break down |
1387+--------------+---------------------------------------------+
1388| `1 + #lanes` | device has full support for FEC stats |
1389+--------------+---------------------------------------------+
1390
1391Drivers fill in the statistics in the following structure:
1392
1393.. kernel-doc:: include/linux/ethtool.h
1394 :identifiers: ethtool_fec_stats
1395
1e5d1f69
JK		 1396FEC_SET
1397=======
1398
1399Sets FEC parameters like ``ETHTOOL_SFECPARAM`` ioctl request.
1400
1401Request contents:
1402
1403 ===================================== ====== ==========================
1404 ``ETHTOOL_A_FEC_HEADER`` nested request header
1405 ``ETHTOOL_A_FEC_MODES`` bitset configured modes
1406 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection
1407 ===================================== ====== ==========================
1408
1409``FEC_SET`` is only meaningful when autonegotiation is disabled. Otherwise
1410FEC mode is selected as part of autonegotiation.
1411
1412``ETHTOOL_A_FEC_MODES`` selects which FEC mode should be used. It's recommended
1413to set only one bit, if multiple bits are set driver may choose between them
1414in an implementation specific way.
1415
1416``ETHTOOL_A_FEC_AUTO`` requests the driver to choose FEC mode based on SFP
1417module parameters. This does not mean autonegotiation.
1418
78c57f22
IS		 1419MODULE_EEPROM_GET
1420=================
c781ff12
VT		 1421
1422Fetch module EEPROM data dump.
1423This interface is designed to allow dumps of at most 1/2 page at once. This
1424means only dumps of 128 (or less) bytes are allowed, without crossing half page
1425boundary located at offset 128. For pages other than 0 only high 128 bytes are
1426accessible.
1427
1428Request contents:
1429
1430 ======================================= ====== ==========================
1431 ``ETHTOOL_A_MODULE_EEPROM_HEADER`` nested request header
1432 ``ETHTOOL_A_MODULE_EEPROM_OFFSET`` u32 offset within a page
1433 ``ETHTOOL_A_MODULE_EEPROM_LENGTH`` u32 amount of bytes to read
1434 ``ETHTOOL_A_MODULE_EEPROM_PAGE`` u8 page number
1435 ``ETHTOOL_A_MODULE_EEPROM_BANK`` u8 bank number
1436 ``ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS`` u8 page I2C address
1437 ======================================= ====== ==========================
1438
37a025e8
IS		 1439If ``ETHTOOL_A_MODULE_EEPROM_BANK`` is not specified, bank 0 is assumed.
1440
c781ff12
VT		 1441Kernel response contents:
1442
1443 +---------------------------------------------+--------+---------------------+
1444 | ``ETHTOOL_A_MODULE_EEPROM_HEADER`` | nested | reply header |
1445 +---------------------------------------------+--------+---------------------+
913d026f 1446 | ``ETHTOOL_A_MODULE_EEPROM_DATA`` | binary | array of bytes from |
c781ff12
VT		 1447 | | | module EEPROM |
1448 +---------------------------------------------+--------+---------------------+
1449
1450``ETHTOOL_A_MODULE_EEPROM_DATA`` has an attribute length equal to the amount of
1451bytes driver actually read.
1452
ddc78b36
JK		 1453STATS_GET
1454=========
1455
1456Get standard statistics for the interface. Note that this is not
1457a re-implementation of ``ETHTOOL_GSTATS`` which exposed driver-defined
1458stats.
1459
1460Request contents:
1461
1462 ======================================= ====== ==========================
1463 ``ETHTOOL_A_STATS_HEADER`` nested request header
1464 ``ETHTOOL_A_STATS_GROUPS`` bitset requested groups of stats
1465 ======================================= ====== ==========================
1466
1467Kernel response contents:
1468
1469 +-----------------------------------+--------+--------------------------------+
1470 | ``ETHTOOL_A_STATS_HEADER`` | nested | reply header |
1471 +-----------------------------------+--------+--------------------------------+
1472 | ``ETHTOOL_A_STATS_GRP`` | nested | one or more group of stats |
1473 +-+---------------------------------+--------+--------------------------------+
1474 | | ``ETHTOOL_A_STATS_GRP_ID`` | u32 | group ID - ``ETHTOOL_STATS_*`` |
1475 +-+---------------------------------+--------+--------------------------------+
1476 | | ``ETHTOOL_A_STATS_GRP_SS_ID`` | u32 | string set ID for names |
1477 +-+---------------------------------+--------+--------------------------------+
1478 | | ``ETHTOOL_A_STATS_GRP_STAT`` | nested | nest containing a statistic |
1479 +-+---------------------------------+--------+--------------------------------+
1480 | | ``ETHTOOL_A_STATS_GRP_HIST_RX`` | nested | histogram statistic (Rx) |
1481 +-+---------------------------------+--------+--------------------------------+
1482 | | ``ETHTOOL_A_STATS_GRP_HIST_TX`` | nested | histogram statistic (Tx) |
1483 +-+---------------------------------+--------+--------------------------------+
1484
1485Users specify which groups of statistics they are requesting via
1486the ``ETHTOOL_A_STATS_GROUPS`` bitset. Currently defined values are:
1487
1488 ====================== ======== ===============================================
1489 ETHTOOL_STATS_ETH_MAC eth-mac Basic IEEE 802.3 MAC statistics (30.3.1.1.*)
1490 ETHTOOL_STATS_ETH_PHY eth-phy Basic IEEE 802.3 PHY statistics (30.3.2.1.*)
1491 ETHTOOL_STATS_ETH_CTRL eth-ctrl Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*)
1492 ETHTOOL_STATS_RMON rmon RMON (RFC 2819) statistics
1493 ====================== ======== ===============================================
1494
1495Each group should have a corresponding ``ETHTOOL_A_STATS_GRP`` in the reply.
1496``ETHTOOL_A_STATS_GRP_ID`` identifies which group's statistics nest contains.
1497``ETHTOOL_A_STATS_GRP_SS_ID`` identifies the string set ID for the names of
1498the statistics in the group, if available.
1499
1500Statistics are added to the ``ETHTOOL_A_STATS_GRP`` nest under
1501``ETHTOOL_A_STATS_GRP_STAT``. ``ETHTOOL_A_STATS_GRP_STAT`` should contain
1502single 8 byte (u64) attribute inside - the type of that attribute is
1503the statistic ID and the value is the value of the statistic.
1504Each group has its own interpretation of statistic IDs.
1505Attribute IDs correspond to strings from the string set identified
1506by ``ETHTOOL_A_STATS_GRP_SS_ID``. Complex statistics (such as RMON histogram
1507entries) are also listed inside ``ETHTOOL_A_STATS_GRP`` and do not have
1508a string defined in the string set.
1509
1510RMON "histogram" counters count number of packets within given size range.
1511Because RFC does not specify the ranges beyond the standard 1518 MTU devices
1512differ in definition of buckets. For this reason the definition of packet ranges
1513is left to each driver.
1514
1515``ETHTOOL_A_STATS_GRP_HIST_RX`` and ``ETHTOOL_A_STATS_GRP_HIST_TX`` nests
1516contain the following attributes:
1517
1518 ================================= ====== ===================================
1519 ETHTOOL_A_STATS_RMON_HIST_BKT_LOW u32 low bound of the packet size bucket
1520 ETHTOOL_A_STATS_RMON_HIST_BKT_HI u32 high bound of the bucket
1521 ETHTOOL_A_STATS_RMON_HIST_VAL u64 packet counter
1522 ================================= ====== ===================================
1523
1524Low and high bounds are inclusive, for example:
1525
1526 ============================= ==== ====
1527 RFC statistic low high
1528 ============================= ==== ====
1529 etherStatsPkts64Octets 0 64
1530 etherStatsPkts512to1023Octets 512 1023
1531 ============================= ==== ====
1532
c156174a
YL		 1533PHC_VCLOCKS_GET
1534===============
1535
1536Query device PHC virtual clocks information.
1537
1538Request contents:
1539
1540 ==================================== ====== ==========================
1541 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested request header
1542 ==================================== ====== ==========================
1543
1544Kernel response contents:
1545
1546 ==================================== ====== ==========================
1547 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested reply header
1548 ``ETHTOOL_A_PHC_VCLOCKS_NUM`` u32 PHC virtual clocks number
1549 ``ETHTOOL_A_PHC_VCLOCKS_INDEX`` s32 PHC index array
1550 ==================================== ====== ==========================
1551
353407d9
IS		 1552MODULE_GET
1553==========
1554
1555Gets transceiver module parameters.
1556
1557Request contents:
1558
1559 ===================================== ====== ==========================
1560 ``ETHTOOL_A_MODULE_HEADER`` nested request header
1561 ===================================== ====== ==========================
1562
1563Kernel response contents:
1564
1565 ====================================== ====== ==========================
1566 ``ETHTOOL_A_MODULE_HEADER`` nested reply header
1567 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy
1568 ``ETHTOOL_A_MODULE_POWER_MODE`` u8 operational power mode
1569 ====================================== ====== ==========================
1570
1571The optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute encodes the
1572transceiver module power mode policy enforced by the host. The default policy
1573is driver-dependent, but "auto" is the recommended default and it should be
1574implemented by new drivers and drivers where conformance to a legacy behavior
1575is not critical.
1576
1577The optional ``ETHTHOOL_A_MODULE_POWER_MODE`` attribute encodes the operational
1578power mode policy of the transceiver module. It is only reported when a module
1579is plugged-in. Possible values are:
1580
1581.. kernel-doc:: include/uapi/linux/ethtool.h
1582 :identifiers: ethtool_module_power_mode
1583
1584MODULE_SET
1585==========
1586
1587Sets transceiver module parameters.
1588
1589Request contents:
1590
1591 ====================================== ====== ==========================
1592 ``ETHTOOL_A_MODULE_HEADER`` nested request header
1593 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy
1594 ====================================== ====== ==========================
1595
1596When set, the optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute is used
1597to set the transceiver module power policy enforced by the host. Possible
1598values are:
1599
1600.. kernel-doc:: include/uapi/linux/ethtool.h
1601 :identifiers: ethtool_module_power_mode_policy
1602
1603For SFF-8636 modules, low power mode is forced by the host according to table
16046-10 in revision 2.10a of the specification.
1605
1606For CMIS modules, low power mode is forced by the host according to table 6-12
1607in revision 5.0 of the specification.
1608
2b4a8990
MK		 1609Request translation
1610===================
1611
1612The following table maps ioctl commands to netlink commands providing their
1613functionality. Entries with "n/a" in right column are commands which do not
11ca3c42
AL		 1614have their netlink replacement yet. Entries which "n/a" in the left column
1615are netlink only.
2b4a8990
MK		 1616
1617 =================================== =====================================
1618 ioctl command netlink command
1619 =================================== =====================================
459e0b81 1620 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET``
f625aa9b 1621 ``ETHTOOL_MSG_LINKMODES_GET``
a53f3d41 1622 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET``
bfbcfe20 1623 ``ETHTOOL_MSG_LINKMODES_SET``
2b4a8990
MK		 1624 ``ETHTOOL_GDRVINFO`` n/a
1625 ``ETHTOOL_GREGS`` n/a
51ea22b0 1626 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET``
8d425b19 1627 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET``
6a94b8cc 1628 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET``
e54d04e3 1629 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET``
2b4a8990 1630 ``ETHTOOL_NWAY_RST`` n/a
3d2b847f 1631 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET``
2b4a8990
MK		 1632 ``ETHTOOL_GEEPROM`` n/a
1633 ``ETHTOOL_SEEPROM`` n/a
21727545 1634 ``ETHTOOL_GCOALESCE`` ``ETHTOOL_MSG_COALESCE_GET``
9881418c 1635 ``ETHTOOL_SCOALESCE`` ``ETHTOOL_MSG_COALESCE_SET``
e4a1717b 1636 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET``
2fc2929e 1637 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET``
7f59fb32 1638 ``ETHTOOL_GPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_GET``
3ab87993 1639 ``ETHTOOL_SPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_SET``
0524399d 1640 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1641 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 1642 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1643 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 1644 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1645 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET``
2b4a8990 1646 ``ETHTOOL_TEST`` n/a
71921690 1647 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET``
2b4a8990
MK		 1648 ``ETHTOOL_PHYS_ID`` n/a
1649 ``ETHTOOL_GSTATS`` n/a
0524399d 1650 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1651 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET``
2b4a8990 1652 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK``
0524399d 1653 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1654 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 1655 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1656 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 1657 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1658 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET``
e16c3386 1659 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET``
f265d799 1660 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET``
2b4a8990
MK		 1661 ``ETHTOOL_GRXFH`` n/a
1662 ``ETHTOOL_SRXFH`` n/a
0524399d 1663 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1664 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET``
2b4a8990
MK		 1665 ``ETHTOOL_GRXRINGS`` n/a
1666 ``ETHTOOL_GRXCLSRLCNT`` n/a
1667 ``ETHTOOL_GRXCLSRULE`` n/a
1668 ``ETHTOOL_GRXCLSRLALL`` n/a
1669 ``ETHTOOL_SRXCLSRLDEL`` n/a
1670 ``ETHTOOL_SRXCLSRLINS`` n/a
1671 ``ETHTOOL_FLASHDEV`` n/a
1672 ``ETHTOOL_RESET`` n/a
1673 ``ETHTOOL_SRXNTUPLE`` n/a
1674 ``ETHTOOL_GRXNTUPLE`` n/a
71921690 1675 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET``
2b4a8990
MK		 1676 ``ETHTOOL_GRXFHINDIR`` n/a
1677 ``ETHTOOL_SRXFHINDIR`` n/a
0524399d 1678 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1679 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET``
0c84979c 1680 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET``
e19c591e 1681 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET``
2b4a8990
MK		 1682 ``ETHTOOL_SET_DUMP`` n/a
1683 ``ETHTOOL_GET_DUMP_FLAG`` n/a
1684 ``ETHTOOL_GET_DUMP_DATA`` n/a
5b071c59 1685 ``ETHTOOL_GET_TS_INFO`` ``ETHTOOL_MSG_TSINFO_GET``
c781ff12
VT		 1686 ``ETHTOOL_GMODULEINFO`` ``ETHTOOL_MSG_MODULE_EEPROM_GET``
1687 ``ETHTOOL_GMODULEEEPROM`` ``ETHTOOL_MSG_MODULE_EEPROM_GET``
b7eeefe7 1688 ``ETHTOOL_GEEE`` ``ETHTOOL_MSG_EEE_GET``
fd77be7b 1689 ``ETHTOOL_SEEE`` ``ETHTOOL_MSG_EEE_SET``
2b4a8990
MK		 1690 ``ETHTOOL_GRSSH`` n/a
1691 ``ETHTOOL_SRSSH`` n/a
1692 ``ETHTOOL_GTUNABLE`` n/a
1693 ``ETHTOOL_STUNABLE`` n/a
1694 ``ETHTOOL_GPHYSTATS`` n/a
1695 ``ETHTOOL_PERQUEUE`` n/a
459e0b81 1696 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET``
f625aa9b 1697 ``ETHTOOL_MSG_LINKMODES_GET``
a53f3d41 1698 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET``
bfbcfe20 1699 ``ETHTOOL_MSG_LINKMODES_SET``
2b4a8990
MK		 1700 ``ETHTOOL_PHY_GTUNABLE`` n/a
1701 ``ETHTOOL_PHY_STUNABLE`` n/a
1e5d1f69
JK		 1702 ``ETHTOOL_GFECPARAM`` ``ETHTOOL_MSG_FEC_GET``
1703 ``ETHTOOL_SFECPARAM`` ``ETHTOOL_MSG_FEC_SET``
0b35e0de
JK		 1704 n/a ``ETHTOOL_MSG_CABLE_TEST_ACT``
1705 n/a ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT``
19a83d36 1706 n/a ``ETHTOOL_MSG_TUNNEL_INFO_GET``
c156174a 1707 n/a ``ETHTOOL_MSG_PHC_VCLOCKS_GET``
353407d9
IS		 1708 n/a ``ETHTOOL_MSG_MODULE_GET``
1709 n/a ``ETHTOOL_MSG_MODULE_SET``
2b4a8990 1710 =================================== =====================================
Linux 6.x block layer and io_uring tree(s)