github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-06 21:58:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

interconnect: Add kernel-doc for devm_of_icc_get(), icc_enable() and icc_disable()

Browse Source 
Documentation/driver-api/interconnect.rst lists devm_of_icc_get(),
icc_enable() and icc_disable() in its kernel-doc directive for
drivers/interconnect/core.c, but none of the three functions has a
kernel-doc comment. The directive silently produces nothing for them, so
the consumer API section of the rendered documentation never shows
them.

Add kernel-doc comments in the style of the neighbouring functions.

Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
Link: https://patch.msgid.link/20260912115456.89169-1-kmehltretter@gmail.com
Signed-off-by: Georgi Djakov <djakov@kernel.org>
This commit is contained in:
Karl Mehltretter 2026-09-12 13:54:56 +02:00 committed by Georgi Djakov
parent 31a3959d87
commit 77cac270e3
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
drivers/interconnect/core.c
View File

@ -423,6 +423,17 @@ static void devm_icc_release(struct device *dev, void *res)
icc_put(*(struct icc_path **)res);
}
/**
* devm_of_icc_get() - get a path handle from a DT node based on name
* @dev: device pointer for the consumer device
* @name: interconnect path name
*
* This function is the resource managed version of of_icc_get(). The path
* is released with icc_put() automatically when @dev is unbound.
*
* Return: icc_path pointer on success or ERR_PTR() on error. NULL is returned
* when the API is disabled or the "interconnects" DT property is missing.
*/
struct icc_path *devm_of_icc_get(struct device *dev, const char *name)
{
struct icc_path **ptr, *path;
@ -786,12 +797,33 @@ static int __icc_enable(struct icc_path *path, bool enable)
path->reqs[0].peak_bw);
}
/**
* icc_enable() - enable a path
* @path: interconnect path
*
* Mark all requests on the path as enabled and reapply the bandwidth that
* was last set with icc_set_bw().
* Passing a NULL @path is a no-op and returns 0.
*
* Return: 0 on success, or an appropriate error code otherwise.
*/
int icc_enable(struct icc_path *path)
{
return __icc_enable(path, true);
}
EXPORT_SYMBOL_GPL(icc_enable);
/**
* icc_disable() - disable a path
* @path: interconnect path
*
* Mark all requests on the path as disabled, so that they no longer count
* towards the aggregated bandwidth, and reapply the constraints. The
* requested bandwidth is kept and restored by icc_enable().
* Passing a NULL @path is a no-op and returns 0.
*
* Return: 0 on success, or an appropriate error code otherwise.
*/
int icc_disable(struct icc_path *path)
{
return __icc_enable(path, false);