Commit | Line | Data |
---|---|---|
2b4a8990 MK |
1 | ============================= |
2 | Netlink interface for ethtool | |
3 | ============================= | |
4 | ||
5 | ||
6 | Basic information | |
7 | ================= | |
8 | ||
9 | Netlink interface for ethtool uses generic netlink family ``ethtool`` | |
10 | (userspace application should use macros ``ETHTOOL_GENL_NAME`` and | |
11 | ``ETHTOOL_GENL_VERSION`` defined in ``<linux/ethtool_netlink.h>`` uapi | |
12 | header). This family does not use a specific header, all information in | |
13 | requests and replies is passed using netlink attributes. | |
14 | ||
15 | The ethtool netlink interface uses extended ACK for error and warning | |
16 | reporting, userspace application developers are encouraged to make these | |
17 | messages available to user in a suitable way. | |
18 | ||
19 | Requests can be divided into three categories: "get" (retrieving information), | |
20 | "set" (setting parameters) and "action" (invoking an action). | |
21 | ||
22 | All "set" and "action" type requests require admin privileges | |
23 | (``CAP_NET_ADMIN`` in the namespace). Most "get" type requests are allowed for | |
24 | anyone but there are exceptions (where the response contains sensitive | |
25 | information). In some cases, the request as such is allowed for anyone but | |
26 | unprivileged users have attributes with sensitive information (e.g. | |
27 | wake-on-lan password) omitted. | |
28 | ||
29 | ||
30 | Conventions | |
31 | =========== | |
32 | ||
33 | Attributes which represent a boolean value usually use NLA_U8 type so that we | |
34 | can distinguish three states: "on", "off" and "not present" (meaning the | |
35 | information is not available in "get" requests or value is not to be changed | |
36 | in "set" requests). For these attributes, the "true" value should be passed as | |
37 | number 1 but any non-zero value should be understood as "true" by recipient. | |
38 | In the tables below, "bool" denotes NLA_U8 attributes interpreted in this way. | |
39 | ||
40 | In the message structure descriptions below, if an attribute name is suffixed | |
41 | with "+", parent nest can contain multiple attributes of the same type. This | |
42 | implements an array of entries. | |
43 | ||
44 | ||
45 | Request header | |
46 | ============== | |
47 | ||
48 | Each request or reply message contains a nested attribute with common header. | |
49 | Structure of this header is | |
50 | ||
51 | ============================== ====== ============================= | |
52 | ``ETHTOOL_A_HEADER_DEV_INDEX`` u32 device ifindex | |
53 | ``ETHTOOL_A_HEADER_DEV_NAME`` string device name | |
54 | ``ETHTOOL_A_HEADER_FLAGS`` u32 flags common for all requests | |
55 | ============================== ====== ============================= | |
56 | ||
57 | ``ETHTOOL_A_HEADER_DEV_INDEX`` and ``ETHTOOL_A_HEADER_DEV_NAME`` identify the | |
58 | device message relates to. One of them is sufficient in requests, if both are | |
59 | used, they must identify the same device. Some requests, e.g. global string | |
60 | sets, do not require device identification. Most ``GET`` requests also allow | |
61 | dump requests without device identification to query the same information for | |
62 | all devices providing it (each device in a separate message). | |
63 | ||
64 | ``ETHTOOL_A_HEADER_FLAGS`` is a bitmap of request flags common for all request | |
65 | types. The interpretation of these flags is the same for all request types but | |
66 | the flags may not apply to requests. Recognized flags are: | |
67 | ||
68 | ================================= =================================== | |
69 | ``ETHTOOL_FLAG_COMPACT_BITSETS`` use compact format bitsets in reply | |
70 | ``ETHTOOL_FLAG_OMIT_REPLY`` omit optional reply (_SET and _ACT) | |
71 | ================================= =================================== | |
72 | ||
73 | New request flags should follow the general idea that if the flag is not set, | |
74 | the behaviour is backward compatible, i.e. requests from old clients not aware | |
75 | of the flag should be interpreted the way the client expects. A client must | |
76 | not set flags it does not understand. | |
77 | ||
78 | ||
10b518d4 MK |
79 | Bit sets |
80 | ======== | |
81 | ||
82 | For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32`` | |
83 | type is used. For arbitrary length bitmaps, ethtool netlink uses a nested | |
84 | attribute with contents of one of two forms: compact (two binary bitmaps | |
85 | representing bit values and mask of affected bits) and bit-by-bit (list of | |
86 | bits identified by either index or name). | |
87 | ||
88 | Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together | |
89 | with their values which saves a round trip (when the bitset is passed in a | |
90 | request) or at least a second request (when the bitset is in a reply). This is | |
91 | useful for one shot applications like traditional ethtool command. On the | |
92 | other hand, long running applications like ethtool monitor (displaying | |
93 | notifications) or network management daemons may prefer fetching the names | |
94 | only once and using compact form to save message size. Notifications from | |
95 | ethtool netlink interface always use compact form for bitsets. | |
96 | ||
97 | A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK`` | |
98 | not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests | |
99 | modifying a bitmap, the former changes the bit set in mask to values set in | |
100 | value and preserves the rest; the latter sets the bits set in the bitmap and | |
101 | clears the rest. | |
102 | ||
103 | Compact form: nested (bitset) atrribute contents: | |
104 | ||
105 | ============================ ====== ============================ | |
106 | ``ETHTOOL_A_BITSET_NOMASK`` flag no mask, only a list | |
107 | ``ETHTOOL_A_BITSET_SIZE`` u32 number of significant bits | |
108 | ``ETHTOOL_A_BITSET_VALUE`` binary bitmap of bit values | |
109 | ``ETHTOOL_A_BITSET_MASK`` binary bitmap of valid bits | |
110 | ============================ ====== ============================ | |
111 | ||
112 | Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits | |
113 | rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte | |
114 | order, words ordered from least significant to most significant (i.e. the same | |
115 | way as bitmaps are passed with ioctl interface). | |
116 | ||
117 | For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are | |
118 | mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if | |
119 | ``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair); | |
120 | if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not | |
121 | allowed (bitset represents a single bitmap. | |
122 | ||
123 | Kernel bit set length may differ from userspace length if older application is | |
124 | used on newer kernel or vice versa. If userspace bitmap is longer, an error is | |
125 | issued only if the request actually tries to set values of some bits not | |
126 | recognized by kernel. | |
127 | ||
128 | Bit-by-bit form: nested (bitset) attribute contents: | |
129 | ||
130 | +------------------------------------+--------+-----------------------------+ | |
131 | | ``ETHTOOL_A_BITSET_NOMASK`` | flag | no mask, only a list | | |
132 | +------------------------------------+--------+-----------------------------+ | |
133 | | ``ETHTOOL_A_BITSET_SIZE`` | u32 | number of significant bits | | |
134 | +------------------------------------+--------+-----------------------------+ | |
135 | | ``ETHTOOL_A_BITSET_BITS`` | nested | array of bits | | |
136 | +-+----------------------------------+--------+-----------------------------+ | |
137 | | | ``ETHTOOL_A_BITSET_BITS_BIT+`` | nested | one bit | | |
138 | +-+-+--------------------------------+--------+-----------------------------+ | |
139 | | | | ``ETHTOOL_A_BITSET_BIT_INDEX`` | u32 | bit index (0 for LSB) | | |
140 | +-+-+--------------------------------+--------+-----------------------------+ | |
141 | | | | ``ETHTOOL_A_BITSET_BIT_NAME`` | string | bit name | | |
142 | +-+-+--------------------------------+--------+-----------------------------+ | |
143 | | | | ``ETHTOOL_A_BITSET_BIT_VALUE`` | flag | present if bit is set | | |
144 | +-+-+--------------------------------+--------+-----------------------------+ | |
145 | ||
146 | Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can | |
147 | only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an | |
148 | arbitrary number of them. A bit may be identified by its index or by its | |
149 | name. When used in requests, listed bits are set to 0 or 1 according to | |
150 | ``ETHTOOL_A_BITSET_BIT_VALUE``, the rest is preserved. A request fails if | |
151 | index exceeds kernel bit length or if name is not recognized. | |
152 | ||
153 | When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as | |
154 | a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in | |
155 | such case. Such bitset represents a bitmap with listed bits set and the rest | |
156 | zero. | |
157 | ||
158 | In requests, application can use either form. Form used by kernel in reply is | |
159 | determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request | |
160 | header. Semantics of value and mask depends on the attribute. | |
161 | ||
162 | ||
2b4a8990 MK |
163 | List of message types |
164 | ===================== | |
165 | ||
166 | All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix | |
167 | according to message purpose: | |
168 | ||
169 | ============== ====================================== | |
170 | ``_GET`` userspace request to retrieve data | |
171 | ``_SET`` userspace request to set data | |
172 | ``_ACT`` userspace request to perform an action | |
173 | ``_GET_REPLY`` kernel reply to a ``GET`` request | |
174 | ``_SET_REPLY`` kernel reply to a ``SET`` request | |
175 | ``_ACT_REPLY`` kernel reply to an ``ACT`` request | |
176 | ``_NTF`` kernel notification | |
177 | ============== ====================================== | |
178 | ||
71921690 MK |
179 | Userspace to kernel: |
180 | ||
181 | ===================================== ================================ | |
182 | ``ETHTOOL_MSG_STRSET_GET`` get string set | |
459e0b81 | 183 | ``ETHTOOL_MSG_LINKINFO_GET`` get link settings |
a53f3d41 | 184 | ``ETHTOOL_MSG_LINKINFO_SET`` set link settings |
f625aa9b | 185 | ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info |
bfbcfe20 | 186 | ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info |
3d2b847f | 187 | ``ETHTOOL_MSG_LINKSTATE_GET`` get link state |
6a94b8cc | 188 | ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings |
e54d04e3 | 189 | ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings |
51ea22b0 | 190 | ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings |
8d425b19 | 191 | ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings |
0524399d | 192 | ``ETHTOOL_MSG_FEATURES_GET`` get device features |
0980bfcd | 193 | ``ETHTOOL_MSG_FEATURES_SET`` set device features |
e16c3386 | 194 | ``ETHTOOL_MSG_PRIVFLAGS_GET`` get private flags |
f265d799 | 195 | ``ETHTOOL_MSG_PRIVFLAGS_SET`` set private flags |
71921690 MK |
196 | ===================================== ================================ |
197 | ||
198 | Kernel to userspace: | |
199 | ||
67bffa79 | 200 | ===================================== ================================= |
71921690 | 201 | ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents |
459e0b81 | 202 | ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings |
73286734 | 203 | ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification |
f625aa9b | 204 | ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info |
1b1b1847 | 205 | ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification |
3d2b847f | 206 | ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info |
6a94b8cc | 207 | ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings |
0bda7af3 | 208 | ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification |
51ea22b0 | 209 | ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings |
67bffa79 | 210 | ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification |
0524399d | 211 | ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features |
0980bfcd | 212 | ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET |
9c6451ef | 213 | ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification |
e16c3386 | 214 | ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags |
f265d799 | 215 | ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags |
67bffa79 | 216 | ===================================== ================================= |
71921690 | 217 | |
2b4a8990 MK |
218 | ``GET`` requests are sent by userspace applications to retrieve device |
219 | information. They usually do not contain any message specific attributes. | |
220 | Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET`` | |
221 | request with ``NLM_F_DUMP`` and no device identification can be used to query | |
222 | the information for all devices supporting the request. | |
223 | ||
224 | If the data can be also modified, corresponding ``SET`` message with the same | |
225 | layout as corresponding ``GET_REPLY`` is used to request changes. Only | |
226 | attributes where a change is requested are included in such request (also, not | |
227 | all attributes may be changed). Replies to most ``SET`` request consist only | |
228 | of error code and extack; if kernel provides additional data, it is sent in | |
229 | the form of corresponding ``SET_REPLY`` message which can be suppressed by | |
230 | setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header. | |
231 | ||
232 | Data modification also triggers sending a ``NTF`` message with a notification. | |
233 | These usually bear only a subset of attributes which was affected by the | |
234 | change. The same notification is issued if the data is modified using other | |
235 | means (mostly ioctl ethtool interface). Unlike notifications from ethtool | |
236 | netlink code which are only sent if something actually changed, notifications | |
237 | triggered by ioctl interface may be sent even if the request did not actually | |
238 | change any data. | |
239 | ||
240 | ``ACT`` messages request kernel (driver) to perform a specific action. If some | |
241 | information is reported by kernel (which can be suppressed by setting | |
242 | ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of | |
243 | an ``ACT_REPLY`` message. Performing an action also triggers a notification | |
244 | (``NTF`` message). | |
245 | ||
246 | Later sections describe the format and semantics of these messages. | |
247 | ||
248 | ||
71921690 MK |
249 | STRSET_GET |
250 | ========== | |
251 | ||
252 | Requests contents of a string set as provided by ioctl commands | |
253 | ``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user | |
254 | writeable so that the corresponding ``STRSET_SET`` message is only used in | |
255 | kernel replies. There are two types of string sets: global (independent of | |
256 | a device, e.g. device feature names) and device specific (e.g. device private | |
257 | flags). | |
258 | ||
259 | Request contents: | |
260 | ||
261 | +---------------------------------------+--------+------------------------+ | |
262 | | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header | | |
263 | +---------------------------------------+--------+------------------------+ | |
264 | | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request | | |
265 | +-+-------------------------------------+--------+------------------------+ | |
266 | | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | | |
267 | +-+-+-----------------------------------+--------+------------------------+ | |
268 | | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | | |
269 | +-+-+-----------------------------------+--------+------------------------+ | |
270 | ||
271 | Kernel response contents: | |
272 | ||
273 | +---------------------------------------+--------+-----------------------+ | |
274 | | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header | | |
275 | +---------------------------------------+--------+-----------------------+ | |
276 | | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets | | |
277 | +-+-------------------------------------+--------+-----------------------+ | |
278 | | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | | |
279 | +-+-+-----------------------------------+--------+-----------------------+ | |
280 | | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | | |
281 | +-+-+-----------------------------------+--------+-----------------------+ | |
282 | | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings | | |
283 | +-+-+-----------------------------------+--------+-----------------------+ | |
284 | | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings | | |
285 | +-+-+-+---------------------------------+--------+-----------------------+ | |
286 | | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string | | |
287 | +-+-+-+-+-------------------------------+--------+-----------------------+ | |
288 | | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index | | |
289 | +-+-+-+-+-------------------------------+--------+-----------------------+ | |
290 | | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value | | |
291 | +-+-+-+-+-------------------------------+--------+-----------------------+ | |
292 | | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts | | |
293 | +---------------------------------------+--------+-----------------------+ | |
294 | ||
295 | Device identification in request header is optional. Depending on its presence | |
296 | a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests: | |
297 | ||
298 | - no ``NLM_F_DUMP,`` no device: get "global" stringsets | |
299 | - no ``NLM_F_DUMP``, with device: get string sets related to the device | |
300 | - ``NLM_F_DUMP``, no device: get device related string sets for all devices | |
301 | ||
302 | If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of | |
303 | requested type are returned, otherwise only those specified in the request. | |
304 | Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string | |
305 | counts of the sets, not the actual strings. | |
306 | ||
307 | ||
459e0b81 MK |
308 | LINKINFO_GET |
309 | ============ | |
310 | ||
311 | Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for | |
312 | link modes and autonegotiation related information. The request does not use | |
313 | any attributes. | |
314 | ||
315 | Request contents: | |
316 | ||
317 | ==================================== ====== ========================== | |
318 | ``ETHTOOL_A_LINKINFO_HEADER`` nested request header | |
319 | ==================================== ====== ========================== | |
320 | ||
321 | Kernel response contents: | |
322 | ||
323 | ==================================== ====== ========================== | |
324 | ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header | |
325 | ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port | |
326 | ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address | |
327 | ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status | |
328 | ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control | |
329 | ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver | |
330 | ==================================== ====== ========================== | |
331 | ||
332 | Attributes and their values have the same meaning as matching members of the | |
333 | corresponding ioctl structures. | |
334 | ||
335 | ``LINKINFO_GET`` allows dump requests (kernel returns reply message for all | |
336 | devices supporting the request). | |
337 | ||
338 | ||
a53f3d41 MK |
339 | LINKINFO_SET |
340 | ============ | |
341 | ||
342 | ``LINKINFO_SET`` request allows setting some of the attributes reported by | |
343 | ``LINKINFO_GET``. | |
344 | ||
345 | Request contents: | |
346 | ||
347 | ==================================== ====== ========================== | |
348 | ``ETHTOOL_A_LINKINFO_HEADER`` nested request header | |
349 | ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port | |
350 | ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address | |
351 | ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control | |
352 | ==================================== ====== ========================== | |
353 | ||
354 | MDI(-X) status and transceiver cannot be set, request with the corresponding | |
355 | attributes is rejected. | |
356 | ||
357 | ||
f625aa9b MK |
358 | LINKMODES_GET |
359 | ============= | |
360 | ||
361 | Requests link modes (supported, advertised and peer advertised) and related | |
362 | information (autonegotiation status, link speed and duplex) as provided by | |
363 | ``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes. | |
364 | ||
365 | Request contents: | |
366 | ||
367 | ==================================== ====== ========================== | |
368 | ``ETHTOOL_A_LINKMODES_HEADER`` nested request header | |
369 | ==================================== ====== ========================== | |
370 | ||
371 | Kernel response contents: | |
372 | ||
373 | ==================================== ====== ========================== | |
374 | ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header | |
375 | ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status | |
376 | ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes | |
377 | ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes | |
378 | ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) | |
379 | ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode | |
380 | ==================================== ====== ========================== | |
381 | ||
382 | For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask | |
383 | represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit | |
384 | list. | |
385 | ||
386 | ``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all | |
387 | devices supporting the request). | |
388 | ||
389 | ||
bfbcfe20 MK |
390 | LINKMODES_SET |
391 | ============= | |
392 | ||
393 | Request contents: | |
394 | ||
395 | ==================================== ====== ========================== | |
396 | ``ETHTOOL_A_LINKMODES_HEADER`` nested request header | |
397 | ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status | |
398 | ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes | |
399 | ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes | |
400 | ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) | |
401 | ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode | |
402 | ==================================== ====== ========================== | |
403 | ||
404 | ``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If | |
405 | autonegotiation is on (either set now or kept from before), advertised modes | |
406 | are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one | |
407 | of speed and duplex is specified, kernel adjusts advertised modes to all | |
408 | supported modes matching speed, duplex or both (whatever is specified). This | |
409 | autoselection is done on ethtool side with ioctl interface, netlink interface | |
410 | is supposed to allow requesting changes without knowing what exactly kernel | |
411 | supports. | |
412 | ||
413 | ||
3d2b847f MK |
414 | LINKSTATE_GET |
415 | ============= | |
416 | ||
417 | Requests link state information. At the moment, only link up/down flag (as | |
418 | provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future | |
419 | extensions are planned (e.g. link down reason). This request does not have any | |
420 | attributes. | |
421 | ||
422 | Request contents: | |
423 | ||
424 | ==================================== ====== ========================== | |
425 | ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header | |
426 | ==================================== ====== ========================== | |
427 | ||
428 | Kernel response contents: | |
429 | ||
430 | ==================================== ====== ========================== | |
431 | ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header | |
432 | ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down) | |
433 | ==================================== ====== ========================== | |
434 | ||
435 | For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns | |
436 | carrier flag provided by ``netif_carrier_ok()`` but there are drivers which | |
437 | define their own handler. | |
438 | ||
439 | ``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all | |
440 | devices supporting the request). | |
441 | ||
442 | ||
6a94b8cc MK |
443 | DEBUG_GET |
444 | ========= | |
445 | ||
446 | Requests debugging settings of a device. At the moment, only message mask is | |
447 | provided. | |
448 | ||
449 | Request contents: | |
450 | ||
451 | ==================================== ====== ========================== | |
452 | ``ETHTOOL_A_DEBUG_HEADER`` nested request header | |
453 | ==================================== ====== ========================== | |
454 | ||
455 | Kernel response contents: | |
456 | ||
457 | ==================================== ====== ========================== | |
458 | ``ETHTOOL_A_DEBUG_HEADER`` nested reply header | |
459 | ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask | |
460 | ==================================== ====== ========================== | |
461 | ||
462 | The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as | |
463 | provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl | |
464 | interface. While it is called message level there for historical reasons, most | |
465 | drivers and almost all newer drivers use it as a mask of enabled message | |
466 | classes (represented by ``NETIF_MSG_*`` constants); therefore netlink | |
467 | interface follows its actual use in practice. | |
468 | ||
469 | ``DEBUG_GET`` allows dump requests (kernel returns reply messages for all | |
470 | devices supporting the request). | |
471 | ||
472 | ||
e54d04e3 MK |
473 | DEBUG_SET |
474 | ========= | |
475 | ||
476 | Set or update debugging settings of a device. At the moment, only message mask | |
477 | is supported. | |
478 | ||
479 | Request contents: | |
480 | ||
481 | ==================================== ====== ========================== | |
482 | ``ETHTOOL_A_DEBUG_HEADER`` nested request header | |
483 | ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask | |
484 | ==================================== ====== ========================== | |
485 | ||
486 | ``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of | |
487 | enabled debugging message types for the device. | |
488 | ||
489 | ||
51ea22b0 MK |
490 | WOL_GET |
491 | ======= | |
492 | ||
493 | Query device wake-on-lan settings. Unlike most "GET" type requests, | |
494 | ``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it | |
495 | (potentially) provides SecureOn(tm) password which is confidential. | |
496 | ||
497 | Request contents: | |
498 | ||
499 | ==================================== ====== ========================== | |
500 | ``ETHTOOL_A_WOL_HEADER`` nested request header | |
501 | ==================================== ====== ========================== | |
502 | ||
503 | Kernel response contents: | |
504 | ||
505 | ==================================== ====== ========================== | |
506 | ``ETHTOOL_A_WOL_HEADER`` nested reply header | |
507 | ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes | |
508 | ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password | |
509 | ==================================== ====== ========================== | |
510 | ||
511 | In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the | |
512 | device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only | |
513 | included in reply if ``WAKE_MAGICSECURE`` mode is supported. | |
514 | ||
515 | ||
8d425b19 MK |
516 | WOL_SET |
517 | ======= | |
518 | ||
519 | Set or update wake-on-lan settings. | |
520 | ||
521 | Request contents: | |
522 | ||
523 | ==================================== ====== ========================== | |
524 | ``ETHTOOL_A_WOL_HEADER`` nested request header | |
525 | ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes | |
526 | ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password | |
527 | ==================================== ====== ========================== | |
528 | ||
529 | ``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting | |
530 | ``WAKE_MAGICSECURE`` mode. | |
531 | ||
532 | ||
0524399d MK |
533 | FEATURES_GET |
534 | ============ | |
535 | ||
536 | Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request. | |
537 | ||
538 | Request contents: | |
539 | ||
540 | ==================================== ====== ========================== | |
541 | ``ETHTOOL_A_FEATURES_HEADER`` nested request header | |
542 | ==================================== ====== ========================== | |
543 | ||
544 | Kernel response contents: | |
545 | ||
546 | ==================================== ====== ========================== | |
547 | ``ETHTOOL_A_FEATURES_HEADER`` nested reply header | |
548 | ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features | |
549 | ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features | |
550 | ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features | |
551 | ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE | |
552 | ==================================== ====== ========================== | |
553 | ||
554 | Bitmaps in kernel response have the same meaning as bitmaps used in ioctl | |
555 | interference but attribute names are different (they are based on | |
556 | corresponding members of struct net_device). Legacy "flags" are not provided, | |
557 | if userspace needs them (most likely only ethtool for backward compatibility), | |
558 | it can calculate their values from related feature bits itself. | |
559 | ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to | |
560 | provide all names when using verbose bitmap format), the other three use no | |
561 | mask (simple bit lists). | |
562 | ||
563 | ||
0980bfcd MK |
564 | FEATURES_SET |
565 | ============ | |
566 | ||
567 | Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request. | |
568 | ||
569 | Request contents: | |
570 | ||
571 | ==================================== ====== ========================== | |
572 | ``ETHTOOL_A_FEATURES_HEADER`` nested request header | |
573 | ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features | |
574 | ==================================== ====== ========================== | |
575 | ||
576 | Kernel response contents: | |
577 | ||
578 | ==================================== ====== ========================== | |
579 | ``ETHTOOL_A_FEATURES_HEADER`` nested reply header | |
580 | ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result | |
581 | ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active | |
582 | ==================================== ====== ========================== | |
583 | ||
584 | Request constains only one bitset which can be either value/mask pair (request | |
585 | to change specific feature bits and leave the rest) or only a value (request | |
586 | to set all features to specified set). | |
587 | ||
588 | As request is subject to netdev_change_features() sanity checks, optional | |
589 | kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request | |
590 | header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED`` | |
591 | reports the difference between client request and actual result: mask consists | |
592 | of bits which differ between requested features and result (dev->features | |
593 | after the operation), value consists of values of these bits in the request | |
594 | (i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE`` | |
595 | reports the difference between old and new dev->features: mask consists of | |
596 | bits which have changed, values are their values in new dev->features (after | |
597 | the operation). | |
598 | ||
9c6451ef MK |
599 | ``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features |
600 | are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl | |
601 | request but also each time features are modified with netdev_update_features() | |
602 | or netdev_change_features(). | |
603 | ||
0980bfcd | 604 | |
e16c3386 MK |
605 | PRIVFLAGS_GET |
606 | ============= | |
607 | ||
608 | Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request. | |
609 | ||
610 | Request contents: | |
611 | ||
612 | ==================================== ====== ========================== | |
613 | ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header | |
614 | ==================================== ====== ========================== | |
615 | ||
616 | Kernel response contents: | |
617 | ||
618 | ==================================== ====== ========================== | |
619 | ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header | |
620 | ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags | |
621 | ==================================== ====== ========================== | |
622 | ||
623 | ``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags. | |
624 | These flags are defined by driver, their number and names (and also meaning) | |
625 | are device dependent. For compact bitset format, names can be retrieved as | |
626 | ``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested, | |
627 | response uses all private flags supported by the device as mask so that client | |
628 | gets the full information without having to fetch the string set with names. | |
629 | ||
630 | ||
f265d799 MK |
631 | PRIVFLAGS_SET |
632 | ============= | |
633 | ||
634 | Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS`` | |
635 | ioctl request. | |
636 | ||
637 | Request contents: | |
638 | ||
639 | ==================================== ====== ========================== | |
640 | ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header | |
641 | ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags | |
642 | ==================================== ====== ========================== | |
643 | ||
644 | ``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or | |
645 | modify only values of some of them. | |
646 | ||
647 | ||
2b4a8990 MK |
648 | Request translation |
649 | =================== | |
650 | ||
651 | The following table maps ioctl commands to netlink commands providing their | |
652 | functionality. Entries with "n/a" in right column are commands which do not | |
653 | have their netlink replacement yet. | |
654 | ||
655 | =================================== ===================================== | |
656 | ioctl command netlink command | |
657 | =================================== ===================================== | |
459e0b81 | 658 | ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET`` |
f625aa9b | 659 | ``ETHTOOL_MSG_LINKMODES_GET`` |
a53f3d41 | 660 | ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET`` |
bfbcfe20 | 661 | ``ETHTOOL_MSG_LINKMODES_SET`` |
2b4a8990 MK |
662 | ``ETHTOOL_GDRVINFO`` n/a |
663 | ``ETHTOOL_GREGS`` n/a | |
51ea22b0 | 664 | ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET`` |
8d425b19 | 665 | ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET`` |
6a94b8cc | 666 | ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET`` |
e54d04e3 | 667 | ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET`` |
2b4a8990 | 668 | ``ETHTOOL_NWAY_RST`` n/a |
3d2b847f | 669 | ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET`` |
2b4a8990 MK |
670 | ``ETHTOOL_GEEPROM`` n/a |
671 | ``ETHTOOL_SEEPROM`` n/a | |
672 | ``ETHTOOL_GCOALESCE`` n/a | |
673 | ``ETHTOOL_SCOALESCE`` n/a | |
674 | ``ETHTOOL_GRINGPARAM`` n/a | |
675 | ``ETHTOOL_SRINGPARAM`` n/a | |
676 | ``ETHTOOL_GPAUSEPARAM`` n/a | |
677 | ``ETHTOOL_SPAUSEPARAM`` n/a | |
0524399d | 678 | ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 679 | ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` |
0524399d | 680 | ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 681 | ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` |
0524399d | 682 | ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 683 | ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET`` |
2b4a8990 | 684 | ``ETHTOOL_TEST`` n/a |
71921690 | 685 | ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET`` |
2b4a8990 MK |
686 | ``ETHTOOL_PHYS_ID`` n/a |
687 | ``ETHTOOL_GSTATS`` n/a | |
0524399d | 688 | ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 689 | ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET`` |
2b4a8990 | 690 | ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK`` |
0524399d | 691 | ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 692 | ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET`` |
0524399d | 693 | ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 694 | ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET`` |
0524399d | 695 | ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 696 | ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET`` |
e16c3386 | 697 | ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET`` |
f265d799 | 698 | ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET`` |
2b4a8990 MK |
699 | ``ETHTOOL_GRXFH`` n/a |
700 | ``ETHTOOL_SRXFH`` n/a | |
0524399d | 701 | ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 702 | ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET`` |
2b4a8990 MK |
703 | ``ETHTOOL_GRXRINGS`` n/a |
704 | ``ETHTOOL_GRXCLSRLCNT`` n/a | |
705 | ``ETHTOOL_GRXCLSRULE`` n/a | |
706 | ``ETHTOOL_GRXCLSRLALL`` n/a | |
707 | ``ETHTOOL_SRXCLSRLDEL`` n/a | |
708 | ``ETHTOOL_SRXCLSRLINS`` n/a | |
709 | ``ETHTOOL_FLASHDEV`` n/a | |
710 | ``ETHTOOL_RESET`` n/a | |
711 | ``ETHTOOL_SRXNTUPLE`` n/a | |
712 | ``ETHTOOL_GRXNTUPLE`` n/a | |
71921690 | 713 | ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET`` |
2b4a8990 MK |
714 | ``ETHTOOL_GRXFHINDIR`` n/a |
715 | ``ETHTOOL_SRXFHINDIR`` n/a | |
0524399d | 716 | ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET`` |
0980bfcd | 717 | ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET`` |
2b4a8990 MK |
718 | ``ETHTOOL_GCHANNELS`` n/a |
719 | ``ETHTOOL_SCHANNELS`` n/a | |
720 | ``ETHTOOL_SET_DUMP`` n/a | |
721 | ``ETHTOOL_GET_DUMP_FLAG`` n/a | |
722 | ``ETHTOOL_GET_DUMP_DATA`` n/a | |
723 | ``ETHTOOL_GET_TS_INFO`` n/a | |
724 | ``ETHTOOL_GMODULEINFO`` n/a | |
725 | ``ETHTOOL_GMODULEEEPROM`` n/a | |
726 | ``ETHTOOL_GEEE`` n/a | |
727 | ``ETHTOOL_SEEE`` n/a | |
728 | ``ETHTOOL_GRSSH`` n/a | |
729 | ``ETHTOOL_SRSSH`` n/a | |
730 | ``ETHTOOL_GTUNABLE`` n/a | |
731 | ``ETHTOOL_STUNABLE`` n/a | |
732 | ``ETHTOOL_GPHYSTATS`` n/a | |
733 | ``ETHTOOL_PERQUEUE`` n/a | |
459e0b81 | 734 | ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET`` |
f625aa9b | 735 | ``ETHTOOL_MSG_LINKMODES_GET`` |
a53f3d41 | 736 | ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET`` |
bfbcfe20 | 737 | ``ETHTOOL_MSG_LINKMODES_SET`` |
2b4a8990 MK |
738 | ``ETHTOOL_PHY_GTUNABLE`` n/a |
739 | ``ETHTOOL_PHY_STUNABLE`` n/a | |
740 | ``ETHTOOL_GFECPARAM`` n/a | |
741 | ``ETHTOOL_SFECPARAM`` n/a | |
742 | =================================== ===================================== |