]> git.ipfire.org Git - thirdparty/kernel/stable.git/commit
Documentation: net: add flow control guide and document ethtool API
authorOleksij Rempel <o.rempel@pengutronix.de>
Wed, 24 Sep 2025 12:02:41 +0000 (14:02 +0200)
committerPaolo Abeni <pabeni@redhat.com>
Tue, 30 Sep 2025 07:48:31 +0000 (09:48 +0200)
commit7bd80ed89d72285515db673803b021469ba71ee8
treec92364da79b65325d85f9c0fcb3a62a4011edbf4
parentc5cb31c99257aacd5cc2ff72a3b6f0c660046c9b
Documentation: net: add flow control guide and document ethtool API

Introduce a new document, flow_control.rst, to provide a comprehensive
guide on Ethernet Flow Control in Linux. The guide explains how flow
control works, how autonegotiation resolves pause capabilities, and how
to configure it using ethtool and Netlink.

In parallel, document the pause and pause-stat attributes in the
ethtool.yaml netlink spec. This enables the ynl tool to generate
kernel-doc comments for the corresponding enums in the UAPI header,
making the C interface self-documenting.

Finally, replace the legacy flow control section in phy.rst with a
reference to the new document and add pointers in the relevant C source
files.

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
Link: https://patch.msgid.link/20250924120241.724850-1-o.rempel@pengutronix.de
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
Documentation/netlink/specs/ethtool.yaml
Documentation/networking/flow_control.rst [new file with mode: 0644]
Documentation/networking/index.rst
Documentation/networking/phy.rst
include/linux/ethtool.h
include/uapi/linux/ethtool_netlink_generated.h
net/dcb/dcbnl.c
net/ethtool/pause.c