1 =============================
2 Netlink interface for ethtool
3 =============================
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.
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.
44 Attributes that need to be filled-in by device drivers and that are dumped to
45 user space based on whether they are valid or not should not use zero as a
46 valid value. This avoids the need to explicitly signal the validity of the
47 attribute in the device driver API.
53 Each request or reply message contains a nested attribute with common header.
54 Structure of this header is
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 ============================== ====== =============================
62 ``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
63 device message relates to. One of them is sufficient in requests, if both are
64 used, they must identify the same device. Some requests, e.g. global string
65 sets, do not require device identification. Most ``GET`` requests also allow
66 dump requests without device identification to query the same information for
67 all devices providing it (each device in a separate message).
69 ``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request
70 types. The interpretation of these flags is the same for all request types but
71 the flags may not apply to requests. Recognized flags are:
73 ================================= ===================================
74 ``ETHTOOL_FLAG_COMPACT_BITSETS`` use compact format bitsets in reply
75 ``ETHTOOL_FLAG_OMIT_REPLY`` omit optional reply (_SET and _ACT)
76 ``ETHTOOL_FLAG_STATS`` include optional device statistics
77 ================================= ===================================
79 New request flags should follow the general idea that if the flag is not set,
80 the behaviour is backward compatible, i.e. requests from old clients not aware
81 of the flag should be interpreted the way the client expects. A client must
82 not set flags it does not understand.
88 For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
89 type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
90 attribute with contents of one of two forms: compact (two binary bitmaps
91 representing bit values and mask of affected bits) and bit-by-bit (list of
92 bits identified by either index or name).
94 Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
95 with their values which saves a round trip (when the bitset is passed in a
96 request) or at least a second request (when the bitset is in a reply). This is
97 useful for one shot applications like traditional ethtool command. On the
98 other hand, long running applications like ethtool monitor (displaying
99 notifications) or network management daemons may prefer fetching the names
100 only once and using compact form to save message size. Notifications from
101 ethtool netlink interface always use compact form for bitsets.
103 A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
104 not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
105 modifying a bitmap, the former changes the bit set in mask to values set in
106 value and preserves the rest; the latter sets the bits set in the bitmap and
109 Compact form: nested (bitset) attribute contents:
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 ============================ ====== ============================
118 Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
119 rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
120 order, words ordered from least significant to most significant (i.e. the same
121 way as bitmaps are passed with ioctl interface).
123 For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
124 mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
125 ``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
126 if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
127 allowed (bitset represents a single bitmap.
129 Kernel bit set length may differ from userspace length if older application is
130 used on newer kernel or vice versa. If userspace bitmap is longer, an error is
131 issued only if the request actually tries to set values of some bits not
132 recognized by kernel.
134 Bit-by-bit form: nested (bitset) attribute contents:
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 +-+-+--------------------------------+--------+-----------------------------+
152 Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
153 only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
154 arbitrary number of them. A bit may be identified by its index or by its
155 name. 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
157 index exceeds kernel bit length or if name is not recognized.
159 When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
160 a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
161 such case. Such bitset represents a bitmap with listed bits set and the rest
164 In requests, application can use either form. Form used by kernel in reply is
165 determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
166 header. Semantics of value and mask depends on the attribute.
169 List of message types
170 =====================
172 All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
173 according to message purpose:
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 ============== ======================================
187 ===================================== =================================
188 ``ETHTOOL_MSG_STRSET_GET`` get string set
189 ``ETHTOOL_MSG_LINKINFO_GET`` get link settings
190 ``ETHTOOL_MSG_LINKINFO_SET`` set link settings
191 ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info
192 ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info
193 ``ETHTOOL_MSG_LINKSTATE_GET`` get link state
194 ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings
195 ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings
196 ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings
197 ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings
198 ``ETHTOOL_MSG_FEATURES_GET`` get device features
199 ``ETHTOOL_MSG_FEATURES_SET`` set device features
200 ``ETHTOOL_MSG_PRIVFLAGS_GET`` get private flags
201 ``ETHTOOL_MSG_PRIVFLAGS_SET`` set private flags
202 ``ETHTOOL_MSG_RINGS_GET`` get ring sizes
203 ``ETHTOOL_MSG_RINGS_SET`` set ring sizes
204 ``ETHTOOL_MSG_CHANNELS_GET`` get channel counts
205 ``ETHTOOL_MSG_CHANNELS_SET`` set channel counts
206 ``ETHTOOL_MSG_COALESCE_GET`` get coalescing parameters
207 ``ETHTOOL_MSG_COALESCE_SET`` set coalescing parameters
208 ``ETHTOOL_MSG_PAUSE_GET`` get pause parameters
209 ``ETHTOOL_MSG_PAUSE_SET`` set pause parameters
210 ``ETHTOOL_MSG_EEE_GET`` get EEE settings
211 ``ETHTOOL_MSG_EEE_SET`` set EEE settings
212 ``ETHTOOL_MSG_TSINFO_GET`` get timestamping info
213 ``ETHTOOL_MSG_CABLE_TEST_ACT`` action start cable test
214 ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT`` action start raw TDR cable test
215 ``ETHTOOL_MSG_TUNNEL_INFO_GET`` get tunnel offload info
216 ``ETHTOOL_MSG_FEC_GET`` get FEC settings
217 ``ETHTOOL_MSG_FEC_SET`` set FEC settings
218 ``ETHTOOL_MSG_MODULE_EEPROM_GET`` read SFP module EEPROM
219 ``ETHTOOL_MSG_STATS_GET`` get standard statistics
220 ``ETHTOOL_MSG_PHC_VCLOCKS_GET`` get PHC virtual clocks info
221 ``ETHTOOL_MSG_MODULE_SET`` set transceiver module parameters
222 ``ETHTOOL_MSG_MODULE_GET`` get transceiver module parameters
223 ``ETHTOOL_MSG_PSE_SET`` set PSE parameters
224 ``ETHTOOL_MSG_PSE_GET`` get PSE parameters
225 ``ETHTOOL_MSG_RSS_GET`` get RSS settings
226 ``ETHTOOL_MSG_MM_GET`` get MAC merge layer state
227 ``ETHTOOL_MSG_MM_SET`` set MAC merge layer parameters
228 ===================================== =================================
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
266 ``ETHTOOL_MSG_PHC_VCLOCKS_GET_REPLY`` PHC virtual clocks info
267 ``ETHTOOL_MSG_MODULE_GET_REPLY`` transceiver module parameters
268 ``ETHTOOL_MSG_PSE_GET_REPLY`` PSE parameters
269 ``ETHTOOL_MSG_RSS_GET_REPLY`` RSS settings
270 ``ETHTOOL_MSG_MM_GET_REPLY`` MAC merge layer status
271 ======================================== =================================
273 ``GET`` requests are sent by userspace applications to retrieve device
274 information. They usually do not contain any message specific attributes.
275 Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
276 request with ``NLM_F_DUMP`` and no device identification can be used to query
277 the information for all devices supporting the request.
279 If the data can be also modified, corresponding ``SET`` message with the same
280 layout as corresponding ``GET_REPLY`` is used to request changes. Only
281 attributes where a change is requested are included in such request (also, not
282 all attributes may be changed). Replies to most ``SET`` request consist only
283 of error code and extack; if kernel provides additional data, it is sent in
284 the form of corresponding ``SET_REPLY`` message which can be suppressed by
285 setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
287 Data modification also triggers sending a ``NTF`` message with a notification.
288 These usually bear only a subset of attributes which was affected by the
289 change. The same notification is issued if the data is modified using other
290 means (mostly ioctl ethtool interface). Unlike notifications from ethtool
291 netlink code which are only sent if something actually changed, notifications
292 triggered by ioctl interface may be sent even if the request did not actually
295 ``ACT`` messages request kernel (driver) to perform a specific action. If some
296 information is reported by kernel (which can be suppressed by setting
297 ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
298 an ``ACT_REPLY`` message. Performing an action also triggers a notification
301 Later sections describe the format and semantics of these messages.
307 Requests contents of a string set as provided by ioctl commands
308 ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
309 writeable so that the corresponding ``STRSET_SET`` message is only used in
310 kernel replies. There are two types of string sets: global (independent of
311 a device, e.g. device feature names) and device specific (e.g. device private
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 +-+-+-----------------------------------+--------+------------------------+
326 Kernel response contents:
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 +---------------------------------------+--------+-----------------------+
350 Device identification in request header is optional. Depending on its presence
351 a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
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
357 If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
358 requested type are returned, otherwise only those specified in the request.
359 Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
360 counts of the sets, not the actual strings.
366 Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
367 link modes and autonegotiation related information. The request does not use
372 ==================================== ====== ==========================
373 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header
374 ==================================== ====== ==========================
376 Kernel response contents:
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 ==================================== ====== ==========================
387 Attributes and their values have the same meaning as matching members of the
388 corresponding ioctl structures.
390 ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
391 devices supporting the request).
397 ``LINKINFO_SET`` request allows setting some of the attributes reported by
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 ==================================== ====== ==========================
409 MDI(-X) status and transceiver cannot be set, request with the corresponding
410 attributes is rejected.
416 Requests link modes (supported, advertised and peer advertised) and related
417 information (autonegotiation status, link speed and duplex) as provided by
418 ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
422 ==================================== ====== ==========================
423 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header
424 ==================================== ====== ==========================
426 Kernel response contents:
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
437 ``ETHTOOL_A_LINKMODES_RATE_MATCHING`` u8 PHY rate matching
438 ========================================== ====== ==========================
440 For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
441 represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
444 ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
445 devices supporting the request).
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
461 ``ETHTOOL_A_LINKMODES_RATE_MATCHING`` u8 PHY rate matching
462 ``ETHTOOL_A_LINKMODES_LANES`` u32 lanes
463 ========================================== ====== ==========================
465 ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
466 autonegotiation is on (either set now or kept from before), advertised modes
467 are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
468 of speed, duplex and lanes is specified, kernel adjusts advertised modes to all
469 supported modes matching speed, duplex, lanes or all (whatever is specified).
470 This autoselection is done on ethtool side with ioctl interface, netlink
471 interface is supposed to allow requesting changes without knowing what exactly
478 Requests link state information. Link up/down flag (as provided by
479 ``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
480 be provided as well. In general, extended state describes reasons for why a port
481 is down, or why it operates in some non-obvious mode. This request does not have
486 ==================================== ====== ==========================
487 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header
488 ==================================== ====== ==========================
490 Kernel response contents:
492 ==================================== ====== ============================
493 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header
494 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down)
495 ``ETHTOOL_A_LINKSTATE_SQI`` u32 Current Signal Quality Index
496 ``ETHTOOL_A_LINKSTATE_SQI_MAX`` u32 Max support SQI value
497 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` u8 link extended state
498 ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` u8 link extended substate
499 ``ETHTOOL_A_LINKSTATE_EXT_DOWN_CNT`` u32 count of link down events
500 ==================================== ====== ============================
502 For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
503 carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
504 define their own handler.
506 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
507 optional values. ethtool core can provide either both
508 ``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
509 or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
511 ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
512 devices supporting the request).
515 Link extended states:
517 ================================================ ============================================
518 ``ETHTOOL_LINK_EXT_STATE_AUTONEG`` States relating to the autonegotiation or
521 ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE`` Failure during link training
523 ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH`` Logical mismatch in physical coding sublayer
524 or forward error correction sublayer
526 ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY`` Signal integrity issues
528 ``ETHTOOL_LINK_EXT_STATE_NO_CABLE`` No cable connected
530 ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE`` Failure is related to cable,
531 e.g., unsupported cable
533 ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE`` Failure is related to EEPROM, e.g., failure
534 during reading or parsing the data
536 ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE`` Failure during calibration algorithm
538 ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED`` The hardware is not able to provide the
539 power required from cable or module
541 ``ETHTOOL_LINK_EXT_STATE_OVERHEAT`` The module is overheated
543 ``ETHTOOL_LINK_EXT_STATE_MODULE`` Transceiver module issue
544 ================================================ ============================================
546 Link extended substates:
550 =============================================================== ================================
551 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED`` Peer side is down
553 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED`` Ack not received from peer side
555 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED`` Next page exchange failed
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
561 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE`` Forward error correction modes
562 in both sides are mismatched
564 ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD`` No Highest Common Denominator
565 =============================================================== ================================
567 Link training substates:
569 =========================================================================== ====================
570 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED`` Frames were not
574 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT`` The lock did not
578 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY`` Peer side did not
583 ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT`` Remote side is not
585 =========================================================================== ====================
587 Link logical mismatch substates:
589 ================================================================ ===============================
590 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK`` Physical coding sublayer was
591 not locked in first phase -
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
598 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS`` Physical coding sublayer did
601 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED`` FC forward error correction is
604 ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED`` RS forward error correction is
606 ================================================================ ===============================
608 Bad signal integrity substates:
610 ================================================================= =============================
611 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS`` Large number of physical
614 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE`` The system attempted to
615 operate the cable at a rate
617 supported, which led to
618 signal integrity issues
620 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST`` The external clock signal for
621 SerDes is too weak or
624 ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS`` The received signal for
625 SerDes is too weak because
626 analog loss of signal.
627 ================================================================= =============================
629 Cable issue substates:
631 =================================================== ============================================
632 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE`` Unsupported cable
634 ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE`` Cable test failure
635 =================================================== ============================================
637 Transceiver module issue substates:
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 =================================================== ============================================
648 Requests debugging settings of a device. At the moment, only message mask is
653 ==================================== ====== ==========================
654 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
655 ==================================== ====== ==========================
657 Kernel response contents:
659 ==================================== ====== ==========================
660 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header
661 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
662 ==================================== ====== ==========================
664 The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
665 provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
666 interface. While it is called message level there for historical reasons, most
667 drivers and almost all newer drivers use it as a mask of enabled message
668 classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
669 interface follows its actual use in practice.
671 ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
672 devices supporting the request).
678 Set or update debugging settings of a device. At the moment, only message mask
683 ==================================== ====== ==========================
684 ``ETHTOOL_A_DEBUG_HEADER`` nested request header
685 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask
686 ==================================== ====== ==========================
688 ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
689 enabled debugging message types for the device.
695 Query 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.
701 ==================================== ====== ==========================
702 ``ETHTOOL_A_WOL_HEADER`` nested request header
703 ==================================== ====== ==========================
705 Kernel response contents:
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 ==================================== ====== ==========================
713 In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
714 device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
715 included in reply if ``WAKE_MAGICSECURE`` mode is supported.
721 Set or update wake-on-lan settings.
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 ==================================== ====== ==========================
731 ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
732 ``WAKE_MAGICSECURE`` mode.
738 Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
742 ==================================== ====== ==========================
743 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
744 ==================================== ====== ==========================
746 Kernel response contents:
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 ==================================== ====== ==========================
756 Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
757 interference but attribute names are different (they are based on
758 corresponding members of struct net_device). Legacy "flags" are not provided,
759 if userspace needs them (most likely only ethtool for backward compatibility),
760 it can calculate their values from related feature bits itself.
761 ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
762 provide all names when using verbose bitmap format), the other three use no
763 mask (simple bit lists).
769 Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
773 ==================================== ====== ==========================
774 ``ETHTOOL_A_FEATURES_HEADER`` nested request header
775 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features
776 ==================================== ====== ==========================
778 Kernel response contents:
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 ==================================== ====== ==========================
786 Request contains only one bitset which can be either value/mask pair (request
787 to change specific feature bits and leave the rest) or only a value (request
788 to set all features to specified set).
790 As request is subject to netdev_change_features() sanity checks, optional
791 kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
792 header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
793 reports the difference between client request and actual result: mask consists
794 of bits which differ between requested features and result (dev->features
795 after the operation), value consists of values of these bits in the request
796 (i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
797 reports the difference between old and new dev->features: mask consists of
798 bits which have changed, values are their values in new dev->features (after
801 ``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
802 are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
803 request but also each time features are modified with netdev_update_features()
804 or netdev_change_features().
810 Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
814 ==================================== ====== ==========================
815 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
816 ==================================== ====== ==========================
818 Kernel response contents:
820 ==================================== ====== ==========================
821 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header
822 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
823 ==================================== ====== ==========================
825 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
826 These flags are defined by driver, their number and names (and also meaning)
827 are device dependent. For compact bitset format, names can be retrieved as
828 ``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
829 response uses all private flags supported by the device as mask so that client
830 gets the full information without having to fetch the string set with names.
836 Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
841 ==================================== ====== ==========================
842 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header
843 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags
844 ==================================== ====== ==========================
846 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
847 modify only values of some of them.
853 Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
857 ==================================== ====== ==========================
858 ``ETHTOOL_A_RINGS_HEADER`` nested request header
859 ==================================== ====== ==========================
861 Kernel response contents:
863 ======================================= ====== ===========================
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
873 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring
874 ``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` u8 TCP header / data split
875 ``ETHTOOL_A_RINGS_CQE_SIZE`` u32 Size of TX/RX CQE
876 ``ETHTOOL_A_RINGS_TX_PUSH`` u8 flag of TX Push mode
877 ``ETHTOOL_A_RINGS_RX_PUSH`` u8 flag of RX Push mode
878 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` u32 size of TX push buffer
879 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN_MAX`` u32 max size of TX push buffer
880 ======================================= ====== ===========================
882 ``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` indicates whether the device is usable with
883 page-flipping TCP zero-copy receive (``getsockopt(TCP_ZEROCOPY_RECEIVE)``).
884 If enabled the device is configured to place frame headers and data into
885 separate buffers. The device configuration must make it possible to receive
886 full memory pages of data, for example because MTU is high enough or through
889 ``ETHTOOL_A_RINGS_[RX|TX]_PUSH`` flag is used to enable descriptor fast
890 path to send or receive packets. In ordinary path, driver fills descriptors in DRAM and
891 notifies NIC hardware. In fast path, driver pushes descriptors to the device
892 through MMIO writes, thus reducing the latency. However, enabling this feature
893 may increase the CPU cost. Drivers may enforce additional per-packet
894 eligibility checks (e.g. on packet size).
896 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` specifies the maximum number of bytes of a
897 transmitted packet a driver can push directly to the underlying device
898 ('push' mode). Pushing some of the payload bytes to the device has the
899 advantages of reducing latency for small packets by avoiding DMA mapping (same
900 as ``ETHTOOL_A_RINGS_TX_PUSH`` parameter) as well as allowing the underlying
901 device to process packet headers ahead of fetching its payload.
902 This can help the device to make fast actions based on the packet's headers.
903 This is similar to the "tx-copybreak" parameter, which copies the packet to a
904 preallocated DMA memory area instead of mapping new memory. However,
905 tx-push-buff parameter copies the packet directly to the device to allow the
906 device to take faster actions on the packet.
911 Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
915 ==================================== ====== ===========================
916 ``ETHTOOL_A_RINGS_HEADER`` nested reply header
917 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring
918 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring
919 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring
920 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring
921 ``ETHTOOL_A_RINGS_RX_BUF_LEN`` u32 size of buffers on the ring
922 ``ETHTOOL_A_RINGS_CQE_SIZE`` u32 Size of TX/RX CQE
923 ``ETHTOOL_A_RINGS_TX_PUSH`` u8 flag of TX Push mode
924 ``ETHTOOL_A_RINGS_RX_PUSH`` u8 flag of RX Push mode
925 ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` u32 size of TX push buffer
926 ==================================== ====== ===========================
928 Kernel checks that requested ring sizes do not exceed limits reported by
929 driver. Driver may impose additional constraints and may not suspport all
933 ``ETHTOOL_A_RINGS_CQE_SIZE`` specifies the completion queue event size.
934 Completion queue events(CQE) are the events posted by NIC to indicate the
935 completion status of a packet when the packet is sent(like send success or
936 error) or received(like pointers to packet fragments). The CQE size parameter
937 enables to modify the CQE size other than default size if NIC supports it.
938 A bigger CQE can have more receive buffer pointers inturn NIC can transfer
939 a bigger frame from wire. Based on the NIC hardware, the overall completion
940 queue size can be adjusted in the driver if CQE size is modified.
945 Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
949 ==================================== ====== ==========================
950 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
951 ==================================== ====== ==========================
953 Kernel response contents:
955 ===================================== ====== ==========================
956 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header
957 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels
958 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels
959 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels
960 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels
961 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
962 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
963 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
964 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
965 ===================================== ====== ==========================
971 Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
975 ===================================== ====== ==========================
976 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header
977 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count
978 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count
979 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count
980 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count
981 ===================================== ====== ==========================
983 Kernel checks that requested channel counts do not exceed limits reported by
984 driver. Driver may impose additional constraints and may not suspport all
991 Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
995 ==================================== ====== ==========================
996 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
997 ==================================== ====== ==========================
999 Kernel response contents:
1001 =========================================== ====== =======================
1002 ``ETHTOOL_A_COALESCE_HEADER`` nested reply header
1003 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
1004 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
1005 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
1006 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
1007 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
1008 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
1009 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
1010 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
1011 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
1012 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
1013 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
1014 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
1015 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
1016 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
1017 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
1018 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
1019 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
1020 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
1021 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
1022 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
1023 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
1024 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
1025 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx
1026 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx
1027 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` u32 max aggr size, Tx
1028 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` u32 max aggr packets, Tx
1029 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` u32 time (us), aggr, Tx
1030 =========================================== ====== =======================
1032 Attributes are only included in reply if their value is not zero or the
1033 corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
1034 they are declared as supported by driver).
1036 Timer reset mode (``ETHTOOL_A_COALESCE_USE_CQE_TX`` and
1037 ``ETHTOOL_A_COALESCE_USE_CQE_RX``) controls the interaction between packet
1038 arrival and the various time based delay parameters. By default timers are
1039 expected to limit the max delay between any packet arrival/departure and a
1040 corresponding interrupt. In this mode timer should be started by packet
1041 arrival (sometimes delivery of previous interrupt) and reset when interrupt
1043 Setting the appropriate attribute to 1 will enable ``CQE`` mode, where
1044 each packet event resets the timer. In this mode timer is used to force
1045 the interrupt if queue goes idle, while busy queues depend on the packet
1046 limit to trigger interrupts.
1048 Tx aggregation consists of copying frames into a contiguous buffer so that they
1049 can be submitted as a single IO operation. ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES``
1050 describes the maximum size in bytes for the submitted buffer.
1051 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` describes the maximum number of frames
1052 that can be aggregated into a single buffer.
1053 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` describes the amount of time in usecs,
1054 counted since the first packet arrival in an aggregated block, after which the
1055 block should be sent.
1056 This feature is mainly of interest for specific USB devices which does not cope
1057 well with frequent small-sized URBs transmissions.
1062 Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
1066 =========================================== ====== =======================
1067 ``ETHTOOL_A_COALESCE_HEADER`` nested request header
1068 ``ETHTOOL_A_COALESCE_RX_USECS`` u32 delay (us), normal Rx
1069 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES`` u32 max packets, normal Rx
1070 ``ETHTOOL_A_COALESCE_RX_USECS_IRQ`` u32 delay (us), Rx in IRQ
1071 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ`` u32 max packets, Rx in IRQ
1072 ``ETHTOOL_A_COALESCE_TX_USECS`` u32 delay (us), normal Tx
1073 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES`` u32 max packets, normal Tx
1074 ``ETHTOOL_A_COALESCE_TX_USECS_IRQ`` u32 delay (us), Tx in IRQ
1075 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ`` u32 IRQ packets, Tx in IRQ
1076 ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS`` u32 delay of stats update
1077 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX`` bool adaptive Rx coalesce
1078 ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX`` bool adaptive Tx coalesce
1079 ``ETHTOOL_A_COALESCE_PKT_RATE_LOW`` u32 threshold for low rate
1080 ``ETHTOOL_A_COALESCE_RX_USECS_LOW`` u32 delay (us), low Rx
1081 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW`` u32 max packets, low Rx
1082 ``ETHTOOL_A_COALESCE_TX_USECS_LOW`` u32 delay (us), low Tx
1083 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW`` u32 max packets, low Tx
1084 ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH`` u32 threshold for high rate
1085 ``ETHTOOL_A_COALESCE_RX_USECS_HIGH`` u32 delay (us), high Rx
1086 ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH`` u32 max packets, high Rx
1087 ``ETHTOOL_A_COALESCE_TX_USECS_HIGH`` u32 delay (us), high Tx
1088 ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH`` u32 max packets, high Tx
1089 ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL`` u32 rate sampling interval
1090 ``ETHTOOL_A_COALESCE_USE_CQE_TX`` bool timer reset mode, Tx
1091 ``ETHTOOL_A_COALESCE_USE_CQE_RX`` bool timer reset mode, Rx
1092 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES`` u32 max aggr size, Tx
1093 ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` u32 max aggr packets, Tx
1094 ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` u32 time (us), aggr, Tx
1095 =========================================== ====== =======================
1097 Request is rejected if it attributes declared as unsupported by driver (i.e.
1098 such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
1099 is not set), regardless of their values. Driver may impose additional
1100 constraints on coalescing parameters and their values.
1102 Compared to requests issued via the ``ioctl()`` netlink version of this request
1103 will try harder to make sure that values specified by the user have been applied
1104 and may call the driver twice.
1110 Gets pause frame settings like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1114 ===================================== ====== ==========================
1115 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1116 ``ETHTOOL_A_PAUSE_STATS_SRC`` u32 source of statistics
1117 ===================================== ====== ==========================
1119 ``ETHTOOL_A_PAUSE_STATS_SRC`` is optional. It takes values from:
1121 .. kernel-doc:: include/uapi/linux/ethtool.h
1122 :identifiers: ethtool_mac_stats_src
1124 If absent from the request, stats will be provided with
1125 an ``ETHTOOL_A_PAUSE_STATS_SRC`` attribute in the response equal to
1126 ``ETHTOOL_MAC_STATS_SRC_AGGREGATE``.
1128 Kernel response contents:
1130 ===================================== ====== ==========================
1131 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1132 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1133 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1134 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
1135 ``ETHTOOL_A_PAUSE_STATS`` nested pause statistics
1136 ===================================== ====== ==========================
1138 ``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set
1139 in ``ETHTOOL_A_HEADER_FLAGS``.
1140 It will be empty if driver did not report any statistics. Drivers fill in
1141 the statistics in the following structure:
1143 .. kernel-doc:: include/linux/ethtool.h
1144 :identifiers: ethtool_pause_stats
1146 Each member has a corresponding attribute defined.
1151 Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1155 ===================================== ====== ==========================
1156 ``ETHTOOL_A_PAUSE_HEADER`` nested request header
1157 ``ETHTOOL_A_PAUSE_AUTONEG`` bool pause autonegotiation
1158 ``ETHTOOL_A_PAUSE_RX`` bool receive pause frames
1159 ``ETHTOOL_A_PAUSE_TX`` bool transmit pause frames
1160 ===================================== ====== ==========================
1166 Gets Energy Efficient Ethernet settings like ``ETHTOOL_GEEE`` ioctl request.
1170 ===================================== ====== ==========================
1171 ``ETHTOOL_A_EEE_HEADER`` nested request header
1172 ===================================== ====== ==========================
1174 Kernel response contents:
1176 ===================================== ====== ==========================
1177 ``ETHTOOL_A_EEE_HEADER`` nested request header
1178 ``ETHTOOL_A_EEE_MODES_OURS`` bool supported/advertised modes
1179 ``ETHTOOL_A_EEE_MODES_PEER`` bool peer advertised link modes
1180 ``ETHTOOL_A_EEE_ACTIVE`` bool EEE is actively used
1181 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1182 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1183 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1184 ===================================== ====== ==========================
1186 In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
1187 enabled, value of link modes for which EEE is advertised. Link modes for which
1188 peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
1189 netlink interface allows reporting EEE status for all link modes but only
1190 first 32 are provided by the ``ethtool_ops`` callback.
1196 Sets Energy Efficient Ethernet parameters like ``ETHTOOL_SEEE`` ioctl request.
1200 ===================================== ====== ==========================
1201 ``ETHTOOL_A_EEE_HEADER`` nested request header
1202 ``ETHTOOL_A_EEE_MODES_OURS`` bool advertised modes
1203 ``ETHTOOL_A_EEE_ENABLED`` bool EEE is enabled
1204 ``ETHTOOL_A_EEE_TX_LPI_ENABLED`` bool Tx lpi enabled
1205 ``ETHTOOL_A_EEE_TX_LPI_TIMER`` u32 Tx lpi timeout (in us)
1206 ===================================== ====== ==========================
1208 ``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
1209 EEE for (if there is no mask) or specify changes to the list (if there is
1210 a mask). The netlink interface allows reporting EEE status for all link modes
1211 but only first 32 can be set at the moment as that is what the ``ethtool_ops``
1218 Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
1222 ===================================== ====== ==========================
1223 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1224 ===================================== ====== ==========================
1226 Kernel response contents:
1228 ===================================== ====== ==========================
1229 ``ETHTOOL_A_TSINFO_HEADER`` nested request header
1230 ``ETHTOOL_A_TSINFO_TIMESTAMPING`` bitset SO_TIMESTAMPING flags
1231 ``ETHTOOL_A_TSINFO_TX_TYPES`` bitset supported Tx types
1232 ``ETHTOOL_A_TSINFO_RX_FILTERS`` bitset supported Rx filters
1233 ``ETHTOOL_A_TSINFO_PHC_INDEX`` u32 PTP hw clock index
1234 ===================================== ====== ==========================
1236 ``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
1237 is no special value for this case). The bitset attributes are omitted if they
1238 would be empty (no bit set).
1247 ==================================== ====== ==========================
1248 ``ETHTOOL_A_CABLE_TEST_HEADER`` nested request header
1249 ==================================== ====== ==========================
1251 Notification contents:
1253 An Ethernet cable typically contains 1, 2 or 4 pairs. The length of
1254 the pair can only be measured when there is a fault in the pair and
1255 hence a reflection. Information about the fault may not be available,
1256 depending on the specific hardware. Hence the contents of the notify
1257 message are mostly optional. The attributes can be repeated an
1258 arbitrary number of times, in an arbitrary order, for an arbitrary
1261 The example shows the notification sent when the test is completed for
1262 a T2 cable, i.e. two pairs. One pair is OK and hence has no length
1263 information. The second pair has a fault and does have length
1266 +---------------------------------------------+--------+---------------------+
1267 | ``ETHTOOL_A_CABLE_TEST_HEADER`` | nested | reply header |
1268 +---------------------------------------------+--------+---------------------+
1269 | ``ETHTOOL_A_CABLE_TEST_STATUS`` | u8 | completed |
1270 +---------------------------------------------+--------+---------------------+
1271 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST`` | nested | all the results |
1272 +-+-------------------------------------------+--------+---------------------+
1273 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test result |
1274 +-+-+-----------------------------------------+--------+---------------------+
1275 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1276 +-+-+-----------------------------------------+--------+---------------------+
1277 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1278 +-+-+-----------------------------------------+--------+---------------------+
1279 | | ``ETHTOOL_A_CABLE_NEST_RESULT`` | nested | cable test results |
1280 +-+-+-----------------------------------------+--------+---------------------+
1281 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1282 +-+-+-----------------------------------------+--------+---------------------+
1283 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE`` | u8 | result code |
1284 +-+-+-----------------------------------------+--------+---------------------+
1285 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH`` | nested | cable length |
1286 +-+-+-----------------------------------------+--------+---------------------+
1287 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR`` | u8 | pair number |
1288 +-+-+-----------------------------------------+--------+---------------------+
1289 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM`` | u32 | length in cm |
1290 +-+-+-----------------------------------------+--------+---------------------+
1295 Start a cable test and report raw TDR data
1299 +--------------------------------------------+--------+-----------------------+
1300 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1301 +--------------------------------------------+--------+-----------------------+
1302 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG`` | nested | test configuration |
1303 +-+------------------------------------------+--------+-----------------------+
1304 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | first data distance |
1305 +-+-+----------------------------------------+--------+-----------------------+
1306 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | last data distance |
1307 +-+-+----------------------------------------+--------+-----------------------+
1308 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step |
1309 +-+-+----------------------------------------+--------+-----------------------+
1310 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR`` | u8 | pair to test |
1311 +-+-+----------------------------------------+--------+-----------------------+
1313 The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members
1314 of the nest. All distances are expressed in centimeters. The PHY takes
1315 the distances as a guide, and rounds to the nearest distance it
1316 actually supports. If a pair is passed, only that one pair will be
1317 tested. Otherwise all pairs are tested.
1319 Notification contents:
1321 Raw TDR data is gathered by sending a pulse down the cable and
1322 recording the amplitude of the reflected pulse for a given distance.
1324 It can take a number of seconds to collect TDR data, especial if the
1325 full 100 meters is probed at 1 meter intervals. When the test is
1326 started a notification will be sent containing just
1327 ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1328 ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED.
1330 When the test has completed a second notification will be sent
1331 containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1332 ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data.
1334 The message may optionally contain the amplitude of the pulse send
1335 down the cable. This is measured in mV. A reflection should not be
1336 bigger than transmitted pulse.
1338 Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP
1339 nest containing information about the distance along the cable for the
1340 first reading, the last reading, and the step between each
1341 reading. Distances are measured in centimeters. These should be the
1342 exact values the PHY used. These may be different to what the user
1343 requested, if the native measurement resolution is greater than 1 cm.
1345 For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is
1346 used to report the amplitude of the reflection for a given pair.
1348 +---------------------------------------------+--------+----------------------+
1349 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER`` | nested | reply header |
1350 +---------------------------------------------+--------+----------------------+
1351 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS`` | u8 | completed |
1352 +---------------------------------------------+--------+----------------------+
1353 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST`` | nested | all the results |
1354 +-+-------------------------------------------+--------+----------------------+
1355 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE`` | nested | TX Pulse amplitude |
1356 +-+-+-----------------------------------------+--------+----------------------+
1357 | | | ``ETHTOOL_A_CABLE_PULSE_mV`` | s16 | Pulse amplitude |
1358 +-+-+-----------------------------------------+--------+----------------------+
1359 | | ``ETHTOOL_A_CABLE_NEST_STEP`` | nested | TDR step info |
1360 +-+-+-----------------------------------------+--------+----------------------+
1361 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32 | First data distance |
1362 +-+-+-----------------------------------------+--------+----------------------+
1363 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE`` | u32 | Last data distance |
1364 +-+-+-----------------------------------------+--------+----------------------+
1365 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE`` | u32 | distance of each step|
1366 +-+-+-----------------------------------------+--------+----------------------+
1367 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1368 +-+-+-----------------------------------------+--------+----------------------+
1369 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1370 +-+-+-----------------------------------------+--------+----------------------+
1371 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1372 +-+-+-----------------------------------------+--------+----------------------+
1373 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1374 +-+-+-----------------------------------------+--------+----------------------+
1375 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1376 +-+-+-----------------------------------------+--------+----------------------+
1377 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1378 +-+-+-----------------------------------------+--------+----------------------+
1379 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE`` | nested | Reflection amplitude |
1380 +-+-+-----------------------------------------+--------+----------------------+
1381 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR`` | u8 | pair number |
1382 +-+-+-----------------------------------------+--------+----------------------+
1383 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV`` | s16 | Reflection amplitude |
1384 +-+-+-----------------------------------------+--------+----------------------+
1389 Gets information about the tunnel state NIC is aware of.
1393 ===================================== ====== ==========================
1394 ``ETHTOOL_A_TUNNEL_INFO_HEADER`` nested request header
1395 ===================================== ====== ==========================
1397 Kernel response contents:
1399 +---------------------------------------------+--------+---------------------+
1400 | ``ETHTOOL_A_TUNNEL_INFO_HEADER`` | nested | reply header |
1401 +---------------------------------------------+--------+---------------------+
1402 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS`` | nested | all UDP port tables |
1403 +-+-------------------------------------------+--------+---------------------+
1404 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE`` | nested | one UDP port table |
1405 +-+-+-----------------------------------------+--------+---------------------+
1406 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE`` | u32 | max size of the |
1408 +-+-+-----------------------------------------+--------+---------------------+
1409 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` | bitset | tunnel types which |
1410 | | | | | table can hold |
1411 +-+-+-----------------------------------------+--------+---------------------+
1412 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY`` | nested | offloaded UDP port |
1413 +-+-+-+---------------------------------------+--------+---------------------+
1414 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT`` | be16 | UDP port |
1415 +-+-+-+---------------------------------------+--------+---------------------+
1416 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE`` | u32 | tunnel type |
1417 +-+-+-+---------------------------------------+--------+---------------------+
1419 For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that
1420 the table contains static entries, hard-coded by the NIC.
1425 Gets FEC configuration and state like ``ETHTOOL_GFECPARAM`` ioctl request.
1429 ===================================== ====== ==========================
1430 ``ETHTOOL_A_FEC_HEADER`` nested request header
1431 ===================================== ====== ==========================
1433 Kernel response contents:
1435 ===================================== ====== ==========================
1436 ``ETHTOOL_A_FEC_HEADER`` nested request header
1437 ``ETHTOOL_A_FEC_MODES`` bitset configured modes
1438 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection
1439 ``ETHTOOL_A_FEC_ACTIVE`` u32 index of active FEC mode
1440 ``ETHTOOL_A_FEC_STATS`` nested FEC statistics
1441 ===================================== ====== ==========================
1443 ``ETHTOOL_A_FEC_ACTIVE`` is the bit index of the FEC link mode currently
1444 active on the interface. This attribute may not be present if device does
1447 ``ETHTOOL_A_FEC_MODES`` and ``ETHTOOL_A_FEC_AUTO`` are only meaningful when
1448 autonegotiation is disabled. If ``ETHTOOL_A_FEC_AUTO`` is non-zero driver will
1449 select the FEC mode automatically based on the parameters of the SFP module.
1450 This is equivalent to the ``ETHTOOL_FEC_AUTO`` bit of the ioctl interface.
1451 ``ETHTOOL_A_FEC_MODES`` carry the current FEC configuration using link mode
1452 bits (rather than old ``ETHTOOL_FEC_*`` bits).
1454 ``ETHTOOL_A_FEC_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
1455 ``ETHTOOL_A_HEADER_FLAGS``.
1456 Each attribute carries an array of 64bit statistics. First entry in the array
1457 contains the total number of events on the port, while the following entries
1458 are counters corresponding to lanes/PCS instances. The number of entries in
1461 +--------------+---------------------------------------------+
1462 | `0` | device does not support FEC statistics |
1463 +--------------+---------------------------------------------+
1464 | `1` | device does not support per-lane break down |
1465 +--------------+---------------------------------------------+
1466 | `1 + #lanes` | device has full support for FEC stats |
1467 +--------------+---------------------------------------------+
1469 Drivers fill in the statistics in the following structure:
1471 .. kernel-doc:: include/linux/ethtool.h
1472 :identifiers: ethtool_fec_stats
1477 Sets FEC parameters like ``ETHTOOL_SFECPARAM`` ioctl request.
1481 ===================================== ====== ==========================
1482 ``ETHTOOL_A_FEC_HEADER`` nested request header
1483 ``ETHTOOL_A_FEC_MODES`` bitset configured modes
1484 ``ETHTOOL_A_FEC_AUTO`` bool FEC mode auto selection
1485 ===================================== ====== ==========================
1487 ``FEC_SET`` is only meaningful when autonegotiation is disabled. Otherwise
1488 FEC mode is selected as part of autonegotiation.
1490 ``ETHTOOL_A_FEC_MODES`` selects which FEC mode should be used. It's recommended
1491 to set only one bit, if multiple bits are set driver may choose between them
1492 in an implementation specific way.
1494 ``ETHTOOL_A_FEC_AUTO`` requests the driver to choose FEC mode based on SFP
1495 module parameters. This does not mean autonegotiation.
1500 Fetch module EEPROM data dump.
1501 This interface is designed to allow dumps of at most 1/2 page at once. This
1502 means only dumps of 128 (or less) bytes are allowed, without crossing half page
1503 boundary located at offset 128. For pages other than 0 only high 128 bytes are
1508 ======================================= ====== ==========================
1509 ``ETHTOOL_A_MODULE_EEPROM_HEADER`` nested request header
1510 ``ETHTOOL_A_MODULE_EEPROM_OFFSET`` u32 offset within a page
1511 ``ETHTOOL_A_MODULE_EEPROM_LENGTH`` u32 amount of bytes to read
1512 ``ETHTOOL_A_MODULE_EEPROM_PAGE`` u8 page number
1513 ``ETHTOOL_A_MODULE_EEPROM_BANK`` u8 bank number
1514 ``ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS`` u8 page I2C address
1515 ======================================= ====== ==========================
1517 If ``ETHTOOL_A_MODULE_EEPROM_BANK`` is not specified, bank 0 is assumed.
1519 Kernel response contents:
1521 +---------------------------------------------+--------+---------------------+
1522 | ``ETHTOOL_A_MODULE_EEPROM_HEADER`` | nested | reply header |
1523 +---------------------------------------------+--------+---------------------+
1524 | ``ETHTOOL_A_MODULE_EEPROM_DATA`` | binary | array of bytes from |
1525 | | | module EEPROM |
1526 +---------------------------------------------+--------+---------------------+
1528 ``ETHTOOL_A_MODULE_EEPROM_DATA`` has an attribute length equal to the amount of
1529 bytes driver actually read.
1534 Get standard statistics for the interface. Note that this is not
1535 a re-implementation of ``ETHTOOL_GSTATS`` which exposed driver-defined
1540 ======================================= ====== ==========================
1541 ``ETHTOOL_A_STATS_HEADER`` nested request header
1542 ``ETHTOOL_A_STATS_SRC`` u32 source of statistics
1543 ``ETHTOOL_A_STATS_GROUPS`` bitset requested groups of stats
1544 ======================================= ====== ==========================
1546 Kernel response contents:
1548 +-----------------------------------+--------+--------------------------------+
1549 | ``ETHTOOL_A_STATS_HEADER`` | nested | reply header |
1550 +-----------------------------------+--------+--------------------------------+
1551 | ``ETHTOOL_A_STATS_SRC`` | u32 | source of statistics |
1552 +-----------------------------------+--------+--------------------------------+
1553 | ``ETHTOOL_A_STATS_GRP`` | nested | one or more group of stats |
1554 +-+---------------------------------+--------+--------------------------------+
1555 | | ``ETHTOOL_A_STATS_GRP_ID`` | u32 | group ID - ``ETHTOOL_STATS_*`` |
1556 +-+---------------------------------+--------+--------------------------------+
1557 | | ``ETHTOOL_A_STATS_GRP_SS_ID`` | u32 | string set ID for names |
1558 +-+---------------------------------+--------+--------------------------------+
1559 | | ``ETHTOOL_A_STATS_GRP_STAT`` | nested | nest containing a statistic |
1560 +-+---------------------------------+--------+--------------------------------+
1561 | | ``ETHTOOL_A_STATS_GRP_HIST_RX`` | nested | histogram statistic (Rx) |
1562 +-+---------------------------------+--------+--------------------------------+
1563 | | ``ETHTOOL_A_STATS_GRP_HIST_TX`` | nested | histogram statistic (Tx) |
1564 +-+---------------------------------+--------+--------------------------------+
1566 Users specify which groups of statistics they are requesting via
1567 the ``ETHTOOL_A_STATS_GROUPS`` bitset. Currently defined values are:
1569 ====================== ======== ===============================================
1570 ETHTOOL_STATS_ETH_MAC eth-mac Basic IEEE 802.3 MAC statistics (30.3.1.1.*)
1571 ETHTOOL_STATS_ETH_PHY eth-phy Basic IEEE 802.3 PHY statistics (30.3.2.1.*)
1572 ETHTOOL_STATS_ETH_CTRL eth-ctrl Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*)
1573 ETHTOOL_STATS_RMON rmon RMON (RFC 2819) statistics
1574 ====================== ======== ===============================================
1576 Each group should have a corresponding ``ETHTOOL_A_STATS_GRP`` in the reply.
1577 ``ETHTOOL_A_STATS_GRP_ID`` identifies which group's statistics nest contains.
1578 ``ETHTOOL_A_STATS_GRP_SS_ID`` identifies the string set ID for the names of
1579 the statistics in the group, if available.
1581 Statistics are added to the ``ETHTOOL_A_STATS_GRP`` nest under
1582 ``ETHTOOL_A_STATS_GRP_STAT``. ``ETHTOOL_A_STATS_GRP_STAT`` should contain
1583 single 8 byte (u64) attribute inside - the type of that attribute is
1584 the statistic ID and the value is the value of the statistic.
1585 Each group has its own interpretation of statistic IDs.
1586 Attribute IDs correspond to strings from the string set identified
1587 by ``ETHTOOL_A_STATS_GRP_SS_ID``. Complex statistics (such as RMON histogram
1588 entries) are also listed inside ``ETHTOOL_A_STATS_GRP`` and do not have
1589 a string defined in the string set.
1591 RMON "histogram" counters count number of packets within given size range.
1592 Because RFC does not specify the ranges beyond the standard 1518 MTU devices
1593 differ in definition of buckets. For this reason the definition of packet ranges
1594 is left to each driver.
1596 ``ETHTOOL_A_STATS_GRP_HIST_RX`` and ``ETHTOOL_A_STATS_GRP_HIST_TX`` nests
1597 contain the following attributes:
1599 ================================= ====== ===================================
1600 ETHTOOL_A_STATS_RMON_HIST_BKT_LOW u32 low bound of the packet size bucket
1601 ETHTOOL_A_STATS_RMON_HIST_BKT_HI u32 high bound of the bucket
1602 ETHTOOL_A_STATS_RMON_HIST_VAL u64 packet counter
1603 ================================= ====== ===================================
1605 Low and high bounds are inclusive, for example:
1607 ============================= ==== ====
1608 RFC statistic low high
1609 ============================= ==== ====
1610 etherStatsPkts64Octets 0 64
1611 etherStatsPkts512to1023Octets 512 1023
1612 ============================= ==== ====
1614 ``ETHTOOL_A_STATS_SRC`` is optional. Similar to ``PAUSE_GET``, it takes values
1615 from ``enum ethtool_mac_stats_src``. If absent from the request, stats will be
1616 provided with an ``ETHTOOL_A_STATS_SRC`` attribute in the response equal to
1617 ``ETHTOOL_MAC_STATS_SRC_AGGREGATE``.
1622 Query device PHC virtual clocks information.
1626 ==================================== ====== ==========================
1627 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested request header
1628 ==================================== ====== ==========================
1630 Kernel response contents:
1632 ==================================== ====== ==========================
1633 ``ETHTOOL_A_PHC_VCLOCKS_HEADER`` nested reply header
1634 ``ETHTOOL_A_PHC_VCLOCKS_NUM`` u32 PHC virtual clocks number
1635 ``ETHTOOL_A_PHC_VCLOCKS_INDEX`` s32 PHC index array
1636 ==================================== ====== ==========================
1641 Gets transceiver module parameters.
1645 ===================================== ====== ==========================
1646 ``ETHTOOL_A_MODULE_HEADER`` nested request header
1647 ===================================== ====== ==========================
1649 Kernel response contents:
1651 ====================================== ====== ==========================
1652 ``ETHTOOL_A_MODULE_HEADER`` nested reply header
1653 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy
1654 ``ETHTOOL_A_MODULE_POWER_MODE`` u8 operational power mode
1655 ====================================== ====== ==========================
1657 The optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute encodes the
1658 transceiver module power mode policy enforced by the host. The default policy
1659 is driver-dependent, but "auto" is the recommended default and it should be
1660 implemented by new drivers and drivers where conformance to a legacy behavior
1663 The optional ``ETHTHOOL_A_MODULE_POWER_MODE`` attribute encodes the operational
1664 power mode policy of the transceiver module. It is only reported when a module
1665 is plugged-in. Possible values are:
1667 .. kernel-doc:: include/uapi/linux/ethtool.h
1668 :identifiers: ethtool_module_power_mode
1673 Sets transceiver module parameters.
1677 ====================================== ====== ==========================
1678 ``ETHTOOL_A_MODULE_HEADER`` nested request header
1679 ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` u8 power mode policy
1680 ====================================== ====== ==========================
1682 When set, the optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute is used
1683 to set the transceiver module power policy enforced by the host. Possible
1686 .. kernel-doc:: include/uapi/linux/ethtool.h
1687 :identifiers: ethtool_module_power_mode_policy
1689 For SFF-8636 modules, low power mode is forced by the host according to table
1690 6-10 in revision 2.10a of the specification.
1692 For CMIS modules, low power mode is forced by the host according to table 6-12
1693 in revision 5.0 of the specification.
1698 Gets PSE attributes.
1702 ===================================== ====== ==========================
1703 ``ETHTOOL_A_PSE_HEADER`` nested request header
1704 ===================================== ====== ==========================
1706 Kernel response contents:
1708 ====================================== ====== =============================
1709 ``ETHTOOL_A_PSE_HEADER`` nested reply header
1710 ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` u32 Operational state of the PoDL
1712 ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` u32 power detection status of the
1714 ====================================== ====== =============================
1716 When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` attribute identifies
1717 the operational state of the PoDL PSE functions. The operational state of the
1718 PSE function can be changed using the ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL``
1719 action. This option is corresponding to ``IEEE 802.3-2018`` 30.15.1.1.2
1720 aPoDLPSEAdminState. Possible values are:
1722 .. kernel-doc:: include/uapi/linux/ethtool.h
1723 :identifiers: ethtool_podl_pse_admin_state
1725 When set, the optional ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` attribute identifies
1726 the power detection status of the PoDL PSE. The status depend on internal PSE
1727 state machine and automatic PD classification support. This option is
1728 corresponding to ``IEEE 802.3-2018`` 30.15.1.1.3 aPoDLPSEPowerDetectionStatus.
1729 Possible values are:
1731 .. kernel-doc:: include/uapi/linux/ethtool.h
1732 :identifiers: ethtool_podl_pse_pw_d_status
1737 Sets PSE parameters.
1741 ====================================== ====== =============================
1742 ``ETHTOOL_A_PSE_HEADER`` nested request header
1743 ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` u32 Control PoDL PSE Admin state
1744 ====================================== ====== =============================
1746 When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` attribute is used
1747 to control PoDL PSE Admin functions. This option is implementing
1748 ``IEEE 802.3-2018`` 30.15.1.2.1 acPoDLPSEAdminControl. See
1749 ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` for supported values.
1754 Get indirection table, hash key and hash function info associated with a
1755 RSS context of an interface similar to ``ETHTOOL_GRSSH`` ioctl request.
1759 ===================================== ====== ==========================
1760 ``ETHTOOL_A_RSS_HEADER`` nested request header
1761 ``ETHTOOL_A_RSS_CONTEXT`` u32 context number
1762 ===================================== ====== ==========================
1764 Kernel response contents:
1766 ===================================== ====== ==========================
1767 ``ETHTOOL_A_RSS_HEADER`` nested reply header
1768 ``ETHTOOL_A_RSS_HFUNC`` u32 RSS hash func
1769 ``ETHTOOL_A_RSS_INDIR`` binary Indir table bytes
1770 ``ETHTOOL_A_RSS_HKEY`` binary Hash key bytes
1771 ===================================== ====== ==========================
1773 ETHTOOL_A_RSS_HFUNC attribute is bitmap indicating the hash function
1774 being used. Current supported options are toeplitz, xor or crc32.
1775 ETHTOOL_A_RSS_INDIR attribute returns RSS indrection table where each byte
1776 indicates queue number.
1781 Gets the IEEE 802.3cg-2019 Clause 148 Physical Layer Collision Avoidance
1782 (PLCA) Reconciliation Sublayer (RS) attributes.
1786 ===================================== ====== ==========================
1787 ``ETHTOOL_A_PLCA_HEADER`` nested request header
1788 ===================================== ====== ==========================
1790 Kernel response contents:
1792 ====================================== ====== =============================
1793 ``ETHTOOL_A_PLCA_HEADER`` nested reply header
1794 ``ETHTOOL_A_PLCA_VERSION`` u16 Supported PLCA management
1795 interface standard/version
1796 ``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State
1797 ``ETHTOOL_A_PLCA_NODE_ID`` u32 PLCA unique local node ID
1798 ``ETHTOOL_A_PLCA_NODE_CNT`` u32 Number of PLCA nodes on the
1799 network, including the
1801 ``ETHTOOL_A_PLCA_TO_TMR`` u32 Transmit Opportunity Timer
1802 value in bit-times (BT)
1803 ``ETHTOOL_A_PLCA_BURST_CNT`` u32 Number of additional packets
1804 the node is allowed to send
1806 ``ETHTOOL_A_PLCA_BURST_TMR`` u32 Time to wait for the MAC to
1807 transmit a new frame before
1808 terminating the burst
1809 ====================================== ====== =============================
1811 When set, the optional ``ETHTOOL_A_PLCA_VERSION`` attribute indicates which
1812 standard and version the PLCA management interface complies to. When not set,
1813 the interface is vendor-specific and (possibly) supplied by the driver.
1814 The OPEN Alliance SIG specifies a standard register map for 10BASE-T1S PHYs
1815 embedding the PLCA Reconcialiation Sublayer. See "10BASE-T1S PLCA Management
1816 Registers" at https://www.opensig.org/about/specifications/.
1818 When set, the optional ``ETHTOOL_A_PLCA_ENABLED`` attribute indicates the
1819 administrative state of the PLCA RS. When not set, the node operates in "plain"
1820 CSMA/CD mode. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.1
1821 aPLCAAdminState / 30.16.1.2.1 acPLCAAdminControl.
1823 When set, the optional ``ETHTOOL_A_PLCA_NODE_ID`` attribute indicates the
1824 configured local node ID of the PHY. This ID determines which transmit
1825 opportunity (TO) is reserved for the node to transmit into. This option is
1826 corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.4 aPLCALocalNodeID. The valid
1827 range for this attribute is [0 .. 255] where 255 means "not configured".
1829 When set, the optional ``ETHTOOL_A_PLCA_NODE_CNT`` attribute indicates the
1830 configured maximum number of PLCA nodes on the mixing-segment. This number
1831 determines the total number of transmit opportunities generated during a
1832 PLCA cycle. This attribute is relevant only for the PLCA coordinator, which is
1833 the node with aPLCALocalNodeID set to 0. Follower nodes ignore this setting.
1834 This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.3
1835 aPLCANodeCount. The valid range for this attribute is [1 .. 255].
1837 When set, the optional ``ETHTOOL_A_PLCA_TO_TMR`` attribute indicates the
1838 configured value of the transmit opportunity timer in bit-times. This value
1839 must be set equal across all nodes sharing the medium for PLCA to work
1840 correctly. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.5
1841 aPLCATransmitOpportunityTimer. The valid range for this attribute is
1844 When set, the optional ``ETHTOOL_A_PLCA_BURST_CNT`` attribute indicates the
1845 configured number of extra packets that the node is allowed to send during a
1846 single transmit opportunity. By default, this attribute is 0, meaning that
1847 the node can only send a single frame per TO. When greater than 0, the PLCA RS
1848 keeps the TO after any transmission, waiting for the MAC to send a new frame
1849 for up to aPLCABurstTimer BTs. This can only happen a number of times per PLCA
1850 cycle up to the value of this parameter. After that, the burst is over and the
1851 normal counting of TOs resumes. This option is corresponding to
1852 ``IEEE 802.3cg-2019`` 30.16.1.1.6 aPLCAMaxBurstCount. The valid range for this
1853 attribute is [0 .. 255].
1855 When set, the optional ``ETHTOOL_A_PLCA_BURST_TMR`` attribute indicates how
1856 many bit-times the PLCA RS waits for the MAC to initiate a new transmission
1857 when aPLCAMaxBurstCount is greater than 0. If the MAC fails to send a new
1858 frame within this time, the burst ends and the counting of TOs resumes.
1859 Otherwise, the new frame is sent as part of the current burst. This option
1860 is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.7 aPLCABurstTimer. The
1861 valid range for this attribute is [0 .. 255]. Although, the value should be
1862 set greater than the Inter-Frame-Gap (IFG) time of the MAC (plus some margin)
1863 for PLCA burst mode to work as intended.
1868 Sets PLCA RS parameters.
1872 ====================================== ====== =============================
1873 ``ETHTOOL_A_PLCA_HEADER`` nested request header
1874 ``ETHTOOL_A_PLCA_ENABLED`` u8 PLCA Admin State
1875 ``ETHTOOL_A_PLCA_NODE_ID`` u8 PLCA unique local node ID
1876 ``ETHTOOL_A_PLCA_NODE_CNT`` u8 Number of PLCA nodes on the
1877 netkork, including the
1879 ``ETHTOOL_A_PLCA_TO_TMR`` u8 Transmit Opportunity Timer
1880 value in bit-times (BT)
1881 ``ETHTOOL_A_PLCA_BURST_CNT`` u8 Number of additional packets
1882 the node is allowed to send
1884 ``ETHTOOL_A_PLCA_BURST_TMR`` u8 Time to wait for the MAC to
1885 transmit a new frame before
1886 terminating the burst
1887 ====================================== ====== =============================
1889 For a description of each attribute, see ``PLCA_GET_CFG``.
1894 Gets PLCA RS status information.
1898 ===================================== ====== ==========================
1899 ``ETHTOOL_A_PLCA_HEADER`` nested request header
1900 ===================================== ====== ==========================
1902 Kernel response contents:
1904 ====================================== ====== =============================
1905 ``ETHTOOL_A_PLCA_HEADER`` nested reply header
1906 ``ETHTOOL_A_PLCA_STATUS`` u8 PLCA RS operational status
1907 ====================================== ====== =============================
1909 When set, the ``ETHTOOL_A_PLCA_STATUS`` attribute indicates whether the node is
1910 detecting the presence of the BEACON on the network. This flag is
1911 corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.2 aPLCAStatus.
1916 Retrieve 802.3 MAC Merge parameters.
1920 ==================================== ====== ==========================
1921 ``ETHTOOL_A_MM_HEADER`` nested request header
1922 ==================================== ====== ==========================
1924 Kernel response contents:
1926 ================================= ====== ===================================
1927 ``ETHTOOL_A_MM_HEADER`` nested request header
1928 ``ETHTOOL_A_MM_PMAC_ENABLED`` bool set if RX of preemptible and SMD-V
1930 ``ETHTOOL_A_MM_TX_ENABLED`` bool set if TX of preemptible frames is
1931 administratively enabled (might be
1932 inactive if verification failed)
1933 ``ETHTOOL_A_MM_TX_ACTIVE`` bool set if TX of preemptible frames is
1934 operationally enabled
1935 ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE`` u32 minimum size of transmitted
1936 non-final fragments, in octets
1937 ``ETHTOOL_A_MM_RX_MIN_FRAG_SIZE`` u32 minimum size of received non-final
1938 fragments, in octets
1939 ``ETHTOOL_A_MM_VERIFY_ENABLED`` bool set if TX of SMD-V frames is
1940 administratively enabled
1941 ``ETHTOOL_A_MM_VERIFY_STATUS`` u8 state of the verification function
1942 ``ETHTOOL_A_MM_VERIFY_TIME`` u32 delay between verification attempts
1943 ``ETHTOOL_A_MM_MAX_VERIFY_TIME``` u32 maximum verification interval
1945 ``ETHTOOL_A_MM_STATS`` nested IEEE 802.3-2018 subclause 30.14.1
1946 oMACMergeEntity statistics counters
1947 ================================= ====== ===================================
1949 The attributes are populated by the device driver through the following
1952 .. kernel-doc:: include/linux/ethtool.h
1953 :identifiers: ethtool_mm_state
1955 The ``ETHTOOL_A_MM_VERIFY_STATUS`` will report one of the values from
1957 .. kernel-doc:: include/uapi/linux/ethtool.h
1958 :identifiers: ethtool_mm_verify_status
1960 If ``ETHTOOL_A_MM_VERIFY_ENABLED`` was passed as false in the ``MM_SET``
1961 command, ``ETHTOOL_A_MM_VERIFY_STATUS`` will report either
1962 ``ETHTOOL_MM_VERIFY_STATUS_INITIAL`` or ``ETHTOOL_MM_VERIFY_STATUS_DISABLED``,
1963 otherwise it should report one of the other states.
1965 It is recommended that drivers start with the pMAC disabled, and enable it upon
1966 user space request. It is also recommended that user space does not depend upon
1967 the default values from ``ETHTOOL_MSG_MM_GET`` requests.
1969 ``ETHTOOL_A_MM_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
1970 ``ETHTOOL_A_HEADER_FLAGS``. The attribute will be empty if driver did not
1971 report any statistics. Drivers fill in the statistics in the following
1974 .. kernel-doc:: include/linux/ethtool.h
1975 :identifiers: ethtool_mm_stats
1980 Modifies the configuration of the 802.3 MAC Merge layer.
1984 ================================= ====== ==========================
1985 ``ETHTOOL_A_MM_VERIFY_TIME`` u32 see MM_GET description
1986 ``ETHTOOL_A_MM_VERIFY_ENABLED`` bool see MM_GET description
1987 ``ETHTOOL_A_MM_TX_ENABLED`` bool see MM_GET description
1988 ``ETHTOOL_A_MM_PMAC_ENABLED`` bool see MM_GET description
1989 ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE`` u32 see MM_GET description
1990 ================================= ====== ==========================
1992 The attributes are propagated to the driver through the following structure:
1994 .. kernel-doc:: include/linux/ethtool.h
1995 :identifiers: ethtool_mm_cfg
2000 The following table maps ioctl commands to netlink commands providing their
2001 functionality. Entries with "n/a" in right column are commands which do not
2002 have their netlink replacement yet. Entries which "n/a" in the left column
2005 =================================== =====================================
2006 ioctl command netlink command
2007 =================================== =====================================
2008 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET``
2009 ``ETHTOOL_MSG_LINKMODES_GET``
2010 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET``
2011 ``ETHTOOL_MSG_LINKMODES_SET``
2012 ``ETHTOOL_GDRVINFO`` n/a
2013 ``ETHTOOL_GREGS`` n/a
2014 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET``
2015 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET``
2016 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET``
2017 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET``
2018 ``ETHTOOL_NWAY_RST`` n/a
2019 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET``
2020 ``ETHTOOL_GEEPROM`` n/a
2021 ``ETHTOOL_SEEPROM`` n/a
2022 ``ETHTOOL_GCOALESCE`` ``ETHTOOL_MSG_COALESCE_GET``
2023 ``ETHTOOL_SCOALESCE`` ``ETHTOOL_MSG_COALESCE_SET``
2024 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET``
2025 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET``
2026 ``ETHTOOL_GPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_GET``
2027 ``ETHTOOL_SPAUSEPARAM`` ``ETHTOOL_MSG_PAUSE_SET``
2028 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
2029 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
2030 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET``
2031 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET``
2032 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET``
2033 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET``
2034 ``ETHTOOL_TEST`` n/a
2035 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET``
2036 ``ETHTOOL_PHYS_ID`` n/a
2037 ``ETHTOOL_GSTATS`` n/a
2038 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET``
2039 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET``
2040 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK``
2041 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET``
2042 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET``
2043 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET``
2044 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET``
2045 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET``
2046 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET``
2047 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET``
2048 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET``
2049 ``ETHTOOL_GRXFH`` n/a
2050 ``ETHTOOL_SRXFH`` n/a
2051 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET``
2052 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET``
2053 ``ETHTOOL_GRXRINGS`` n/a
2054 ``ETHTOOL_GRXCLSRLCNT`` n/a
2055 ``ETHTOOL_GRXCLSRULE`` n/a
2056 ``ETHTOOL_GRXCLSRLALL`` n/a
2057 ``ETHTOOL_SRXCLSRLDEL`` n/a
2058 ``ETHTOOL_SRXCLSRLINS`` n/a
2059 ``ETHTOOL_FLASHDEV`` n/a
2060 ``ETHTOOL_RESET`` n/a
2061 ``ETHTOOL_SRXNTUPLE`` n/a
2062 ``ETHTOOL_GRXNTUPLE`` n/a
2063 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET``
2064 ``ETHTOOL_GRXFHINDIR`` n/a
2065 ``ETHTOOL_SRXFHINDIR`` n/a
2066 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET``
2067 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET``
2068 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET``
2069 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET``
2070 ``ETHTOOL_SET_DUMP`` n/a
2071 ``ETHTOOL_GET_DUMP_FLAG`` n/a
2072 ``ETHTOOL_GET_DUMP_DATA`` n/a
2073 ``ETHTOOL_GET_TS_INFO`` ``ETHTOOL_MSG_TSINFO_GET``
2074 ``ETHTOOL_GMODULEINFO`` ``ETHTOOL_MSG_MODULE_EEPROM_GET``
2075 ``ETHTOOL_GMODULEEEPROM`` ``ETHTOOL_MSG_MODULE_EEPROM_GET``
2076 ``ETHTOOL_GEEE`` ``ETHTOOL_MSG_EEE_GET``
2077 ``ETHTOOL_SEEE`` ``ETHTOOL_MSG_EEE_SET``
2078 ``ETHTOOL_GRSSH`` ``ETHTOOL_MSG_RSS_GET``
2079 ``ETHTOOL_SRSSH`` n/a
2080 ``ETHTOOL_GTUNABLE`` n/a
2081 ``ETHTOOL_STUNABLE`` n/a
2082 ``ETHTOOL_GPHYSTATS`` n/a
2083 ``ETHTOOL_PERQUEUE`` n/a
2084 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET``
2085 ``ETHTOOL_MSG_LINKMODES_GET``
2086 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET``
2087 ``ETHTOOL_MSG_LINKMODES_SET``
2088 ``ETHTOOL_PHY_GTUNABLE`` n/a
2089 ``ETHTOOL_PHY_STUNABLE`` n/a
2090 ``ETHTOOL_GFECPARAM`` ``ETHTOOL_MSG_FEC_GET``
2091 ``ETHTOOL_SFECPARAM`` ``ETHTOOL_MSG_FEC_SET``
2092 n/a ``ETHTOOL_MSG_CABLE_TEST_ACT``
2093 n/a ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT``
2094 n/a ``ETHTOOL_MSG_TUNNEL_INFO_GET``
2095 n/a ``ETHTOOL_MSG_PHC_VCLOCKS_GET``
2096 n/a ``ETHTOOL_MSG_MODULE_GET``
2097 n/a ``ETHTOOL_MSG_MODULE_SET``
2098 n/a ``ETHTOOL_MSG_PLCA_GET_CFG``
2099 n/a ``ETHTOOL_MSG_PLCA_SET_CFG``
2100 n/a ``ETHTOOL_MSG_PLCA_GET_STATUS``
2101 n/a ``ETHTOOL_MSG_MM_GET``
2102 n/a ``ETHTOOL_MSG_MM_SET``
2103 =================================== =====================================