From 1c2c8484b9de941a5363d880e92d8b00a73065b0 Mon Sep 17 00:00:00 2001 From: Randy Dunlap Date: Thu, 23 Jul 2026 14:41:18 -0700 Subject: base: soc: fixup sys_soc.h kernel-doc warnings - add function return values in 2 places - use the correct function parameter name in kernel-doc comments to avoid these kernel-doc warnings: Warning: include/linux/sys_soc.h:25 No description found for return value of 'soc_device_register' Warning: include/linux/sys_soc.h:37 No description found for return value of 'soc_device_to_device' Warning: include/linux/sys_soc.h:31 function parameter 'soc_dev' not described in 'soc_device_unregister' Warning: include/linux/sys_soc.h:31 Excess function parameter 'dev' description in 'soc_device_unregister' Signed-off-by: Randy Dunlap Link: https://patch.msgid.link/20260723214118.652616-1-rdunlap@infradead.org Signed-off-by: Danilo Krummrich --- include/linux/sys_soc.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/include/linux/sys_soc.h b/include/linux/sys_soc.h index f19f5cec18e2..cedabf177f47 100644 --- a/include/linux/sys_soc.h +++ b/include/linux/sys_soc.h @@ -21,19 +21,26 @@ struct soc_device_attribute { /** * soc_device_register - register SoC as a device * @soc_plat_dev_attr: Attributes passed from platform to be attributed to a SoC + * + * Returns: + * - %NULL if the SoC bus is not yet registered; + * - on success, the newly allocated &struct soc_device pointer; + * - on failure, a negative error code as an ERR_PTR(). */ struct soc_device *soc_device_register( struct soc_device_attribute *soc_plat_dev_attr); /** * soc_device_unregister - unregister SoC device - * @dev: SoC device to be unregistered + * @soc_dev: SoC device to be unregistered */ void soc_device_unregister(struct soc_device *soc_dev); /** * soc_device_to_device - helper function to fetch struct device * @soc: Previously registered SoC device container + * + * Returns: &struct device pointer for this @soc */ struct device *soc_device_to_device(struct soc_device *soc); -- cgit v1.2.3