[PATCH] PM: SmartReflex: fix kernel-doc warnings in smartreflex.h
From: Randy Dunlap
Date: Thu Mar 12 2026 - 01:16:42 EST
Use the correct function name in a kernel-doc comment and
use the correct kernel-doc format for struct members to avoid
kernel-doc warnings:
Warning: include/linux/power/smartreflex.h:187 expecting prototype for
test_cond_timeout(). Prototype was for sr_test_cond_timeout() instead
Warning: include/linux/power/smartreflex.h:292 struct member 'err_weight'
not described in 'omap_sr_data'
Warning: include/linux/power/smartreflex.h:292 struct member
'err_maxlimit' not described in 'omap_sr_data'
Warning: include/linux/power/smartreflex.h:292 struct member 'accum_data'
not described in 'omap_sr_data'
Warning: include/linux/power/smartreflex.h:292 struct member
'senn_avgweight' not described in 'omap_sr_data'
Warning: include/linux/power/smartreflex.h:292 struct member
'senp_avgweight' not described in 'omap_sr_data'
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
Cc: Nishanth Menon <nm@xxxxxx>
Cc: Sebastian Reichel <sre@xxxxxxxxxx>
Cc: linux-pm@xxxxxxxxxxxxxxx
include/linux/power/smartreflex.h | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
--- linux-next-20260311.orig/include/linux/power/smartreflex.h
+++ linux-next-20260311/include/linux/power/smartreflex.h
@@ -174,7 +174,7 @@ struct omap_sr {
};
/**
- * test_cond_timeout - busy-loop, testing a condition
+ * sr_test_cond_timeout - busy-loop, testing a condition
* @cond: condition to test until it evaluates to true
* @timeout: maximum number of microseconds in the timeout
* @index: loop index (integer)
@@ -267,11 +267,11 @@ struct omap_sr_nvalue_table {
* @ip_type: Smartreflex IP type.
* @senp_mod: SENPENABLE value of the sr CONFIG register
* @senn_mod: SENNENABLE value for sr CONFIG register
- * @err_weight ERRWEIGHT value of the sr ERRCONFIG register
- * @err_maxlimit ERRMAXLIMIT value of the sr ERRCONFIG register
- * @accum_data ACCUMDATA value of the sr CONFIG register
- * @senn_avgweight SENNAVGWEIGHT value of the sr AVGWEIGHT register
- * @senp_avgweight SENPAVGWEIGHT value of the sr AVGWEIGHT register
+ * @err_weight: ERRWEIGHT value of the sr ERRCONFIG register
+ * @err_maxlimit: ERRMAXLIMIT value of the sr ERRCONFIG register
+ * @accum_data: ACCUMDATA value of the sr CONFIG register
+ * @senn_avgweight: SENNAVGWEIGHT value of the sr AVGWEIGHT register
+ * @senp_avgweight: SENPAVGWEIGHT value of the sr AVGWEIGHT register
* @nvalue_count: Number of distinct nvalues in the nvalue table
* @nvalue_table: table containing the efuse offsets and nvalues
* corresponding to them.