Documentation/netlink/specs/ethtool.yaml

Source file repositories/reference/linux-study-clean/Documentation/netlink/specs/ethtool.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/netlink/specs/ethtool.yaml
Extension
.yaml
Size
58448 bytes
Lines
2868
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
---
name: ethtool

protocol: genetlink-legacy

doc: Partial family for Ethtool Netlink.
uapi-header: linux/ethtool_netlink_generated.h

c-family-name: ethtool-genl-name
c-version-name: ethtool-genl-version

definitions:
  -
    name: udp-tunnel-type
    enum-name:
    type: enum
    entries: [vxlan, geneve, vxlan-gpe]
    enum-cnt-name: __ethtool-udp-tunnel-type-cnt
    render-max: true
  -
    name: stringset
    type: enum
    entries: []
    header: linux/ethtool.h  # skip rendering, no actual definition
  -
    name: header-flags
    type: flags
    name-prefix: ethtool-flag-
    doc: common ethtool header flags
    entries:
      -
        name: compact-bitsets
        doc: use compact bitsets in reply
      -
        name: omit-reply
        doc: provide optional reply for SET or ACT requests
      -
        name: stats
        doc: request statistics, if supported by the driver
  -
    name: module-fw-flash-status
    type: enum
    doc: plug-in module firmware flashing status
    header: linux/ethtool.h
    entries:
      -
        name: started
        doc: The firmware flashing process has started.
      -
        name: in-progress
        doc: The firmware flashing process is in progress.
      -
        name: completed
        doc: The firmware flashing process was completed successfully.
      -
        name: error
        doc: The firmware flashing process was stopped due to an error.
  -
    name: c33-pse-ext-state
    doc: |
      "groups of PSE extended states functions. IEEE 802.3-2022 33.2.4.4
      Variables"
    type: enum
    name-prefix: ethtool-c33-pse-ext-state-
    header: linux/ethtool.h
    entries:
      -
        name: none
        doc: none

Annotation

Implementation Notes