summaryrefslogtreecommitdiff
path: root/Documentation/networking/kapi.rst
diff options
context:
space:
mode:
authorRussell King <rmk+kernel@armlinux.org.uk>2017-12-01 10:24:47 +0000
committerDavid S. Miller <davem@davemloft.net>2017-12-05 11:16:19 -0500
commit8796c8923d9c4297723ae51c832ea166964970c1 (patch)
tree50c2330d9ef33e6aa99a9d30772a60577affdc40 /Documentation/networking/kapi.rst
parent85b43945cf758704f5d97767ec70a317c6c8d8eb (diff)
downloadlwn-8796c8923d9c4297723ae51c832ea166964970c1.tar.gz
lwn-8796c8923d9c4297723ae51c832ea166964970c1.zip
phylink: add documentation for kernel APIs
Add kernel-doc documentation for phylink kernel APIs, and link it into the networking kapi documentation under "Network device support". Signed-off-by: Russell King <rmk+kernel@armlinux.org.uk> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking/kapi.rst')
-rw-r--r--Documentation/networking/kapi.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/networking/kapi.rst b/Documentation/networking/kapi.rst
index 580289f345da..df4141b72f24 100644
--- a/Documentation/networking/kapi.rst
+++ b/Documentation/networking/kapi.rst
@@ -145,3 +145,15 @@ PHY Support
.. kernel-doc:: drivers/net/phy/mdio_bus.c
:internal:
+
+PHYLINK
+-------
+
+ PHYLINK interfaces traditional network drivers with PHYLIB, fixed-links,
+ and SFF modules (eg, hot-pluggable SFP) that may contain PHYs. PHYLINK
+ provides management of the link state and link modes.
+
+.. kernel-doc:: include/linux/phylink.h
+ :internal:
+
+.. kernel-doc:: drivers/net/phy/phylink.c