| blob | 30b98245979fdc848842e125cace2d687aeeecc8 |
1 =============================
2 Netlink interface for ethtool
3 =============================
6 Basic information
7 =================
9 Netlink interface for ethtool uses generic netlink family ``ethtool``
10 (userspace application should use macros ``ETHTOOL_GENL_NAME`` and
11 ``ETHTOOL_GENL_VERSION`` defined in ``<linux/ethtool_netlink.h>`` uapi
12 header). This family does not use a specific header, all information in
13 requests and replies is passed using netlink attributes.
15 The ethtool netlink interface uses extended ACK for error and warning
16 reporting, userspace application developers are encouraged to make these
17 messages available to user in a suitable way.
19 Requests can be divided into three categories: "get" (retrieving information),
20 "set" (setting parameters) and "action" (invoking an action).
22 All "set" and "action" type requests require admin privileges
23 (``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for
24 anyone but there are exceptions (where the response contains sensitive
25 information). In some cases, the request as such is allowed for anyone but
26 unprivileged users have attributes with sensitive information (e.g.
27 wake-on-lan password) omitted.
30 Conventions
31 ===========
33 Attributes which represent a boolean value usually use NLA_U8 type so that we
34 can distinguish three states: "on", "off" and "not present" (meaning the
35 information is not available in "get" requests or value is not to be changed
36 in "set" requests). For these attributes, the "true" value should be passed as
37 number 1 but any non-zero value should be understood as "true" by recipient.
38 In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way.
40 In the message structure descriptions below, if an attribute name is suffixed
41 with "+", parent nest can contain multiple attributes of the same type. This
42 implements an array of entries.
45 Request header
46 ==============
48 Each request or reply message contains a nested attribute with common header.
49 Structure of this header is
51 ============================== ====== =============================
52 ``ETHTOOL_A_HEADER_DEV_INDEX`` u32 device ifindex
53 ``ETHTOOL_A_HEADER_DEV_NAME`` string device name
54 ``ETHTOOL_A_HEADER_FLAGS`` u32 flags common for all requests
55 ============================== ====== =============================
57 ``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
58 device message relates to. One of them is sufficient in requests, if both are
59 used, they must identify the same device. Some requests, e.g. global string
60 sets, do not require device identification. Most ``GET`` requests also allow
61 dump requests without device identification to query the same information for
62 all devices providing it (each device in a separate message).
64 ``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request
65 types. The interpretation of these flags is the same for all request types but
66 the flags may not apply to requests. Recognized flags are:
68 ================================= ===================================
69 ``ETHTOOL_FLAG_COMPACT_BITSETS`` use compact format bitsets in reply
70 ``ETHTOOL_FLAG_OMIT_REPLY`` omit optional reply (_SET and _ACT)
71 ``ETHTOOL_FLAG_STATS`` include optional device statistics
72 ================================= ===================================
74 New request flags should follow the general idea that if the flag is not set,
75 the behaviour is backward compatible, i.e. requests from old clients not aware
76 of the flag should be interpreted the way the client expects. A client must
77 not set flags it does not understand.
80 Bit sets
81 ========
83 For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
84 type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
85 attribute with contents of one of two forms: compact (two binary bitmaps
86 representing bit values and mask of affected bits) and bit-by-bit (list of
87 bits identified by either index or name).
89 Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
90 with their values which saves a round trip (when the bitset is passed in a
91 request) or at least a second request (when the bitset is in a reply). This is
92 useful for one shot applications like traditional ethtool command. On the
93 other hand, long running applications like ethtool monitor (displaying
94 notifications) or network management daemons may prefer fetching the names
95 only once and using compact form to save message size. Notifications from
96 ethtool netlink interface always use compact form for bitsets.
98 A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
99 not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
100 modifying a bitmap, the former changes the bit set in mask to values set in
101 value and preserves the rest; the latter sets the bits set in the bitmap and
102 clears the rest.
104 Compact form: nested (bitset) atrribute contents:
106 ============================ ====== ============================
107 ``ETHTOOL_A_BITSET_NOMASK`` flag no mask, only a list
108 ``ETHTOOL_A_BITSET_SIZE`` u32 number of significant bits
109 ``ETHTOOL_A_BITSET_VALUE`` binary bitmap of bit values
110 ``ETHTOOL_A_BITSET_MASK`` binary bitmap of valid bits
111 ============================ ====== ============================
113 Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
114 rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
115 order, words ordered from least significant to most significant (i.e. the same
116 way as bitmaps are passed with ioctl interface).
118 For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
119 mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
120 ``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
121 if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
122 allowed (bitset represents a single bitmap.
124 Kernel bit set length may differ from userspace length if older application is
125 used on newer kernel or vice versa. If userspace bitmap is longer, an error is
126 issued only if the request actually tries to set values of some bits not
127 recognized by kernel.
129 Bit-by-bit form: nested (bitset) attribute contents:
131 +------------------------------------+--------+-----------------------------+
132 | ``ETHTOOL_A_BITSET_NOMASK`` | flag | no mask, only a list |
133 +------------------------------------+--------+-----------------------------+
134 | ``ETHTOOL_A_BITSET_SIZE`` | u32 | number of significant bits |
135 +------------------------------------+--------+-----------------------------+
136 | ``ETHTOOL_A_BITSET_BITS`` | nested | array of bits |
137 +-+----------------------------------+--------+-----------------------------+
138 | | ``ETHTOOL_A_BITSET_BITS_BIT+`` | nested | one bit |
139 +-+-+--------------------------------+--------+-----------------------------+
140 | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32 | bit index (0 for LSB) |
141 +-+-+--------------------------------+--------+-----------------------------+
142 | | | ``ETHTOOL_A_BITSET_BIT_NAME`` | string | bit name |
143 +-+-+--------------------------------+--------+-----------------------------+
144 | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag | present if bit is set |
145 +-+-+--------------------------------+--------+-----------------------------+
147 Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
148 only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
149 arbitrary number of them. A bit may be identified by its index or by its
150 name. When used in requests, listed bits are set to 0 or 1 according to
151 ``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if
152 index exceeds kernel bit length or if name is not recognized.
154 When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
155 a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
156 such case. Such bitset represents a bitmap with listed bits set and the rest
157 zero.
159 In requests, application can use either form. Form used by kernel in reply is
160 determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
161 header. Semantics of value and mask depends on the attribute.
164 List of message types
165 =====================
167 All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
168 according to message purpose:
170 ============== ======================================
171 ``_GET`` userspace request to retrieve data
172 ``_SET`` userspace request to set data
173 ``_ACT`` userspace request to perform an action
174 ``_GET_REPLY`` kernel reply to a ``GET`` request
175 ``_SET_REPLY`` kernel reply to a ``SET`` request
176 ``_ACT_REPLY`` kernel reply to an ``ACT`` request
177 ``_NTF`` kernel notification
178 ============== ======================================
180 Userspace to kernel:
182 ===================================== ================================
183 ``ETHTOOL_MSG_STRSET_GET`` get string set
184 ``ETHTOOL_MSG_LINKINFO_GET`` get link settings
185 ``ETHTOOL_MSG_LINKINFO_SET`` set link settings
186 ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info
187 ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info
188 ``ETHTOOL_MSG_LINKSTATE_GET`` get link state
189 ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings
190 ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings
191 ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings
192 ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings
193 ``ETHTOOL_MSG_FEATURES_GET`` get device features
194 ``ETHTOOL_MSG_FEATURES_SET`` set device features
195 ``ETHTOOL_MSG_PRIVFLAGS_GET`` get private flags
196 ``ETHTOOL_MSG_PRIVFLAGS_SET`` set private flags
197 ``ETHTOOL_MSG_RINGS_GET`` get ring sizes
198 ``ETHTOOL_MSG_RINGS_SET`` set ring sizes
199 ``ETHTOOL_MSG_CHANNELS_GET`` get channel counts
200 ``ETHTOOL_MSG_CHANNELS_SET`` set channel counts
201 ``ETHTOOL_MSG_COALESCE_GET`` get coalescing parameters
202 ``ETHTOOL_MSG_COALESCE_SET`` set coalescing parameters
203 ``ETHTOOL_MSG_PAUSE_GET`` get pause parameters
204 ``ETHTOOL_MSG_PAUSE_SET`` set pause parameters
205 ``ETHTOOL_MSG_EEE_GET`` get EEE settings
206 ``ETHTOOL_MSG_EEE_SET`` set EEE settings
207 ``ETHTOOL_MSG_TSINFO_GET`` get timestamping info
208 ``ETHTOOL_MSG_CABLE_TEST_ACT`` action start cable test
209 ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT`` action start raw TDR cable test
210 ``ETHTOOL_MSG_TUNNEL_INFO_GET`` get tunnel offload info
211 ===================================== ================================
213 Kernel to userspace:
215 ===================================== =================================
216 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents
217 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings
218 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification
219 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info
220 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification
221 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info
222 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings
223 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification
224 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings
225 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification
226 ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features
227 ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET
228 ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification
229 ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags
230 ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags
231 ``ETHTOOL_MSG_RINGS_GET_REPLY`` ring sizes
232 ``ETHTOOL_MSG_RINGS_NTF`` ring sizes
233 ``ETHTOOL_MSG_CHANNELS_GET_REPLY`` channel counts
234 ``ETHTOOL_MSG_CHANNELS_NTF`` channel counts
235 ``ETHTOOL_MSG_COALESCE_GET_REPLY`` coalescing parameters
236 ``ETHTOOL_MSG_COALESCE_NTF`` coalescing parameters
237 ``ETHTOOL_MSG_PAUSE_GET_REPLY`` pause parameters
238 ``ETHTOOL_MSG_PAUSE_NTF`` pause parameters
239 ``ETHTOOL_MSG_EEE_GET_REPLY`` EEE settings
240 ``ETHTOOL_MSG_EEE_NTF`` EEE settings
241 ``ETHTOOL_MSG_TSINFO_GET_REPLY`` timestamping info
242 ``ETHTOOL_MSG_CABLE_TEST_NTF`` Cable test results
243 ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF`` Cable test TDR results
244 ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY`` tunnel offload info
245 ===================================== =================================
247 ``GET`` requests are sent by userspace applications to retrieve device
248 information. They usually do not contain any message specific attributes.
249 Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
250 request with ``NLM_F_DUMP`` and no device identification can be used to query
251 the information for all devices supporting the request.
253 If the data can be also modified, corresponding ``SET`` message with the same
254 layout as corresponding ``GET_REPLY`` is used to request changes. Only
255 attributes where a change is requested are included in such request (also, not
256 all attributes may be changed). Replies to most ``SET`` request consist only
257 of error code and extack; if kernel provides additional data, it is sent in
258 the form of corresponding ``SET_REPLY`` message which can be suppressed by
259 setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
261 Data modification also triggers sending a ``NTF`` message with a notification.
262 These usually bear only a subset of attributes which was affected by the
263 change. The same notification is issued if the data is modified using other
264 means (mostly ioctl ethtool interface). Unlike notifications from ethtool
265 netlink code which are only sent if something actually changed, notifications
266 triggered by ioctl interface may be sent even if the request did not actually
267 change any data.
269 ``ACT`` messages request kernel (driver) to perform a specific action. If some
270 information is reported by kernel (which can be suppressed by setting
271 ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
272 an ``ACT_REPLY`` message. Performing an action also triggers a notification
273 (``NTF`` message).
275 Later sections describe the format and semantics of these messages.
278 STRSET_GET
279 ==========
281 Requests contents of a string set as provided by ioctl commands
282 ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
283 writeable so that the corresponding ``STRSET_SET`` message is only used in
284 kernel replies. There are two types of string sets: global (independent of
285 a device, e.g. device feature names) and device specific (e.g. device private
286 flags).
288 Request contents:
290 +---------------------------------------+--------+------------------------+
291 | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header |
292 +---------------------------------------+--------+------------------------+
293 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request |
294 +-+-------------------------------------+--------+------------------------+
295 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set |
296 +-+-+-----------------------------------+--------+------------------------+
297 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id |
298 +-+-+-----------------------------------+--------+------------------------+
300 Kernel response contents:
302 +---------------------------------------+--------+-----------------------+
303 | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header |
304 +---------------------------------------+--------+-----------------------+
305 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets |
306 +-+-------------------------------------+--------+-----------------------+
307 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set |
308 +-+-+-----------------------------------+--------+-----------------------+
309 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id |
310 +-+-+-----------------------------------+--------+-----------------------+
311 | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings |
312 +-+-+-----------------------------------+--------+-----------------------+
313 | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings |
314 +-+-+-+---------------------------------+--------+-----------------------+
315 | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string |
316 +-+-+-+-+-------------------------------+--------+-----------------------+
317 | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index |
318 +-+-+-+-+-------------------------------+--------+-----------------------+
319 | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value |
320 +-+-+-+-+-------------------------------+--------+-----------------------+
321 | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts |
322 +---------------------------------------+--------+-----------------------+
324 Device identification in request header is optional. Depending on its presence
325 a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
327 - no ``NLM_F_DUMP,`` no device: get "global" stringsets
328 - no ``NLM_F_DUMP``, with device: get string sets related to the device
329 - ``NLM_F_DUMP``, no device: get device related string sets for all devices
331 If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
332 requested type are returned, otherwise only those specified in the request.
333 Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
334 counts of the sets, not the actual strings.
337 LINKINFO_GET
338 ============
340 Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
341 link modes and autonegotiation related information. The request does not use
342 any attributes.
344 Request contents:
346 ==================================== ====== ==========================
347 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
348 ==================================== ====== ==========================
350 Kernel response contents:
352 ==================================== ====== ==========================
353 ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header
354 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port
355 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address
356 ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status
357 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control
358 ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver
359 ==================================== ====== ==========================
361 Attributes and their values have the same meaning as matching members of the
362 corresponding ioctl structures.
364 ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
365 devices supporting the request).
368 LINKINFO_SET
369 ============
371 ``LINKINFO_SET`` request allows setting some of the attributes reported by
372 ``LINKINFO_GET``.
374 Request contents:
376 ==================================== ====== ==========================
377 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
378 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port
379 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address
380 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control
381 ==================================== ====== ==========================
383 MDI(-X) status and transceiver cannot be set, request with the corresponding
384 attributes is rejected.
387 LINKMODES_GET
388 =============
390 Requests link modes (supported, advertised and peer advertised) and related
391 information (autonegotiation status, link speed and duplex) as provided by
392 ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
394 Request contents:
396 ==================================== ====== ==========================
397 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
398 ==================================== ====== ==========================
400 Kernel response contents:
402 ========================================== ====== ==========================
403 ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header
404 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status
405 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes
406 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes
407 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s)
408 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode
409 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode
410 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE`` u8 Master/slave port state
411 ========================================== ====== ==========================
413 For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
414 represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
415 list.
417 ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
418 devices supporting the request).
421 LINKMODES_SET
422 =============
424 Request contents:
426 ========================================== ====== ==========================
427 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
428 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status
429 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes
430 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes
431 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s)
432 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode
433 ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG`` u8 Master/slave port mode
434 ========================================== ====== ==========================
436 ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
437 autonegotiation is on (either set now or kept from before), advertised modes
438 are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
439 of speed and duplex is specified, kernel adjusts advertised modes to all
440 supported modes matching speed, duplex or both (whatever is specified). This
441 autoselection is done on ethtool side with ioctl interface, netlink interface
442 is supposed to allow requesting changes without knowing what exactly kernel
443 supports.
446 LINKSTATE_GET
447 =============
449 Requests link state information. Link up/down flag (as provided by
450 ``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
451 be provided as well. In general, extended state describes reasons for why a port
452 is down, or why it operates in some non-obvious mode. This request does not have
453 any attributes.
455 Request contents:
457 ==================================== ====== ==========================
458 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header
459 ==================================== ====== ==========================
461 Kernel response contents:
463 ==================================== ====== ============================
464 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header
465 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down)
466 ``ETHTOOL_A_LINKSTATE_SQI`` u32 Current Signal Quality Index
467 ``ETHTOOL_A_LINKSTATE_SQI_MAX`` u32 Max support SQI value
468 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state
469 ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate
470 ==================================== ====== ============================
472 For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
473 carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
474 define their own handler.
476 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
477 optional values. ethtool core can provide either both
478 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
479 or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
481 ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
482 devices supporting the request).
485 Link extended states:
487 ================================================ ============================================
488 ``ETHTOOL_LINK_EXT_STATE_AUTONEG`` States relating to the autonegotiation or
489 issues therein
491 ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE`` Failure during link training
493 ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH`` Logical mismatch in physical coding sublayer
494 or forward error correction sublayer
496 ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY`` Signal integrity issues
498 ``ETHTOOL_LINK_EXT_STATE_NO_CABLE`` No cable connected
500 ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE`` Failure is related to cable,
501 e.g., unsupported cable
503 ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE`` Failure is related to EEPROM, e.g., failure
504 during reading or parsing the data
506 ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE`` Failure during calibration algorithm
508 ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED`` The hardware is not able to provide the
509 power required from cable or module
511 ``ETHTOOL_LINK_EXT_STATE_OVERHEAT`` The module is overheated
512 ================================================ ============================================
514 Link extended substates:
516 Autoneg substates:
518 =============================================================== ================================
519 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED`` Peer side is down
521 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED`` Ack not received from peer side
523 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED`` Next page exchange failed
525 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE`` Peer side is down during force
526 mode or there is no agreement of
527 speed
529 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE`` Forward error correction modes
530 in both sides are mismatched
532 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD`` No Highest Common Denominator
533 =============================================================== ================================
535 Link training substates:
537 =========================================================================== ====================
538 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED`` Frames were not
539 recognized, the
540 lock failed
542 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT`` The lock did not
543 occur before
544 timeout
546 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY`` Peer side did not
547 send ready signal
548 after training
549 process
551 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT`` Remote side is not
552 ready yet
553 =========================================================================== ====================
555 Link logical mismatch substates:
557 ================================================================ ===============================
558 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK`` Physical coding sublayer was
559 not locked in first phase -
560 block lock
562 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK`` Physical coding sublayer was
563 not locked in second phase -
564 alignment markers lock
566 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS`` Physical coding sublayer did
567 not get align status
569 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED`` FC forward error correction is
570 not locked
572 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED`` RS forward error correction is
573 not locked
574 ================================================================ ===============================
576 Bad signal integrity substates:
578 ================================================================= =============================
579 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS`` Large number of physical
580 errors
582 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE`` The system attempted to
583 operate the cable at a rate
584 that is not formally
585 supported, which led to
586 signal integrity issues
587 ================================================================= =============================
589 Cable issue substates:
591 =================================================== ============================================
592 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE`` Unsupported cable
594 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE`` Cable test failure
595 =================================================== ============================================
597 DEBUG_GET
598 =========
600 Requests debugging settings of a device. At the moment, only message mask is
601 provided.
603 Request contents:
605 ==================================== ====== ==========================
606 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
607 ==================================== ====== ==========================
609 Kernel response contents:
611 ==================================== ====== ==========================
612 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header
613 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
614 ==================================== ====== ==========================
616 The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
617 provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
618 interface. While it is called message level there for historical reasons, most
619 drivers and almost all newer drivers use it as a mask of enabled message
620 classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
621 interface follows its actual use in practice.
623 ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
624 devices supporting the request).
627 DEBUG_SET
628 =========
630 Set or update debugging settings of a device. At the moment, only message mask
631 is supported.
633 Request contents:
635 ==================================== ====== ==========================
636 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
637 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
638 ==================================== ====== ==========================
640 ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
641 enabled debugging message types for the device.
644 WOL_GET
645 =======
647 Query device wake-on-lan settings. Unlike most "GET" type requests,
648 ``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
649 (potentially) provides SecureOn(tm) password which is confidential.
651 Request contents:
653 ==================================== ====== ==========================
654 ``ETHTOOL_A_WOL_HEADER`` nested request header
655 ==================================== ====== ==========================
657 Kernel response contents:
659 ==================================== ====== ==========================
660 ``ETHTOOL_A_WOL_HEADER`` nested reply header
661 ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes
662 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password
663 ==================================== ====== ==========================
665 In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
666 device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
667 included in reply if ``WAKE_MAGICSECURE`` mode is supported.
670 WOL_SET
671 =======
673 Set or update wake-on-lan settings.
675 Request contents:
677 ==================================== ====== ==========================
678 ``ETHTOOL_A_WOL_HEADER`` nested request header
679 ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes
680 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password
681 ==================================== ====== ==========================
683 ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
684 ``WAKE_MAGICSECURE`` mode.
687 FEATURES_GET
688 ============
690 Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
692 Request contents:
694 ==================================== ====== ==========================
695 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
696 ==================================== ====== ==========================
698 Kernel response contents:
700 ==================================== ====== ==========================
701 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header
702 ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features
703 ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features
704 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features
705 ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE
706 ==================================== ====== ==========================
708 Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
709 interference but attribute names are different (they are based on
710 corresponding members of struct net_device). Legacy "flags" are not provided,
711 if userspace needs them (most likely only ethtool for backward compatibility),
712 it can calculate their values from related feature bits itself.
713 ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
714 provide all names when using verbose bitmap format), the other three use no
715 mask (simple bit lists).
718 FEATURES_SET
719 ============
721 Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
723 Request contents:
725 ==================================== ====== ==========================
726 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
727 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features
728 ==================================== ====== ==========================
730 Kernel response contents:
732 ==================================== ====== ==========================
733 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header
734 ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result
735 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active
736 ==================================== ====== ==========================
738 Request constains only one bitset which can be either value/mask pair (request
739 to change specific feature bits and leave the rest) or only a value (request
740 to set all features to specified set).
742 As request is subject to netdev_change_features() sanity checks, optional
743 kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
744 header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
745 reports the difference between client request and actual result: mask consists
746 of bits which differ between requested features and result (dev->features
747 after the operation), value consists of values of these bits in the request
748 (i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
749 reports the difference between old and new dev->features: mask consists of
750 bits which have changed, values are their values in new dev->features (after
751 the operation).
753 ``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
754 are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
755 request but also each time features are modified with netdev_update_features()
756 or netdev_change_features().
759 PRIVFLAGS_GET
760 =============
762 Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
764 Request contents:
766 ==================================== ====== ==========================
767 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
768 ==================================== ====== ==========================
770 Kernel response contents:
772 ==================================== ====== ==========================
773 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header
774 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
775 ==================================== ====== ==========================
777 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
778 These flags are defined by driver, their number and names (and also meaning)
779 are device dependent. For compact bitset format, names can be retrieved as
780 ``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
781 response uses all private flags supported by the device as mask so that client
782 gets the full information without having to fetch the string set with names.
785 PRIVFLAGS_SET
786 =============
788 Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
789 ioctl request.
791 Request contents:
793 ==================================== ====== ==========================
794 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
795 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
796 ==================================== ====== ==========================
798 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
799 modify only values of some of them.
802 RINGS_GET
803 =========
805 Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
807 Request contents:
809 ==================================== ====== ==========================
810 ``ETHTOOL_A_RINGS_HEADER`` nested request header
811 ==================================== ====== ==========================
813 Kernel response contents:
815 ==================================== ====== ==========================
816 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
817 ``ETHTOOL_A_RINGS_RX_MAX`` u32 max size of RX ring
818 ``ETHTOOL_A_RINGS_RX_MINI_MAX`` u32 max size of RX mini ring
819 ``ETHTOOL_A_RINGS_RX_JUMBO_MAX`` u32 max size of RX jumbo ring
820 ``ETHTOOL_A_RINGS_TX_MAX`` u32 max size of TX ring
821 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
822 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
823 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
824 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
825 ==================================== ====== ==========================
828 RINGS_SET
829 =========
831 Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
833 Request contents:
835 ==================================== ====== ==========================
836 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
837 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
838 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
839 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
840 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
841 ==================================== ====== ==========================
843 Kernel checks that requested ring sizes do not exceed limits reported by
844 driver. Driver may impose additional constraints and may not suspport all
845 attributes.
848 CHANNELS_GET
849 ============
851 Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
853 Request contents:
855 ==================================== ====== ==========================
856 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
857 ==================================== ====== ==========================
859 Kernel response contents:
861 ===================================== ====== ==========================
862 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header
863 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels
864 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels
865 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels
866 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels
867 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
868 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
869 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
870 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
871 ===================================== ====== ==========================
874 CHANNELS_SET
875 ============
877 Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
879 Request contents:
881 ===================================== ====== ==========================
882 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
883 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
884 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
885 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
886 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
887 ===================================== ====== ==========================
889 Kernel checks that requested channel counts do not exceed limits reported by
890 driver. Driver may impose additional constraints and may not suspport all
891 attributes.
894 COALESCE_GET
895 ============
897 Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
899 Request contents:
901 ==================================== ====== ==========================
902 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
903 ==================================== ====== ==========================
905 Kernel response contents:
907 =========================================== ====== =======================
908 ``ETHTOOL_A_COALESCE_HEADER`` nested reply header
909 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
910 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
911 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
912 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
913 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
914 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
915 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
916 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
917 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
918 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
919 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
920 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
921 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
922 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
923 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
924 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
925 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
926 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
927 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
928 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
929 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
930 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
931 =========================================== ====== =======================
933 Attributes are only included in reply if their value is not zero or the
934 corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
935 they are declared as supported by driver).
938 COALESCE_SET
939 ============
941 Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
943 Request contents:
945 =========================================== ====== =======================
946 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
947 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
948 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
949 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
950 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
951 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
952 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
953 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
954 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
955 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
956 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
957 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
958 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
959 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
960 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
961 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
962 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
963 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
964 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
965 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
966 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
967 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
968 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
969 =========================================== ====== =======================
971 Request is rejected if it attributes declared as unsupported by driver (i.e.
972 such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
973 is not set), regardless of their values. Driver may impose additional
974 constraints on coalescing parameters and their values.
977 PAUSE_GET
978 ============
980 Gets channel counts like ``ETHTOOL_GPAUSE`` ioctl request.
982 Request contents:
984 ===================================== ====== ==========================
985 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
986 ===================================== ====== ==========================
988 Kernel response contents:
990 ===================================== ====== ==========================
991 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
992 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
993 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
994 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
995 ``ETHTOOL_A_PAUSE_STATS`` nested pause statistics
996 ===================================== ====== ==========================
998 ``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set
999 in ``ETHTOOL_A_HEADER_FLAGS``.
1000 It will be empty if driver did not report any statistics. Drivers fill in
1001 the statistics in the following structure:
1003 .. kernel-doc:: include/linux/ethtool.h
1004 :identifiers: ethtool_pause_stats
1006 Each member has a corresponding attribute defined.
1008 PAUSE_SET
1009 ============
1011 Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1013 Request contents:
1015 ===================================== ====== ==========================
1016 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1017 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1018 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1019 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
1020 ===================================== ====== ==========================
1023 EEE_GET
1024 =======
1026 Gets channel counts like ``ETHTOOL_GEEE`` ioctl request.
1028 Request contents:
1030 ===================================== ====== ==========================
1031 ``ETHTOOL_A_EEE_HEADER`` nested request header
1032 ===================================== ====== ==========================
1034 Kernel response contents:
1036 ===================================== ====== ==========================
1037 ``ETHTOOL_A_EEE_HEADER`` nested request header
1038 ``ETHTOOL_A_EEE_MODES_OURS`` bool supported/advertised modes
1039 ``ETHTOOL_A_EEE_MODES_PEER`` bool peer advertised link modes
1040 ``ETHTOOL_A_EEE_ACTIVE`` bool EEE is actively used
1041 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1042 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1043 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1044 ===================================== ====== ==========================
1046 In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
1047 enabled, value of link modes for which EEE is advertised. Link modes for which
1048 peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
1049 netlink interface allows reporting EEE status for all link modes but only
1050 first 32 are provided by the ``ethtool_ops`` callback.
1053 EEE_SET
1054 =======
1056 Sets pause parameters like ``ETHTOOL_GEEEPARAM`` ioctl request.
1058 Request contents:
1060 ===================================== ====== ==========================
1061 ``ETHTOOL_A_EEE_HEADER`` nested request header
1062 ``ETHTOOL_A_EEE_MODES_OURS`` bool advertised modes
1063 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1064 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1065 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1066 ===================================== ====== ==========================
1068 ``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
1069 EEE for (if there is no mask) or specify changes to the list (if there is
1070 a mask). The netlink interface allows reporting EEE status for all link modes
1071 but only first 32 can be set at the moment as that is what the ``ethtool_ops``
1072 callback supports.
1075 TSINFO_GET
1076 ==========
1078 Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
1080 Request contents:
1082 ===================================== ====== ==========================
1083 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1084 ===================================== ====== ==========================
1086 Kernel response contents:
1088 ===================================== ====== ==========================
1089 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1090 ``ETHTOOL_A_TSINFO_TIMESTAMPING`` bitset SO_TIMESTAMPING flags
1091 ``ETHTOOL_A_TSINFO_TX_TYPES`` bitset supported Tx types
1092 ``ETHTOOL_A_TSINFO_RX_FILTERS`` bitset supported Rx filters
1093 ``ETHTOOL_A_TSINFO_PHC_INDEX`` u32 PTP hw clock index
1094 ===================================== ====== ==========================
1096 ``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
1097 is no special value for this case). The bitset attributes are omitted if they
1098 would be empty (no bit set).
1100 CABLE_TEST
1101 ==========
1103 Start a cable test.
1105 Request contents:
1107 ==================================== ====== ==========================
1108 ``ETHTOOL_A_CABLE_TEST_HEADER`` nested request header
1109 ==================================== ====== ==========================
1111 Notification contents:
1113 An Ethernet cable typically contains 1, 2 or 4 pairs. The length of
1114 the pair can only be measured when there is a fault in the pair and
1115 hence a reflection. Information about the fault may not be available,
1116 depending on the specific hardware. Hence the contents of the notify
1117 message are mostly optional. The attributes can be repeated an
1118 arbitrary number of times, in an arbitrary order, for an arbitrary
1119 number of pairs.
1121 The example shows the notification sent when the test is completed for
1122 a T2 cable, i.e. two pairs. One pair is OK and hence has no length
1123 information. The second pair has a fault and does have length
1124 information.
1126 +---------------------------------------------+--------+---------------------+
1127 | ``ETHTOOL_A_CABLE_TEST_HEADER`` | nested | reply header |
1128 +---------------------------------------------+--------+---------------------+
1129 | ``ETHTOOL_A_CABLE_TEST_STATUS`` | u8 | completed |
1130 +---------------------------------------------+--------+---------------------+
1131 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST`` | nested | all the results |
1132 +-+-------------------------------------------+--------+---------------------+
1133 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test result |
1134 +-+-+-----------------------------------------+--------+---------------------+
1135 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1136 +-+-+-----------------------------------------+--------+---------------------+
1137 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1138 +-+-+-----------------------------------------+--------+---------------------+
1139 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test results |
1140 +-+-+-----------------------------------------+--------+---------------------+
1141 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1142 +-+-+-----------------------------------------+--------+---------------------+
1143 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1144 +-+-+-----------------------------------------+--------+---------------------+
1145 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH`` | nested | cable length |
1146 +-+-+-----------------------------------------+--------+---------------------+
1147 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR`` | u8 | pair number |
1148 +-+-+-----------------------------------------+--------+---------------------+
1149 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM`` | u32 | length in cm |
1150 +-+-+-----------------------------------------+--------+---------------------+
1152 CABLE_TEST TDR
1153 ==============
1155 Start a cable test and report raw TDR data
1157 Request contents:
1159 +--------------------------------------------+--------+-----------------------+
1160 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1161 +--------------------------------------------+--------+-----------------------+
1162 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG`` | nested | test configuration |
1163 +-+------------------------------------------+--------+-----------------------+
1164 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | first data distance |
1165 +-+-+----------------------------------------+--------+-----------------------+
1166 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | last data distance |
1167 +-+-+----------------------------------------+--------+-----------------------+
1168 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step |
1169 +-+-+----------------------------------------+--------+-----------------------+
1170 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR`` | u8 | pair to test |
1171 +-+-+----------------------------------------+--------+-----------------------+
1173 The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members
1174 of the nest. All distances are expressed in centimeters. The PHY takes
1175 the distances as a guide, and rounds to the nearest distance it
1176 actually supports. If a pair is passed, only that one pair will be
1177 tested. Otherwise all pairs are tested.
1179 Notification contents:
1181 Raw TDR data is gathered by sending a pulse down the cable and
1182 recording the amplitude of the reflected pulse for a given distance.
1184 It can take a number of seconds to collect TDR data, especial if the
1185 full 100 meters is probed at 1 meter intervals. When the test is
1186 started a notification will be sent containing just
1187 ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1188 ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED.
1190 When the test has completed a second notification will be sent
1191 containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1192 ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data.
1194 The message may optionally contain the amplitude of the pulse send
1195 down the cable. This is measured in mV. A reflection should not be
1196 bigger than transmitted pulse.
1198 Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP
1199 nest containing information about the distance along the cable for the
1200 first reading, the last reading, and the step between each
1201 reading. Distances are measured in centimeters. These should be the
1202 exact values the PHY used. These may be different to what the user
1203 requested, if the native measurement resolution is greater than 1 cm.
1205 For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is
1206 used to report the amplitude of the reflection for a given pair.
1208 +---------------------------------------------+--------+----------------------+
1209 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1210 +---------------------------------------------+--------+----------------------+
1211 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS`` | u8 | completed |
1212 +---------------------------------------------+--------+----------------------+
1213 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST`` | nested | all the results |
1214 +-+-------------------------------------------+--------+----------------------+
1215 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE`` | nested | TX Pulse amplitude |
1216 +-+-+-----------------------------------------+--------+----------------------+
1217 | | | ``ETHTOOL_A_CABLE_PULSE_mV`` | s16 | Pulse amplitude |
1218 +-+-+-----------------------------------------+--------+----------------------+
1219 | | ``ETHTOOL_A_CABLE_NEST_STEP`` | nested | TDR step info |
1220 +-+-+-----------------------------------------+--------+----------------------+
1221 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | First data distance |
1222 +-+-+-----------------------------------------+--------+----------------------+
1223 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | Last data distance |
1224 +-+-+-----------------------------------------+--------+----------------------+
1225 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step|
1226 +-+-+-----------------------------------------+--------+----------------------+
1227 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1228 +-+-+-----------------------------------------+--------+----------------------+
1229 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1230 +-+-+-----------------------------------------+--------+----------------------+
1231 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1232 +-+-+-----------------------------------------+--------+----------------------+
1233 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1234 +-+-+-----------------------------------------+--------+----------------------+
1235 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1236 +-+-+-----------------------------------------+--------+----------------------+
1237 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1238 +-+-+-----------------------------------------+--------+----------------------+
1239 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1240 +-+-+-----------------------------------------+--------+----------------------+
1241 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1242 +-+-+-----------------------------------------+--------+----------------------+
1243 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1244 +-+-+-----------------------------------------+--------+----------------------+
1246 TUNNEL_INFO
1247 ===========
1249 Gets information about the tunnel state NIC is aware of.
1251 Request contents:
1253 ===================================== ====== ==========================
1254 ``ETHTOOL_A_TUNNEL_INFO_HEADER`` nested request header
1255 ===================================== ====== ==========================
1257 Kernel response contents:
1259 +---------------------------------------------+--------+---------------------+
1260 | ``ETHTOOL_A_TUNNEL_INFO_HEADER`` | nested | reply header |
1261 +---------------------------------------------+--------+---------------------+
1262 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS`` | nested | all UDP port tables |
1263 +-+-------------------------------------------+--------+---------------------+
1264 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE`` | nested | one UDP port table |
1265 +-+-+-----------------------------------------+--------+---------------------+
1266 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE`` | u32 | max size of the |
1267 | | | | | table |
1268 +-+-+-----------------------------------------+--------+---------------------+
1269 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` | bitset | tunnel types which |
1270 | | | | | table can hold |
1271 +-+-+-----------------------------------------+--------+---------------------+
1272 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY`` | nested | offloaded UDP port |
1273 +-+-+-+---------------------------------------+--------+---------------------+
1274 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT`` | be16 | UDP port |
1275 +-+-+-+---------------------------------------+--------+---------------------+
1276 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE`` | u32 | tunnel type |
1277 +-+-+-+---------------------------------------+--------+---------------------+
1279 For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that
1280 the table contains static entries, hard-coded by the NIC.
1282 Request translation
1283 ===================
1285 The following table maps ioctl commands to netlink commands providing their
1286 functionality. Entries with "n/a" in right column are commands which do not
1287 have their netlink replacement yet. Entries which "n/a" in the left column
1288 are netlink only.
1290 =================================== =====================================
1291 ioctl command netlink command
1292 =================================== =====================================
1293 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET``
1294 ``ETHTOOL_MSG_LINKMODES_GET``
1295 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET``
1296 ``ETHTOOL_MSG_LINKMODES_SET``
1297 ``ETHTOOL_GDRVINFO`` n/a
1298 ``ETHTOOL_GREGS`` n/a
1299 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET``
1300 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET``
1301 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET``
1302 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET``
1303 ``ETHTOOL_NWAY_RST`` n/a
1304 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET``
1305 ``ETHTOOL_GEEPROM`` n/a
1306 ``ETHTOOL_SEEPROM`` n/a
1307 ``ETHTOOL_GCOALESCE`` ``ETHTOOL_MSG_COALESCE_GET``
1308 ``ETHTOOL_SCOALESCE`` ``ETHTOOL_MSG_COALESCE_SET``
1309 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET``
1310 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET``
1311 ``ETHTOOL_GPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_GET``
1312 ``ETHTOOL_SPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_SET``
1313 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
1314 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
1315 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
1316 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
1317 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET``
1318 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET``
1319 ``ETHTOOL_TEST`` n/a
1320 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET``
1321 ``ETHTOOL_PHYS_ID`` n/a
1322 ``ETHTOOL_GSTATS`` n/a
1323 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET``
1324 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET``
1325 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK``
1326 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET``
1327 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET``
1328 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET``
1329 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET``
1330 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET``
1331 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET``
1332 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET``
1333 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET``
1334 ``ETHTOOL_GRXFH`` n/a
1335 ``ETHTOOL_SRXFH`` n/a
1336 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET``
1337 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET``
1338 ``ETHTOOL_GRXRINGS`` n/a
1339 ``ETHTOOL_GRXCLSRLCNT`` n/a
1340 ``ETHTOOL_GRXCLSRULE`` n/a
1341 ``ETHTOOL_GRXCLSRLALL`` n/a
1342 ``ETHTOOL_SRXCLSRLDEL`` n/a
1343 ``ETHTOOL_SRXCLSRLINS`` n/a
1344 ``ETHTOOL_FLASHDEV`` n/a
1345 ``ETHTOOL_RESET`` n/a
1346 ``ETHTOOL_SRXNTUPLE`` n/a
1347 ``ETHTOOL_GRXNTUPLE`` n/a
1348 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET``
1349 ``ETHTOOL_GRXFHINDIR`` n/a
1350 ``ETHTOOL_SRXFHINDIR`` n/a
1351 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET``
1352 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET``
1353 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET``
1354 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET``
1355 ``ETHTOOL_SET_DUMP`` n/a
1356 ``ETHTOOL_GET_DUMP_FLAG`` n/a
1357 ``ETHTOOL_GET_DUMP_DATA`` n/a
1358 ``ETHTOOL_GET_TS_INFO`` ``ETHTOOL_MSG_TSINFO_GET``
1359 ``ETHTOOL_GMODULEINFO`` n/a
1360 ``ETHTOOL_GMODULEEEPROM`` n/a
1361 ``ETHTOOL_GEEE`` ``ETHTOOL_MSG_EEE_GET``
1362 ``ETHTOOL_SEEE`` ``ETHTOOL_MSG_EEE_SET``
1363 ``ETHTOOL_GRSSH`` n/a
1364 ``ETHTOOL_SRSSH`` n/a
1365 ``ETHTOOL_GTUNABLE`` n/a
1366 ``ETHTOOL_STUNABLE`` n/a
1367 ``ETHTOOL_GPHYSTATS`` n/a
1368 ``ETHTOOL_PERQUEUE`` n/a
1369 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET``
1370 ``ETHTOOL_MSG_LINKMODES_GET``
1371 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET``
1372 ``ETHTOOL_MSG_LINKMODES_SET``
1373 ``ETHTOOL_PHY_GTUNABLE`` n/a
1374 ``ETHTOOL_PHY_STUNABLE`` n/a
1375 ``ETHTOOL_GFECPARAM`` n/a
1376 ``ETHTOOL_SFECPARAM`` n/a
1377 n/a ''ETHTOOL_MSG_CABLE_TEST_ACT''
1378 n/a ''ETHTOOL_MSG_CABLE_TEST_TDR_ACT''
1379 n/a ``ETHTOOL_MSG_TUNNEL_INFO_GET``
1380 =================================== =====================================