]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: interconnect: Document consumer APIs and drop outdated text
authorKuan-Wei Chiu <visitorckw@gmail.com>
Thu, 12 Mar 2026 17:53:41 +0000 (17:53 +0000)
committerJonathan Corbet <corbet@lwn.net>
Tue, 17 Mar 2026 14:51:28 +0000 (08:51 -0600)
The documentation currently states that consumer interfaces are not
documented, which is no longer true.

Remove the outdated claim and include the existing kernel-doc from
drivers/interconnect/core.c (filtered for consumer APIs) and
drivers/interconnect/bulk.c.

Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260312175341.2944154-3-visitorckw@gmail.com>

Documentation/driver-api/interconnect.rst

index cf7a83f8c953b1785d30e9071e8fc81b44110da9..cebb77b49d8d486e83a5ee989c78466dbf81abd4 100644 (file)
@@ -95,8 +95,14 @@ Interconnect consumers
 
 Interconnect consumers are the clients which use the interconnect APIs to
 get paths between endpoints and set their bandwidth/latency/QoS requirements
-for these interconnect paths.  These interfaces are not currently
-documented.
+for these interconnect paths.
+
+.. kernel-doc:: drivers/interconnect/core.c
+   :functions: devm_of_icc_get of_icc_get_by_index of_icc_get icc_get
+               icc_put icc_enable icc_disable icc_set_bw icc_set_tag
+               icc_get_name
+
+.. kernel-doc:: drivers/interconnect/bulk.c
 
 Interconnect debugfs interfaces
 -------------------------------