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 44 45Request header 46============== 47 48Each request or reply message contains a nested attribute with common header. 49Structure 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 58device message relates to. One of them is sufficient in requests, if both are 59used, they must identify the same device. Some requests, e.g. global string 60sets, do not require device identification. Most ``GET`` requests also allow 61dump requests without device identification to query the same information for 62all 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 65types. The interpretation of these flags is the same for all request types but 66the 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 73New request flags should follow the general idea that if the flag is not set, 74the behaviour is backward compatible, i.e. requests from old clients not aware 75of the flag should be interpreted the way the client expects. A client must 76not set flags it does not understand. 77 78 79Bit sets 80======== 81 82For short bitmaps of (reasonably) fixed length, standard ``NLA_BITFIELD32`` 83type is used. For arbitrary length bitmaps, ethtool netlink uses a nested 84attribute with contents of one of two forms: compact (two binary bitmaps 85representing bit values and mask of affected bits) and bit-by-bit (list of 86bits identified by either index or name). 87 88Verbose (bit-by-bit) bitsets allow sending symbolic names for bits together 89with their values which saves a round trip (when the bitset is passed in a 90request) or at least a second request (when the bitset is in a reply). This is 91useful for one shot applications like traditional ethtool command. On the 92other hand, long running applications like ethtool monitor (displaying 93notifications) or network management daemons may prefer fetching the names 94only once and using compact form to save message size. Notifications from 95ethtool netlink interface always use compact form for bitsets. 96 97A bitset can represent either a value/mask pair (``ETHTOOL_A_BITSET_NOMASK`` 98not set) or a single bitmap (``ETHTOOL_A_BITSET_NOMASK`` set). In requests 99modifying a bitmap, the former changes the bit set in mask to values set in 100value and preserves the rest; the latter sets the bits set in the bitmap and 101clears the rest. 102 103Compact 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 112Value and mask must have length at least ``ETHTOOL_A_BITSET_SIZE`` bits 113rounded up to a multiple of 32 bits. They consist of 32-bit words in host byte 114order, words ordered from least significant to most significant (i.e. the same 115way as bitmaps are passed with ioctl interface). 116 117For compact form, ``ETHTOOL_A_BITSET_SIZE`` and ``ETHTOOL_A_BITSET_VALUE`` are 118mandatory. ``ETHTOOL_A_BITSET_MASK`` attribute is mandatory if 119``ETHTOOL_A_BITSET_NOMASK`` is not set (bitset represents a value/mask pair); 120if ``ETHTOOL_A_BITSET_NOMASK`` is not set, ``ETHTOOL_A_BITSET_MASK`` is not 121allowed (bitset represents a single bitmap. 122 123Kernel bit set length may differ from userspace length if older application is 124used on newer kernel or vice versa. If userspace bitmap is longer, an error is 125issued only if the request actually tries to set values of some bits not 126recognized by kernel. 127 128Bit-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 146Bit size is optional for bit-by-bit form. ``ETHTOOL_A_BITSET_BITS`` nest can 147only contain ``ETHTOOL_A_BITSET_BITS_BIT`` attributes but there can be an 148arbitrary number of them. A bit may be identified by its index or by its 149name. 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 151index exceeds kernel bit length or if name is not recognized. 152 153When ``ETHTOOL_A_BITSET_NOMASK`` flag is present, bitset is interpreted as 154a simple bitmap. ``ETHTOOL_A_BITSET_BIT_VALUE`` attributes are not used in 155such case. Such bitset represents a bitmap with listed bits set and the rest 156zero. 157 158In requests, application can use either form. Form used by kernel in reply is 159determined by ``ETHTOOL_FLAG_COMPACT_BITSETS`` flag in flags field of request 160header. Semantics of value and mask depends on the attribute. 161 162 163List of message types 164===================== 165 166All constants identifying message types use ``ETHTOOL_CMD_`` prefix and suffix 167according 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 179Userspace to kernel: 180 181 ===================================== ================================ 182 ``ETHTOOL_MSG_STRSET_GET`` get string set 183 ``ETHTOOL_MSG_LINKINFO_GET`` get link settings 184 ``ETHTOOL_MSG_LINKINFO_SET`` set link settings 185 ``ETHTOOL_MSG_LINKMODES_GET`` get link modes info 186 ``ETHTOOL_MSG_LINKMODES_SET`` set link modes info 187 ``ETHTOOL_MSG_LINKSTATE_GET`` get link state 188 ``ETHTOOL_MSG_DEBUG_GET`` get debugging settings 189 ``ETHTOOL_MSG_DEBUG_SET`` set debugging settings 190 ``ETHTOOL_MSG_WOL_GET`` get wake-on-lan settings 191 ``ETHTOOL_MSG_WOL_SET`` set wake-on-lan settings 192 ``ETHTOOL_MSG_FEATURES_GET`` get device features 193 ``ETHTOOL_MSG_FEATURES_SET`` set device features 194 ``ETHTOOL_MSG_PRIVFLAGS_GET`` get private flags 195 ``ETHTOOL_MSG_PRIVFLAGS_SET`` set private flags 196 ``ETHTOOL_MSG_RINGS_GET`` get ring sizes 197 ``ETHTOOL_MSG_RINGS_SET`` set ring sizes 198 ``ETHTOOL_MSG_CHANNELS_GET`` get channel counts 199 ``ETHTOOL_MSG_CHANNELS_SET`` set channel counts 200 ===================================== ================================ 201 202Kernel to userspace: 203 204 ===================================== ================================= 205 ``ETHTOOL_MSG_STRSET_GET_REPLY`` string set contents 206 ``ETHTOOL_MSG_LINKINFO_GET_REPLY`` link settings 207 ``ETHTOOL_MSG_LINKINFO_NTF`` link settings notification 208 ``ETHTOOL_MSG_LINKMODES_GET_REPLY`` link modes info 209 ``ETHTOOL_MSG_LINKMODES_NTF`` link modes notification 210 ``ETHTOOL_MSG_LINKSTATE_GET_REPLY`` link state info 211 ``ETHTOOL_MSG_DEBUG_GET_REPLY`` debugging settings 212 ``ETHTOOL_MSG_DEBUG_NTF`` debugging settings notification 213 ``ETHTOOL_MSG_WOL_GET_REPLY`` wake-on-lan settings 214 ``ETHTOOL_MSG_WOL_NTF`` wake-on-lan settings notification 215 ``ETHTOOL_MSG_FEATURES_GET_REPLY`` device features 216 ``ETHTOOL_MSG_FEATURES_SET_REPLY`` optional reply to FEATURES_SET 217 ``ETHTOOL_MSG_FEATURES_NTF`` netdev features notification 218 ``ETHTOOL_MSG_PRIVFLAGS_GET_REPLY`` private flags 219 ``ETHTOOL_MSG_PRIVFLAGS_NTF`` private flags 220 ``ETHTOOL_MSG_RINGS_GET_REPLY`` ring sizes 221 ``ETHTOOL_MSG_RINGS_NTF`` ring sizes 222 ``ETHTOOL_MSG_CHANNELS_GET_REPLY`` channel counts 223 ``ETHTOOL_MSG_CHANNELS_NTF`` channel counts 224 ===================================== ================================= 225 226``GET`` requests are sent by userspace applications to retrieve device 227information. They usually do not contain any message specific attributes. 228Kernel replies with corresponding "GET_REPLY" message. For most types, ``GET`` 229request with ``NLM_F_DUMP`` and no device identification can be used to query 230the information for all devices supporting the request. 231 232If the data can be also modified, corresponding ``SET`` message with the same 233layout as corresponding ``GET_REPLY`` is used to request changes. Only 234attributes where a change is requested are included in such request (also, not 235all attributes may be changed). Replies to most ``SET`` request consist only 236of error code and extack; if kernel provides additional data, it is sent in 237the form of corresponding ``SET_REPLY`` message which can be suppressed by 238setting ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header. 239 240Data modification also triggers sending a ``NTF`` message with a notification. 241These usually bear only a subset of attributes which was affected by the 242change. The same notification is issued if the data is modified using other 243means (mostly ioctl ethtool interface). Unlike notifications from ethtool 244netlink code which are only sent if something actually changed, notifications 245triggered by ioctl interface may be sent even if the request did not actually 246change any data. 247 248``ACT`` messages request kernel (driver) to perform a specific action. If some 249information is reported by kernel (which can be suppressed by setting 250``ETHTOOL_FLAG_OMIT_REPLY`` flag in request header), the reply takes form of 251an ``ACT_REPLY`` message. Performing an action also triggers a notification 252(``NTF`` message). 253 254Later sections describe the format and semantics of these messages. 255 256 257STRSET_GET 258========== 259 260Requests contents of a string set as provided by ioctl commands 261``ETHTOOL_GSSET_INFO`` and ``ETHTOOL_GSTRINGS.`` String sets are not user 262writeable so that the corresponding ``STRSET_SET`` message is only used in 263kernel replies. There are two types of string sets: global (independent of 264a device, e.g. device feature names) and device specific (e.g. device private 265flags). 266 267Request contents: 268 269 +---------------------------------------+--------+------------------------+ 270 | ``ETHTOOL_A_STRSET_HEADER`` | nested | request header | 271 +---------------------------------------+--------+------------------------+ 272 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | string set to request | 273 +-+-------------------------------------+--------+------------------------+ 274 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | 275 +-+-+-----------------------------------+--------+------------------------+ 276 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | 277 +-+-+-----------------------------------+--------+------------------------+ 278 279Kernel response contents: 280 281 +---------------------------------------+--------+-----------------------+ 282 | ``ETHTOOL_A_STRSET_HEADER`` | nested | reply header | 283 +---------------------------------------+--------+-----------------------+ 284 | ``ETHTOOL_A_STRSET_STRINGSETS`` | nested | array of string sets | 285 +-+-------------------------------------+--------+-----------------------+ 286 | | ``ETHTOOL_A_STRINGSETS_STRINGSET+`` | nested | one string set | 287 +-+-+-----------------------------------+--------+-----------------------+ 288 | | | ``ETHTOOL_A_STRINGSET_ID`` | u32 | set id | 289 +-+-+-----------------------------------+--------+-----------------------+ 290 | | | ``ETHTOOL_A_STRINGSET_COUNT`` | u32 | number of strings | 291 +-+-+-----------------------------------+--------+-----------------------+ 292 | | | ``ETHTOOL_A_STRINGSET_STRINGS`` | nested | array of strings | 293 +-+-+-+---------------------------------+--------+-----------------------+ 294 | | | | ``ETHTOOL_A_STRINGS_STRING+`` | nested | one string | 295 +-+-+-+-+-------------------------------+--------+-----------------------+ 296 | | | | | ``ETHTOOL_A_STRING_INDEX`` | u32 | string index | 297 +-+-+-+-+-------------------------------+--------+-----------------------+ 298 | | | | | ``ETHTOOL_A_STRING_VALUE`` | string | string value | 299 +-+-+-+-+-------------------------------+--------+-----------------------+ 300 | ``ETHTOOL_A_STRSET_COUNTS_ONLY`` | flag | return only counts | 301 +---------------------------------------+--------+-----------------------+ 302 303Device identification in request header is optional. Depending on its presence 304a and ``NLM_F_DUMP`` flag, there are three type of ``STRSET_GET`` requests: 305 306 - no ``NLM_F_DUMP,`` no device: get "global" stringsets 307 - no ``NLM_F_DUMP``, with device: get string sets related to the device 308 - ``NLM_F_DUMP``, no device: get device related string sets for all devices 309 310If there is no ``ETHTOOL_A_STRSET_STRINGSETS`` array, all string sets of 311requested type are returned, otherwise only those specified in the request. 312Flag ``ETHTOOL_A_STRSET_COUNTS_ONLY`` tells kernel to only return string 313counts of the sets, not the actual strings. 314 315 316LINKINFO_GET 317============ 318 319Requests link settings as provided by ``ETHTOOL_GLINKSETTINGS`` except for 320link modes and autonegotiation related information. The request does not use 321any attributes. 322 323Request contents: 324 325 ==================================== ====== ========================== 326 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header 327 ==================================== ====== ========================== 328 329Kernel response contents: 330 331 ==================================== ====== ========================== 332 ``ETHTOOL_A_LINKINFO_HEADER`` nested reply header 333 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port 334 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address 335 ``ETHTOOL_A_LINKINFO_TP_MDIX`` u8 MDI(-X) status 336 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control 337 ``ETHTOOL_A_LINKINFO_TRANSCEIVER`` u8 transceiver 338 ==================================== ====== ========================== 339 340Attributes and their values have the same meaning as matching members of the 341corresponding ioctl structures. 342 343``LINKINFO_GET`` allows dump requests (kernel returns reply message for all 344devices supporting the request). 345 346 347LINKINFO_SET 348============ 349 350``LINKINFO_SET`` request allows setting some of the attributes reported by 351``LINKINFO_GET``. 352 353Request contents: 354 355 ==================================== ====== ========================== 356 ``ETHTOOL_A_LINKINFO_HEADER`` nested request header 357 ``ETHTOOL_A_LINKINFO_PORT`` u8 physical port 358 ``ETHTOOL_A_LINKINFO_PHYADDR`` u8 phy MDIO address 359 ``ETHTOOL_A_LINKINFO_TP_MDIX_CTRL`` u8 MDI(-X) control 360 ==================================== ====== ========================== 361 362MDI(-X) status and transceiver cannot be set, request with the corresponding 363attributes is rejected. 364 365 366LINKMODES_GET 367============= 368 369Requests link modes (supported, advertised and peer advertised) and related 370information (autonegotiation status, link speed and duplex) as provided by 371``ETHTOOL_GLINKSETTINGS``. The request does not use any attributes. 372 373Request contents: 374 375 ==================================== ====== ========================== 376 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header 377 ==================================== ====== ========================== 378 379Kernel response contents: 380 381 ==================================== ====== ========================== 382 ``ETHTOOL_A_LINKMODES_HEADER`` nested reply header 383 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status 384 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes 385 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes 386 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) 387 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode 388 ==================================== ====== ========================== 389 390For ``ETHTOOL_A_LINKMODES_OURS``, value represents advertised modes and mask 391represents supported modes. ``ETHTOOL_A_LINKMODES_PEER`` in the reply is a bit 392list. 393 394``LINKMODES_GET`` allows dump requests (kernel returns reply messages for all 395devices supporting the request). 396 397 398LINKMODES_SET 399============= 400 401Request contents: 402 403 ==================================== ====== ========================== 404 ``ETHTOOL_A_LINKMODES_HEADER`` nested request header 405 ``ETHTOOL_A_LINKMODES_AUTONEG`` u8 autonegotiation status 406 ``ETHTOOL_A_LINKMODES_OURS`` bitset advertised link modes 407 ``ETHTOOL_A_LINKMODES_PEER`` bitset partner link modes 408 ``ETHTOOL_A_LINKMODES_SPEED`` u32 link speed (Mb/s) 409 ``ETHTOOL_A_LINKMODES_DUPLEX`` u8 duplex mode 410 ==================================== ====== ========================== 411 412``ETHTOOL_A_LINKMODES_OURS`` bit set allows setting advertised link modes. If 413autonegotiation is on (either set now or kept from before), advertised modes 414are not changed (no ``ETHTOOL_A_LINKMODES_OURS`` attribute) and at least one 415of speed and duplex is specified, kernel adjusts advertised modes to all 416supported modes matching speed, duplex or both (whatever is specified). This 417autoselection is done on ethtool side with ioctl interface, netlink interface 418is supposed to allow requesting changes without knowing what exactly kernel 419supports. 420 421 422LINKSTATE_GET 423============= 424 425Requests link state information. At the moment, only link up/down flag (as 426provided by ``ETHTOOL_GLINK`` ioctl command) is provided but some future 427extensions are planned (e.g. link down reason). This request does not have any 428attributes. 429 430Request contents: 431 432 ==================================== ====== ========================== 433 ``ETHTOOL_A_LINKSTATE_HEADER`` nested request header 434 ==================================== ====== ========================== 435 436Kernel response contents: 437 438 ==================================== ====== ========================== 439 ``ETHTOOL_A_LINKSTATE_HEADER`` nested reply header 440 ``ETHTOOL_A_LINKSTATE_LINK`` bool link state (up/down) 441 ==================================== ====== ========================== 442 443For most NIC drivers, the value of ``ETHTOOL_A_LINKSTATE_LINK`` returns 444carrier flag provided by ``netif_carrier_ok()`` but there are drivers which 445define their own handler. 446 447``LINKSTATE_GET`` allows dump requests (kernel returns reply messages for all 448devices supporting the request). 449 450 451DEBUG_GET 452========= 453 454Requests debugging settings of a device. At the moment, only message mask is 455provided. 456 457Request contents: 458 459 ==================================== ====== ========================== 460 ``ETHTOOL_A_DEBUG_HEADER`` nested request header 461 ==================================== ====== ========================== 462 463Kernel response contents: 464 465 ==================================== ====== ========================== 466 ``ETHTOOL_A_DEBUG_HEADER`` nested reply header 467 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask 468 ==================================== ====== ========================== 469 470The message mask (``ETHTOOL_A_DEBUG_MSGMASK``) is equal to message level as 471provided by ``ETHTOOL_GMSGLVL`` and set by ``ETHTOOL_SMSGLVL`` in ioctl 472interface. While it is called message level there for historical reasons, most 473drivers and almost all newer drivers use it as a mask of enabled message 474classes (represented by ``NETIF_MSG_*`` constants); therefore netlink 475interface follows its actual use in practice. 476 477``DEBUG_GET`` allows dump requests (kernel returns reply messages for all 478devices supporting the request). 479 480 481DEBUG_SET 482========= 483 484Set or update debugging settings of a device. At the moment, only message mask 485is supported. 486 487Request contents: 488 489 ==================================== ====== ========================== 490 ``ETHTOOL_A_DEBUG_HEADER`` nested request header 491 ``ETHTOOL_A_DEBUG_MSGMASK`` bitset message mask 492 ==================================== ====== ========================== 493 494``ETHTOOL_A_DEBUG_MSGMASK`` bit set allows setting or modifying mask of 495enabled debugging message types for the device. 496 497 498WOL_GET 499======= 500 501Query device wake-on-lan settings. Unlike most "GET" type requests, 502``ETHTOOL_MSG_WOL_GET`` requires (netns) ``CAP_NET_ADMIN`` privileges as it 503(potentially) provides SecureOn(tm) password which is confidential. 504 505Request contents: 506 507 ==================================== ====== ========================== 508 ``ETHTOOL_A_WOL_HEADER`` nested request header 509 ==================================== ====== ========================== 510 511Kernel response contents: 512 513 ==================================== ====== ========================== 514 ``ETHTOOL_A_WOL_HEADER`` nested reply header 515 ``ETHTOOL_A_WOL_MODES`` bitset mask of enabled WoL modes 516 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password 517 ==================================== ====== ========================== 518 519In reply, ``ETHTOOL_A_WOL_MODES`` mask consists of modes supported by the 520device, value of modes which are enabled. ``ETHTOOL_A_WOL_SOPASS`` is only 521included in reply if ``WAKE_MAGICSECURE`` mode is supported. 522 523 524WOL_SET 525======= 526 527Set or update wake-on-lan settings. 528 529Request contents: 530 531 ==================================== ====== ========================== 532 ``ETHTOOL_A_WOL_HEADER`` nested request header 533 ``ETHTOOL_A_WOL_MODES`` bitset enabled WoL modes 534 ``ETHTOOL_A_WOL_SOPASS`` binary SecureOn(tm) password 535 ==================================== ====== ========================== 536 537``ETHTOOL_A_WOL_SOPASS`` is only allowed for devices supporting 538``WAKE_MAGICSECURE`` mode. 539 540 541FEATURES_GET 542============ 543 544Gets netdev features like ``ETHTOOL_GFEATURES`` ioctl request. 545 546Request contents: 547 548 ==================================== ====== ========================== 549 ``ETHTOOL_A_FEATURES_HEADER`` nested request header 550 ==================================== ====== ========================== 551 552Kernel response contents: 553 554 ==================================== ====== ========================== 555 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header 556 ``ETHTOOL_A_FEATURES_HW`` bitset dev->hw_features 557 ``ETHTOOL_A_FEATURES_WANTED`` bitset dev->wanted_features 558 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset dev->features 559 ``ETHTOOL_A_FEATURES_NOCHANGE`` bitset NETIF_F_NEVER_CHANGE 560 ==================================== ====== ========================== 561 562Bitmaps in kernel response have the same meaning as bitmaps used in ioctl 563interference but attribute names are different (they are based on 564corresponding members of struct net_device). Legacy "flags" are not provided, 565if userspace needs them (most likely only ethtool for backward compatibility), 566it can calculate their values from related feature bits itself. 567ETHA_FEATURES_HW uses mask consisting of all features recognized by kernel (to 568provide all names when using verbose bitmap format), the other three use no 569mask (simple bit lists). 570 571 572FEATURES_SET 573============ 574 575Request to set netdev features like ``ETHTOOL_SFEATURES`` ioctl request. 576 577Request contents: 578 579 ==================================== ====== ========================== 580 ``ETHTOOL_A_FEATURES_HEADER`` nested request header 581 ``ETHTOOL_A_FEATURES_WANTED`` bitset requested features 582 ==================================== ====== ========================== 583 584Kernel response contents: 585 586 ==================================== ====== ========================== 587 ``ETHTOOL_A_FEATURES_HEADER`` nested reply header 588 ``ETHTOOL_A_FEATURES_WANTED`` bitset diff wanted vs. result 589 ``ETHTOOL_A_FEATURES_ACTIVE`` bitset diff old vs. new active 590 ==================================== ====== ========================== 591 592Request constains only one bitset which can be either value/mask pair (request 593to change specific feature bits and leave the rest) or only a value (request 594to set all features to specified set). 595 596As request is subject to netdev_change_features() sanity checks, optional 597kernel reply (can be suppressed by ``ETHTOOL_FLAG_OMIT_REPLY`` flag in request 598header) informs client about the actual result. ``ETHTOOL_A_FEATURES_WANTED`` 599reports the difference between client request and actual result: mask consists 600of bits which differ between requested features and result (dev->features 601after the operation), value consists of values of these bits in the request 602(i.e. negated values from resulting features). ``ETHTOOL_A_FEATURES_ACTIVE`` 603reports the difference between old and new dev->features: mask consists of 604bits which have changed, values are their values in new dev->features (after 605the operation). 606 607``ETHTOOL_MSG_FEATURES_NTF`` notification is sent not only if device features 608are modified using ``ETHTOOL_MSG_FEATURES_SET`` request or on of ethtool ioctl 609request but also each time features are modified with netdev_update_features() 610or netdev_change_features(). 611 612 613PRIVFLAGS_GET 614============= 615 616Gets private flags like ``ETHTOOL_GPFLAGS`` ioctl request. 617 618Request contents: 619 620 ==================================== ====== ========================== 621 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header 622 ==================================== ====== ========================== 623 624Kernel response contents: 625 626 ==================================== ====== ========================== 627 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested reply header 628 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags 629 ==================================== ====== ========================== 630 631``ETHTOOL_A_PRIVFLAGS_FLAGS`` is a bitset with values of device private flags. 632These flags are defined by driver, their number and names (and also meaning) 633are device dependent. For compact bitset format, names can be retrieved as 634``ETH_SS_PRIV_FLAGS`` string set. If verbose bitset format is requested, 635response uses all private flags supported by the device as mask so that client 636gets the full information without having to fetch the string set with names. 637 638 639PRIVFLAGS_SET 640============= 641 642Sets or modifies values of device private flags like ``ETHTOOL_SPFLAGS`` 643ioctl request. 644 645Request contents: 646 647 ==================================== ====== ========================== 648 ``ETHTOOL_A_PRIVFLAGS_HEADER`` nested request header 649 ``ETHTOOL_A_PRIVFLAGS_FLAGS`` bitset private flags 650 ==================================== ====== ========================== 651 652``ETHTOOL_A_PRIVFLAGS_FLAGS`` can either set the whole set of private flags or 653modify only values of some of them. 654 655 656RINGS_GET 657========= 658 659Gets ring sizes like ``ETHTOOL_GRINGPARAM`` ioctl request. 660 661Request contents: 662 663 ==================================== ====== ========================== 664 ``ETHTOOL_A_RINGS_HEADER`` nested request header 665 ==================================== ====== ========================== 666 667Kernel response contents: 668 669 ==================================== ====== ========================== 670 ``ETHTOOL_A_RINGS_HEADER`` nested reply header 671 ``ETHTOOL_A_RINGS_RX_MAX`` u32 max size of RX ring 672 ``ETHTOOL_A_RINGS_RX_MINI_MAX`` u32 max size of RX mini ring 673 ``ETHTOOL_A_RINGS_RX_JUMBO_MAX`` u32 max size of RX jumbo ring 674 ``ETHTOOL_A_RINGS_TX_MAX`` u32 max size of TX ring 675 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring 676 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring 677 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring 678 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring 679 ==================================== ====== ========================== 680 681 682RINGS_SET 683========= 684 685Sets ring sizes like ``ETHTOOL_SRINGPARAM`` ioctl request. 686 687Request contents: 688 689 ==================================== ====== ========================== 690 ``ETHTOOL_A_RINGS_HEADER`` nested reply header 691 ``ETHTOOL_A_RINGS_RX`` u32 size of RX ring 692 ``ETHTOOL_A_RINGS_RX_MINI`` u32 size of RX mini ring 693 ``ETHTOOL_A_RINGS_RX_JUMBO`` u32 size of RX jumbo ring 694 ``ETHTOOL_A_RINGS_TX`` u32 size of TX ring 695 ==================================== ====== ========================== 696 697Kernel checks that requested ring sizes do not exceed limits reported by 698driver. Driver may impose additional constraints and may not suspport all 699attributes. 700 701 702CHANNELS_GET 703============ 704 705Gets channel counts like ``ETHTOOL_GCHANNELS`` ioctl request. 706 707Request contents: 708 709 ==================================== ====== ========================== 710 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header 711 ==================================== ====== ========================== 712 713Kernel response contents: 714 715 ===================================== ====== ========================== 716 ``ETHTOOL_A_CHANNELS_HEADER`` nested reply header 717 ``ETHTOOL_A_CHANNELS_RX_MAX`` u32 max receive channels 718 ``ETHTOOL_A_CHANNELS_TX_MAX`` u32 max transmit channels 719 ``ETHTOOL_A_CHANNELS_OTHER_MAX`` u32 max other channels 720 ``ETHTOOL_A_CHANNELS_COMBINED_MAX`` u32 max combined channels 721 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count 722 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count 723 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count 724 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count 725 ===================================== ====== ========================== 726 727 728CHANNELS_SET 729============ 730 731Sets channel counts like ``ETHTOOL_SCHANNELS`` ioctl request. 732 733Request contents: 734 735 ===================================== ====== ========================== 736 ``ETHTOOL_A_CHANNELS_HEADER`` nested request header 737 ``ETHTOOL_A_CHANNELS_RX_COUNT`` u32 receive channel count 738 ``ETHTOOL_A_CHANNELS_TX_COUNT`` u32 transmit channel count 739 ``ETHTOOL_A_CHANNELS_OTHER_COUNT`` u32 other channel count 740 ``ETHTOOL_A_CHANNELS_COMBINED_COUNT`` u32 combined channel count 741 ===================================== ====== ========================== 742 743Kernel checks that requested channel counts do not exceed limits reported by 744driver. Driver may impose additional constraints and may not suspport all 745attributes. 746 747 748Request translation 749=================== 750 751The following table maps ioctl commands to netlink commands providing their 752functionality. Entries with "n/a" in right column are commands which do not 753have their netlink replacement yet. 754 755 =================================== ===================================== 756 ioctl command netlink command 757 =================================== ===================================== 758 ``ETHTOOL_GSET`` ``ETHTOOL_MSG_LINKINFO_GET`` 759 ``ETHTOOL_MSG_LINKMODES_GET`` 760 ``ETHTOOL_SSET`` ``ETHTOOL_MSG_LINKINFO_SET`` 761 ``ETHTOOL_MSG_LINKMODES_SET`` 762 ``ETHTOOL_GDRVINFO`` n/a 763 ``ETHTOOL_GREGS`` n/a 764 ``ETHTOOL_GWOL`` ``ETHTOOL_MSG_WOL_GET`` 765 ``ETHTOOL_SWOL`` ``ETHTOOL_MSG_WOL_SET`` 766 ``ETHTOOL_GMSGLVL`` ``ETHTOOL_MSG_DEBUG_GET`` 767 ``ETHTOOL_SMSGLVL`` ``ETHTOOL_MSG_DEBUG_SET`` 768 ``ETHTOOL_NWAY_RST`` n/a 769 ``ETHTOOL_GLINK`` ``ETHTOOL_MSG_LINKSTATE_GET`` 770 ``ETHTOOL_GEEPROM`` n/a 771 ``ETHTOOL_SEEPROM`` n/a 772 ``ETHTOOL_GCOALESCE`` n/a 773 ``ETHTOOL_SCOALESCE`` n/a 774 ``ETHTOOL_GRINGPARAM`` ``ETHTOOL_MSG_RINGS_GET`` 775 ``ETHTOOL_SRINGPARAM`` ``ETHTOOL_MSG_RINGS_SET`` 776 ``ETHTOOL_GPAUSEPARAM`` n/a 777 ``ETHTOOL_SPAUSEPARAM`` n/a 778 ``ETHTOOL_GRXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` 779 ``ETHTOOL_SRXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` 780 ``ETHTOOL_GTXCSUM`` ``ETHTOOL_MSG_FEATURES_GET`` 781 ``ETHTOOL_STXCSUM`` ``ETHTOOL_MSG_FEATURES_SET`` 782 ``ETHTOOL_GSG`` ``ETHTOOL_MSG_FEATURES_GET`` 783 ``ETHTOOL_SSG`` ``ETHTOOL_MSG_FEATURES_SET`` 784 ``ETHTOOL_TEST`` n/a 785 ``ETHTOOL_GSTRINGS`` ``ETHTOOL_MSG_STRSET_GET`` 786 ``ETHTOOL_PHYS_ID`` n/a 787 ``ETHTOOL_GSTATS`` n/a 788 ``ETHTOOL_GTSO`` ``ETHTOOL_MSG_FEATURES_GET`` 789 ``ETHTOOL_STSO`` ``ETHTOOL_MSG_FEATURES_SET`` 790 ``ETHTOOL_GPERMADDR`` rtnetlink ``RTM_GETLINK`` 791 ``ETHTOOL_GUFO`` ``ETHTOOL_MSG_FEATURES_GET`` 792 ``ETHTOOL_SUFO`` ``ETHTOOL_MSG_FEATURES_SET`` 793 ``ETHTOOL_GGSO`` ``ETHTOOL_MSG_FEATURES_GET`` 794 ``ETHTOOL_SGSO`` ``ETHTOOL_MSG_FEATURES_SET`` 795 ``ETHTOOL_GFLAGS`` ``ETHTOOL_MSG_FEATURES_GET`` 796 ``ETHTOOL_SFLAGS`` ``ETHTOOL_MSG_FEATURES_SET`` 797 ``ETHTOOL_GPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_GET`` 798 ``ETHTOOL_SPFLAGS`` ``ETHTOOL_MSG_PRIVFLAGS_SET`` 799 ``ETHTOOL_GRXFH`` n/a 800 ``ETHTOOL_SRXFH`` n/a 801 ``ETHTOOL_GGRO`` ``ETHTOOL_MSG_FEATURES_GET`` 802 ``ETHTOOL_SGRO`` ``ETHTOOL_MSG_FEATURES_SET`` 803 ``ETHTOOL_GRXRINGS`` n/a 804 ``ETHTOOL_GRXCLSRLCNT`` n/a 805 ``ETHTOOL_GRXCLSRULE`` n/a 806 ``ETHTOOL_GRXCLSRLALL`` n/a 807 ``ETHTOOL_SRXCLSRLDEL`` n/a 808 ``ETHTOOL_SRXCLSRLINS`` n/a 809 ``ETHTOOL_FLASHDEV`` n/a 810 ``ETHTOOL_RESET`` n/a 811 ``ETHTOOL_SRXNTUPLE`` n/a 812 ``ETHTOOL_GRXNTUPLE`` n/a 813 ``ETHTOOL_GSSET_INFO`` ``ETHTOOL_MSG_STRSET_GET`` 814 ``ETHTOOL_GRXFHINDIR`` n/a 815 ``ETHTOOL_SRXFHINDIR`` n/a 816 ``ETHTOOL_GFEATURES`` ``ETHTOOL_MSG_FEATURES_GET`` 817 ``ETHTOOL_SFEATURES`` ``ETHTOOL_MSG_FEATURES_SET`` 818 ``ETHTOOL_GCHANNELS`` ``ETHTOOL_MSG_CHANNELS_GET`` 819 ``ETHTOOL_SCHANNELS`` ``ETHTOOL_MSG_CHANNELS_SET`` 820 ``ETHTOOL_SET_DUMP`` n/a 821 ``ETHTOOL_GET_DUMP_FLAG`` n/a 822 ``ETHTOOL_GET_DUMP_DATA`` n/a 823 ``ETHTOOL_GET_TS_INFO`` n/a 824 ``ETHTOOL_GMODULEINFO`` n/a 825 ``ETHTOOL_GMODULEEEPROM`` n/a 826 ``ETHTOOL_GEEE`` n/a 827 ``ETHTOOL_SEEE`` n/a 828 ``ETHTOOL_GRSSH`` n/a 829 ``ETHTOOL_SRSSH`` n/a 830 ``ETHTOOL_GTUNABLE`` n/a 831 ``ETHTOOL_STUNABLE`` n/a 832 ``ETHTOOL_GPHYSTATS`` n/a 833 ``ETHTOOL_PERQUEUE`` n/a 834 ``ETHTOOL_GLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_GET`` 835 ``ETHTOOL_MSG_LINKMODES_GET`` 836 ``ETHTOOL_SLINKSETTINGS`` ``ETHTOOL_MSG_LINKINFO_SET`` 837 ``ETHTOOL_MSG_LINKMODES_SET`` 838 ``ETHTOOL_PHY_GTUNABLE`` n/a 839 ``ETHTOOL_PHY_STUNABLE`` n/a 840 ``ETHTOOL_GFECPARAM`` n/a 841 ``ETHTOOL_SFECPARAM`` n/a 842 =================================== ===================================== 843