]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: interconnect: Add provider APIs to documentation
authorKuan-Wei Chiu <visitorckw@gmail.com>
Thu, 12 Mar 2026 17:53:40 +0000 (17:53 +0000)
committerJonathan Corbet <corbet@lwn.net>
Tue, 17 Mar 2026 14:51:28 +0000 (08:51 -0600)
The "Interconnect providers" section currently only includes data
structures from include/linux/interconnect-provider.h.

Include drivers/interconnect/core.c to extract provider-specific
API documentation. The :functions: directive is used to prevent
mixing with consumer APIs.

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

Documentation/driver-api/interconnect.rst

index a92d0f277a1f0186dd85ad5eb0ee172c38d58ae4..cf7a83f8c953b1785d30e9071e8fc81b44110da9 100644 (file)
@@ -84,6 +84,12 @@ be registered with the interconnect provider core.
 
 .. kernel-doc:: include/linux/interconnect-provider.h
 
+.. kernel-doc:: drivers/interconnect/core.c
+   :functions: icc_provider_init icc_provider_register icc_provider_deregister
+               icc_node_create icc_node_create_dyn icc_node_destroy
+               icc_node_add icc_node_del icc_nodes_remove icc_node_set_name
+               icc_link_create icc_link_nodes
+
 Interconnect consumers
 ----------------------