xref: /linux/Documentation/networking/ethtool-netlink.rst (revision c532de5a67a70f8533d495f8f2aaa9a0491c3ad0)
1=============================
2Netlink interface for ethtool
3=============================
4
5
6Basic information
7=================
8
9Netlink interface for ethtool uses generic netlink family ``ethtool``
10(userspace application should use macros ``ETHTOOL_GENL_NAME`` and
11``ETHTOOL_GENL_VERSION`` defined in ``<linux/ethtool_netlink.h>`` uapi
12header). This family does not use a specific header, all information in
13requests and replies is passed using netlink attributes.
14
15The ethtool netlink interface uses extended ACK for error and warning
16reporting, userspace application developers are encouraged to make these
17messages available to user in a suitable way.
18
19Requests can be divided into three categories: "get" (retrieving information),
20"set" (setting parameters) and "action" (invoking an action).
21
22All "set" and "action" type requests require admin privileges
23(``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for
24anyone but there are exceptions (where the response contains sensitive
25information). In some cases, the request as such is allowed for anyone but
26unprivileged users have attributes with sensitive information (e.g.
27wake-on-lan password) omitted.
28
29
30Conventions
31===========
32
33Attributes which represent a boolean value usually use NLA_U8 type so that we
34can distinguish three states: "on", "off" and "not present" (meaning the
35information is not available in "get" requests or value is not to be changed
36in "set" requests). For these attributes, the "true" value should be passed as
37number 1 but any non-zero value should be understood as "true" by recipient.
38In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way.
39
40In the message structure descriptions below, if an attribute name is suffixed
41with "+", parent nest can contain multiple attributes of the same type. This
42implements an array of entries.
43
44Attributes that need to be filled-in by device drivers and that are dumped to
45user space based on whether they are valid or not should not use zero as a
46valid value. This avoids the need to explicitly signal the validity of the
47attribute in the device driver API.
48
49
50Request header
51==============
52
53Each request or reply message contains a nested attribute with common header.
54Structure of this header is
55
56  ==============================  ======  =============================
57  ``ETHTOOL_A_HEADER_DEV_INDEX``  u32     device ifindex
58  ``ETHTOOL_A_HEADER_DEV_NAME``   string  device name
59  ``ETHTOOL_A_HEADER_FLAGS``      u32     flags common for all requests
60  ``ETHTOOL_A_HEADER_PHY_INDEX``  u32     phy device index
61  ==============================  ======  =============================
62
63``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the
64device message relates to. One of them is sufficient in requests, if both are
65used, they must identify the same device. Some requests, e.g. global string
66sets, do not require device identification. Most ``GET`` requests also allow
67dump requests without device identification to query the same information for
68all devices providing it (each device in a separate message).
69
70``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request
71types. The interpretation of these flags is the same for all request types but
72the flags may not apply to requests. Recognized flags are:
73
74  =================================  ===================================
75  ``ETHTOOL_FLAG_COMPACT_BITSETS``   use compact format bitsets in reply
76  ``ETHTOOL_FLAG_OMIT_REPLY``        omit optional reply (_SET and _ACT)
77  ``ETHTOOL_FLAG_STATS``             include optional device statistics
78  =================================  ===================================
79
80New request flags should follow the general idea that if the flag is not set,
81the behaviour is backward compatible, i.e. requests from old clients not aware
82of the flag should be interpreted the way the client expects. A client must
83not set flags it does not understand.
84
85``ETHTOOL_A_HEADER_PHY_INDEX`` identifies the Ethernet PHY the message relates to.
86As there are numerous commands that are related to PHY configuration, and because
87there may be more than one PHY on the link, the PHY index can be passed in the
88request for the commands that needs it. It is, however, not mandatory, and if it
89is not passed for commands that target a PHY, the net_device.phydev pointer
90is used.
91
92Bit sets
93========
94
95For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32``
96type is used. For arbitrary length bitmaps, ethtool netlink uses a nested
97attribute with contents of one of two forms: compact (two binary bitmaps
98representing bit values and mask of affected bits) and bit-by-bit (list of
99bits identified by either index or name).
100
101Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together
102with their values which saves a round trip (when the bitset is passed in a
103request) or at least a second request (when the bitset is in a reply). This is
104useful for one shot applications like traditional ethtool command. On the
105other hand, long running applications like ethtool monitor (displaying
106notifications) or network management daemons may prefer fetching the names
107only once and using compact form to save message size. Notifications from
108ethtool netlink interface always use compact form for bitsets.
109
110A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK``
111not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests
112modifying a bitmap, the former changes the bit set in mask to values set in
113value and preserves the rest; the latter sets the bits set in the bitmap and
114clears the rest.
115
116Compact form: nested (bitset) attribute contents:
117
118  ============================  ======  ============================
119  ``ETHTOOL_A_BITSET_NOMASK``   flag    no mask, only a list
120  ``ETHTOOL_A_BITSET_SIZE``     u32     number of significant bits
121  ``ETHTOOL_A_BITSET_VALUE``    binary  bitmap of bit values
122  ``ETHTOOL_A_BITSET_MASK``     binary  bitmap of valid bits
123  ============================  ======  ============================
124
125Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits
126rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte
127order, words ordered from least significant to most significant (i.e. the same
128way as bitmaps are passed with ioctl interface).
129
130For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are
131mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if
132``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair);
133if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not
134allowed (bitset represents a single bitmap.
135
136Kernel bit set length may differ from userspace length if older application is
137used on newer kernel or vice versa. If userspace bitmap is longer, an error is
138issued only if the request actually tries to set values of some bits not
139recognized by kernel.
140
141Bit-by-bit form: nested (bitset) attribute contents:
142
143 +------------------------------------+--------+-----------------------------+
144 | ``ETHTOOL_A_BITSET_NOMASK``        | flag   | no mask, only a list        |
145 +------------------------------------+--------+-----------------------------+
146 | ``ETHTOOL_A_BITSET_SIZE``          | u32    | number of significant bits  |
147 +------------------------------------+--------+-----------------------------+
148 | ``ETHTOOL_A_BITSET_BITS``          | nested | array of bits               |
149 +-+----------------------------------+--------+-----------------------------+
150 | | ``ETHTOOL_A_BITSET_BITS_BIT+``   | nested | one bit                     |
151 +-+-+--------------------------------+--------+-----------------------------+
152 | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32    | bit index (0 for LSB)       |
153 +-+-+--------------------------------+--------+-----------------------------+
154 | | | ``ETHTOOL_A_BITSET_BIT_NAME``  | string | bit name                    |
155 +-+-+--------------------------------+--------+-----------------------------+
156 | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag   | present if bit is set       |
157 +-+-+--------------------------------+--------+-----------------------------+
158
159Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can
160only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an
161arbitrary number of them.  A bit may be identified by its index or by its
162name. When used in requests, listed bits are set to 0 or 1 according to
163``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if
164index exceeds kernel bit length or if name is not recognized.
165
166When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as
167a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in
168such case. Such bitset represents a bitmap with listed bits set and the rest
169zero.
170
171In requests, application can use either form. Form used by kernel in reply is
172determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request
173header. Semantics of value and mask depends on the attribute.
174
175
176List of message types
177=====================
178
179All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix
180according to message purpose:
181
182  ==============    ======================================
183  ``_GET``          userspace request to retrieve data
184  ``_SET``          userspace request to set data
185  ``_ACT``          userspace request to perform an action
186  ``_GET_REPLY``    kernel reply to a ``GET`` request
187  ``_SET_REPLY``    kernel reply to a ``SET`` request
188  ``_ACT_REPLY``    kernel reply to an ``ACT`` request
189  ``_NTF``          kernel notification
190  ==============    ======================================
191
192Userspace to kernel:
193
194  ===================================== =================================
195  ``ETHTOOL_MSG_STRSET_GET``            get string set
196  ``ETHTOOL_MSG_LINKINFO_GET``          get link settings
197  ``ETHTOOL_MSG_LINKINFO_SET``          set link settings
198  ``ETHTOOL_MSG_LINKMODES_GET``         get link modes info
199  ``ETHTOOL_MSG_LINKMODES_SET``         set link modes info
200  ``ETHTOOL_MSG_LINKSTATE_GET``         get link state
201  ``ETHTOOL_MSG_DEBUG_GET``             get debugging settings
202  ``ETHTOOL_MSG_DEBUG_SET``             set debugging settings
203  ``ETHTOOL_MSG_WOL_GET``               get wake-on-lan settings
204  ``ETHTOOL_MSG_WOL_SET``               set wake-on-lan settings
205  ``ETHTOOL_MSG_FEATURES_GET``          get device features
206  ``ETHTOOL_MSG_FEATURES_SET``          set device features
207  ``ETHTOOL_MSG_PRIVFLAGS_GET``         get private flags
208  ``ETHTOOL_MSG_PRIVFLAGS_SET``         set private flags
209  ``ETHTOOL_MSG_RINGS_GET``             get ring sizes
210  ``ETHTOOL_MSG_RINGS_SET``             set ring sizes
211  ``ETHTOOL_MSG_CHANNELS_GET``          get channel counts
212  ``ETHTOOL_MSG_CHANNELS_SET``          set channel counts
213  ``ETHTOOL_MSG_COALESCE_GET``          get coalescing parameters
214  ``ETHTOOL_MSG_COALESCE_SET``          set coalescing parameters
215  ``ETHTOOL_MSG_PAUSE_GET``             get pause parameters
216  ``ETHTOOL_MSG_PAUSE_SET``             set pause parameters
217  ``ETHTOOL_MSG_EEE_GET``               get EEE settings
218  ``ETHTOOL_MSG_EEE_SET``               set EEE settings
219  ``ETHTOOL_MSG_TSINFO_GET``		get timestamping info
220  ``ETHTOOL_MSG_CABLE_TEST_ACT``        action start cable test
221  ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT``    action start raw TDR cable test
222  ``ETHTOOL_MSG_TUNNEL_INFO_GET``       get tunnel offload info
223  ``ETHTOOL_MSG_FEC_GET``               get FEC settings
224  ``ETHTOOL_MSG_FEC_SET``               set FEC settings
225  ``ETHTOOL_MSG_MODULE_EEPROM_GET``     read SFP module EEPROM
226  ``ETHTOOL_MSG_STATS_GET``             get standard statistics
227  ``ETHTOOL_MSG_PHC_VCLOCKS_GET``       get PHC virtual clocks info
228  ``ETHTOOL_MSG_MODULE_SET``            set transceiver module parameters
229  ``ETHTOOL_MSG_MODULE_GET``            get transceiver module parameters
230  ``ETHTOOL_MSG_PSE_SET``               set PSE parameters
231  ``ETHTOOL_MSG_PSE_GET``               get PSE parameters
232  ``ETHTOOL_MSG_RSS_GET``               get RSS settings
233  ``ETHTOOL_MSG_PLCA_GET_CFG``          get PLCA RS parameters
234  ``ETHTOOL_MSG_PLCA_SET_CFG``          set PLCA RS parameters
235  ``ETHTOOL_MSG_PLCA_GET_STATUS``       get PLCA RS status
236  ``ETHTOOL_MSG_MM_GET``                get MAC merge layer state
237  ``ETHTOOL_MSG_MM_SET``                set MAC merge layer parameters
238  ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``   flash transceiver module firmware
239  ===================================== =================================
240
241Kernel to userspace:
242
243  ======================================== =================================
244  ``ETHTOOL_MSG_STRSET_GET_REPLY``         string set contents
245  ``ETHTOOL_MSG_LINKINFO_GET_REPLY``       link settings
246  ``ETHTOOL_MSG_LINKINFO_NTF``             link settings notification
247  ``ETHTOOL_MSG_LINKMODES_GET_REPLY``      link modes info
248  ``ETHTOOL_MSG_LINKMODES_NTF``            link modes notification
249  ``ETHTOOL_MSG_LINKSTATE_GET_REPLY``      link state info
250  ``ETHTOOL_MSG_DEBUG_GET_REPLY``          debugging settings
251  ``ETHTOOL_MSG_DEBUG_NTF``                debugging settings notification
252  ``ETHTOOL_MSG_WOL_GET_REPLY``            wake-on-lan settings
253  ``ETHTOOL_MSG_WOL_NTF``                  wake-on-lan settings notification
254  ``ETHTOOL_MSG_FEATURES_GET_REPLY``       device features
255  ``ETHTOOL_MSG_FEATURES_SET_REPLY``       optional reply to FEATURES_SET
256  ``ETHTOOL_MSG_FEATURES_NTF``             netdev features notification
257  ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY``      private flags
258  ``ETHTOOL_MSG_PRIVFLAGS_NTF``            private flags
259  ``ETHTOOL_MSG_RINGS_GET_REPLY``          ring sizes
260  ``ETHTOOL_MSG_RINGS_NTF``                ring sizes
261  ``ETHTOOL_MSG_CHANNELS_GET_REPLY``       channel counts
262  ``ETHTOOL_MSG_CHANNELS_NTF``             channel counts
263  ``ETHTOOL_MSG_COALESCE_GET_REPLY``       coalescing parameters
264  ``ETHTOOL_MSG_COALESCE_NTF``             coalescing parameters
265  ``ETHTOOL_MSG_PAUSE_GET_REPLY``          pause parameters
266  ``ETHTOOL_MSG_PAUSE_NTF``                pause parameters
267  ``ETHTOOL_MSG_EEE_GET_REPLY``            EEE settings
268  ``ETHTOOL_MSG_EEE_NTF``                  EEE settings
269  ``ETHTOOL_MSG_TSINFO_GET_REPLY``         timestamping info
270  ``ETHTOOL_MSG_CABLE_TEST_NTF``           Cable test results
271  ``ETHTOOL_MSG_CABLE_TEST_TDR_NTF``       Cable test TDR results
272  ``ETHTOOL_MSG_TUNNEL_INFO_GET_REPLY``    tunnel offload info
273  ``ETHTOOL_MSG_FEC_GET_REPLY``            FEC settings
274  ``ETHTOOL_MSG_FEC_NTF``                  FEC settings
275  ``ETHTOOL_MSG_MODULE_EEPROM_GET_REPLY``  read SFP module EEPROM
276  ``ETHTOOL_MSG_STATS_GET_REPLY``          standard statistics
277  ``ETHTOOL_MSG_PHC_VCLOCKS_GET_REPLY``    PHC virtual clocks info
278  ``ETHTOOL_MSG_MODULE_GET_REPLY``         transceiver module parameters
279  ``ETHTOOL_MSG_PSE_GET_REPLY``            PSE parameters
280  ``ETHTOOL_MSG_RSS_GET_REPLY``            RSS settings
281  ``ETHTOOL_MSG_PLCA_GET_CFG_REPLY``       PLCA RS parameters
282  ``ETHTOOL_MSG_PLCA_GET_STATUS_REPLY``    PLCA RS status
283  ``ETHTOOL_MSG_PLCA_NTF``                 PLCA RS parameters
284  ``ETHTOOL_MSG_MM_GET_REPLY``             MAC merge layer status
285  ``ETHTOOL_MSG_MODULE_FW_FLASH_NTF``      transceiver module flash updates
286  ======================================== =================================
287
288``GET`` requests are sent by userspace applications to retrieve device
289information. They usually do not contain any message specific attributes.
290Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET``
291request with ``NLM_F_DUMP`` and no device identification can be used to query
292the information for all devices supporting the request.
293
294If the data can be also modified, corresponding ``SET`` message with the same
295layout as corresponding ``GET_REPLY`` is used to request changes. Only
296attributes where a change is requested are included in such request (also, not
297all attributes may be changed). Replies to most ``SET`` request consist only
298of error code and extack; if kernel provides additional data, it is sent in
299the form of corresponding ``SET_REPLY`` message which can be suppressed by
300setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header.
301
302Data modification also triggers sending a ``NTF`` message with a notification.
303These usually bear only a subset of attributes which was affected by the
304change. The same notification is issued if the data is modified using other
305means (mostly ioctl ethtool interface). Unlike notifications from ethtool
306netlink code which are only sent if something actually changed, notifications
307triggered by ioctl interface may be sent even if the request did not actually
308change any data.
309
310``ACT`` messages request kernel (driver) to perform a specific action. If some
311information is reported by kernel (which can be suppressed by setting
312``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of
313an ``ACT_REPLY`` message. Performing an action also triggers a notification
314(``NTF`` message).
315
316Later sections describe the format and semantics of these messages.
317
318
319STRSET_GET
320==========
321
322Requests contents of a string set as provided by ioctl commands
323``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user
324writeable so that the corresponding ``STRSET_SET`` message is only used in
325kernel replies. There are two types of string sets: global (independent of
326a device, e.g. device feature names) and device specific (e.g. device private
327flags).
328
329Request contents:
330
331 +---------------------------------------+--------+------------------------+
332 | ``ETHTOOL_A_STRSET_HEADER``           | nested | request header         |
333 +---------------------------------------+--------+------------------------+
334 | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | string set to request  |
335 +-+-------------------------------------+--------+------------------------+
336 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set         |
337 +-+-+-----------------------------------+--------+------------------------+
338 | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                 |
339 +-+-+-----------------------------------+--------+------------------------+
340
341Kernel response contents:
342
343 +---------------------------------------+--------+-----------------------+
344 | ``ETHTOOL_A_STRSET_HEADER``           | nested | reply header          |
345 +---------------------------------------+--------+-----------------------+
346 | ``ETHTOOL_A_STRSET_STRINGSETS``       | nested | array of string sets  |
347 +-+-------------------------------------+--------+-----------------------+
348 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set        |
349 +-+-+-----------------------------------+--------+-----------------------+
350 | | | ``ETHTOOL_A_STRINGSET_ID``        | u32    | set id                |
351 +-+-+-----------------------------------+--------+-----------------------+
352 | | | ``ETHTOOL_A_STRINGSET_COUNT``     | u32    | number of strings     |
353 +-+-+-----------------------------------+--------+-----------------------+
354 | | | ``ETHTOOL_A_STRINGSET_STRINGS``   | nested | array of strings      |
355 +-+-+-+---------------------------------+--------+-----------------------+
356 | | | | ``ETHTOOL_A_STRINGS_STRING+``   | nested | one string            |
357 +-+-+-+-+-------------------------------+--------+-----------------------+
358 | | | | | ``ETHTOOL_A_STRING_INDEX``    | u32    | string index          |
359 +-+-+-+-+-------------------------------+--------+-----------------------+
360 | | | | | ``ETHTOOL_A_STRING_VALUE``    | string | string value          |
361 +-+-+-+-+-------------------------------+--------+-----------------------+
362 | ``ETHTOOL_A_STRSET_COUNTS_ONLY``      | flag   | return only counts    |
363 +---------------------------------------+--------+-----------------------+
364
365Device identification in request header is optional. Depending on its presence
366a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests:
367
368 - no ``NLM_F_DUMP,`` no device: get "global" stringsets
369 - no ``NLM_F_DUMP``, with device: get string sets related to the device
370 - ``NLM_F_DUMP``, no device: get device related string sets for all devices
371
372If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of
373requested type are returned, otherwise only those specified in the request.
374Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string
375counts of the sets, not the actual strings.
376
377
378LINKINFO_GET
379============
380
381Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for
382link modes and autonegotiation related information. The request does not use
383any attributes.
384
385Request contents:
386
387  ====================================  ======  ==========================
388  ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
389  ====================================  ======  ==========================
390
391Kernel response contents:
392
393  ====================================  ======  ==========================
394  ``ETHTOOL_A_LINKINFO_HEADER``         nested  reply header
395  ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
396  ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
397  ``ETHTOOL_A_LINKINFO_TP_MDIX``        u8      MDI(-X) status
398  ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
399  ``ETHTOOL_A_LINKINFO_TRANSCEIVER``    u8      transceiver
400  ====================================  ======  ==========================
401
402Attributes and their values have the same meaning as matching members of the
403corresponding ioctl structures.
404
405``LINKINFO_GET`` allows dump requests (kernel returns reply message for all
406devices supporting the request).
407
408
409LINKINFO_SET
410============
411
412``LINKINFO_SET`` request allows setting some of the attributes reported by
413``LINKINFO_GET``.
414
415Request contents:
416
417  ====================================  ======  ==========================
418  ``ETHTOOL_A_LINKINFO_HEADER``         nested  request header
419  ``ETHTOOL_A_LINKINFO_PORT``           u8      physical port
420  ``ETHTOOL_A_LINKINFO_PHYADDR``        u8      phy MDIO address
421  ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL``   u8      MDI(-X) control
422  ====================================  ======  ==========================
423
424MDI(-X) status and transceiver cannot be set, request with the corresponding
425attributes is rejected.
426
427
428LINKMODES_GET
429=============
430
431Requests link modes (supported, advertised and peer advertised) and related
432information (autonegotiation status, link speed and duplex) as provided by
433``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes.
434
435Request contents:
436
437  ====================================  ======  ==========================
438  ``ETHTOOL_A_LINKMODES_HEADER``        nested  request header
439  ====================================  ======  ==========================
440
441Kernel response contents:
442
443  ==========================================  ======  ==========================
444  ``ETHTOOL_A_LINKMODES_HEADER``              nested  reply header
445  ``ETHTOOL_A_LINKMODES_AUTONEG``             u8      autonegotiation status
446  ``ETHTOOL_A_LINKMODES_OURS``                bitset  advertised link modes
447  ``ETHTOOL_A_LINKMODES_PEER``                bitset  partner link modes
448  ``ETHTOOL_A_LINKMODES_SPEED``               u32     link speed (Mb/s)
449  ``ETHTOOL_A_LINKMODES_DUPLEX``              u8      duplex mode
450  ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG``    u8      Master/slave port mode
451  ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_STATE``  u8      Master/slave port state
452  ``ETHTOOL_A_LINKMODES_RATE_MATCHING``       u8      PHY rate matching
453  ==========================================  ======  ==========================
454
455For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask
456represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit
457list.
458
459``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all
460devices supporting the request).
461
462
463LINKMODES_SET
464=============
465
466Request contents:
467
468  ==========================================  ======  ==========================
469  ``ETHTOOL_A_LINKMODES_HEADER``              nested  request header
470  ``ETHTOOL_A_LINKMODES_AUTONEG``             u8      autonegotiation status
471  ``ETHTOOL_A_LINKMODES_OURS``                bitset  advertised link modes
472  ``ETHTOOL_A_LINKMODES_PEER``                bitset  partner link modes
473  ``ETHTOOL_A_LINKMODES_SPEED``               u32     link speed (Mb/s)
474  ``ETHTOOL_A_LINKMODES_DUPLEX``              u8      duplex mode
475  ``ETHTOOL_A_LINKMODES_MASTER_SLAVE_CFG``    u8      Master/slave port mode
476  ``ETHTOOL_A_LINKMODES_RATE_MATCHING``       u8      PHY rate matching
477  ``ETHTOOL_A_LINKMODES_LANES``               u32     lanes
478  ==========================================  ======  ==========================
479
480``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If
481autonegotiation is on (either set now or kept from before), advertised modes
482are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one
483of speed, duplex and lanes is specified, kernel adjusts advertised modes to all
484supported modes matching speed, duplex, lanes or all (whatever is specified).
485This autoselection is done on ethtool side with ioctl interface, netlink
486interface is supposed to allow requesting changes without knowing what exactly
487kernel supports.
488
489
490LINKSTATE_GET
491=============
492
493Requests link state information. Link up/down flag (as provided by
494``ETHTOOL_GLINK`` ioctl command) is provided. Optionally, extended state might
495be provided as well. In general, extended state describes reasons for why a port
496is down, or why it operates in some non-obvious mode. This request does not have
497any attributes.
498
499Request contents:
500
501  ====================================  ======  ==========================
502  ``ETHTOOL_A_LINKSTATE_HEADER``        nested  request header
503  ====================================  ======  ==========================
504
505Kernel response contents:
506
507  ====================================  ======  ============================
508  ``ETHTOOL_A_LINKSTATE_HEADER``        nested  reply header
509  ``ETHTOOL_A_LINKSTATE_LINK``          bool    link state (up/down)
510  ``ETHTOOL_A_LINKSTATE_SQI``           u32     Current Signal Quality Index
511  ``ETHTOOL_A_LINKSTATE_SQI_MAX``       u32     Max support SQI value
512  ``ETHTOOL_A_LINKSTATE_EXT_STATE``     u8      link extended state
513  ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``  u8      link extended substate
514  ``ETHTOOL_A_LINKSTATE_EXT_DOWN_CNT``  u32     count of link down events
515  ====================================  ======  ============================
516
517For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns
518carrier flag provided by ``netif_carrier_ok()`` but there are drivers which
519define their own handler.
520
521``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE`` are
522optional values. ethtool core can provide either both
523``ETHTOOL_A_LINKSTATE_EXT_STATE`` and ``ETHTOOL_A_LINKSTATE_EXT_SUBSTATE``,
524or only ``ETHTOOL_A_LINKSTATE_EXT_STATE``, or none of them.
525
526``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all
527devices supporting the request).
528
529
530Link extended states:
531
532  ================================================      ============================================
533  ``ETHTOOL_LINK_EXT_STATE_AUTONEG``                    States relating to the autonegotiation or
534                                                        issues therein
535
536  ``ETHTOOL_LINK_EXT_STATE_LINK_TRAINING_FAILURE``      Failure during link training
537
538  ``ETHTOOL_LINK_EXT_STATE_LINK_LOGICAL_MISMATCH``      Logical mismatch in physical coding sublayer
539                                                        or forward error correction sublayer
540
541  ``ETHTOOL_LINK_EXT_STATE_BAD_SIGNAL_INTEGRITY``       Signal integrity issues
542
543  ``ETHTOOL_LINK_EXT_STATE_NO_CABLE``                   No cable connected
544
545  ``ETHTOOL_LINK_EXT_STATE_CABLE_ISSUE``                Failure is related to cable,
546                                                        e.g., unsupported cable
547
548  ``ETHTOOL_LINK_EXT_STATE_EEPROM_ISSUE``               Failure is related to EEPROM, e.g., failure
549                                                        during reading or parsing the data
550
551  ``ETHTOOL_LINK_EXT_STATE_CALIBRATION_FAILURE``        Failure during calibration algorithm
552
553  ``ETHTOOL_LINK_EXT_STATE_POWER_BUDGET_EXCEEDED``      The hardware is not able to provide the
554                                                        power required from cable or module
555
556  ``ETHTOOL_LINK_EXT_STATE_OVERHEAT``                   The module is overheated
557
558  ``ETHTOOL_LINK_EXT_STATE_MODULE``                     Transceiver module issue
559  ================================================      ============================================
560
561Link extended substates:
562
563  Autoneg substates:
564
565  ===============================================================   ================================
566  ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED``              Peer side is down
567
568  ``ETHTOOL_LINK_EXT_SUBSTATE_AN_ACK_NOT_RECEIVED``                 Ack not received from peer side
569
570  ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NEXT_PAGE_EXCHANGE_FAILED``        Next page exchange failed
571
572  ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_PARTNER_DETECTED_FORCE_MODE``   Peer side is down during force
573                                                                    mode or there is no agreement of
574                                                                    speed
575
576  ``ETHTOOL_LINK_EXT_SUBSTATE_AN_FEC_MISMATCH_DURING_OVERRIDE``     Forward error correction modes
577                                                                    in both sides are mismatched
578
579  ``ETHTOOL_LINK_EXT_SUBSTATE_AN_NO_HCD``                           No Highest Common Denominator
580  ===============================================================   ================================
581
582  Link training substates:
583
584  ===========================================================================   ====================
585  ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_FRAME_LOCK_NOT_ACQUIRED``                    Frames were not
586                                                                                 recognized, the
587                                                                                 lock failed
588
589  ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_INHIBIT_TIMEOUT``                       The lock did not
590                                                                                 occur before
591                                                                                 timeout
592
593  ``ETHTOOL_LINK_EXT_SUBSTATE_LT_KR_LINK_PARTNER_DID_NOT_SET_RECEIVER_READY``    Peer side did not
594                                                                                 send ready signal
595                                                                                 after training
596                                                                                 process
597
598  ``ETHTOOL_LINK_EXT_SUBSTATE_LT_REMOTE_FAULT``                                  Remote side is not
599                                                                                 ready yet
600  ===========================================================================   ====================
601
602  Link logical mismatch substates:
603
604  ================================================================   ===============================
605  ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_BLOCK_LOCK``   Physical coding sublayer was
606                                                                     not locked in first phase -
607                                                                     block lock
608
609  ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_ACQUIRE_AM_LOCK``      Physical coding sublayer was
610                                                                     not locked in second phase -
611                                                                     alignment markers lock
612
613  ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_PCS_DID_NOT_GET_ALIGN_STATUS``     Physical coding sublayer did
614                                                                     not get align status
615
616  ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_FC_FEC_IS_NOT_LOCKED``             FC forward error correction is
617                                                                     not locked
618
619  ``ETHTOOL_LINK_EXT_SUBSTATE_LLM_RS_FEC_IS_NOT_LOCKED``             RS forward error correction is
620                                                                     not locked
621  ================================================================   ===============================
622
623  Bad signal integrity substates:
624
625  =================================================================    =============================
626  ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_LARGE_NUMBER_OF_PHYSICAL_ERRORS``    Large number of physical
627                                                                       errors
628
629  ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_UNSUPPORTED_RATE``                   The system attempted to
630                                                                       operate the cable at a rate
631                                                                       that is not formally
632                                                                       supported, which led to
633                                                                       signal integrity issues
634
635  ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_REFERENCE_CLOCK_LOST``        The external clock signal for
636                                                                       SerDes is too weak or
637                                                                       unavailable.
638
639  ``ETHTOOL_LINK_EXT_SUBSTATE_BSI_SERDES_ALOS``                        The received signal for
640                                                                       SerDes is too weak because
641                                                                       analog loss of signal.
642  =================================================================    =============================
643
644  Cable issue substates:
645
646  ===================================================   ============================================
647  ``ETHTOOL_LINK_EXT_SUBSTATE_CI_UNSUPPORTED_CABLE``    Unsupported cable
648
649  ``ETHTOOL_LINK_EXT_SUBSTATE_CI_CABLE_TEST_FAILURE``   Cable test failure
650  ===================================================   ============================================
651
652  Transceiver module issue substates:
653
654  ===================================================   ============================================
655  ``ETHTOOL_LINK_EXT_SUBSTATE_MODULE_CMIS_NOT_READY``   The CMIS Module State Machine did not reach
656                                                        the ModuleReady state. For example, if the
657                                                        module is stuck at ModuleFault state
658  ===================================================   ============================================
659
660DEBUG_GET
661=========
662
663Requests debugging settings of a device. At the moment, only message mask is
664provided.
665
666Request contents:
667
668  ====================================  ======  ==========================
669  ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
670  ====================================  ======  ==========================
671
672Kernel response contents:
673
674  ====================================  ======  ==========================
675  ``ETHTOOL_A_DEBUG_HEADER``            nested  reply header
676  ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
677  ====================================  ======  ==========================
678
679The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as
680provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl
681interface. While it is called message level there for historical reasons, most
682drivers and almost all newer drivers use it as a mask of enabled message
683classes (represented by ``NETIF_MSG_*`` constants); therefore netlink
684interface follows its actual use in practice.
685
686``DEBUG_GET`` allows dump requests (kernel returns reply messages for all
687devices supporting the request).
688
689
690DEBUG_SET
691=========
692
693Set or update debugging settings of a device. At the moment, only message mask
694is supported.
695
696Request contents:
697
698  ====================================  ======  ==========================
699  ``ETHTOOL_A_DEBUG_HEADER``            nested  request header
700  ``ETHTOOL_A_DEBUG_MSGMASK``           bitset  message mask
701  ====================================  ======  ==========================
702
703``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of
704enabled debugging message types for the device.
705
706
707WOL_GET
708=======
709
710Query device wake-on-lan settings. Unlike most "GET" type requests,
711``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it
712(potentially) provides SecureOn(tm) password which is confidential.
713
714Request contents:
715
716  ====================================  ======  ==========================
717  ``ETHTOOL_A_WOL_HEADER``              nested  request header
718  ====================================  ======  ==========================
719
720Kernel response contents:
721
722  ====================================  ======  ==========================
723  ``ETHTOOL_A_WOL_HEADER``              nested  reply header
724  ``ETHTOOL_A_WOL_MODES``               bitset  mask of enabled WoL modes
725  ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
726  ====================================  ======  ==========================
727
728In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the
729device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only
730included in reply if ``WAKE_MAGICSECURE`` mode is supported.
731
732
733WOL_SET
734=======
735
736Set or update wake-on-lan settings.
737
738Request contents:
739
740  ====================================  ======  ==========================
741  ``ETHTOOL_A_WOL_HEADER``              nested  request header
742  ``ETHTOOL_A_WOL_MODES``               bitset  enabled WoL modes
743  ``ETHTOOL_A_WOL_SOPASS``              binary  SecureOn(tm) password
744  ====================================  ======  ==========================
745
746``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting
747``WAKE_MAGICSECURE`` mode.
748
749
750FEATURES_GET
751============
752
753Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request.
754
755Request contents:
756
757  ====================================  ======  ==========================
758  ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
759  ====================================  ======  ==========================
760
761Kernel response contents:
762
763  ====================================  ======  ==========================
764  ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
765  ``ETHTOOL_A_FEATURES_HW``             bitset  dev->hw_features
766  ``ETHTOOL_A_FEATURES_WANTED``         bitset  dev->wanted_features
767  ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  dev->features
768  ``ETHTOOL_A_FEATURES_NOCHANGE``       bitset  NETIF_F_NEVER_CHANGE
769  ====================================  ======  ==========================
770
771Bitmaps in kernel response have the same meaning as bitmaps used in ioctl
772interference but attribute names are different (they are based on
773corresponding members of struct net_device). Legacy "flags" are not provided,
774if userspace needs them (most likely only ethtool for backward compatibility),
775it can calculate their values from related feature bits itself.
776ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to
777provide all names when using verbose bitmap format), the other three use no
778mask (simple bit lists).
779
780
781FEATURES_SET
782============
783
784Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request.
785
786Request contents:
787
788  ====================================  ======  ==========================
789  ``ETHTOOL_A_FEATURES_HEADER``         nested  request header
790  ``ETHTOOL_A_FEATURES_WANTED``         bitset  requested features
791  ====================================  ======  ==========================
792
793Kernel response contents:
794
795  ====================================  ======  ==========================
796  ``ETHTOOL_A_FEATURES_HEADER``         nested  reply header
797  ``ETHTOOL_A_FEATURES_WANTED``         bitset  diff wanted vs. result
798  ``ETHTOOL_A_FEATURES_ACTIVE``         bitset  diff old vs. new active
799  ====================================  ======  ==========================
800
801Request contains only one bitset which can be either value/mask pair (request
802to change specific feature bits and leave the rest) or only a value (request
803to set all features to specified set).
804
805As request is subject to netdev_change_features() sanity checks, optional
806kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request
807header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED``
808reports the difference between client request and actual result: mask consists
809of bits which differ between requested features and result (dev->features
810after the operation), value consists of values of these bits in the request
811(i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE``
812reports the difference between old and new dev->features: mask consists of
813bits which have changed, values are their values in new dev->features (after
814the operation).
815
816``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features
817are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl
818request but also each time features are modified with netdev_update_features()
819or netdev_change_features().
820
821
822PRIVFLAGS_GET
823=============
824
825Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request.
826
827Request contents:
828
829  ====================================  ======  ==========================
830  ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
831  ====================================  ======  ==========================
832
833Kernel response contents:
834
835  ====================================  ======  ==========================
836  ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  reply header
837  ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
838  ====================================  ======  ==========================
839
840``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags.
841These flags are defined by driver, their number and names (and also meaning)
842are device dependent. For compact bitset format, names can be retrieved as
843``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested,
844response uses all private flags supported by the device as mask so that client
845gets the full information without having to fetch the string set with names.
846
847
848PRIVFLAGS_SET
849=============
850
851Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS``
852ioctl request.
853
854Request contents:
855
856  ====================================  ======  ==========================
857  ``ETHTOOL_A_PRIVFLAGS_HEADER``        nested  request header
858  ``ETHTOOL_A_PRIVFLAGS_FLAGS``         bitset  private flags
859  ====================================  ======  ==========================
860
861``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or
862modify only values of some of them.
863
864
865RINGS_GET
866=========
867
868Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request.
869
870Request contents:
871
872  ====================================  ======  ==========================
873  ``ETHTOOL_A_RINGS_HEADER``            nested  request header
874  ====================================  ======  ==========================
875
876Kernel response contents:
877
878  =======================================   ======  ===========================
879  ``ETHTOOL_A_RINGS_HEADER``                nested  reply header
880  ``ETHTOOL_A_RINGS_RX_MAX``                u32     max size of RX ring
881  ``ETHTOOL_A_RINGS_RX_MINI_MAX``           u32     max size of RX mini ring
882  ``ETHTOOL_A_RINGS_RX_JUMBO_MAX``          u32     max size of RX jumbo ring
883  ``ETHTOOL_A_RINGS_TX_MAX``                u32     max size of TX ring
884  ``ETHTOOL_A_RINGS_RX``                    u32     size of RX ring
885  ``ETHTOOL_A_RINGS_RX_MINI``               u32     size of RX mini ring
886  ``ETHTOOL_A_RINGS_RX_JUMBO``              u32     size of RX jumbo ring
887  ``ETHTOOL_A_RINGS_TX``                    u32     size of TX ring
888  ``ETHTOOL_A_RINGS_RX_BUF_LEN``            u32     size of buffers on the ring
889  ``ETHTOOL_A_RINGS_TCP_DATA_SPLIT``        u8      TCP header / data split
890  ``ETHTOOL_A_RINGS_CQE_SIZE``              u32     Size of TX/RX CQE
891  ``ETHTOOL_A_RINGS_TX_PUSH``               u8      flag of TX Push mode
892  ``ETHTOOL_A_RINGS_RX_PUSH``               u8      flag of RX Push mode
893  ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN``       u32     size of TX push buffer
894  ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN_MAX``   u32     max size of TX push buffer
895  =======================================   ======  ===========================
896
897``ETHTOOL_A_RINGS_TCP_DATA_SPLIT`` indicates whether the device is usable with
898page-flipping TCP zero-copy receive (``getsockopt(TCP_ZEROCOPY_RECEIVE)``).
899If enabled the device is configured to place frame headers and data into
900separate buffers. The device configuration must make it possible to receive
901full memory pages of data, for example because MTU is high enough or through
902HW-GRO.
903
904``ETHTOOL_A_RINGS_[RX|TX]_PUSH`` flag is used to enable descriptor fast
905path to send or receive packets. In ordinary path, driver fills descriptors in DRAM and
906notifies NIC hardware. In fast path, driver pushes descriptors to the device
907through MMIO writes, thus reducing the latency. However, enabling this feature
908may increase the CPU cost. Drivers may enforce additional per-packet
909eligibility checks (e.g. on packet size).
910
911``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN`` specifies the maximum number of bytes of a
912transmitted packet a driver can push directly to the underlying device
913('push' mode). Pushing some of the payload bytes to the device has the
914advantages of reducing latency for small packets by avoiding DMA mapping (same
915as ``ETHTOOL_A_RINGS_TX_PUSH`` parameter) as well as allowing the underlying
916device to process packet headers ahead of fetching its payload.
917This can help the device to make fast actions based on the packet's headers.
918This is similar to the "tx-copybreak" parameter, which copies the packet to a
919preallocated DMA memory area instead of mapping new memory. However,
920tx-push-buff parameter copies the packet directly to the device to allow the
921device to take faster actions on the packet.
922
923RINGS_SET
924=========
925
926Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request.
927
928Request contents:
929
930  ====================================  ======  ===========================
931  ``ETHTOOL_A_RINGS_HEADER``            nested  reply header
932  ``ETHTOOL_A_RINGS_RX``                u32     size of RX ring
933  ``ETHTOOL_A_RINGS_RX_MINI``           u32     size of RX mini ring
934  ``ETHTOOL_A_RINGS_RX_JUMBO``          u32     size of RX jumbo ring
935  ``ETHTOOL_A_RINGS_TX``                u32     size of TX ring
936  ``ETHTOOL_A_RINGS_RX_BUF_LEN``        u32     size of buffers on the ring
937  ``ETHTOOL_A_RINGS_CQE_SIZE``          u32     Size of TX/RX CQE
938  ``ETHTOOL_A_RINGS_TX_PUSH``           u8      flag of TX Push mode
939  ``ETHTOOL_A_RINGS_RX_PUSH``           u8      flag of RX Push mode
940  ``ETHTOOL_A_RINGS_TX_PUSH_BUF_LEN``   u32     size of TX push buffer
941  ====================================  ======  ===========================
942
943Kernel checks that requested ring sizes do not exceed limits reported by
944driver. Driver may impose additional constraints and may not support all
945attributes.
946
947
948``ETHTOOL_A_RINGS_CQE_SIZE`` specifies the completion queue event size.
949Completion queue events (CQE) are the events posted by NIC to indicate the
950completion status of a packet when the packet is sent (like send success or
951error) or received (like pointers to packet fragments). The CQE size parameter
952enables to modify the CQE size other than default size if NIC supports it.
953A bigger CQE can have more receive buffer pointers, and in turn the NIC can
954transfer a bigger frame from wire. Based on the NIC hardware, the overall
955completion queue size can be adjusted in the driver if CQE size is modified.
956
957CHANNELS_GET
958============
959
960Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request.
961
962Request contents:
963
964  ====================================  ======  ==========================
965  ``ETHTOOL_A_CHANNELS_HEADER``         nested  request header
966  ====================================  ======  ==========================
967
968Kernel response contents:
969
970  =====================================  ======  ==========================
971  ``ETHTOOL_A_CHANNELS_HEADER``          nested  reply header
972  ``ETHTOOL_A_CHANNELS_RX_MAX``          u32     max receive channels
973  ``ETHTOOL_A_CHANNELS_TX_MAX``          u32     max transmit channels
974  ``ETHTOOL_A_CHANNELS_OTHER_MAX``       u32     max other channels
975  ``ETHTOOL_A_CHANNELS_COMBINED_MAX``    u32     max combined channels
976  ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
977  ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
978  ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
979  ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
980  =====================================  ======  ==========================
981
982
983CHANNELS_SET
984============
985
986Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request.
987
988Request contents:
989
990  =====================================  ======  ==========================
991  ``ETHTOOL_A_CHANNELS_HEADER``          nested  request header
992  ``ETHTOOL_A_CHANNELS_RX_COUNT``        u32     receive channel count
993  ``ETHTOOL_A_CHANNELS_TX_COUNT``        u32     transmit channel count
994  ``ETHTOOL_A_CHANNELS_OTHER_COUNT``     u32     other channel count
995  ``ETHTOOL_A_CHANNELS_COMBINED_COUNT``  u32     combined channel count
996  =====================================  ======  ==========================
997
998Kernel checks that requested channel counts do not exceed limits reported by
999driver. Driver may impose additional constraints and may not support all
1000attributes.
1001
1002
1003COALESCE_GET
1004============
1005
1006Gets coalescing parameters like ``ETHTOOL_GCOALESCE`` ioctl request.
1007
1008Request contents:
1009
1010  ====================================  ======  ==========================
1011  ``ETHTOOL_A_COALESCE_HEADER``         nested  request header
1012  ====================================  ======  ==========================
1013
1014Kernel response contents:
1015
1016  ===========================================  ======  =======================
1017  ``ETHTOOL_A_COALESCE_HEADER``                nested  reply header
1018  ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
1019  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
1020  ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
1021  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
1022  ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
1023  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
1024  ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
1025  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
1026  ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
1027  ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
1028  ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
1029  ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
1030  ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
1031  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
1032  ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
1033  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
1034  ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
1035  ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
1036  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
1037  ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
1038  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
1039  ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
1040  ``ETHTOOL_A_COALESCE_USE_CQE_TX``            bool    timer reset mode, Tx
1041  ``ETHTOOL_A_COALESCE_USE_CQE_RX``            bool    timer reset mode, Rx
1042  ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES``     u32     max aggr size, Tx
1043  ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES``    u32     max aggr packets, Tx
1044  ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS``    u32     time (us), aggr, Tx
1045  ``ETHTOOL_A_COALESCE_RX_PROFILE``            nested  profile of DIM, Rx
1046  ``ETHTOOL_A_COALESCE_TX_PROFILE``            nested  profile of DIM, Tx
1047  ===========================================  ======  =======================
1048
1049Attributes are only included in reply if their value is not zero or the
1050corresponding bit in ``ethtool_ops::supported_coalesce_params`` is set (i.e.
1051they are declared as supported by driver).
1052
1053Timer reset mode (``ETHTOOL_A_COALESCE_USE_CQE_TX`` and
1054``ETHTOOL_A_COALESCE_USE_CQE_RX``) controls the interaction between packet
1055arrival and the various time based delay parameters. By default timers are
1056expected to limit the max delay between any packet arrival/departure and a
1057corresponding interrupt. In this mode timer should be started by packet
1058arrival (sometimes delivery of previous interrupt) and reset when interrupt
1059is delivered.
1060Setting the appropriate attribute to 1 will enable ``CQE`` mode, where
1061each packet event resets the timer. In this mode timer is used to force
1062the interrupt if queue goes idle, while busy queues depend on the packet
1063limit to trigger interrupts.
1064
1065Tx aggregation consists of copying frames into a contiguous buffer so that they
1066can be submitted as a single IO operation. ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES``
1067describes the maximum size in bytes for the submitted buffer.
1068``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES`` describes the maximum number of frames
1069that can be aggregated into a single buffer.
1070``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS`` describes the amount of time in usecs,
1071counted since the first packet arrival in an aggregated block, after which the
1072block should be sent.
1073This feature is mainly of interest for specific USB devices which does not cope
1074well with frequent small-sized URBs transmissions.
1075
1076``ETHTOOL_A_COALESCE_RX_PROFILE`` and ``ETHTOOL_A_COALESCE_TX_PROFILE`` refer
1077to DIM parameters, see `Generic Network Dynamic Interrupt Moderation (Net DIM)
1078<https://www.kernel.org/doc/Documentation/networking/net_dim.rst>`_.
1079
1080COALESCE_SET
1081============
1082
1083Sets coalescing parameters like ``ETHTOOL_SCOALESCE`` ioctl request.
1084
1085Request contents:
1086
1087  ===========================================  ======  =======================
1088  ``ETHTOOL_A_COALESCE_HEADER``                nested  request header
1089  ``ETHTOOL_A_COALESCE_RX_USECS``              u32     delay (us), normal Rx
1090  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES``         u32     max packets, normal Rx
1091  ``ETHTOOL_A_COALESCE_RX_USECS_IRQ``          u32     delay (us), Rx in IRQ
1092  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_IRQ``     u32     max packets, Rx in IRQ
1093  ``ETHTOOL_A_COALESCE_TX_USECS``              u32     delay (us), normal Tx
1094  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES``         u32     max packets, normal Tx
1095  ``ETHTOOL_A_COALESCE_TX_USECS_IRQ``          u32     delay (us), Tx in IRQ
1096  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_IRQ``     u32     IRQ packets, Tx in IRQ
1097  ``ETHTOOL_A_COALESCE_STATS_BLOCK_USECS``     u32     delay of stats update
1098  ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_RX``       bool    adaptive Rx coalesce
1099  ``ETHTOOL_A_COALESCE_USE_ADAPTIVE_TX``       bool    adaptive Tx coalesce
1100  ``ETHTOOL_A_COALESCE_PKT_RATE_LOW``          u32     threshold for low rate
1101  ``ETHTOOL_A_COALESCE_RX_USECS_LOW``          u32     delay (us), low Rx
1102  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_LOW``     u32     max packets, low Rx
1103  ``ETHTOOL_A_COALESCE_TX_USECS_LOW``          u32     delay (us), low Tx
1104  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_LOW``     u32     max packets, low Tx
1105  ``ETHTOOL_A_COALESCE_PKT_RATE_HIGH``         u32     threshold for high rate
1106  ``ETHTOOL_A_COALESCE_RX_USECS_HIGH``         u32     delay (us), high Rx
1107  ``ETHTOOL_A_COALESCE_RX_MAX_FRAMES_HIGH``    u32     max packets, high Rx
1108  ``ETHTOOL_A_COALESCE_TX_USECS_HIGH``         u32     delay (us), high Tx
1109  ``ETHTOOL_A_COALESCE_TX_MAX_FRAMES_HIGH``    u32     max packets, high Tx
1110  ``ETHTOOL_A_COALESCE_RATE_SAMPLE_INTERVAL``  u32     rate sampling interval
1111  ``ETHTOOL_A_COALESCE_USE_CQE_TX``            bool    timer reset mode, Tx
1112  ``ETHTOOL_A_COALESCE_USE_CQE_RX``            bool    timer reset mode, Rx
1113  ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_BYTES``     u32     max aggr size, Tx
1114  ``ETHTOOL_A_COALESCE_TX_AGGR_MAX_FRAMES``    u32     max aggr packets, Tx
1115  ``ETHTOOL_A_COALESCE_TX_AGGR_TIME_USECS``    u32     time (us), aggr, Tx
1116  ``ETHTOOL_A_COALESCE_RX_PROFILE``            nested  profile of DIM, Rx
1117  ``ETHTOOL_A_COALESCE_TX_PROFILE``            nested  profile of DIM, Tx
1118  ===========================================  ======  =======================
1119
1120Request is rejected if it attributes declared as unsupported by driver (i.e.
1121such that the corresponding bit in ``ethtool_ops::supported_coalesce_params``
1122is not set), regardless of their values. Driver may impose additional
1123constraints on coalescing parameters and their values.
1124
1125Compared to requests issued via the ``ioctl()`` netlink version of this request
1126will try harder to make sure that values specified by the user have been applied
1127and may call the driver twice.
1128
1129
1130PAUSE_GET
1131=========
1132
1133Gets pause frame settings like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1134
1135Request contents:
1136
1137  =====================================  ======  ==========================
1138  ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
1139  ``ETHTOOL_A_PAUSE_STATS_SRC``          u32     source of statistics
1140  =====================================  ======  ==========================
1141
1142``ETHTOOL_A_PAUSE_STATS_SRC`` is optional. It takes values from:
1143
1144.. kernel-doc:: include/uapi/linux/ethtool.h
1145    :identifiers: ethtool_mac_stats_src
1146
1147If absent from the request, stats will be provided with
1148an ``ETHTOOL_A_PAUSE_STATS_SRC`` attribute in the response equal to
1149``ETHTOOL_MAC_STATS_SRC_AGGREGATE``.
1150
1151Kernel response contents:
1152
1153  =====================================  ======  ==========================
1154  ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
1155  ``ETHTOOL_A_PAUSE_AUTONEG``            bool    pause autonegotiation
1156  ``ETHTOOL_A_PAUSE_RX``                 bool    receive pause frames
1157  ``ETHTOOL_A_PAUSE_TX``                 bool    transmit pause frames
1158  ``ETHTOOL_A_PAUSE_STATS``              nested  pause statistics
1159  =====================================  ======  ==========================
1160
1161``ETHTOOL_A_PAUSE_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set
1162in ``ETHTOOL_A_HEADER_FLAGS``.
1163It will be empty if driver did not report any statistics. Drivers fill in
1164the statistics in the following structure:
1165
1166.. kernel-doc:: include/linux/ethtool.h
1167    :identifiers: ethtool_pause_stats
1168
1169Each member has a corresponding attribute defined.
1170
1171PAUSE_SET
1172=========
1173
1174Sets pause parameters like ``ETHTOOL_GPAUSEPARAM`` ioctl request.
1175
1176Request contents:
1177
1178  =====================================  ======  ==========================
1179  ``ETHTOOL_A_PAUSE_HEADER``             nested  request header
1180  ``ETHTOOL_A_PAUSE_AUTONEG``            bool    pause autonegotiation
1181  ``ETHTOOL_A_PAUSE_RX``                 bool    receive pause frames
1182  ``ETHTOOL_A_PAUSE_TX``                 bool    transmit pause frames
1183  =====================================  ======  ==========================
1184
1185
1186EEE_GET
1187=======
1188
1189Gets Energy Efficient Ethernet settings like ``ETHTOOL_GEEE`` ioctl request.
1190
1191Request contents:
1192
1193  =====================================  ======  ==========================
1194  ``ETHTOOL_A_EEE_HEADER``               nested  request header
1195  =====================================  ======  ==========================
1196
1197Kernel response contents:
1198
1199  =====================================  ======  ==========================
1200  ``ETHTOOL_A_EEE_HEADER``               nested  request header
1201  ``ETHTOOL_A_EEE_MODES_OURS``           bool    supported/advertised modes
1202  ``ETHTOOL_A_EEE_MODES_PEER``           bool    peer advertised link modes
1203  ``ETHTOOL_A_EEE_ACTIVE``               bool    EEE is actively used
1204  ``ETHTOOL_A_EEE_ENABLED``              bool    EEE is enabled
1205  ``ETHTOOL_A_EEE_TX_LPI_ENABLED``       bool    Tx lpi enabled
1206  ``ETHTOOL_A_EEE_TX_LPI_TIMER``         u32     Tx lpi timeout (in us)
1207  =====================================  ======  ==========================
1208
1209In ``ETHTOOL_A_EEE_MODES_OURS``, mask consists of link modes for which EEE is
1210enabled, value of link modes for which EEE is advertised. Link modes for which
1211peer advertises EEE are listed in ``ETHTOOL_A_EEE_MODES_PEER`` (no mask). The
1212netlink interface allows reporting EEE status for all link modes but only
1213first 32 are provided by the ``ethtool_ops`` callback.
1214
1215
1216EEE_SET
1217=======
1218
1219Sets Energy Efficient Ethernet parameters like ``ETHTOOL_SEEE`` ioctl request.
1220
1221Request contents:
1222
1223  =====================================  ======  ==========================
1224  ``ETHTOOL_A_EEE_HEADER``               nested  request header
1225  ``ETHTOOL_A_EEE_MODES_OURS``           bool    advertised modes
1226  ``ETHTOOL_A_EEE_ENABLED``              bool    EEE is enabled
1227  ``ETHTOOL_A_EEE_TX_LPI_ENABLED``       bool    Tx lpi enabled
1228  ``ETHTOOL_A_EEE_TX_LPI_TIMER``         u32     Tx lpi timeout (in us)
1229  =====================================  ======  ==========================
1230
1231``ETHTOOL_A_EEE_MODES_OURS`` is used to either list link modes to advertise
1232EEE for (if there is no mask) or specify changes to the list (if there is
1233a mask). The netlink interface allows reporting EEE status for all link modes
1234but only first 32 can be set at the moment as that is what the ``ethtool_ops``
1235callback supports.
1236
1237
1238TSINFO_GET
1239==========
1240
1241Gets timestamping information like ``ETHTOOL_GET_TS_INFO`` ioctl request.
1242
1243Request contents:
1244
1245  =====================================  ======  ==========================
1246  ``ETHTOOL_A_TSINFO_HEADER``            nested  request header
1247  =====================================  ======  ==========================
1248
1249Kernel response contents:
1250
1251  =====================================  ======  ==========================
1252  ``ETHTOOL_A_TSINFO_HEADER``            nested  request header
1253  ``ETHTOOL_A_TSINFO_TIMESTAMPING``      bitset  SO_TIMESTAMPING flags
1254  ``ETHTOOL_A_TSINFO_TX_TYPES``          bitset  supported Tx types
1255  ``ETHTOOL_A_TSINFO_RX_FILTERS``        bitset  supported Rx filters
1256  ``ETHTOOL_A_TSINFO_PHC_INDEX``         u32     PTP hw clock index
1257  ``ETHTOOL_A_TSINFO_STATS``             nested  HW timestamping statistics
1258  =====================================  ======  ==========================
1259
1260``ETHTOOL_A_TSINFO_PHC_INDEX`` is absent if there is no associated PHC (there
1261is no special value for this case). The bitset attributes are omitted if they
1262would be empty (no bit set).
1263
1264Additional hardware timestamping statistics response contents:
1265
1266  =====================================  ======  ===================================
1267  ``ETHTOOL_A_TS_STAT_TX_PKTS``          uint    Packets with Tx HW timestamps
1268  ``ETHTOOL_A_TS_STAT_TX_LOST``          uint    Tx HW timestamp not arrived count
1269  ``ETHTOOL_A_TS_STAT_TX_ERR``           uint    HW error request Tx timestamp count
1270  =====================================  ======  ===================================
1271
1272CABLE_TEST
1273==========
1274
1275Start a cable test.
1276
1277Request contents:
1278
1279  ====================================  ======  ==========================
1280  ``ETHTOOL_A_CABLE_TEST_HEADER``       nested  request header
1281  ====================================  ======  ==========================
1282
1283Notification contents:
1284
1285An Ethernet cable typically contains 1, 2 or 4 pairs. The length of
1286the pair can only be measured when there is a fault in the pair and
1287hence a reflection. Information about the fault may not be available,
1288depending on the specific hardware. Hence the contents of the notify
1289message are mostly optional. The attributes can be repeated an
1290arbitrary number of times, in an arbitrary order, for an arbitrary
1291number of pairs.
1292
1293The example shows the notification sent when the test is completed for
1294a T2 cable, i.e. two pairs. One pair is OK and hence has no length
1295information. The second pair has a fault and does have length
1296information.
1297
1298 +---------------------------------------------+--------+---------------------+
1299 | ``ETHTOOL_A_CABLE_TEST_HEADER``             | nested | reply header        |
1300 +---------------------------------------------+--------+---------------------+
1301 | ``ETHTOOL_A_CABLE_TEST_STATUS``             | u8     | completed           |
1302 +---------------------------------------------+--------+---------------------+
1303 | ``ETHTOOL_A_CABLE_TEST_NTF_NEST``           | nested | all the results     |
1304 +-+-------------------------------------------+--------+---------------------+
1305 | | ``ETHTOOL_A_CABLE_NEST_RESULT``           | nested | cable test result   |
1306 +-+-+-----------------------------------------+--------+---------------------+
1307 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number         |
1308 +-+-+-----------------------------------------+--------+---------------------+
1309 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE``        | u8     | result code         |
1310 +-+-+-----------------------------------------+--------+---------------------+
1311 | | ``ETHTOOL_A_CABLE_NEST_RESULT``           | nested | cable test results  |
1312 +-+-+-----------------------------------------+--------+---------------------+
1313 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number         |
1314 +-+-+-----------------------------------------+--------+---------------------+
1315 | | | ``ETHTOOL_A_CABLE_RESULTS_CODE``        | u8     | result code         |
1316 +-+-+-----------------------------------------+--------+---------------------+
1317 | | | ``ETHTOOL_A_CABLE_RESULT_SRC``          | u32    | information source  |
1318 +-+-+-----------------------------------------+--------+---------------------+
1319 | | ``ETHTOOL_A_CABLE_NEST_FAULT_LENGTH``     | nested | cable length        |
1320 +-+-+-----------------------------------------+--------+---------------------+
1321 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_PAIR``   | u8     | pair number         |
1322 +-+-+-----------------------------------------+--------+---------------------+
1323 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_CM``     | u32    | length in cm        |
1324 +-+-+-----------------------------------------+--------+---------------------+
1325 | | | ``ETHTOOL_A_CABLE_FAULT_LENGTH_SRC``    | u32    | information source  |
1326 +-+-+-----------------------------------------+--------+---------------------+
1327
1328
1329CABLE_TEST TDR
1330==============
1331
1332Start a cable test and report raw TDR data
1333
1334Request contents:
1335
1336 +--------------------------------------------+--------+-----------------------+
1337 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER``        | nested | reply header          |
1338 +--------------------------------------------+--------+-----------------------+
1339 | ``ETHTOOL_A_CABLE_TEST_TDR_CFG``           | nested | test configuration    |
1340 +-+------------------------------------------+--------+-----------------------+
1341 | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE``  | u32    | first data distance   |
1342 +-+-+----------------------------------------+--------+-----------------------+
1343 | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE``   | u32    | last data distance    |
1344 +-+-+----------------------------------------+--------+-----------------------+
1345 | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE``   | u32    | distance of each step |
1346 +-+-+----------------------------------------+--------+-----------------------+
1347 | | ``ETHTOOL_A_CABLE_TEST_TDR_CFG_PAIR``    | u8     | pair to test          |
1348 +-+-+----------------------------------------+--------+-----------------------+
1349
1350The ETHTOOL_A_CABLE_TEST_TDR_CFG is optional, as well as all members
1351of the nest. All distances are expressed in centimeters. The PHY takes
1352the distances as a guide, and rounds to the nearest distance it
1353actually supports. If a pair is passed, only that one pair will be
1354tested. Otherwise all pairs are tested.
1355
1356Notification contents:
1357
1358Raw TDR data is gathered by sending a pulse down the cable and
1359recording the amplitude of the reflected pulse for a given distance.
1360
1361It can take a number of seconds to collect TDR data, especial if the
1362full 100 meters is probed at 1 meter intervals. When the test is
1363started a notification will be sent containing just
1364ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1365ETHTOOL_A_CABLE_TEST_NTF_STATUS_STARTED.
1366
1367When the test has completed a second notification will be sent
1368containing ETHTOOL_A_CABLE_TEST_TDR_STATUS with the value
1369ETHTOOL_A_CABLE_TEST_NTF_STATUS_COMPLETED and the TDR data.
1370
1371The message may optionally contain the amplitude of the pulse send
1372down the cable. This is measured in mV. A reflection should not be
1373bigger than transmitted pulse.
1374
1375Before the raw TDR data should be an ETHTOOL_A_CABLE_TDR_NEST_STEP
1376nest containing information about the distance along the cable for the
1377first reading, the last reading, and the step between each
1378reading. Distances are measured in centimeters. These should be the
1379exact values the PHY used. These may be different to what the user
1380requested, if the native measurement resolution is greater than 1 cm.
1381
1382For each step along the cable, a ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE is
1383used to report the amplitude of the reflection for a given pair.
1384
1385 +---------------------------------------------+--------+----------------------+
1386 | ``ETHTOOL_A_CABLE_TEST_TDR_HEADER``         | nested | reply header         |
1387 +---------------------------------------------+--------+----------------------+
1388 | ``ETHTOOL_A_CABLE_TEST_TDR_STATUS``         | u8     | completed            |
1389 +---------------------------------------------+--------+----------------------+
1390 | ``ETHTOOL_A_CABLE_TEST_TDR_NTF_NEST``       | nested | all the results      |
1391 +-+-------------------------------------------+--------+----------------------+
1392 | | ``ETHTOOL_A_CABLE_TDR_NEST_PULSE``        | nested | TX Pulse amplitude   |
1393 +-+-+-----------------------------------------+--------+----------------------+
1394 | | | ``ETHTOOL_A_CABLE_PULSE_mV``            | s16    | Pulse amplitude      |
1395 +-+-+-----------------------------------------+--------+----------------------+
1396 | | ``ETHTOOL_A_CABLE_NEST_STEP``             | nested | TDR step info        |
1397 +-+-+-----------------------------------------+--------+----------------------+
1398 | | | ``ETHTOOL_A_CABLE_STEP_FIRST_DISTANCE`` | u32    | First data distance  |
1399 +-+-+-----------------------------------------+--------+----------------------+
1400 | | | ``ETHTOOL_A_CABLE_STEP_LAST_DISTANCE``  | u32    | Last data distance   |
1401 +-+-+-----------------------------------------+--------+----------------------+
1402 | | | ``ETHTOOL_A_CABLE_STEP_STEP_DISTANCE``  | u32    | distance of each step|
1403 +-+-+-----------------------------------------+--------+----------------------+
1404 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE``    | nested | Reflection amplitude |
1405 +-+-+-----------------------------------------+--------+----------------------+
1406 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number          |
1407 +-+-+-----------------------------------------+--------+----------------------+
1408 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV``        | s16    | Reflection amplitude |
1409 +-+-+-----------------------------------------+--------+----------------------+
1410 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE``    | nested | Reflection amplitude |
1411 +-+-+-----------------------------------------+--------+----------------------+
1412 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number          |
1413 +-+-+-----------------------------------------+--------+----------------------+
1414 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV``        | s16    | Reflection amplitude |
1415 +-+-+-----------------------------------------+--------+----------------------+
1416 | | ``ETHTOOL_A_CABLE_TDR_NEST_AMPLITUDE``    | nested | Reflection amplitude |
1417 +-+-+-----------------------------------------+--------+----------------------+
1418 | | | ``ETHTOOL_A_CABLE_RESULTS_PAIR``        | u8     | pair number          |
1419 +-+-+-----------------------------------------+--------+----------------------+
1420 | | | ``ETHTOOL_A_CABLE_AMPLITUDE_mV``        | s16    | Reflection amplitude |
1421 +-+-+-----------------------------------------+--------+----------------------+
1422
1423TUNNEL_INFO
1424===========
1425
1426Gets information about the tunnel state NIC is aware of.
1427
1428Request contents:
1429
1430  =====================================  ======  ==========================
1431  ``ETHTOOL_A_TUNNEL_INFO_HEADER``       nested  request header
1432  =====================================  ======  ==========================
1433
1434Kernel response contents:
1435
1436 +---------------------------------------------+--------+---------------------+
1437 | ``ETHTOOL_A_TUNNEL_INFO_HEADER``            | nested | reply header        |
1438 +---------------------------------------------+--------+---------------------+
1439 | ``ETHTOOL_A_TUNNEL_INFO_UDP_PORTS``         | nested | all UDP port tables |
1440 +-+-------------------------------------------+--------+---------------------+
1441 | | ``ETHTOOL_A_TUNNEL_UDP_TABLE``            | nested | one UDP port table  |
1442 +-+-+-----------------------------------------+--------+---------------------+
1443 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_SIZE``     | u32    | max size of the     |
1444 | | |                                         |        | table               |
1445 +-+-+-----------------------------------------+--------+---------------------+
1446 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES``    | bitset | tunnel types which  |
1447 | | |                                         |        | table can hold      |
1448 +-+-+-----------------------------------------+--------+---------------------+
1449 | | | ``ETHTOOL_A_TUNNEL_UDP_TABLE_ENTRY``    | nested | offloaded UDP port  |
1450 +-+-+-+---------------------------------------+--------+---------------------+
1451 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_PORT``   | be16   | UDP port            |
1452 +-+-+-+---------------------------------------+--------+---------------------+
1453 | | | | ``ETHTOOL_A_TUNNEL_UDP_ENTRY_TYPE``   | u32    | tunnel type         |
1454 +-+-+-+---------------------------------------+--------+---------------------+
1455
1456For UDP tunnel table empty ``ETHTOOL_A_TUNNEL_UDP_TABLE_TYPES`` indicates that
1457the table contains static entries, hard-coded by the NIC.
1458
1459FEC_GET
1460=======
1461
1462Gets FEC configuration and state like ``ETHTOOL_GFECPARAM`` ioctl request.
1463
1464Request contents:
1465
1466  =====================================  ======  ==========================
1467  ``ETHTOOL_A_FEC_HEADER``               nested  request header
1468  =====================================  ======  ==========================
1469
1470Kernel response contents:
1471
1472  =====================================  ======  ==========================
1473  ``ETHTOOL_A_FEC_HEADER``               nested  request header
1474  ``ETHTOOL_A_FEC_MODES``                bitset  configured modes
1475  ``ETHTOOL_A_FEC_AUTO``                 bool    FEC mode auto selection
1476  ``ETHTOOL_A_FEC_ACTIVE``               u32     index of active FEC mode
1477  ``ETHTOOL_A_FEC_STATS``                nested  FEC statistics
1478  =====================================  ======  ==========================
1479
1480``ETHTOOL_A_FEC_ACTIVE`` is the bit index of the FEC link mode currently
1481active on the interface. This attribute may not be present if device does
1482not support FEC.
1483
1484``ETHTOOL_A_FEC_MODES`` and ``ETHTOOL_A_FEC_AUTO`` are only meaningful when
1485autonegotiation is disabled. If ``ETHTOOL_A_FEC_AUTO`` is non-zero driver will
1486select the FEC mode automatically based on the parameters of the SFP module.
1487This is equivalent to the ``ETHTOOL_FEC_AUTO`` bit of the ioctl interface.
1488``ETHTOOL_A_FEC_MODES`` carry the current FEC configuration using link mode
1489bits (rather than old ``ETHTOOL_FEC_*`` bits).
1490
1491``ETHTOOL_A_FEC_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
1492``ETHTOOL_A_HEADER_FLAGS``.
1493Each attribute carries an array of 64bit statistics. First entry in the array
1494contains the total number of events on the port, while the following entries
1495are counters corresponding to lanes/PCS instances. The number of entries in
1496the array will be:
1497
1498+--------------+---------------------------------------------+
1499| `0`          | device does not support FEC statistics      |
1500+--------------+---------------------------------------------+
1501| `1`          | device does not support per-lane break down |
1502+--------------+---------------------------------------------+
1503| `1 + #lanes` | device has full support for FEC stats       |
1504+--------------+---------------------------------------------+
1505
1506Drivers fill in the statistics in the following structure:
1507
1508.. kernel-doc:: include/linux/ethtool.h
1509    :identifiers: ethtool_fec_stats
1510
1511FEC_SET
1512=======
1513
1514Sets FEC parameters like ``ETHTOOL_SFECPARAM`` ioctl request.
1515
1516Request contents:
1517
1518  =====================================  ======  ==========================
1519  ``ETHTOOL_A_FEC_HEADER``               nested  request header
1520  ``ETHTOOL_A_FEC_MODES``                bitset  configured modes
1521  ``ETHTOOL_A_FEC_AUTO``                 bool    FEC mode auto selection
1522  =====================================  ======  ==========================
1523
1524``FEC_SET`` is only meaningful when autonegotiation is disabled. Otherwise
1525FEC mode is selected as part of autonegotiation.
1526
1527``ETHTOOL_A_FEC_MODES`` selects which FEC mode should be used. It's recommended
1528to set only one bit, if multiple bits are set driver may choose between them
1529in an implementation specific way.
1530
1531``ETHTOOL_A_FEC_AUTO`` requests the driver to choose FEC mode based on SFP
1532module parameters. This does not mean autonegotiation.
1533
1534MODULE_EEPROM_GET
1535=================
1536
1537Fetch module EEPROM data dump.
1538This interface is designed to allow dumps of at most 1/2 page at once. This
1539means only dumps of 128 (or less) bytes are allowed, without crossing half page
1540boundary located at offset 128. For pages other than 0 only high 128 bytes are
1541accessible.
1542
1543Request contents:
1544
1545  =======================================  ======  ==========================
1546  ``ETHTOOL_A_MODULE_EEPROM_HEADER``       nested  request header
1547  ``ETHTOOL_A_MODULE_EEPROM_OFFSET``       u32     offset within a page
1548  ``ETHTOOL_A_MODULE_EEPROM_LENGTH``       u32     amount of bytes to read
1549  ``ETHTOOL_A_MODULE_EEPROM_PAGE``         u8      page number
1550  ``ETHTOOL_A_MODULE_EEPROM_BANK``         u8      bank number
1551  ``ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS``  u8      page I2C address
1552  =======================================  ======  ==========================
1553
1554If ``ETHTOOL_A_MODULE_EEPROM_BANK`` is not specified, bank 0 is assumed.
1555
1556Kernel response contents:
1557
1558 +---------------------------------------------+--------+---------------------+
1559 | ``ETHTOOL_A_MODULE_EEPROM_HEADER``          | nested | reply header        |
1560 +---------------------------------------------+--------+---------------------+
1561 | ``ETHTOOL_A_MODULE_EEPROM_DATA``            | binary | array of bytes from |
1562 |                                             |        | module EEPROM       |
1563 +---------------------------------------------+--------+---------------------+
1564
1565``ETHTOOL_A_MODULE_EEPROM_DATA`` has an attribute length equal to the amount of
1566bytes driver actually read.
1567
1568STATS_GET
1569=========
1570
1571Get standard statistics for the interface. Note that this is not
1572a re-implementation of ``ETHTOOL_GSTATS`` which exposed driver-defined
1573stats.
1574
1575Request contents:
1576
1577  =======================================  ======  ==========================
1578  ``ETHTOOL_A_STATS_HEADER``               nested  request header
1579  ``ETHTOOL_A_STATS_SRC``                  u32     source of statistics
1580  ``ETHTOOL_A_STATS_GROUPS``               bitset  requested groups of stats
1581  =======================================  ======  ==========================
1582
1583Kernel response contents:
1584
1585 +-----------------------------------+--------+--------------------------------+
1586 | ``ETHTOOL_A_STATS_HEADER``        | nested | reply header                   |
1587 +-----------------------------------+--------+--------------------------------+
1588 | ``ETHTOOL_A_STATS_SRC``           | u32    | source of statistics           |
1589 +-----------------------------------+--------+--------------------------------+
1590 | ``ETHTOOL_A_STATS_GRP``           | nested | one or more group of stats     |
1591 +-+---------------------------------+--------+--------------------------------+
1592 | | ``ETHTOOL_A_STATS_GRP_ID``      | u32    | group ID - ``ETHTOOL_STATS_*`` |
1593 +-+---------------------------------+--------+--------------------------------+
1594 | | ``ETHTOOL_A_STATS_GRP_SS_ID``   | u32    | string set ID for names        |
1595 +-+---------------------------------+--------+--------------------------------+
1596 | | ``ETHTOOL_A_STATS_GRP_STAT``    | nested | nest containing a statistic    |
1597 +-+---------------------------------+--------+--------------------------------+
1598 | | ``ETHTOOL_A_STATS_GRP_HIST_RX`` | nested | histogram statistic (Rx)       |
1599 +-+---------------------------------+--------+--------------------------------+
1600 | | ``ETHTOOL_A_STATS_GRP_HIST_TX`` | nested | histogram statistic (Tx)       |
1601 +-+---------------------------------+--------+--------------------------------+
1602
1603Users specify which groups of statistics they are requesting via
1604the ``ETHTOOL_A_STATS_GROUPS`` bitset. Currently defined values are:
1605
1606 ====================== ======== ===============================================
1607 ETHTOOL_STATS_ETH_MAC  eth-mac  Basic IEEE 802.3 MAC statistics (30.3.1.1.*)
1608 ETHTOOL_STATS_ETH_PHY  eth-phy  Basic IEEE 802.3 PHY statistics (30.3.2.1.*)
1609 ETHTOOL_STATS_ETH_CTRL eth-ctrl Basic IEEE 802.3 MAC Ctrl statistics (30.3.3.*)
1610 ETHTOOL_STATS_RMON     rmon     RMON (RFC 2819) statistics
1611 ====================== ======== ===============================================
1612
1613Each group should have a corresponding ``ETHTOOL_A_STATS_GRP`` in the reply.
1614``ETHTOOL_A_STATS_GRP_ID`` identifies which group's statistics nest contains.
1615``ETHTOOL_A_STATS_GRP_SS_ID`` identifies the string set ID for the names of
1616the statistics in the group, if available.
1617
1618Statistics are added to the ``ETHTOOL_A_STATS_GRP`` nest under
1619``ETHTOOL_A_STATS_GRP_STAT``. ``ETHTOOL_A_STATS_GRP_STAT`` should contain
1620single 8 byte (u64) attribute inside - the type of that attribute is
1621the statistic ID and the value is the value of the statistic.
1622Each group has its own interpretation of statistic IDs.
1623Attribute IDs correspond to strings from the string set identified
1624by ``ETHTOOL_A_STATS_GRP_SS_ID``. Complex statistics (such as RMON histogram
1625entries) are also listed inside ``ETHTOOL_A_STATS_GRP`` and do not have
1626a string defined in the string set.
1627
1628RMON "histogram" counters count number of packets within given size range.
1629Because RFC does not specify the ranges beyond the standard 1518 MTU devices
1630differ in definition of buckets. For this reason the definition of packet ranges
1631is left to each driver.
1632
1633``ETHTOOL_A_STATS_GRP_HIST_RX`` and ``ETHTOOL_A_STATS_GRP_HIST_TX`` nests
1634contain the following attributes:
1635
1636 ================================= ====== ===================================
1637 ETHTOOL_A_STATS_RMON_HIST_BKT_LOW u32    low bound of the packet size bucket
1638 ETHTOOL_A_STATS_RMON_HIST_BKT_HI  u32    high bound of the bucket
1639 ETHTOOL_A_STATS_RMON_HIST_VAL     u64    packet counter
1640 ================================= ====== ===================================
1641
1642Low and high bounds are inclusive, for example:
1643
1644 ============================= ==== ====
1645 RFC statistic                 low  high
1646 ============================= ==== ====
1647 etherStatsPkts64Octets          0    64
1648 etherStatsPkts512to1023Octets 512  1023
1649 ============================= ==== ====
1650
1651``ETHTOOL_A_STATS_SRC`` is optional. Similar to ``PAUSE_GET``, it takes values
1652from ``enum ethtool_mac_stats_src``. If absent from the request, stats will be
1653provided with an ``ETHTOOL_A_STATS_SRC`` attribute in the response equal to
1654``ETHTOOL_MAC_STATS_SRC_AGGREGATE``.
1655
1656PHC_VCLOCKS_GET
1657===============
1658
1659Query device PHC virtual clocks information.
1660
1661Request contents:
1662
1663  ====================================  ======  ==========================
1664  ``ETHTOOL_A_PHC_VCLOCKS_HEADER``      nested  request header
1665  ====================================  ======  ==========================
1666
1667Kernel response contents:
1668
1669  ====================================  ======  ==========================
1670  ``ETHTOOL_A_PHC_VCLOCKS_HEADER``      nested  reply header
1671  ``ETHTOOL_A_PHC_VCLOCKS_NUM``         u32     PHC virtual clocks number
1672  ``ETHTOOL_A_PHC_VCLOCKS_INDEX``       s32     PHC index array
1673  ====================================  ======  ==========================
1674
1675MODULE_GET
1676==========
1677
1678Gets transceiver module parameters.
1679
1680Request contents:
1681
1682  =====================================  ======  ==========================
1683  ``ETHTOOL_A_MODULE_HEADER``            nested  request header
1684  =====================================  ======  ==========================
1685
1686Kernel response contents:
1687
1688  ======================================  ======  ==========================
1689  ``ETHTOOL_A_MODULE_HEADER``             nested  reply header
1690  ``ETHTOOL_A_MODULE_POWER_MODE_POLICY``  u8      power mode policy
1691  ``ETHTOOL_A_MODULE_POWER_MODE``         u8      operational power mode
1692  ======================================  ======  ==========================
1693
1694The optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute encodes the
1695transceiver module power mode policy enforced by the host. The default policy
1696is driver-dependent, but "auto" is the recommended default and it should be
1697implemented by new drivers and drivers where conformance to a legacy behavior
1698is not critical.
1699
1700The optional ``ETHTHOOL_A_MODULE_POWER_MODE`` attribute encodes the operational
1701power mode policy of the transceiver module. It is only reported when a module
1702is plugged-in. Possible values are:
1703
1704.. kernel-doc:: include/uapi/linux/ethtool.h
1705    :identifiers: ethtool_module_power_mode
1706
1707MODULE_SET
1708==========
1709
1710Sets transceiver module parameters.
1711
1712Request contents:
1713
1714  ======================================  ======  ==========================
1715  ``ETHTOOL_A_MODULE_HEADER``             nested  request header
1716  ``ETHTOOL_A_MODULE_POWER_MODE_POLICY``  u8      power mode policy
1717  ======================================  ======  ==========================
1718
1719When set, the optional ``ETHTOOL_A_MODULE_POWER_MODE_POLICY`` attribute is used
1720to set the transceiver module power policy enforced by the host. Possible
1721values are:
1722
1723.. kernel-doc:: include/uapi/linux/ethtool.h
1724    :identifiers: ethtool_module_power_mode_policy
1725
1726For SFF-8636 modules, low power mode is forced by the host according to table
17276-10 in revision 2.10a of the specification.
1728
1729For CMIS modules, low power mode is forced by the host according to table 6-12
1730in revision 5.0 of the specification.
1731
1732PSE_GET
1733=======
1734
1735Gets PSE attributes.
1736
1737Request contents:
1738
1739  =====================================  ======  ==========================
1740  ``ETHTOOL_A_PSE_HEADER``               nested  request header
1741  =====================================  ======  ==========================
1742
1743Kernel response contents:
1744
1745  ==========================================  ======  =============================
1746  ``ETHTOOL_A_PSE_HEADER``                    nested  reply header
1747  ``ETHTOOL_A_PODL_PSE_ADMIN_STATE``             u32  Operational state of the PoDL
1748                                                      PSE functions
1749  ``ETHTOOL_A_PODL_PSE_PW_D_STATUS``             u32  power detection status of the
1750                                                      PoDL PSE.
1751  ``ETHTOOL_A_C33_PSE_ADMIN_STATE``              u32  Operational state of the PoE
1752                                                      PSE functions.
1753  ``ETHTOOL_A_C33_PSE_PW_D_STATUS``              u32  power detection status of the
1754                                                      PoE PSE.
1755  ``ETHTOOL_A_C33_PSE_PW_CLASS``                 u32  power class of the PoE PSE.
1756  ``ETHTOOL_A_C33_PSE_ACTUAL_PW``                u32  actual power drawn on the
1757                                                      PoE PSE.
1758  ``ETHTOOL_A_C33_PSE_EXT_STATE``                u32  power extended state of the
1759                                                      PoE PSE.
1760  ``ETHTOOL_A_C33_PSE_EXT_SUBSTATE``             u32  power extended substatus of
1761                                                      the PoE PSE.
1762  ``ETHTOOL_A_C33_PSE_AVAIL_PW_LIMIT``           u32  currently configured power
1763                                                      limit of the PoE PSE.
1764  ``ETHTOOL_A_C33_PSE_PW_LIMIT_RANGES``       nested  Supported power limit
1765                                                      configuration ranges.
1766  ==========================================  ======  =============================
1767
1768When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` attribute identifies
1769the operational state of the PoDL PSE functions.  The operational state of the
1770PSE function can be changed using the ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL``
1771action. This attribute corresponds to ``IEEE 802.3-2018`` 30.15.1.1.2
1772aPoDLPSEAdminState. Possible values are:
1773
1774.. kernel-doc:: include/uapi/linux/ethtool.h
1775    :identifiers: ethtool_podl_pse_admin_state
1776
1777The same goes for ``ETHTOOL_A_C33_PSE_ADMIN_STATE`` implementing
1778``IEEE 802.3-2022`` 30.9.1.1.2 aPSEAdminState.
1779
1780.. kernel-doc:: include/uapi/linux/ethtool.h
1781    :identifiers: ethtool_c33_pse_admin_state
1782
1783When set, the optional ``ETHTOOL_A_PODL_PSE_PW_D_STATUS`` attribute identifies
1784the power detection status of the PoDL PSE.  The status depend on internal PSE
1785state machine and automatic PD classification support. This attribute
1786corresponds to ``IEEE 802.3-2018`` 30.15.1.1.3 aPoDLPSEPowerDetectionStatus.
1787Possible values are:
1788
1789.. kernel-doc:: include/uapi/linux/ethtool.h
1790    :identifiers: ethtool_podl_pse_pw_d_status
1791
1792The same goes for ``ETHTOOL_A_C33_PSE_ADMIN_PW_D_STATUS`` implementing
1793``IEEE 802.3-2022`` 30.9.1.1.5 aPSEPowerDetectionStatus.
1794
1795.. kernel-doc:: include/uapi/linux/ethtool.h
1796    :identifiers: ethtool_c33_pse_pw_d_status
1797
1798When set, the optional ``ETHTOOL_A_C33_PSE_PW_CLASS`` attribute identifies
1799the power class of the C33 PSE. It depends on the class negotiated between
1800the PSE and the PD. This attribute corresponds to ``IEEE 802.3-2022``
180130.9.1.1.8 aPSEPowerClassification.
1802
1803When set, the optional ``ETHTOOL_A_C33_PSE_ACTUAL_PW`` attribute identifies
1804the actual power drawn by the C33 PSE. This attribute corresponds to
1805``IEEE 802.3-2022`` 30.9.1.1.23 aPSEActualPower. Actual power is reported
1806in mW.
1807
1808When set, the optional ``ETHTOOL_A_C33_PSE_EXT_STATE`` attribute identifies
1809the extended error state of the C33 PSE. Possible values are:
1810
1811.. kernel-doc:: include/uapi/linux/ethtool.h
1812    :identifiers: ethtool_c33_pse_ext_state
1813
1814When set, the optional ``ETHTOOL_A_C33_PSE_EXT_SUBSTATE`` attribute identifies
1815the extended error state of the C33 PSE. Possible values are:
1816Possible values are:
1817
1818.. kernel-doc:: include/uapi/linux/ethtool.h
1819    :identifiers: ethtool_c33_pse_ext_substate_class_num_events
1820		  ethtool_c33_pse_ext_substate_error_condition
1821		  ethtool_c33_pse_ext_substate_mr_pse_enable
1822		  ethtool_c33_pse_ext_substate_option_detect_ted
1823		  ethtool_c33_pse_ext_substate_option_vport_lim
1824		  ethtool_c33_pse_ext_substate_ovld_detected
1825		  ethtool_c33_pse_ext_substate_pd_dll_power_type
1826		  ethtool_c33_pse_ext_substate_power_not_available
1827		  ethtool_c33_pse_ext_substate_short_detected
1828
1829When set, the optional ``ETHTOOL_A_C33_PSE_AVAIL_PW_LIMIT`` attribute
1830identifies the C33 PSE power limit in mW.
1831
1832When set the optional ``ETHTOOL_A_C33_PSE_PW_LIMIT_RANGES`` nested attribute
1833identifies the C33 PSE power limit ranges through
1834``ETHTOOL_A_C33_PSE_PWR_VAL_LIMIT_RANGE_MIN`` and
1835``ETHTOOL_A_C33_PSE_PWR_VAL_LIMIT_RANGE_MAX``.
1836If the controller works with fixed classes, the min and max values will be
1837equal.
1838
1839PSE_SET
1840=======
1841
1842Sets PSE parameters.
1843
1844Request contents:
1845
1846  ======================================  ======  =============================
1847  ``ETHTOOL_A_PSE_HEADER``                nested  request header
1848  ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL``       u32  Control PoDL PSE Admin state
1849  ``ETHTOOL_A_C33_PSE_ADMIN_CONTROL``        u32  Control PSE Admin state
1850  ``ETHTOOL_A_C33_PSE_AVAIL_PWR_LIMIT``      u32  Control PoE PSE available
1851                                                  power limit
1852  ======================================  ======  =============================
1853
1854When set, the optional ``ETHTOOL_A_PODL_PSE_ADMIN_CONTROL`` attribute is used
1855to control PoDL PSE Admin functions. This option implements
1856``IEEE 802.3-2018`` 30.15.1.2.1 acPoDLPSEAdminControl. See
1857``ETHTOOL_A_PODL_PSE_ADMIN_STATE`` for supported values.
1858
1859The same goes for ``ETHTOOL_A_C33_PSE_ADMIN_CONTROL`` implementing
1860``IEEE 802.3-2022`` 30.9.1.2.1 acPSEAdminControl.
1861
1862When set, the optional ``ETHTOOL_A_C33_PSE_AVAIL_PWR_LIMIT`` attribute is
1863used to control the available power value limit for C33 PSE in milliwatts.
1864This attribute corresponds  to the `pse_available_power` variable described in
1865``IEEE 802.3-2022`` 33.2.4.4 Variables  and `pse_avail_pwr` in 145.2.5.4
1866Variables, which are described in power classes.
1867
1868It was decided to use milliwatts for this interface to unify it with other
1869power monitoring interfaces, which also use milliwatts, and to align with
1870various existing products that document power consumption in watts rather than
1871classes. If power limit configuration based on classes is needed, the
1872conversion can be done in user space, for example by ethtool.
1873
1874RSS_GET
1875=======
1876
1877Get indirection table, hash key and hash function info associated with a
1878RSS context of an interface similar to ``ETHTOOL_GRSSH`` ioctl request.
1879
1880Request contents:
1881
1882=====================================  ======  ============================
1883  ``ETHTOOL_A_RSS_HEADER``             nested  request header
1884  ``ETHTOOL_A_RSS_CONTEXT``            u32     context number
1885  ``ETHTOOL_A_RSS_START_CONTEXT``      u32     start context number (dumps)
1886=====================================  ======  ============================
1887
1888``ETHTOOL_A_RSS_CONTEXT`` specifies which RSS context number to query,
1889if not set context 0 (the main context) is queried. Dumps can be filtered
1890by device (only listing contexts of a given netdev). Filtering single
1891context number is not supported but ``ETHTOOL_A_RSS_START_CONTEXT``
1892can be used to start dumping context from the given number (primarily
1893used to ignore context 0s and only dump additional contexts).
1894
1895Kernel response contents:
1896
1897=====================================  ======  ==========================
1898  ``ETHTOOL_A_RSS_HEADER``             nested  reply header
1899  ``ETHTOOL_A_RSS_CONTEXT``            u32     context number
1900  ``ETHTOOL_A_RSS_HFUNC``              u32     RSS hash func
1901  ``ETHTOOL_A_RSS_INDIR``              binary  Indir table bytes
1902  ``ETHTOOL_A_RSS_HKEY``               binary  Hash key bytes
1903  ``ETHTOOL_A_RSS_INPUT_XFRM``         u32     RSS input data transformation
1904=====================================  ======  ==========================
1905
1906ETHTOOL_A_RSS_HFUNC attribute is bitmap indicating the hash function
1907being used. Current supported options are toeplitz, xor or crc32.
1908ETHTOOL_A_RSS_INDIR attribute returns RSS indirection table where each byte
1909indicates queue number.
1910ETHTOOL_A_RSS_INPUT_XFRM attribute is a bitmap indicating the type of
1911transformation applied to the input protocol fields before given to the RSS
1912hfunc. Current supported option is symmetric-xor.
1913
1914PLCA_GET_CFG
1915============
1916
1917Gets the IEEE 802.3cg-2019 Clause 148 Physical Layer Collision Avoidance
1918(PLCA) Reconciliation Sublayer (RS) attributes.
1919
1920Request contents:
1921
1922  =====================================  ======  ==========================
1923  ``ETHTOOL_A_PLCA_HEADER``              nested  request header
1924  =====================================  ======  ==========================
1925
1926Kernel response contents:
1927
1928  ======================================  ======  =============================
1929  ``ETHTOOL_A_PLCA_HEADER``               nested  reply header
1930  ``ETHTOOL_A_PLCA_VERSION``              u16     Supported PLCA management
1931                                                  interface standard/version
1932  ``ETHTOOL_A_PLCA_ENABLED``              u8      PLCA Admin State
1933  ``ETHTOOL_A_PLCA_NODE_ID``              u32     PLCA unique local node ID
1934  ``ETHTOOL_A_PLCA_NODE_CNT``             u32     Number of PLCA nodes on the
1935                                                  network, including the
1936                                                  coordinator
1937  ``ETHTOOL_A_PLCA_TO_TMR``               u32     Transmit Opportunity Timer
1938                                                  value in bit-times (BT)
1939  ``ETHTOOL_A_PLCA_BURST_CNT``            u32     Number of additional packets
1940                                                  the node is allowed to send
1941                                                  within a single TO
1942  ``ETHTOOL_A_PLCA_BURST_TMR``            u32     Time to wait for the MAC to
1943                                                  transmit a new frame before
1944                                                  terminating the burst
1945  ======================================  ======  =============================
1946
1947When set, the optional ``ETHTOOL_A_PLCA_VERSION`` attribute indicates which
1948standard and version the PLCA management interface complies to. When not set,
1949the interface is vendor-specific and (possibly) supplied by the driver.
1950The OPEN Alliance SIG specifies a standard register map for 10BASE-T1S PHYs
1951embedding the PLCA Reconciliation Sublayer. See "10BASE-T1S PLCA Management
1952Registers" at https://www.opensig.org/about/specifications/.
1953
1954When set, the optional ``ETHTOOL_A_PLCA_ENABLED`` attribute indicates the
1955administrative state of the PLCA RS. When not set, the node operates in "plain"
1956CSMA/CD mode. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.1
1957aPLCAAdminState / 30.16.1.2.1 acPLCAAdminControl.
1958
1959When set, the optional ``ETHTOOL_A_PLCA_NODE_ID`` attribute indicates the
1960configured local node ID of the PHY. This ID determines which transmit
1961opportunity (TO) is reserved for the node to transmit into. This option is
1962corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.4 aPLCALocalNodeID. The valid
1963range for this attribute is [0 .. 255] where 255 means "not configured".
1964
1965When set, the optional ``ETHTOOL_A_PLCA_NODE_CNT`` attribute indicates the
1966configured maximum number of PLCA nodes on the mixing-segment. This number
1967determines the total number of transmit opportunities generated during a
1968PLCA cycle. This attribute is relevant only for the PLCA coordinator, which is
1969the node with aPLCALocalNodeID set to 0. Follower nodes ignore this setting.
1970This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.3
1971aPLCANodeCount. The valid range for this attribute is [1 .. 255].
1972
1973When set, the optional ``ETHTOOL_A_PLCA_TO_TMR`` attribute indicates the
1974configured value of the transmit opportunity timer in bit-times. This value
1975must be set equal across all nodes sharing the medium for PLCA to work
1976correctly. This option is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.5
1977aPLCATransmitOpportunityTimer. The valid range for this attribute is
1978[0 .. 255].
1979
1980When set, the optional ``ETHTOOL_A_PLCA_BURST_CNT`` attribute indicates the
1981configured number of extra packets that the node is allowed to send during a
1982single transmit opportunity. By default, this attribute is 0, meaning that
1983the node can only send a single frame per TO. When greater than 0, the PLCA RS
1984keeps the TO after any transmission, waiting for the MAC to send a new frame
1985for up to aPLCABurstTimer BTs. This can only happen a number of times per PLCA
1986cycle up to the value of this parameter. After that, the burst is over and the
1987normal counting of TOs resumes. This option is corresponding to
1988``IEEE 802.3cg-2019`` 30.16.1.1.6 aPLCAMaxBurstCount. The valid range for this
1989attribute is [0 .. 255].
1990
1991When set, the optional ``ETHTOOL_A_PLCA_BURST_TMR`` attribute indicates how
1992many bit-times the PLCA RS waits for the MAC to initiate a new transmission
1993when aPLCAMaxBurstCount is greater than 0. If the MAC fails to send a new
1994frame within this time, the burst ends and the counting of TOs resumes.
1995Otherwise, the new frame is sent as part of the current burst. This option
1996is corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.7 aPLCABurstTimer. The
1997valid range for this attribute is [0 .. 255]. Although, the value should be
1998set greater than the Inter-Frame-Gap (IFG) time of the MAC (plus some margin)
1999for PLCA burst mode to work as intended.
2000
2001PLCA_SET_CFG
2002============
2003
2004Sets PLCA RS parameters.
2005
2006Request contents:
2007
2008  ======================================  ======  =============================
2009  ``ETHTOOL_A_PLCA_HEADER``               nested  request header
2010  ``ETHTOOL_A_PLCA_ENABLED``              u8      PLCA Admin State
2011  ``ETHTOOL_A_PLCA_NODE_ID``              u8      PLCA unique local node ID
2012  ``ETHTOOL_A_PLCA_NODE_CNT``             u8      Number of PLCA nodes on the
2013                                                  network, including the
2014                                                  coordinator
2015  ``ETHTOOL_A_PLCA_TO_TMR``               u8      Transmit Opportunity Timer
2016                                                  value in bit-times (BT)
2017  ``ETHTOOL_A_PLCA_BURST_CNT``            u8      Number of additional packets
2018                                                  the node is allowed to send
2019                                                  within a single TO
2020  ``ETHTOOL_A_PLCA_BURST_TMR``            u8      Time to wait for the MAC to
2021                                                  transmit a new frame before
2022                                                  terminating the burst
2023  ======================================  ======  =============================
2024
2025For a description of each attribute, see ``PLCA_GET_CFG``.
2026
2027PLCA_GET_STATUS
2028===============
2029
2030Gets PLCA RS status information.
2031
2032Request contents:
2033
2034  =====================================  ======  ==========================
2035  ``ETHTOOL_A_PLCA_HEADER``              nested  request header
2036  =====================================  ======  ==========================
2037
2038Kernel response contents:
2039
2040  ======================================  ======  =============================
2041  ``ETHTOOL_A_PLCA_HEADER``               nested  reply header
2042  ``ETHTOOL_A_PLCA_STATUS``               u8      PLCA RS operational status
2043  ======================================  ======  =============================
2044
2045When set, the ``ETHTOOL_A_PLCA_STATUS`` attribute indicates whether the node is
2046detecting the presence of the BEACON on the network. This flag is
2047corresponding to ``IEEE 802.3cg-2019`` 30.16.1.1.2 aPLCAStatus.
2048
2049MM_GET
2050======
2051
2052Retrieve 802.3 MAC Merge parameters.
2053
2054Request contents:
2055
2056  ====================================  ======  ==========================
2057  ``ETHTOOL_A_MM_HEADER``               nested  request header
2058  ====================================  ======  ==========================
2059
2060Kernel response contents:
2061
2062  =================================  ======  ===================================
2063  ``ETHTOOL_A_MM_HEADER``            nested  request header
2064  ``ETHTOOL_A_MM_PMAC_ENABLED``      bool    set if RX of preemptible and SMD-V
2065                                             frames is enabled
2066  ``ETHTOOL_A_MM_TX_ENABLED``        bool    set if TX of preemptible frames is
2067                                             administratively enabled (might be
2068                                             inactive if verification failed)
2069  ``ETHTOOL_A_MM_TX_ACTIVE``         bool    set if TX of preemptible frames is
2070                                             operationally enabled
2071  ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE``  u32     minimum size of transmitted
2072                                             non-final fragments, in octets
2073  ``ETHTOOL_A_MM_RX_MIN_FRAG_SIZE``  u32     minimum size of received non-final
2074                                             fragments, in octets
2075  ``ETHTOOL_A_MM_VERIFY_ENABLED``    bool    set if TX of SMD-V frames is
2076                                             administratively enabled
2077  ``ETHTOOL_A_MM_VERIFY_STATUS``     u8      state of the verification function
2078  ``ETHTOOL_A_MM_VERIFY_TIME``       u32     delay between verification attempts
2079  ``ETHTOOL_A_MM_MAX_VERIFY_TIME```  u32     maximum verification interval
2080                                             supported by device
2081  ``ETHTOOL_A_MM_STATS``             nested  IEEE 802.3-2018 subclause 30.14.1
2082                                             oMACMergeEntity statistics counters
2083  =================================  ======  ===================================
2084
2085The attributes are populated by the device driver through the following
2086structure:
2087
2088.. kernel-doc:: include/linux/ethtool.h
2089    :identifiers: ethtool_mm_state
2090
2091The ``ETHTOOL_A_MM_VERIFY_STATUS`` will report one of the values from
2092
2093.. kernel-doc:: include/uapi/linux/ethtool.h
2094    :identifiers: ethtool_mm_verify_status
2095
2096If ``ETHTOOL_A_MM_VERIFY_ENABLED`` was passed as false in the ``MM_SET``
2097command, ``ETHTOOL_A_MM_VERIFY_STATUS`` will report either
2098``ETHTOOL_MM_VERIFY_STATUS_INITIAL`` or ``ETHTOOL_MM_VERIFY_STATUS_DISABLED``,
2099otherwise it should report one of the other states.
2100
2101It is recommended that drivers start with the pMAC disabled, and enable it upon
2102user space request. It is also recommended that user space does not depend upon
2103the default values from ``ETHTOOL_MSG_MM_GET`` requests.
2104
2105``ETHTOOL_A_MM_STATS`` are reported if ``ETHTOOL_FLAG_STATS`` was set in
2106``ETHTOOL_A_HEADER_FLAGS``. The attribute will be empty if driver did not
2107report any statistics. Drivers fill in the statistics in the following
2108structure:
2109
2110.. kernel-doc:: include/linux/ethtool.h
2111    :identifiers: ethtool_mm_stats
2112
2113MM_SET
2114======
2115
2116Modifies the configuration of the 802.3 MAC Merge layer.
2117
2118Request contents:
2119
2120  =================================  ======  ==========================
2121  ``ETHTOOL_A_MM_VERIFY_TIME``       u32     see MM_GET description
2122  ``ETHTOOL_A_MM_VERIFY_ENABLED``    bool    see MM_GET description
2123  ``ETHTOOL_A_MM_TX_ENABLED``        bool    see MM_GET description
2124  ``ETHTOOL_A_MM_PMAC_ENABLED``      bool    see MM_GET description
2125  ``ETHTOOL_A_MM_TX_MIN_FRAG_SIZE``  u32     see MM_GET description
2126  =================================  ======  ==========================
2127
2128The attributes are propagated to the driver through the following structure:
2129
2130.. kernel-doc:: include/linux/ethtool.h
2131    :identifiers: ethtool_mm_cfg
2132
2133MODULE_FW_FLASH_ACT
2134===================
2135
2136Flashes transceiver module firmware.
2137
2138Request contents:
2139
2140  =======================================  ======  ===========================
2141  ``ETHTOOL_A_MODULE_FW_FLASH_HEADER``     nested  request header
2142  ``ETHTOOL_A_MODULE_FW_FLASH_FILE_NAME``  string  firmware image file name
2143  ``ETHTOOL_A_MODULE_FW_FLASH_PASSWORD``   u32     transceiver module password
2144  =======================================  ======  ===========================
2145
2146The firmware update process consists of three logical steps:
2147
21481. Downloading a firmware image to the transceiver module and validating it.
21492. Running the firmware image.
21503. Committing the firmware image so that it is run upon reset.
2151
2152When flash command is given, those three steps are taken in that order.
2153
2154This message merely schedules the update process and returns immediately
2155without blocking. The process then runs asynchronously.
2156Since it can take several minutes to complete, during the update process
2157notifications are emitted from the kernel to user space updating it about
2158the status and progress.
2159
2160The ``ETHTOOL_A_MODULE_FW_FLASH_FILE_NAME`` attribute encodes the firmware
2161image file name. The firmware image is downloaded to the transceiver module,
2162validated, run and committed.
2163
2164The optional ``ETHTOOL_A_MODULE_FW_FLASH_PASSWORD`` attribute encodes a password
2165that might be required as part of the transceiver module firmware update
2166process.
2167
2168The firmware update process can take several minutes to complete. Therefore,
2169during the update process notifications are emitted from the kernel to user
2170space updating it about the status and progress.
2171
2172
2173
2174Notification contents:
2175
2176 +---------------------------------------------------+--------+----------------+
2177 | ``ETHTOOL_A_MODULE_FW_FLASH_HEADER``              | nested | reply header   |
2178 +---------------------------------------------------+--------+----------------+
2179 | ``ETHTOOL_A_MODULE_FW_FLASH_STATUS``              | u32    | status         |
2180 +---------------------------------------------------+--------+----------------+
2181 | ``ETHTOOL_A_MODULE_FW_FLASH_STATUS_MSG``          | string | status message |
2182 +---------------------------------------------------+--------+----------------+
2183 | ``ETHTOOL_A_MODULE_FW_FLASH_DONE``                | uint   | progress       |
2184 +---------------------------------------------------+--------+----------------+
2185 | ``ETHTOOL_A_MODULE_FW_FLASH_TOTAL``               | uint   | total          |
2186 +---------------------------------------------------+--------+----------------+
2187
2188The ``ETHTOOL_A_MODULE_FW_FLASH_STATUS`` attribute encodes the current status
2189of the firmware update process. Possible values are:
2190
2191.. kernel-doc:: include/uapi/linux/ethtool.h
2192    :identifiers: ethtool_module_fw_flash_status
2193
2194The ``ETHTOOL_A_MODULE_FW_FLASH_STATUS_MSG`` attribute encodes a status message
2195string.
2196
2197The ``ETHTOOL_A_MODULE_FW_FLASH_DONE`` and ``ETHTOOL_A_MODULE_FW_FLASH_TOTAL``
2198attributes encode the completed and total amount of work, respectively.
2199
2200PHY_GET
2201=======
2202
2203Retrieve information about a given Ethernet PHY sitting on the link. The DO
2204operation returns all available information about dev->phydev. User can also
2205specify a PHY_INDEX, in which case the DO request returns information about that
2206specific PHY.
2207
2208As there can be more than one PHY, the DUMP operation can be used to list the PHYs
2209present on a given interface, by passing an interface index or name in
2210the dump request.
2211
2212For more information, refer to :ref:`phy_link_topology`
2213
2214Request contents:
2215
2216  ====================================  ======  ==========================
2217  ``ETHTOOL_A_PHY_HEADER``              nested  request header
2218  ====================================  ======  ==========================
2219
2220Kernel response contents:
2221
2222  ===================================== ======  ===============================
2223  ``ETHTOOL_A_PHY_HEADER``              nested  request header
2224  ``ETHTOOL_A_PHY_INDEX``               u32     the phy's unique index, that can
2225                                                be used for phy-specific
2226                                                requests
2227  ``ETHTOOL_A_PHY_DRVNAME``             string  the phy driver name
2228  ``ETHTOOL_A_PHY_NAME``                string  the phy device name
2229  ``ETHTOOL_A_PHY_UPSTREAM_TYPE``       u32     the type of device this phy is
2230                                                connected to
2231  ``ETHTOOL_A_PHY_UPSTREAM_INDEX``      u32     the PHY index of the upstream
2232                                                PHY
2233  ``ETHTOOL_A_PHY_UPSTREAM_SFP_NAME``   string  if this PHY is connected to
2234                                                its parent PHY through an SFP
2235                                                bus, the name of this sfp bus
2236  ``ETHTOOL_A_PHY_DOWNSTREAM_SFP_NAME`` string  if the phy controls an sfp bus,
2237                                                the name of the sfp bus
2238  ===================================== ======  ===============================
2239
2240When ``ETHTOOL_A_PHY_UPSTREAM_TYPE`` is PHY_UPSTREAM_PHY, the PHY's parent is
2241another PHY.
2242
2243Request translation
2244===================
2245
2246The following table maps ioctl commands to netlink commands providing their
2247functionality. Entries with "n/a" in right column are commands which do not
2248have their netlink replacement yet. Entries which "n/a" in the left column
2249are netlink only.
2250
2251  =================================== =====================================
2252  ioctl command                       netlink command
2253  =================================== =====================================
2254  ``ETHTOOL_GSET``                    ``ETHTOOL_MSG_LINKINFO_GET``
2255                                      ``ETHTOOL_MSG_LINKMODES_GET``
2256  ``ETHTOOL_SSET``                    ``ETHTOOL_MSG_LINKINFO_SET``
2257                                      ``ETHTOOL_MSG_LINKMODES_SET``
2258  ``ETHTOOL_GDRVINFO``                n/a
2259  ``ETHTOOL_GREGS``                   n/a
2260  ``ETHTOOL_GWOL``                    ``ETHTOOL_MSG_WOL_GET``
2261  ``ETHTOOL_SWOL``                    ``ETHTOOL_MSG_WOL_SET``
2262  ``ETHTOOL_GMSGLVL``                 ``ETHTOOL_MSG_DEBUG_GET``
2263  ``ETHTOOL_SMSGLVL``                 ``ETHTOOL_MSG_DEBUG_SET``
2264  ``ETHTOOL_NWAY_RST``                n/a
2265  ``ETHTOOL_GLINK``                   ``ETHTOOL_MSG_LINKSTATE_GET``
2266  ``ETHTOOL_GEEPROM``                 n/a
2267  ``ETHTOOL_SEEPROM``                 n/a
2268  ``ETHTOOL_GCOALESCE``               ``ETHTOOL_MSG_COALESCE_GET``
2269  ``ETHTOOL_SCOALESCE``               ``ETHTOOL_MSG_COALESCE_SET``
2270  ``ETHTOOL_GRINGPARAM``              ``ETHTOOL_MSG_RINGS_GET``
2271  ``ETHTOOL_SRINGPARAM``              ``ETHTOOL_MSG_RINGS_SET``
2272  ``ETHTOOL_GPAUSEPARAM``             ``ETHTOOL_MSG_PAUSE_GET``
2273  ``ETHTOOL_SPAUSEPARAM``             ``ETHTOOL_MSG_PAUSE_SET``
2274  ``ETHTOOL_GRXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
2275  ``ETHTOOL_SRXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
2276  ``ETHTOOL_GTXCSUM``                 ``ETHTOOL_MSG_FEATURES_GET``
2277  ``ETHTOOL_STXCSUM``                 ``ETHTOOL_MSG_FEATURES_SET``
2278  ``ETHTOOL_GSG``                     ``ETHTOOL_MSG_FEATURES_GET``
2279  ``ETHTOOL_SSG``                     ``ETHTOOL_MSG_FEATURES_SET``
2280  ``ETHTOOL_TEST``                    n/a
2281  ``ETHTOOL_GSTRINGS``                ``ETHTOOL_MSG_STRSET_GET``
2282  ``ETHTOOL_PHYS_ID``                 n/a
2283  ``ETHTOOL_GSTATS``                  n/a
2284  ``ETHTOOL_GTSO``                    ``ETHTOOL_MSG_FEATURES_GET``
2285  ``ETHTOOL_STSO``                    ``ETHTOOL_MSG_FEATURES_SET``
2286  ``ETHTOOL_GPERMADDR``               rtnetlink ``RTM_GETLINK``
2287  ``ETHTOOL_GUFO``                    ``ETHTOOL_MSG_FEATURES_GET``
2288  ``ETHTOOL_SUFO``                    ``ETHTOOL_MSG_FEATURES_SET``
2289  ``ETHTOOL_GGSO``                    ``ETHTOOL_MSG_FEATURES_GET``
2290  ``ETHTOOL_SGSO``                    ``ETHTOOL_MSG_FEATURES_SET``
2291  ``ETHTOOL_GFLAGS``                  ``ETHTOOL_MSG_FEATURES_GET``
2292  ``ETHTOOL_SFLAGS``                  ``ETHTOOL_MSG_FEATURES_SET``
2293  ``ETHTOOL_GPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_GET``
2294  ``ETHTOOL_SPFLAGS``                 ``ETHTOOL_MSG_PRIVFLAGS_SET``
2295  ``ETHTOOL_GRXFH``                   n/a
2296  ``ETHTOOL_SRXFH``                   n/a
2297  ``ETHTOOL_GGRO``                    ``ETHTOOL_MSG_FEATURES_GET``
2298  ``ETHTOOL_SGRO``                    ``ETHTOOL_MSG_FEATURES_SET``
2299  ``ETHTOOL_GRXRINGS``                n/a
2300  ``ETHTOOL_GRXCLSRLCNT``             n/a
2301  ``ETHTOOL_GRXCLSRULE``              n/a
2302  ``ETHTOOL_GRXCLSRLALL``             n/a
2303  ``ETHTOOL_SRXCLSRLDEL``             n/a
2304  ``ETHTOOL_SRXCLSRLINS``             n/a
2305  ``ETHTOOL_FLASHDEV``                n/a
2306  ``ETHTOOL_RESET``                   n/a
2307  ``ETHTOOL_SRXNTUPLE``               n/a
2308  ``ETHTOOL_GRXNTUPLE``               n/a
2309  ``ETHTOOL_GSSET_INFO``              ``ETHTOOL_MSG_STRSET_GET``
2310  ``ETHTOOL_GRXFHINDIR``              n/a
2311  ``ETHTOOL_SRXFHINDIR``              n/a
2312  ``ETHTOOL_GFEATURES``               ``ETHTOOL_MSG_FEATURES_GET``
2313  ``ETHTOOL_SFEATURES``               ``ETHTOOL_MSG_FEATURES_SET``
2314  ``ETHTOOL_GCHANNELS``               ``ETHTOOL_MSG_CHANNELS_GET``
2315  ``ETHTOOL_SCHANNELS``               ``ETHTOOL_MSG_CHANNELS_SET``
2316  ``ETHTOOL_SET_DUMP``                n/a
2317  ``ETHTOOL_GET_DUMP_FLAG``           n/a
2318  ``ETHTOOL_GET_DUMP_DATA``           n/a
2319  ``ETHTOOL_GET_TS_INFO``             ``ETHTOOL_MSG_TSINFO_GET``
2320  ``ETHTOOL_GMODULEINFO``             ``ETHTOOL_MSG_MODULE_EEPROM_GET``
2321  ``ETHTOOL_GMODULEEEPROM``           ``ETHTOOL_MSG_MODULE_EEPROM_GET``
2322  ``ETHTOOL_GEEE``                    ``ETHTOOL_MSG_EEE_GET``
2323  ``ETHTOOL_SEEE``                    ``ETHTOOL_MSG_EEE_SET``
2324  ``ETHTOOL_GRSSH``                   ``ETHTOOL_MSG_RSS_GET``
2325  ``ETHTOOL_SRSSH``                   n/a
2326  ``ETHTOOL_GTUNABLE``                n/a
2327  ``ETHTOOL_STUNABLE``                n/a
2328  ``ETHTOOL_GPHYSTATS``               n/a
2329  ``ETHTOOL_PERQUEUE``                n/a
2330  ``ETHTOOL_GLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_GET``
2331                                      ``ETHTOOL_MSG_LINKMODES_GET``
2332  ``ETHTOOL_SLINKSETTINGS``           ``ETHTOOL_MSG_LINKINFO_SET``
2333                                      ``ETHTOOL_MSG_LINKMODES_SET``
2334  ``ETHTOOL_PHY_GTUNABLE``            n/a
2335  ``ETHTOOL_PHY_STUNABLE``            n/a
2336  ``ETHTOOL_GFECPARAM``               ``ETHTOOL_MSG_FEC_GET``
2337  ``ETHTOOL_SFECPARAM``               ``ETHTOOL_MSG_FEC_SET``
2338  n/a                                 ``ETHTOOL_MSG_CABLE_TEST_ACT``
2339  n/a                                 ``ETHTOOL_MSG_CABLE_TEST_TDR_ACT``
2340  n/a                                 ``ETHTOOL_MSG_TUNNEL_INFO_GET``
2341  n/a                                 ``ETHTOOL_MSG_PHC_VCLOCKS_GET``
2342  n/a                                 ``ETHTOOL_MSG_MODULE_GET``
2343  n/a                                 ``ETHTOOL_MSG_MODULE_SET``
2344  n/a                                 ``ETHTOOL_MSG_PLCA_GET_CFG``
2345  n/a                                 ``ETHTOOL_MSG_PLCA_SET_CFG``
2346  n/a                                 ``ETHTOOL_MSG_PLCA_GET_STATUS``
2347  n/a                                 ``ETHTOOL_MSG_MM_GET``
2348  n/a                                 ``ETHTOOL_MSG_MM_SET``
2349  n/a                                 ``ETHTOOL_MSG_MODULE_FW_FLASH_ACT``
2350  n/a                                 ``ETHTOOL_MSG_PHY_GET``
2351  =================================== =====================================
2352