projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
docs: ethtool-netlink: document interface for MAC Merge layer
[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
18ff0bcd
OR		 223 ``ETHTOOL_MSG_PSE_SET`` set PSE parameters
224 ``ETHTOOL_MSG_PSE_GET`` get PSE parameters
7112a046 225 ``ETHTOOL_MSG_RSS_GET`` get RSS settings
37000004
VO		 226 ``ETHTOOL_MSG_MM_GET`` get MAC merge layer state
227 ``ETHTOOL_MSG_MM_SET`` set MAC merge layer parameters
353407d9 228 ===================================== =================================
71921690
MK		 229
230Kernel to userspace:
231
e9377a91
JK		 232 ======================================== =================================
233 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents
234 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings
235 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification
236 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info
237 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification
238 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info
239 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings
240 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification
241 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings
242 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification
243 ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features
244 ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET
245 ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification
246 ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags
247 ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags
248 ``ETHTOOL_MSG_RINGS_GET_REPLY`` ring sizes
249 ``ETHTOOL_MSG_RINGS_NTF`` ring sizes
250 ``ETHTOOL_MSG_CHANNELS_GET_REPLY`` channel counts
251 ``ETHTOOL_MSG_CHANNELS_NTF`` channel counts
252 ``ETHTOOL_MSG_COALESCE_GET_REPLY`` coalescing parameters
253 ``ETHTOOL_MSG_COALESCE_NTF`` coalescing parameters
254 ``ETHTOOL_MSG_PAUSE_GET_REPLY`` pause parameters
255 ``ETHTOOL_MSG_PAUSE_NTF`` pause parameters
256 ``ETHTOOL_MSG_EEE_GET_REPLY`` EEE settings
257 ``ETHTOOL_MSG_EEE_NTF`` EEE settings
258 ``ETHTOOL_MSG_TSINFO_GET_REPLY`` timestamping info
259 ``ETHTOOL_MSG_CABLE_TEST_NTF`` Cable test results
260 ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF`` Cable test TDR results
261 ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY`` tunnel offload info
262 ``ETHTOOL_MSG_FEC_GET_REPLY`` FEC settings
263 ``ETHTOOL_MSG_FEC_NTF`` FEC settings
264 ``ETHTOOL_MSG_MODULE_EEPROM_GET_REPLY`` read SFP module EEPROM
265 ``ETHTOOL_MSG_STATS_GET_REPLY`` standard statistics
c156174a 266 ``ETHTOOL_MSG_PHC_VCLOCKS_GET_REPLY`` PHC virtual clocks info
353407d9 267 ``ETHTOOL_MSG_MODULE_GET_REPLY`` transceiver module parameters
18ff0bcd 268 ``ETHTOOL_MSG_PSE_GET_REPLY`` PSE parameters
7112a046 269 ``ETHTOOL_MSG_RSS_GET_REPLY`` RSS settings
37000004 270 ``ETHTOOL_MSG_MM_GET_REPLY`` MAC merge layer status
e9377a91 271 ======================================== =================================
71921690 272
2b4a8990
MK		 273``GET`` requests are sent by userspace applications to retrieve device
274information. They usually do not contain any message specific attributes.
275Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
276request with ``NLM_F_DUMP`` and no device identification can be used to query
277the information for all devices supporting the request.
278
279If the data can be also modified, corresponding ``SET`` message with the same
280layout as corresponding ``GET_REPLY`` is used to request changes. Only
281attributes where a change is requested are included in such request (also, not
282all attributes may be changed). Replies to most ``SET`` request consist only
283of error code and extack; if kernel provides additional data, it is sent in
284the form of corresponding ``SET_REPLY`` message which can be suppressed by
285setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
286
287Data modification also triggers sending a ``NTF`` message with a notification.
288These usually bear only a subset of attributes which was affected by the
289change. The same notification is issued if the data is modified using other
290means (mostly ioctl ethtool interface). Unlike notifications from ethtool
291netlink code which are only sent if something actually changed, notifications
292triggered by ioctl interface may be sent even if the request did not actually
293change any data.
294
295``ACT`` messages request kernel (driver) to perform a specific action. If some
296information is reported by kernel (which can be suppressed by setting
297``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
298an ``ACT_REPLY`` message. Performing an action also triggers a notification
299(``NTF`` message).
300
301Later sections describe the format and semantics of these messages.
302
303
71921690
MK		 304STRSET_GET
305==========
306
307Requests contents of a string set as provided by ioctl commands
308``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
309writeable so that the corresponding ``STRSET_SET`` message is only used in
310kernel replies. There are two types of string sets: global (independent of
311a device, e.g. device feature names) and device specific (e.g. device private
312flags).
313
314Request contents:
315
316 +---------------------------------------+--------+------------------------+
317 | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header |
318 +---------------------------------------+--------+------------------------+
319 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request |
320 +-+-------------------------------------+--------+------------------------+
321 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set |
322 +-+-+-----------------------------------+--------+------------------------+
323 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id |
324 +-+-+-----------------------------------+--------+------------------------+
325
326Kernel response contents:
327
328 +---------------------------------------+--------+-----------------------+
329 | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header |
330 +---------------------------------------+--------+-----------------------+
331 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets |
332 +-+-------------------------------------+--------+-----------------------+
333 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set |
334 +-+-+-----------------------------------+--------+-----------------------+
335 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id |
336 +-+-+-----------------------------------+--------+-----------------------+
337 | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings |
338 +-+-+-----------------------------------+--------+-----------------------+
339 | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings |
340 +-+-+-+---------------------------------+--------+-----------------------+
341 | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string |
342 +-+-+-+-+-------------------------------+--------+-----------------------+
343 | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index |
344 +-+-+-+-+-------------------------------+--------+-----------------------+
345 | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value |
346 +-+-+-+-+-------------------------------+--------+-----------------------+
347 | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts |
348 +---------------------------------------+--------+-----------------------+
349
350Device identification in request header is optional. Depending on its presence
351a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
352
353 - no ``NLM_F_DUMP,`` no device: get "global" stringsets
354 - no ``NLM_F_DUMP``, with device: get string sets related to the device
355 - ``NLM_F_DUMP``, no device: get device related string sets for all devices
356
357If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
358requested type are returned, otherwise only those specified in the request.
359Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
360counts of the sets, not the actual strings.
361
362
459e0b81
MK		 363LINKINFO_GET
364============
365
366Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
367link modes and autonegotiation related information. The request does not use
368any attributes.
369
370Request contents:
371
372 ==================================== ====== ==========================
373 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
374 ==================================== ====== ==========================
375
376Kernel response contents:
377
378 ==================================== ====== ==========================
379 ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header
380 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port
381 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address
382 ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status
383 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control
384 ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver
385 ==================================== ====== ==========================
386
387Attributes and their values have the same meaning as matching members of the
388corresponding ioctl structures.
389
390``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
391devices supporting the request).
392
393
a53f3d41
MK		 394LINKINFO_SET
395============
396
397``LINKINFO_SET`` request allows setting some of the attributes reported by
398``LINKINFO_GET``.
399
400Request contents:
401
402 ==================================== ====== ==========================
403 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
404 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port
405 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address
406 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control
407 ==================================== ====== ==========================
408
409MDI(-X) status and transceiver cannot be set, request with the corresponding
410attributes is rejected.
411
412
f625aa9b
MK		 413LINKMODES_GET
414=============
415
416Requests link modes (supported, advertised and peer advertised) and related
417information (autonegotiation status, link speed and duplex) as provided by
418``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
419
420Request contents:
421
422 ==================================== ====== ==========================
423 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
424 ==================================== ====== ==========================
425
426Kernel response contents:
427
bdbdac76
OR		 428 ========================================== ====== ==========================
429 ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header
430 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status
431 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes
432 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes
433 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s)
434 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode
435 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode
436 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE`` u8 Master/slave port state
0c3e10cb 437 ``ETHTOOL_A_LINKMODES_RATE_MATCHING`` u8 PHY rate matching
bdbdac76 438 ========================================== ====== ==========================
f625aa9b
MK		 439
440For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
441represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
442list.
443
444``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
445devices supporting the request).
446
447
bfbcfe20
MK		 448LINKMODES_SET
449=============
450
451Request contents:
452
bdbdac76
OR		 453 ========================================== ====== ==========================
454 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
455 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status
456 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes
457 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes
458 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s)
459 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode
460 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode
0c3e10cb 461 ``ETHTOOL_A_LINKMODES_RATE_MATCHING`` u8 PHY rate matching
012ce4dd 462 ``ETHTOOL_A_LINKMODES_LANES`` u32 lanes
bdbdac76 463 ========================================== ====== ==========================
bfbcfe20
MK		 464
465``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
466autonegotiation is on (either set now or kept from before), advertised modes
467are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
012ce4dd
DR		 468of speed, duplex and lanes is specified, kernel adjusts advertised modes to all
469supported modes matching speed, duplex, lanes or all (whatever is specified).
470This autoselection is done on ethtool side with ioctl interface, netlink
471interface is supposed to allow requesting changes without knowing what exactly
472kernel supports.
bfbcfe20
MK		 473
474
3d2b847f
MK		 475LINKSTATE_GET
476=============
477
e120c801
AC		 478Requests link state information. Link up/down flag (as provided by
479``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
480be provided as well. In general, extended state describes reasons for why a port
481is down, or why it operates in some non-obvious mode. This request does not have
482any attributes.
3d2b847f
MK		 483
484Request contents:
485
486 ==================================== ====== ==========================
487 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header
488 ==================================== ====== ==========================
489
490Kernel response contents:
491
80660219 492 ==================================== ====== ============================
3d2b847f
MK		 493 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header
494 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down)
80660219
OR		 495 ``ETHTOOL_A_LINKSTATE_SQI`` u32 Current Signal Quality Index
496 ``ETHTOOL_A_LINKSTATE_SQI_MAX`` u32 Max support SQI value
e120c801
AC		 497 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state
498 ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate
9a0f830f 499 ``ETHTOOL_A_LINKSTATE_EXT_DOWN_CNT`` u32 count of link down events
80660219 500 ==================================== ====== ============================
3d2b847f
MK		 501
502For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
503carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
504define their own handler.
505
e120c801
AC		 506``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
507optional values. ethtool core can provide either both
508``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
509or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
510
3d2b847f
MK		 511``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
512devices supporting the request).
513
514
e120c801
AC		 515Link extended states:
516
517 ================================================ ============================================
518 ``ETHTOOL_LINK_EXT_STATE_AUTONEG`` States relating to the autonegotiation or
519 issues therein
520
521 ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE`` Failure during link training
522
523 ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH`` Logical mismatch in physical coding sublayer
524 or forward error correction sublayer
525
526 ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY`` Signal integrity issues
527
528 ``ETHTOOL_LINK_EXT_STATE_NO_CABLE`` No cable connected
529
530 ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE`` Failure is related to cable,
531 e.g., unsupported cable
532
533 ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE`` Failure is related to EEPROM, e.g., failure
534 during reading or parsing the data
535
536 ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE`` Failure during calibration algorithm
537
538 ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED`` The hardware is not able to provide the
539 power required from cable or module
540
541 ``ETHTOOL_LINK_EXT_STATE_OVERHEAT`` The module is overheated
3dfb5112
IS		 542
543 ``ETHTOOL_LINK_EXT_STATE_MODULE`` Transceiver module issue
1a4d6816 544 ================================================ ============================================
e120c801
AC		 545
546Link extended substates:
547
548 Autoneg substates:
549
1a4d6816 550 =============================================================== ================================
e120c801
AC		 551 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED`` Peer side is down
552
553 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED`` Ack not received from peer side
554
555 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED`` Next page exchange failed
556
557 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE`` Peer side is down during force
558 mode or there is no agreement of
559 speed
560
561 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE`` Forward error correction modes
562 in both sides are mismatched
563
564 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD`` No Highest Common Denominator
1a4d6816 565 =============================================================== ================================
e120c801
AC		 566
567 Link training substates:
568
1a4d6816 569 =========================================================================== ====================
e120c801
AC		 570 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED`` Frames were not
571 recognized, the
572 lock failed
573
574 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT`` The lock did not
575 occur before
576 timeout
577
578 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY`` Peer side did not
579 send ready signal
580 after training
581 process
582
583 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT`` Remote side is not
584 ready yet
1a4d6816 585 =========================================================================== ====================
e120c801
AC		 586
587 Link logical mismatch substates:
588
1a4d6816 589 ================================================================ ===============================
e120c801
AC		 590 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK`` Physical coding sublayer was
591 not locked in first phase -
592 block lock
593
594 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK`` Physical coding sublayer was
595 not locked in second phase -
596 alignment markers lock
597
598 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS`` Physical coding sublayer did
599 not get align status
600
601 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED`` FC forward error correction is
602 not locked
603
604 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED`` RS forward error correction is
605 not locked
1a4d6816 606 ================================================================ ===============================
e120c801
AC		 607
608 Bad signal integrity substates:
609
610 ================================================================= =============================
611 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS`` Large number of physical
612 errors
613
614 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE`` The system attempted to
615 operate the cable at a rate
616 that is not formally
617 supported, which led to
618 signal integrity issues
958ab281
GH		 619
620 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST`` The external clock signal for
621 SerDes is too weak or
622 unavailable.
623
624 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS`` The received signal for
625 SerDes is too weak because
626 analog loss of signal.
e120c801
AC		 627 ================================================================= =============================
628
629 Cable issue substates:
630
1a4d6816 631 =================================================== ============================================
e120c801
AC		 632 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE`` Unsupported cable
633
634 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE`` Cable test failure
1a4d6816 635 =================================================== ============================================
3dfb5112
IS		 636
637 Transceiver module issue substates:
638
639 =================================================== ============================================
640 ``ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY`` The CMIS Module State Machine did not reach
641 the ModuleReady state. For example, if the
642 module is stuck at ModuleFault state
643 =================================================== ============================================
e120c801 644
6a94b8cc
MK		 645DEBUG_GET
646=========
647
648Requests debugging settings of a device. At the moment, only message mask is
649provided.
650
651Request contents:
652
653 ==================================== ====== ==========================
654 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
655 ==================================== ====== ==========================
656
657Kernel response contents:
658
659 ==================================== ====== ==========================
660 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header
661 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
662 ==================================== ====== ==========================
663
664The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
665provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
666interface. While it is called message level there for historical reasons, most
667drivers and almost all newer drivers use it as a mask of enabled message
668classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
669interface follows its actual use in practice.
670
671``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
672devices supporting the request).
673
674
e54d04e3
MK		 675DEBUG_SET
676=========
677
678Set or update debugging settings of a device. At the moment, only message mask
679is supported.
680
681Request contents:
682
683 ==================================== ====== ==========================
684 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
685 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
686 ==================================== ====== ==========================
687
688``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
689enabled debugging message types for the device.
690
691
51ea22b0
MK		 692WOL_GET
693=======
694
695Query device wake-on-lan settings. Unlike most "GET" type requests,
696``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
697(potentially) provides SecureOn(tm) password which is confidential.
698
699Request contents:
700
701 ==================================== ====== ==========================
702 ``ETHTOOL_A_WOL_HEADER`` nested request header
703 ==================================== ====== ==========================
704
705Kernel response contents:
706
707 ==================================== ====== ==========================
708 ``ETHTOOL_A_WOL_HEADER`` nested reply header
709 ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes
710 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password
711 ==================================== ====== ==========================
712
713In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
714device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
715included in reply if ``WAKE_MAGICSECURE`` mode is supported.
716
717
8d425b19
MK		 718WOL_SET
719=======
720
721Set or update wake-on-lan settings.
722
723Request contents:
724
725 ==================================== ====== ==========================
726 ``ETHTOOL_A_WOL_HEADER`` nested request header
727 ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes
728 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password
729 ==================================== ====== ==========================
730
731``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
732``WAKE_MAGICSECURE`` mode.
733
734
0524399d
MK		 735FEATURES_GET
736============
737
738Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
739
740Request contents:
741
742 ==================================== ====== ==========================
743 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
744 ==================================== ====== ==========================
745
746Kernel response contents:
747
748 ==================================== ====== ==========================
749 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header
750 ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features
751 ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features
752 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features
753 ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE
754 ==================================== ====== ==========================
755
756Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
757interference but attribute names are different (they are based on
758corresponding members of struct net_device). Legacy "flags" are not provided,
759if userspace needs them (most likely only ethtool for backward compatibility),
760it can calculate their values from related feature bits itself.
761ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
762provide all names when using verbose bitmap format), the other three use no
763mask (simple bit lists).
764
765
0980bfcd
MK		 766FEATURES_SET
767============
768
769Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
770
771Request contents:
772
773 ==================================== ====== ==========================
774 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
775 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features
776 ==================================== ====== ==========================
777
778Kernel response contents:
779
780 ==================================== ====== ==========================
781 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header
782 ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result
783 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active
784 ==================================== ====== ==========================
785
786Request constains only one bitset which can be either value/mask pair (request
787to change specific feature bits and leave the rest) or only a value (request
788to set all features to specified set).
789
790As request is subject to netdev_change_features() sanity checks, optional
791kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
792header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
793reports the difference between client request and actual result: mask consists
794of bits which differ between requested features and result (dev->features
795after the operation), value consists of values of these bits in the request
796(i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
797reports the difference between old and new dev->features: mask consists of
798bits which have changed, values are their values in new dev->features (after
799the operation).
800
9c6451ef
MK		 801``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
802are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
803request but also each time features are modified with netdev_update_features()
804or netdev_change_features().
805
0980bfcd 806
e16c3386
MK		 807PRIVFLAGS_GET
808=============
809
810Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
811
812Request contents:
813
814 ==================================== ====== ==========================
815 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
816 ==================================== ====== ==========================
817
818Kernel response contents:
819
820 ==================================== ====== ==========================
821 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header
822 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
823 ==================================== ====== ==========================
824
825``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
826These flags are defined by driver, their number and names (and also meaning)
827are device dependent. For compact bitset format, names can be retrieved as
828``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
829response uses all private flags supported by the device as mask so that client
830gets the full information without having to fetch the string set with names.
831
832
f265d799
MK		 833PRIVFLAGS_SET
834=============
835
836Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
837ioctl request.
838
839Request contents:
840
841 ==================================== ====== ==========================
842 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
843 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
844 ==================================== ====== ==========================
845
846``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
847modify only values of some of them.
848
849
e4a1717b
MK		 850RINGS_GET
851=========
852
853Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
854
855Request contents:
856
857 ==================================== ====== ==========================
858 ``ETHTOOL_A_RINGS_HEADER`` nested request header
859 ==================================== ====== ==========================
860
861Kernel response contents:
862
0b70c256 863 ==================================== ====== ===========================
e4a1717b
MK		 864 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
865 ``ETHTOOL_A_RINGS_RX_MAX`` u32 max size of RX ring
866 ``ETHTOOL_A_RINGS_RX_MINI_MAX`` u32 max size of RX mini ring
867 ``ETHTOOL_A_RINGS_RX_JUMBO_MAX`` u32 max size of RX jumbo ring
868 ``ETHTOOL_A_RINGS_TX_MAX`` u32 max size of TX ring
869 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
870 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
871 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
872 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
0b70c256 873 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring
9690ae60 874 ``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` u8 TCP header / data split
1241e329 875 ``ETHTOOL_A_RINGS_CQE_SIZE`` u32 Size of TX/RX CQE
4dc84c06 876 ``ETHTOOL_A_RINGS_TX_PUSH`` u8 flag of TX Push mode
0b70c256 877 ==================================== ====== ===========================
e4a1717b 878
9690ae60
JK		 879``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` indicates whether the device is usable with
880page-flipping TCP zero-copy receive (``getsockopt(TCP_ZEROCOPY_RECEIVE)``).
881If enabled the device is configured to place frame headers and data into
882separate buffers. The device configuration must make it possible to receive
883full memory pages of data, for example because MTU is high enough or through
884HW-GRO.
885
4dc84c06
JW		 886``ETHTOOL_A_RINGS_TX_PUSH`` flag is used to enable descriptor fast
887path to send packets. In ordinary path, driver fills descriptors in DRAM and
888notifies NIC hardware. In fast path, driver pushes descriptors to the device
889through MMIO writes, thus reducing the latency. However, enabling this feature
890may increase the CPU cost. Drivers may enforce additional per-packet
891eligibility checks (e.g. on packet size).
e4a1717b 892
2fc2929e
MK		 893RINGS_SET
894=========
895
896Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
897
898Request contents:
899
0b70c256 900 ==================================== ====== ===========================
2fc2929e
MK		 901 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
902 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
903 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
904 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
905 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
0b70c256 906 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring
1241e329 907 ``ETHTOOL_A_RINGS_CQE_SIZE`` u32 Size of TX/RX CQE
4dc84c06 908 ``ETHTOOL_A_RINGS_TX_PUSH`` u8 flag of TX Push mode
0b70c256 909 ==================================== ====== ===========================
2fc2929e
MK		 910
911Kernel checks that requested ring sizes do not exceed limits reported by
912driver. Driver may impose additional constraints and may not suspport all
913attributes.
914
915
1241e329
SS		 916``ETHTOOL_A_RINGS_CQE_SIZE`` specifies the completion queue event size.
917Completion queue events(CQE) are the events posted by NIC to indicate the
918completion status of a packet when the packet is sent(like send success or
919error) or received(like pointers to packet fragments). The CQE size parameter
920enables to modify the CQE size other than default size if NIC supports it.
921A bigger CQE can have more receive buffer pointers inturn NIC can transfer
922a bigger frame from wire. Based on the NIC hardware, the overall completion
923queue size can be adjusted in the driver if CQE size is modified.
924
0c84979c
MK		 925CHANNELS_GET
926============
927
928Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
929
930Request contents:
931
932 ==================================== ====== ==========================
933 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
934 ==================================== ====== ==========================
935
936Kernel response contents:
937
938 ===================================== ====== ==========================
939 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header
940 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels
941 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels
942 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels
943 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels
944 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
945 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
946 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
947 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
948 ===================================== ====== ==========================
949
950
e19c591e
MK		 951CHANNELS_SET
952============
953
954Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
955
956Request contents:
957
958 ===================================== ====== ==========================
959 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
960 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
961 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
962 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
963 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
964 ===================================== ====== ==========================
965
966Kernel checks that requested channel counts do not exceed limits reported by
967driver. Driver may impose additional constraints and may not suspport all
968attributes.
969
970
21727545
MK		 971COALESCE_GET
972============
973
974Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
975
976Request contents:
977
978 ==================================== ====== ==========================
979 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
980 ==================================== ====== ==========================
981
982Kernel response contents:
983
984 =========================================== ====== =======================
985 ``ETHTOOL_A_COALESCE_HEADER`` nested reply header
986 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
987 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
988 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
989 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
990 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
991 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
992 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
993 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
994 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
995 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
996 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
997 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
998 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
999 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
1000 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
1001 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
1002 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
1003 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
1004 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
1005 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
1006 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
1007 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
029ee6b1
YM		 1008 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx
1009 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx
31de2842
DP		 1010 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` u32 max aggr size, Tx
1011 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` u32 max aggr packets, Tx
1012 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` u32 time (us), aggr, Tx
21727545
MK		 1013 =========================================== ====== =======================
1014
1015Attributes are only included in reply if their value is not zero or the
1016corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
1017they are declared as supported by driver).
1018
029ee6b1
YM		 1019Timer reset mode (``ETHTOOL_A_COALESCE_USE_CQE_TX`` and
1020``ETHTOOL_A_COALESCE_USE_CQE_RX``) controls the interaction between packet
1021arrival and the various time based delay parameters. By default timers are
1022expected to limit the max delay between any packet arrival/departure and a
1023corresponding interrupt. In this mode timer should be started by packet
1024arrival (sometimes delivery of previous interrupt) and reset when interrupt
1025is delivered.
1026Setting the appropriate attribute to 1 will enable ``CQE`` mode, where
1027each packet event resets the timer. In this mode timer is used to force
1028the interrupt if queue goes idle, while busy queues depend on the packet
1029limit to trigger interrupts.
21727545 1030
31de2842
DP		 1031Tx aggregation consists of copying frames into a contiguous buffer so that they
1032can be submitted as a single IO operation. ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES``
1033describes the maximum size in bytes for the submitted buffer.
1034``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` describes the maximum number of frames
1035that can be aggregated into a single buffer.
1036``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` describes the amount of time in usecs,
1037counted since the first packet arrival in an aggregated block, after which the
1038block should be sent.
1039This feature is mainly of interest for specific USB devices which does not cope
1040well with frequent small-sized URBs transmissions.
1041
9881418c
MK		 1042COALESCE_SET
1043============
1044
1045Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
1046
1047Request contents:
1048
1049 =========================================== ====== =======================
1050 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
1051 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
1052 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
1053 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
1054 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
1055 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
1056 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
1057 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
1058 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
1059 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
1060 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
1061 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
1062 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
1063 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
1064 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
1065 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
1066 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
1067 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
1068 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
1069 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
1070 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
1071 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
1072 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
029ee6b1
YM		 1073 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx
1074 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx
31de2842
DP		 1075 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` u32 max aggr size, Tx
1076 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` u32 max aggr packets, Tx
1077 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` u32 time (us), aggr, Tx
9881418c
MK		 1078 =========================================== ====== =======================
1079
1080Request is rejected if it attributes declared as unsupported by driver (i.e.
1081such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
1082is not set), regardless of their values. Driver may impose additional
1083constraints on coalescing parameters and their values.
1084
1085
7f59fb32 1086PAUSE_GET
5219d601 1087=========
7f59fb32 1088
5219d601 1089Gets pause frame settings like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
7f59fb32
MK		 1090
1091Request contents:
1092
1093 ===================================== ====== ==========================
1094 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1095 ===================================== ====== ==========================
1096
1097Kernel response contents:
1098
1099 ===================================== ====== ==========================
1100 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1101 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1102 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1103 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
9a27a330 1104 ``ETHTOOL_A_PAUSE_STATS`` nested pause statistics
7f59fb32
MK		 1105 ===================================== ====== ==========================
1106
9a27a330
JK		 1107``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set
1108in ``ETHTOOL_A_HEADER_FLAGS``.
1109It will be empty if driver did not report any statistics. Drivers fill in
1110the statistics in the following structure:
1111
1112.. kernel-doc:: include/linux/ethtool.h
1113 :identifiers: ethtool_pause_stats
1114
1115Each member has a corresponding attribute defined.
7f59fb32
MK		 1116
1117PAUSE_SET
5219d601 1118=========
7f59fb32
MK		 1119
1120Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1121
1122Request contents:
1123
1124 ===================================== ====== ==========================
1125 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1126 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1127 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1128 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
1129 ===================================== ====== ==========================
1130
1131
b7eeefe7
MK		 1132EEE_GET
1133=======
1134
5219d601 1135Gets Energy Efficient Ethernet settings like ``ETHTOOL_GEEE`` ioctl request.
b7eeefe7
MK		 1136
1137Request contents:
1138
1139 ===================================== ====== ==========================
1140 ``ETHTOOL_A_EEE_HEADER`` nested request header
1141 ===================================== ====== ==========================
1142
1143Kernel response contents:
1144
1145 ===================================== ====== ==========================
1146 ``ETHTOOL_A_EEE_HEADER`` nested request header
1147 ``ETHTOOL_A_EEE_MODES_OURS`` bool supported/advertised modes
1148 ``ETHTOOL_A_EEE_MODES_PEER`` bool peer advertised link modes
1149 ``ETHTOOL_A_EEE_ACTIVE`` bool EEE is actively used
1150 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1151 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1152 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1153 ===================================== ====== ==========================
1154
1155In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
1156enabled, value of link modes for which EEE is advertised. Link modes for which
1157peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
1158netlink interface allows reporting EEE status for all link modes but only
1159first 32 are provided by the ``ethtool_ops`` callback.
1160
1161
fd77be7b
MK		 1162EEE_SET
1163=======
1164
5219d601 1165Sets Energy Efficient Ethernet parameters like ``ETHTOOL_SEEE`` ioctl request.
fd77be7b
MK		 1166
1167Request contents:
1168
1169 ===================================== ====== ==========================
1170 ``ETHTOOL_A_EEE_HEADER`` nested request header
1171 ``ETHTOOL_A_EEE_MODES_OURS`` bool advertised modes
1172 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1173 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1174 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1175 ===================================== ====== ==========================
1176
1177``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
1178EEE for (if there is no mask) or specify changes to the list (if there is
1179a mask). The netlink interface allows reporting EEE status for all link modes
1180but only first 32 can be set at the moment as that is what the ``ethtool_ops``
1181callback supports.
1182
1183
5b071c59
MK		 1184TSINFO_GET
1185==========
1186
1187Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
1188
1189Request contents:
1190
1191 ===================================== ====== ==========================
1192 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1193 ===================================== ====== ==========================
1194
1195Kernel response contents:
1196
1197 ===================================== ====== ==========================
1198 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1199 ``ETHTOOL_A_TSINFO_TIMESTAMPING`` bitset SO_TIMESTAMPING flags
1200 ``ETHTOOL_A_TSINFO_TX_TYPES`` bitset supported Tx types
1201 ``ETHTOOL_A_TSINFO_RX_FILTERS`` bitset supported Rx filters
1202 ``ETHTOOL_A_TSINFO_PHC_INDEX`` u32 PTP hw clock index
1203 ===================================== ====== ==========================
1204
1205``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
1206is no special value for this case). The bitset attributes are omitted if they
1207would be empty (no bit set).
1208
11ca3c42
AL		 1209CABLE_TEST
1210==========
1211
1212Start a cable test.
1213
1214Request contents:
1215
1216 ==================================== ====== ==========================
1217 ``ETHTOOL_A_CABLE_TEST_HEADER`` nested request header
1218 ==================================== ====== ==========================
1219
b28efb93
AL		 1220Notification contents:
1221
1222An Ethernet cable typically contains 1, 2 or 4 pairs. The length of
1223the pair can only be measured when there is a fault in the pair and
1224hence a reflection. Information about the fault may not be available,
1225depending on the specific hardware. Hence the contents of the notify
1226message are mostly optional. The attributes can be repeated an
1227arbitrary number of times, in an arbitrary order, for an arbitrary
1228number of pairs.
1229
1230The example shows the notification sent when the test is completed for
1231a T2 cable, i.e. two pairs. One pair is OK and hence has no length
1232information. The second pair has a fault and does have length
1233information.
1234
1235 +---------------------------------------------+--------+---------------------+
1236 | ``ETHTOOL_A_CABLE_TEST_HEADER`` | nested | reply header |
1237 +---------------------------------------------+--------+---------------------+
1238 | ``ETHTOOL_A_CABLE_TEST_STATUS`` | u8 | completed |
1239 +---------------------------------------------+--------+---------------------+
1240 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST`` | nested | all the results |
1241 +-+-------------------------------------------+--------+---------------------+
1242 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test result |
1243 +-+-+-----------------------------------------+--------+---------------------+
1244 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1245 +-+-+-----------------------------------------+--------+---------------------+
1246 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1247 +-+-+-----------------------------------------+--------+---------------------+
1248 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test results |
1249 +-+-+-----------------------------------------+--------+---------------------+
1250 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1251 +-+-+-----------------------------------------+--------+---------------------+
1252 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1253 +-+-+-----------------------------------------+--------+---------------------+
1254 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH`` | nested | cable length |
1255 +-+-+-----------------------------------------+--------+---------------------+
1256 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR`` | u8 | pair number |
1257 +-+-+-----------------------------------------+--------+---------------------+
1258 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM`` | u32 | length in cm |
1259 +-+-+-----------------------------------------+--------+---------------------+
5b071c59 1260
a331172b
AL		 1261CABLE_TEST TDR
1262==============
1263
1264Start a cable test and report raw TDR data
1265
1266Request contents:
1267
f2bc8ad3
AL		 1268 +--------------------------------------------+--------+-----------------------+
1269 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1270 +--------------------------------------------+--------+-----------------------+
1271 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG`` | nested | test configuration |
1272 +-+------------------------------------------+--------+-----------------------+
58e898a0 1273 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | first data distance |
f2bc8ad3 1274 +-+-+----------------------------------------+--------+-----------------------+
58e898a0 1275 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | last data distance |
f2bc8ad3 1276 +-+-+----------------------------------------+--------+-----------------------+
58e898a0 1277 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step |
f2bc8ad3
AL		 1278 +-+-+----------------------------------------+--------+-----------------------+
1279 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR`` | u8 | pair to test |
1280 +-+-+----------------------------------------+--------+-----------------------+
1281
1282The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members
1283of the nest. All distances are expressed in centimeters. The PHY takes
1284the distances as a guide, and rounds to the nearest distance it
1285actually supports. If a pair is passed, only that one pair will be
1286tested. Otherwise all pairs are tested.
a331172b
AL		 1287
1288Notification contents:
1289
1290Raw TDR data is gathered by sending a pulse down the cable and
1291recording the amplitude of the reflected pulse for a given distance.
1292
1293It can take a number of seconds to collect TDR data, especial if the
1294full 100 meters is probed at 1 meter intervals. When the test is
1295started a notification will be sent containing just
1296ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1297ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED.
1298
1299When the test has completed a second notification will be sent
1300containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1301ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data.
1302
1303The message may optionally contain the amplitude of the pulse send
1304down the cable. This is measured in mV. A reflection should not be
1305bigger than transmitted pulse.
1306
1307Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP
1308nest containing information about the distance along the cable for the
1309first reading, the last reading, and the step between each
1310reading. Distances are measured in centimeters. These should be the
1311exact values the PHY used. These may be different to what the user
1312requested, if the native measurement resolution is greater than 1 cm.
1313
1314For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is
1315used to report the amplitude of the reflection for a given pair.
1316
1317 +---------------------------------------------+--------+----------------------+
1318 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1319 +---------------------------------------------+--------+----------------------+
1320 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS`` | u8 | completed |
1321 +---------------------------------------------+--------+----------------------+
1322 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST`` | nested | all the results |
1323 +-+-------------------------------------------+--------+----------------------+
1324 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE`` | nested | TX Pulse amplitude |
1325 +-+-+-----------------------------------------+--------+----------------------+
1326 | | | ``ETHTOOL_A_CABLE_PULSE_mV`` | s16 | Pulse amplitude |
1327 +-+-+-----------------------------------------+--------+----------------------+
1328 | | ``ETHTOOL_A_CABLE_NEST_STEP`` | nested | TDR step info |
1329 +-+-+-----------------------------------------+--------+----------------------+
58e898a0 1330 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | First data distance |
a331172b 1331 +-+-+-----------------------------------------+--------+----------------------+
58e898a0 1332 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | Last data distance |
a331172b 1333 +-+-+-----------------------------------------+--------+----------------------+
58e898a0 1334 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step|
a331172b
AL		 1335 +-+-+-----------------------------------------+--------+----------------------+
1336 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1337 +-+-+-----------------------------------------+--------+----------------------+
1338 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1339 +-+-+-----------------------------------------+--------+----------------------+
1340 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1341 +-+-+-----------------------------------------+--------+----------------------+
1342 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1343 +-+-+-----------------------------------------+--------+----------------------+
1344 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1345 +-+-+-----------------------------------------+--------+----------------------+
1346 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1347 +-+-+-----------------------------------------+--------+----------------------+
1348 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1349 +-+-+-----------------------------------------+--------+----------------------+
1350 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1351 +-+-+-----------------------------------------+--------+----------------------+
1352 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1353 +-+-+-----------------------------------------+--------+----------------------+
1354
c7d759eb
JK		 1355TUNNEL_INFO
1356===========
1357
1358Gets information about the tunnel state NIC is aware of.
1359
1360Request contents:
1361
1362 ===================================== ====== ==========================
1363 ``ETHTOOL_A_TUNNEL_INFO_HEADER`` nested request header
1364 ===================================== ====== ==========================
1365
1366Kernel response contents:
1367
1368 +---------------------------------------------+--------+---------------------+
1369 | ``ETHTOOL_A_TUNNEL_INFO_HEADER`` | nested | reply header |
1370 +---------------------------------------------+--------+---------------------+
1371 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS`` | nested | all UDP port tables |
1372 +-+-------------------------------------------+--------+---------------------+
1373 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE`` | nested | one UDP port table |
1374 +-+-+-----------------------------------------+--------+---------------------+
1375 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE`` | u32 | max size of the |
1376 | | | | | table |
1377 +-+-+-----------------------------------------+--------+---------------------+
1378 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` | bitset | tunnel types which |
1379 | | | | | table can hold |
1380 +-+-+-----------------------------------------+--------+---------------------+
1381 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY`` | nested | offloaded UDP port |
1382 +-+-+-+---------------------------------------+--------+---------------------+
1383 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT`` | be16 | UDP port |
1384 +-+-+-+---------------------------------------+--------+---------------------+
1385 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE`` | u32 | tunnel type |
1386 +-+-+-+---------------------------------------+--------+---------------------+
1387
966e5059
JK		 1388For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that
1389the table contains static entries, hard-coded by the NIC.
1390
1e5d1f69
JK		 1391FEC_GET
1392=======
1393
1394Gets FEC configuration and state like ``ETHTOOL_GFECPARAM`` ioctl request.
1395
1396Request contents:
1397
1398 ===================================== ====== ==========================
1399 ``ETHTOOL_A_FEC_HEADER`` nested request header
1400 ===================================== ====== ==========================
1401
1402Kernel response contents:
1403
1404 ===================================== ====== ==========================
1405 ``ETHTOOL_A_FEC_HEADER`` nested request header
1406 ``ETHTOOL_A_FEC_MODES`` bitset configured modes
1407 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection
1408 ``ETHTOOL_A_FEC_ACTIVE`` u32 index of active FEC mode
be85dbfe 1409 ``ETHTOOL_A_FEC_STATS`` nested FEC statistics
1e5d1f69
JK		 1410 ===================================== ====== ==========================
1411
1412``ETHTOOL_A_FEC_ACTIVE`` is the bit index of the FEC link mode currently
1413active on the interface. This attribute may not be present if device does
1414not support FEC.
1415
1416``ETHTOOL_A_FEC_MODES`` and ``ETHTOOL_A_FEC_AUTO`` are only meaningful when
1417autonegotiation is disabled. If ``ETHTOOL_A_FEC_AUTO`` is non-zero driver will
1418select the FEC mode automatically based on the parameters of the SFP module.
1419This is equivalent to the ``ETHTOOL_FEC_AUTO`` bit of the ioctl interface.
1420``ETHTOOL_A_FEC_MODES`` carry the current FEC configuration using link mode
1421bits (rather than old ``ETHTOOL_FEC_*`` bits).
1422
be85dbfe
JK		 1423``ETHTOOL_A_FEC_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
1424``ETHTOOL_A_HEADER_FLAGS``.
1425Each attribute carries an array of 64bit statistics. First entry in the array
1426contains the total number of events on the port, while the following entries
1427are counters corresponding to lanes/PCS instances. The number of entries in
1428the array will be:
1429
1430+--------------+---------------------------------------------+
1431| `0` | device does not support FEC statistics |
1432+--------------+---------------------------------------------+
1433| `1` | device does not support per-lane break down |
1434+--------------+---------------------------------------------+
1435| `1 + #lanes` | device has full support for FEC stats |
1436+--------------+---------------------------------------------+
1437
1438Drivers fill in the statistics in the following structure:
1439
1440.. kernel-doc:: include/linux/ethtool.h
1441 :identifiers: ethtool_fec_stats
1442
1e5d1f69
JK		 1443FEC_SET
1444=======
1445
1446Sets FEC parameters like ``ETHTOOL_SFECPARAM`` ioctl request.
1447
1448Request contents:
1449
1450 ===================================== ====== ==========================
1451 ``ETHTOOL_A_FEC_HEADER`` nested request header
1452 ``ETHTOOL_A_FEC_MODES`` bitset configured modes
1453 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection
1454 ===================================== ====== ==========================
1455
1456``FEC_SET`` is only meaningful when autonegotiation is disabled. Otherwise
1457FEC mode is selected as part of autonegotiation.
1458
1459``ETHTOOL_A_FEC_MODES`` selects which FEC mode should be used. It's recommended
1460to set only one bit, if multiple bits are set driver may choose between them
1461in an implementation specific way.
1462
1463``ETHTOOL_A_FEC_AUTO`` requests the driver to choose FEC mode based on SFP
1464module parameters. This does not mean autonegotiation.
1465
78c57f22
IS		 1466MODULE_EEPROM_GET
1467=================
c781ff12
VT		 1468
1469Fetch module EEPROM data dump.
1470This interface is designed to allow dumps of at most 1/2 page at once. This
1471means only dumps of 128 (or less) bytes are allowed, without crossing half page
1472boundary located at offset 128. For pages other than 0 only high 128 bytes are
1473accessible.
1474
1475Request contents:
1476
1477 ======================================= ====== ==========================
1478 ``ETHTOOL_A_MODULE_EEPROM_HEADER`` nested request header
1479 ``ETHTOOL_A_MODULE_EEPROM_OFFSET`` u32 offset within a page
1480 ``ETHTOOL_A_MODULE_EEPROM_LENGTH`` u32 amount of bytes to read
1481 ``ETHTOOL_A_MODULE_EEPROM_PAGE`` u8 page number
1482 ``ETHTOOL_A_MODULE_EEPROM_BANK`` u8 bank number
1483 ``ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS`` u8 page I2C address
1484 ======================================= ====== ==========================
1485
37a025e8
IS		 1486If ``ETHTOOL_A_MODULE_EEPROM_BANK`` is not specified, bank 0 is assumed.
1487
c781ff12
VT		 1488Kernel response contents:
1489
1490 +---------------------------------------------+--------+---------------------+
1491 | ``ETHTOOL_A_MODULE_EEPROM_HEADER`` | nested | reply header |
1492 +---------------------------------------------+--------+---------------------+
913d026f 1493 | ``ETHTOOL_A_MODULE_EEPROM_DATA`` | binary | array of bytes from |
c781ff12
VT		 1494 | | | module EEPROM |
1495 +---------------------------------------------+--------+---------------------+
1496
1497``ETHTOOL_A_MODULE_EEPROM_DATA`` has an attribute length equal to the amount of
1498bytes driver actually read.
1499
ddc78b36
JK		 1500STATS_GET
1501=========
1502
1503Get standard statistics for the interface. Note that this is not
1504a re-implementation of ``ETHTOOL_GSTATS`` which exposed driver-defined
1505stats.
1506
1507Request contents:
1508
1509 ======================================= ====== ==========================
1510 ``ETHTOOL_A_STATS_HEADER`` nested request header
1511 ``ETHTOOL_A_STATS_GROUPS`` bitset requested groups of stats
1512 ======================================= ====== ==========================
1513
1514Kernel response contents:
1515
1516 +-----------------------------------+--------+--------------------------------+
1517 | ``ETHTOOL_A_STATS_HEADER`` | nested | reply header |
1518 +-----------------------------------+--------+--------------------------------+
1519 | ``ETHTOOL_A_STATS_GRP`` | nested | one or more group of stats |
1520 +-+---------------------------------+--------+--------------------------------+
1521 | | ``ETHTOOL_A_STATS_GRP_ID`` | u32 | group ID - ``ETHTOOL_STATS_*`` |
1522 +-+---------------------------------+--------+--------------------------------+
1523 | | ``ETHTOOL_A_STATS_GRP_SS_ID`` | u32 | string set ID for names |
1524 +-+---------------------------------+--------+--------------------------------+
1525 | | ``ETHTOOL_A_STATS_GRP_STAT`` | nested | nest containing a statistic |
1526 +-+---------------------------------+--------+--------------------------------+
1527 | | ``ETHTOOL_A_STATS_GRP_HIST_RX`` | nested | histogram statistic (Rx) |
1528 +-+---------------------------------+--------+--------------------------------+
1529 | | ``ETHTOOL_A_STATS_GRP_HIST_TX`` | nested | histogram statistic (Tx) |
1530 +-+---------------------------------+--------+--------------------------------+
1531
1532Users specify which groups of statistics they are requesting via
1533the ``ETHTOOL_A_STATS_GROUPS`` bitset. Currently defined values are:
1534
1535 ====================== ======== ===============================================
1536 ETHTOOL_STATS_ETH_MAC eth-mac Basic IEEE 802.3 MAC statistics (30.3.1.1.*)
1537 ETHTOOL_STATS_ETH_PHY eth-phy Basic IEEE 802.3 PHY statistics (30.3.2.1.*)
1538 ETHTOOL_STATS_ETH_CTRL eth-ctrl Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*)
1539 ETHTOOL_STATS_RMON rmon RMON (RFC 2819) statistics
1540 ====================== ======== ===============================================
1541
1542Each group should have a corresponding ``ETHTOOL_A_STATS_GRP`` in the reply.
1543``ETHTOOL_A_STATS_GRP_ID`` identifies which group's statistics nest contains.
1544``ETHTOOL_A_STATS_GRP_SS_ID`` identifies the string set ID for the names of
1545the statistics in the group, if available.
1546
1547Statistics are added to the ``ETHTOOL_A_STATS_GRP`` nest under
1548``ETHTOOL_A_STATS_GRP_STAT``. ``ETHTOOL_A_STATS_GRP_STAT`` should contain
1549single 8 byte (u64) attribute inside - the type of that attribute is
1550the statistic ID and the value is the value of the statistic.
1551Each group has its own interpretation of statistic IDs.
1552Attribute IDs correspond to strings from the string set identified
1553by ``ETHTOOL_A_STATS_GRP_SS_ID``. Complex statistics (such as RMON histogram
1554entries) are also listed inside ``ETHTOOL_A_STATS_GRP`` and do not have
1555a string defined in the string set.
1556
1557RMON "histogram" counters count number of packets within given size range.
1558Because RFC does not specify the ranges beyond the standard 1518 MTU devices
1559differ in definition of buckets. For this reason the definition of packet ranges
1560is left to each driver.
1561
1562``ETHTOOL_A_STATS_GRP_HIST_RX`` and ``ETHTOOL_A_STATS_GRP_HIST_TX`` nests
1563contain the following attributes:
1564
1565 ================================= ====== ===================================
1566 ETHTOOL_A_STATS_RMON_HIST_BKT_LOW u32 low bound of the packet size bucket
1567 ETHTOOL_A_STATS_RMON_HIST_BKT_HI u32 high bound of the bucket
1568 ETHTOOL_A_STATS_RMON_HIST_VAL u64 packet counter
1569 ================================= ====== ===================================
1570
1571Low and high bounds are inclusive, for example:
1572
1573 ============================= ==== ====
1574 RFC statistic low high
1575 ============================= ==== ====
1576 etherStatsPkts64Octets 0 64
1577 etherStatsPkts512to1023Octets 512 1023
1578 ============================= ==== ====
1579
c156174a
YL		 1580PHC_VCLOCKS_GET
1581===============
1582
1583Query device PHC virtual clocks information.
1584
1585Request contents:
1586
1587 ==================================== ====== ==========================
1588 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested request header
1589 ==================================== ====== ==========================
1590
1591Kernel response contents:
1592
1593 ==================================== ====== ==========================
1594 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested reply header
1595 ``ETHTOOL_A_PHC_VCLOCKS_NUM`` u32 PHC virtual clocks number
1596 ``ETHTOOL_A_PHC_VCLOCKS_INDEX`` s32 PHC index array
1597 ==================================== ====== ==========================
1598
353407d9
IS		 1599MODULE_GET
1600==========
1601
1602Gets transceiver module parameters.
1603
1604Request contents:
1605
1606 ===================================== ====== ==========================
1607 ``ETHTOOL_A_MODULE_HEADER`` nested request header
1608 ===================================== ====== ==========================
1609
1610Kernel response contents:
1611
1612 ====================================== ====== ==========================
1613 ``ETHTOOL_A_MODULE_HEADER`` nested reply header
1614 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy
1615 ``ETHTOOL_A_MODULE_POWER_MODE`` u8 operational power mode
1616 ====================================== ====== ==========================
1617
1618The optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute encodes the
1619transceiver module power mode policy enforced by the host. The default policy
1620is driver-dependent, but "auto" is the recommended default and it should be
1621implemented by new drivers and drivers where conformance to a legacy behavior
1622is not critical.
1623
1624The optional ``ETHTHOOL_A_MODULE_POWER_MODE`` attribute encodes the operational
1625power mode policy of the transceiver module. It is only reported when a module
1626is plugged-in. Possible values are:
1627
1628.. kernel-doc:: include/uapi/linux/ethtool.h
1629 :identifiers: ethtool_module_power_mode
1630
1631MODULE_SET
1632==========
1633
1634Sets transceiver module parameters.
1635
1636Request contents:
1637
1638 ====================================== ====== ==========================
1639 ``ETHTOOL_A_MODULE_HEADER`` nested request header
1640 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy
1641 ====================================== ====== ==========================
1642
1643When set, the optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute is used
1644to set the transceiver module power policy enforced by the host. Possible
1645values are:
1646
1647.. kernel-doc:: include/uapi/linux/ethtool.h
1648 :identifiers: ethtool_module_power_mode_policy
1649
1650For SFF-8636 modules, low power mode is forced by the host according to table
16516-10 in revision 2.10a of the specification.
1652
1653For CMIS modules, low power mode is forced by the host according to table 6-12
1654in revision 5.0 of the specification.
1655
18ff0bcd
OR		 1656PSE_GET
1657=======
1658
1659Gets PSE attributes.
1660
1661Request contents:
1662
1663 ===================================== ====== ==========================
1664 ``ETHTOOL_A_PSE_HEADER`` nested request header
1665 ===================================== ====== ==========================
1666
1667Kernel response contents:
1668
1669 ====================================== ====== =============================
1670 ``ETHTOOL_A_PSE_HEADER`` nested reply header
1671 ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` u32 Operational state of the PoDL
1672 PSE functions
1673 ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` u32 power detection status of the
1674 PoDL PSE.
1675 ====================================== ====== =============================
1676
1677When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` attribute identifies
1678the operational state of the PoDL PSE functions. The operational state of the
1679PSE function can be changed using the ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL``
1680action. This option is corresponding to ``IEEE 802.3-2018`` 30.15.1.1.2
1681aPoDLPSEAdminState. Possible values are:
1682
1683.. kernel-doc:: include/uapi/linux/ethtool.h
1684 :identifiers: ethtool_podl_pse_admin_state
1685
1686When set, the optional ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` attribute identifies
1687the power detection status of the PoDL PSE. The status depend on internal PSE
1688state machine and automatic PD classification support. This option is
1689corresponding to ``IEEE 802.3-2018`` 30.15.1.1.3 aPoDLPSEPowerDetectionStatus.
1690Possible values are:
1691
1692.. kernel-doc:: include/uapi/linux/ethtool.h
1693 :identifiers: ethtool_podl_pse_pw_d_status
1694
1695PSE_SET
1696=======
1697
1698Sets PSE parameters.
1699
1700Request contents:
1701
1702 ====================================== ====== =============================
1703 ``ETHTOOL_A_PSE_HEADER`` nested request header
1704 ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` u32 Control PoDL PSE Admin state
1705 ====================================== ====== =============================
1706
1707When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` attribute is used
1708to control PoDL PSE Admin functions. This option is implementing
1709``IEEE 802.3-2018`` 30.15.1.2.1 acPoDLPSEAdminControl. See
1710``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` for supported values.
1711
7112a046
SM		 1712RSS_GET
1713=======
1714
1715Get indirection table, hash key and hash function info associated with a
1716RSS context of an interface similar to ``ETHTOOL_GRSSH`` ioctl request.
1717
1718Request contents:
1719
1720===================================== ====== ==========================
1721 ``ETHTOOL_A_RSS_HEADER`` nested request header
1722 ``ETHTOOL_A_RSS_CONTEXT`` u32 context number
1723===================================== ====== ==========================
1724
1725Kernel response contents:
1726
1727===================================== ====== ==========================
1728 ``ETHTOOL_A_RSS_HEADER`` nested reply header
1729 ``ETHTOOL_A_RSS_HFUNC`` u32 RSS hash func
1730 ``ETHTOOL_A_RSS_INDIR`` binary Indir table bytes
1731 ``ETHTOOL_A_RSS_HKEY`` binary Hash key bytes
1732===================================== ====== ==========================
1733
1734ETHTOOL_A_RSS_HFUNC attribute is bitmap indicating the hash function
1735being used. Current supported options are toeplitz, xor or crc32.
1736ETHTOOL_A_RSS_INDIR attribute returns RSS indrection table where each byte
1737indicates queue number.
1738
8580e16c
PB		 1739PLCA_GET_CFG
1740============
1741
1742Gets the IEEE 802.3cg-2019 Clause 148 Physical Layer Collision Avoidance
1743(PLCA) Reconciliation Sublayer (RS) attributes.
1744
1745Request contents:
1746
1747 ===================================== ====== ==========================
1748 ``ETHTOOL_A_PLCA_HEADER`` nested request header
1749 ===================================== ====== ==========================
1750
1751Kernel response contents:
1752
1753 ====================================== ====== =============================
1754 ``ETHTOOL_A_PLCA_HEADER`` nested reply header
1755 ``ETHTOOL_A_PLCA_VERSION`` u16 Supported PLCA management
1756 interface standard/version
1757 ``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State
1758 ``ETHTOOL_A_PLCA_NODE_ID`` u32 PLCA unique local node ID
1759 ``ETHTOOL_A_PLCA_NODE_CNT`` u32 Number of PLCA nodes on the
1760 network, including the
1761 coordinator
1762 ``ETHTOOL_A_PLCA_TO_TMR`` u32 Transmit Opportunity Timer
1763 value in bit-times (BT)
1764 ``ETHTOOL_A_PLCA_BURST_CNT`` u32 Number of additional packets
1765 the node is allowed to send
1766 within a single TO
1767 ``ETHTOOL_A_PLCA_BURST_TMR`` u32 Time to wait for the MAC to
1768 transmit a new frame before
1769 terminating the burst
1770 ====================================== ====== =============================
1771
1772When set, the optional ``ETHTOOL_A_PLCA_VERSION`` attribute indicates which
1773standard and version the PLCA management interface complies to. When not set,
1774the interface is vendor-specific and (possibly) supplied by the driver.
1775The OPEN Alliance SIG specifies a standard register map for 10BASE-T1S PHYs
1776embedding the PLCA Reconcialiation Sublayer. See "10BASE-T1S PLCA Management
1777Registers" at https://www.opensig.org/about/specifications/.
1778
1779When set, the optional ``ETHTOOL_A_PLCA_ENABLED`` attribute indicates the
1780administrative state of the PLCA RS. When not set, the node operates in "plain"
1781CSMA/CD mode. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.1
1782aPLCAAdminState / 30.16.1.2.1 acPLCAAdminControl.
1783
1784When set, the optional ``ETHTOOL_A_PLCA_NODE_ID`` attribute indicates the
1785configured local node ID of the PHY. This ID determines which transmit
1786opportunity (TO) is reserved for the node to transmit into. This option is
1787corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.4 aPLCALocalNodeID. The valid
1788range for this attribute is [0 .. 255] where 255 means "not configured".
1789
1790When set, the optional ``ETHTOOL_A_PLCA_NODE_CNT`` attribute indicates the
1791configured maximum number of PLCA nodes on the mixing-segment. This number
1792determines the total number of transmit opportunities generated during a
1793PLCA cycle. This attribute is relevant only for the PLCA coordinator, which is
1794the node with aPLCALocalNodeID set to 0. Follower nodes ignore this setting.
1795This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.3
1796aPLCANodeCount. The valid range for this attribute is [1 .. 255].
1797
1798When set, the optional ``ETHTOOL_A_PLCA_TO_TMR`` attribute indicates the
1799configured value of the transmit opportunity timer in bit-times. This value
1800must be set equal across all nodes sharing the medium for PLCA to work
1801correctly. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.5
1802aPLCATransmitOpportunityTimer. The valid range for this attribute is
1803[0 .. 255].
1804
1805When set, the optional ``ETHTOOL_A_PLCA_BURST_CNT`` attribute indicates the
1806configured number of extra packets that the node is allowed to send during a
1807single transmit opportunity. By default, this attribute is 0, meaning that
1808the node can only send a sigle frame per TO. When greater than 0, the PLCA RS
1809keeps the TO after any transmission, waiting for the MAC to send a new frame
1810for up to aPLCABurstTimer BTs. This can only happen a number of times per PLCA
1811cycle up to the value of this parameter. After that, the burst is over and the
1812normal counting of TOs resumes. This option is corresponding to
1813``IEEE 802.3cg-2019`` 30.16.1.1.6 aPLCAMaxBurstCount. The valid range for this
1814attribute is [0 .. 255].
1815
1816When set, the optional ``ETHTOOL_A_PLCA_BURST_TMR`` attribute indicates how
1817many bit-times the PLCA RS waits for the MAC to initiate a new transmission
1818when aPLCAMaxBurstCount is greater than 0. If the MAC fails to send a new
1819frame within this time, the burst ends and the counting of TOs resumes.
1820Otherwise, the new frame is sent as part of the current burst. This option
1821is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.7 aPLCABurstTimer. The
1822valid range for this attribute is [0 .. 255]. Although, the value should be
1823set greater than the Inter-Frame-Gap (IFG) time of the MAC (plus some margin)
1824for PLCA burst mode to work as intended.
1825
1826PLCA_SET_CFG
1827============
1828
1829Sets PLCA RS parameters.
1830
1831Request contents:
1832
1833 ====================================== ====== =============================
1834 ``ETHTOOL_A_PLCA_HEADER`` nested request header
1835 ``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State
1836 ``ETHTOOL_A_PLCA_NODE_ID`` u8 PLCA unique local node ID
1837 ``ETHTOOL_A_PLCA_NODE_CNT`` u8 Number of PLCA nodes on the
1838 netkork, including the
1839 coordinator
1840 ``ETHTOOL_A_PLCA_TO_TMR`` u8 Transmit Opportunity Timer
1841 value in bit-times (BT)
1842 ``ETHTOOL_A_PLCA_BURST_CNT`` u8 Number of additional packets
1843 the node is allowed to send
1844 within a single TO
1845 ``ETHTOOL_A_PLCA_BURST_TMR`` u8 Time to wait for the MAC to
1846 transmit a new frame before
1847 terminating the burst
1848 ====================================== ====== =============================
1849
1850For a description of each attribute, see ``PLCA_GET_CFG``.
1851
1852PLCA_GET_STATUS
1853===============
1854
1855Gets PLCA RS status information.
1856
1857Request contents:
1858
1859 ===================================== ====== ==========================
1860 ``ETHTOOL_A_PLCA_HEADER`` nested request header
1861 ===================================== ====== ==========================
1862
1863Kernel response contents:
1864
1865 ====================================== ====== =============================
1866 ``ETHTOOL_A_PLCA_HEADER`` nested reply header
1867 ``ETHTOOL_A_PLCA_STATUS`` u8 PLCA RS operational status
1868 ====================================== ====== =============================
1869
1870When set, the ``ETHTOOL_A_PLCA_STATUS`` attribute indicates whether the node is
1871detecting the presence of the BEACON on the network. This flag is
1872corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.2 aPLCAStatus.
1873
37000004
VO		 1874MM_GET
1875======
1876
1877Retrieve 802.3 MAC Merge parameters.
1878
1879Request contents:
1880
1881 ==================================== ====== ==========================
1882 ``ETHTOOL_A_MM_HEADER`` nested request header
1883 ==================================== ====== ==========================
1884
1885Kernel response contents:
1886
1887 ================================= ====== ===================================
1888 ``ETHTOOL_A_MM_HEADER`` nested request header
1889 ``ETHTOOL_A_MM_PMAC_ENABLED`` bool set if RX of preemptible and SMD-V
1890 frames is enabled
1891 ``ETHTOOL_A_MM_TX_ENABLED`` bool set if TX of preemptible frames is
1892 administratively enabled (might be
1893 inactive if verification failed)
1894 ``ETHTOOL_A_MM_TX_ACTIVE`` bool set if TX of preemptible frames is
1895 operationally enabled
1896 ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE`` u32 minimum size of transmitted
1897 non-final fragments, in octets
1898 ``ETHTOOL_A_MM_RX_MIN_FRAG_SIZE`` u32 minimum size of received non-final
1899 fragments, in octets
1900 ``ETHTOOL_A_MM_VERIFY_ENABLED`` bool set if TX of SMD-V frames is
1901 administratively enabled
1902 ``ETHTOOL_A_MM_VERIFY_STATUS`` u8 state of the verification function
1903 ``ETHTOOL_A_MM_VERIFY_TIME`` u32 delay between verification attempts
1904 ``ETHTOOL_A_MM_MAX_VERIFY_TIME``` u32 maximum verification interval
1905 supported by device
1906 ``ETHTOOL_A_MM_STATS`` nested IEEE 802.3-2018 subclause 30.14.1
1907 oMACMergeEntity statistics counters
1908 ================================= ====== ===================================
1909
1910The attributes are populated by the device driver through the following
1911structure:
1912
1913.. kernel-doc:: include/linux/ethtool.h
1914 :identifiers: ethtool_mm_state
1915
1916The ``ETHTOOL_A_MM_VERIFY_STATUS`` will report one of the values from
1917
1918.. kernel-doc:: include/uapi/linux/ethtool.h
1919 :identifiers: ethtool_mm_verify_status
1920
1921If ``ETHTOOL_A_MM_VERIFY_ENABLED`` was passed as false in the ``MM_SET``
1922command, ``ETHTOOL_A_MM_VERIFY_STATUS`` will report either
1923``ETHTOOL_MM_VERIFY_STATUS_INITIAL`` or ``ETHTOOL_MM_VERIFY_STATUS_DISABLED``,
1924otherwise it should report one of the other states.
1925
1926It is recommended that drivers start with the pMAC disabled, and enable it upon
1927user space request. It is also recommended that user space does not depend upon
1928the default values from ``ETHTOOL_MSG_MM_GET`` requests.
1929
1930``ETHTOOL_A_MM_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
1931``ETHTOOL_A_HEADER_FLAGS``. The attribute will be empty if driver did not
1932report any statistics. Drivers fill in the statistics in the following
1933structure:
1934
1935.. kernel-doc:: include/linux/ethtool.h
1936 :identifiers: ethtool_mm_stats
1937
1938MM_SET
1939======
1940
1941Modifies the configuration of the 802.3 MAC Merge layer.
1942
1943Request contents:
1944
1945 ================================= ====== ==========================
1946 ``ETHTOOL_A_MM_VERIFY_TIME`` u32 see MM_GET description
1947 ``ETHTOOL_A_MM_VERIFY_ENABLED`` bool see MM_GET description
1948 ``ETHTOOL_A_MM_TX_ENABLED`` bool see MM_GET description
1949 ``ETHTOOL_A_MM_PMAC_ENABLED`` bool see MM_GET description
1950 ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE`` u32 see MM_GET description
1951 ================================= ====== ==========================
1952
1953The attributes are propagated to the driver through the following structure:
1954
1955.. kernel-doc:: include/linux/ethtool.h
1956 :identifiers: ethtool_mm_cfg
1957
2b4a8990
MK		 1958Request translation
1959===================
1960
1961The following table maps ioctl commands to netlink commands providing their
1962functionality. Entries with "n/a" in right column are commands which do not
11ca3c42
AL		 1963have their netlink replacement yet. Entries which "n/a" in the left column
1964are netlink only.
2b4a8990
MK		 1965
1966 =================================== =====================================
1967 ioctl command netlink command
1968 =================================== =====================================
459e0b81 1969 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET``
f625aa9b 1970 ``ETHTOOL_MSG_LINKMODES_GET``
a53f3d41 1971 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET``
bfbcfe20 1972 ``ETHTOOL_MSG_LINKMODES_SET``
2b4a8990
MK		 1973 ``ETHTOOL_GDRVINFO`` n/a
1974 ``ETHTOOL_GREGS`` n/a
51ea22b0 1975 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET``
8d425b19 1976 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET``
6a94b8cc 1977 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET``
e54d04e3 1978 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET``
2b4a8990 1979 ``ETHTOOL_NWAY_RST`` n/a
3d2b847f 1980 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET``
2b4a8990
MK		 1981 ``ETHTOOL_GEEPROM`` n/a
1982 ``ETHTOOL_SEEPROM`` n/a
21727545 1983 ``ETHTOOL_GCOALESCE`` ``ETHTOOL_MSG_COALESCE_GET``
9881418c 1984 ``ETHTOOL_SCOALESCE`` ``ETHTOOL_MSG_COALESCE_SET``
e4a1717b 1985 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET``
2fc2929e 1986 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET``
7f59fb32 1987 ``ETHTOOL_GPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_GET``
3ab87993 1988 ``ETHTOOL_SPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_SET``
0524399d 1989 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1990 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 1991 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1992 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 1993 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 1994 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET``
2b4a8990 1995 ``ETHTOOL_TEST`` n/a
71921690 1996 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET``
2b4a8990
MK		 1997 ``ETHTOOL_PHYS_ID`` n/a
1998 ``ETHTOOL_GSTATS`` n/a
0524399d 1999 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 2000 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET``
2b4a8990 2001 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK``
0524399d 2002 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 2003 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 2004 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 2005 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET``
0524399d 2006 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 2007 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET``
e16c3386 2008 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET``
f265d799 2009 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET``
2b4a8990
MK		 2010 ``ETHTOOL_GRXFH`` n/a
2011 ``ETHTOOL_SRXFH`` n/a
0524399d 2012 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 2013 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET``
2b4a8990
MK		 2014 ``ETHTOOL_GRXRINGS`` n/a
2015 ``ETHTOOL_GRXCLSRLCNT`` n/a
2016 ``ETHTOOL_GRXCLSRULE`` n/a
2017 ``ETHTOOL_GRXCLSRLALL`` n/a
2018 ``ETHTOOL_SRXCLSRLDEL`` n/a
2019 ``ETHTOOL_SRXCLSRLINS`` n/a
2020 ``ETHTOOL_FLASHDEV`` n/a
2021 ``ETHTOOL_RESET`` n/a
2022 ``ETHTOOL_SRXNTUPLE`` n/a
2023 ``ETHTOOL_GRXNTUPLE`` n/a
71921690 2024 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET``
2b4a8990
MK		 2025 ``ETHTOOL_GRXFHINDIR`` n/a
2026 ``ETHTOOL_SRXFHINDIR`` n/a
0524399d 2027 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET``
0980bfcd 2028 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET``
0c84979c 2029 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET``
e19c591e 2030 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET``
2b4a8990
MK		 2031 ``ETHTOOL_SET_DUMP`` n/a
2032 ``ETHTOOL_GET_DUMP_FLAG`` n/a
2033 ``ETHTOOL_GET_DUMP_DATA`` n/a
5b071c59 2034 ``ETHTOOL_GET_TS_INFO`` ``ETHTOOL_MSG_TSINFO_GET``
c781ff12
VT		 2035 ``ETHTOOL_GMODULEINFO`` ``ETHTOOL_MSG_MODULE_EEPROM_GET``
2036 ``ETHTOOL_GMODULEEEPROM`` ``ETHTOOL_MSG_MODULE_EEPROM_GET``
b7eeefe7 2037 ``ETHTOOL_GEEE`` ``ETHTOOL_MSG_EEE_GET``
fd77be7b 2038 ``ETHTOOL_SEEE`` ``ETHTOOL_MSG_EEE_SET``
7112a046 2039 ``ETHTOOL_GRSSH`` ``ETHTOOL_MSG_RSS_GET``
2b4a8990
MK		 2040 ``ETHTOOL_SRSSH`` n/a
2041 ``ETHTOOL_GTUNABLE`` n/a
2042 ``ETHTOOL_STUNABLE`` n/a
2043 ``ETHTOOL_GPHYSTATS`` n/a
2044 ``ETHTOOL_PERQUEUE`` n/a
459e0b81 2045 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET``
f625aa9b 2046 ``ETHTOOL_MSG_LINKMODES_GET``
a53f3d41 2047 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET``
bfbcfe20 2048 ``ETHTOOL_MSG_LINKMODES_SET``
2b4a8990
MK		 2049 ``ETHTOOL_PHY_GTUNABLE`` n/a
2050 ``ETHTOOL_PHY_STUNABLE`` n/a
1e5d1f69
JK		 2051 ``ETHTOOL_GFECPARAM`` ``ETHTOOL_MSG_FEC_GET``
2052 ``ETHTOOL_SFECPARAM`` ``ETHTOOL_MSG_FEC_SET``
0b35e0de
JK		 2053 n/a ``ETHTOOL_MSG_CABLE_TEST_ACT``
2054 n/a ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT``
19a83d36 2055 n/a ``ETHTOOL_MSG_TUNNEL_INFO_GET``
c156174a 2056 n/a ``ETHTOOL_MSG_PHC_VCLOCKS_GET``
353407d9
IS		 2057 n/a ``ETHTOOL_MSG_MODULE_GET``
2058 n/a ``ETHTOOL_MSG_MODULE_SET``
8580e16c
PB		 2059 n/a ``ETHTOOL_MSG_PLCA_GET_CFG``
2060 n/a ``ETHTOOL_MSG_PLCA_SET_CFG``
2061 n/a ``ETHTOOL_MSG_PLCA_GET_STATUS``
37000004
VO		 2062 n/a ``ETHTOOL_MSG_MM_GET``
2063 n/a ``ETHTOOL_MSG_MM_SET``
2b4a8990 2064 =================================== =====================================
Linux 6.x block layer and io_uring tree(s)