LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH 00/10] Rid W=1 warnings from OF
@ 2021-03-12 11:07 Lee Jones
  2021-03-12 11:07 ` [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse Lee Jones
                   ` (9 more replies)
  0 siblings, 10 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Andrew Lunn, Anton Vorontsov, benh, Colin Cross,
	David S. Miller, devicetree, Frank Rowand, Heiner Kallweit,
	Josh Cartwright, Kees Cook, Marek Szyprowski, netdev,
	Pantelis Antoniou, Rob Herring, Russell King, Tony Luck

This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.

Lee Jones (10):
  of: device: Fix function name in header and demote kernel-doc abuse
  of: dynamic: Fix incorrect parameter name and demote kernel-doc abuse
  of: platform: Demote kernel-doc abuse
  of: base: Fix some formatting issues and demote non-conformant
    kernel-doc headers
  of: property: Provide missing member description and remove excess
    param
  of: address: Demote non-conformant kernel-doc header
  of: fdt: Demote kernel-doc abuses
  of: of_net: Demote non-conforming kernel-doc header
  of: overlay: Fix function name disparity
  of: of_reserved_mem: Demote kernel-doc abuses

 drivers/of/address.c         |  2 +-
 drivers/of/base.c            | 16 ++++++++--------
 drivers/of/device.c          |  6 +++---
 drivers/of/dynamic.c         |  6 +++---
 drivers/of/fdt.c             | 19 ++++++++++---------
 drivers/of/of_net.c          |  2 +-
 drivers/of/of_reserved_mem.c |  6 +++---
 drivers/of/overlay.c         |  2 +-
 drivers/of/platform.c        |  2 +-
 drivers/of/property.c        |  2 +-
 10 files changed, 32 insertions(+), 31 deletions(-)

Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Anton Vorontsov <anton@enomsg.org>
Cc: benh@kernel.crashing.org
Cc: Colin Cross <ccross@android.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: devicetree@vger.kernel.org
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Heiner Kallweit <hkallweit1@gmail.com>
Cc: Josh Cartwright <joshc@codeaurora.org>
Cc: Kees Cook <keescook@chromium.org>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
Cc: netdev@vger.kernel.org
Cc: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Russell King <linux@armlinux.org.uk>
Cc: Tony Luck <tony.luck@intel.com>
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 14:54   ` Rob Herring
  2021-03-12 11:07 ` [PATCH 02/10] of: dynamic: Fix incorrect parameter name " Lee Jones
                   ` (8 subsequent siblings)
  9 siblings, 1 reply; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones; +Cc: linux-kernel, Rob Herring, Frank Rowand, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/device.c:72: warning: expecting prototype for of_dma_configure(). Prototype was for of_dma_configure_id() instead
 drivers/of/device.c:263: warning: Function parameter or member 'dev' not described in 'of_device_modalias'
 drivers/of/device.c:263: warning: Function parameter or member 'str' not described in 'of_device_modalias'
 drivers/of/device.c:263: warning: Function parameter or member 'len' not described in 'of_device_modalias'
 drivers/of/device.c:280: warning: Function parameter or member 'dev' not described in 'of_device_uevent'
 drivers/of/device.c:280: warning: Function parameter or member 'env' not described in 'of_device_uevent'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/device.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/of/device.c b/drivers/of/device.c
index 6cb86de404f1c..64ee363abde24 100644
--- a/drivers/of/device.c
+++ b/drivers/of/device.c
@@ -53,7 +53,7 @@ int of_device_add(struct platform_device *ofdev)
 }
 
 /**
- * of_dma_configure - Setup DMA configuration
+ * of_dma_configure_id - Setup DMA configuration
  * @dev:	Device to apply DMA configuration
  * @np:		Pointer to OF node having DMA configuration
  * @force_dma:  Whether device is to be set up by of_dma_configure() even if
@@ -256,7 +256,7 @@ int of_device_request_module(struct device *dev)
 }
 EXPORT_SYMBOL_GPL(of_device_request_module);
 
-/**
+/*
  * of_device_modalias - Fill buffer with newline terminated modalias string
  */
 ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
@@ -273,7 +273,7 @@ ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
 }
 EXPORT_SYMBOL_GPL(of_device_modalias);
 
-/**
+/*
  * of_device_uevent - Display OF related uevent information
  */
 void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 02/10] of: dynamic: Fix incorrect parameter name and demote kernel-doc abuse
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
  2021-03-12 11:07 ` [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 11:07 ` [PATCH 03/10] of: platform: Demote " Lee Jones
                   ` (7 subsequent siblings)
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones; +Cc: linux-kernel, Rob Herring, Frank Rowand, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/dynamic.c:234: warning: Function parameter or member 'np' not described in 'of_attach_node'
 drivers/of/dynamic.c:286: warning: Function parameter or member 'np' not described in 'of_detach_node'
 drivers/of/dynamic.c:326: warning: Function parameter or member 'kobj' not described in 'of_node_release'
 drivers/of/dynamic.c:326: warning: Excess function parameter 'kref' description in 'of_node_release'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/dynamic.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/of/dynamic.c b/drivers/of/dynamic.c
index 9a824decf61f1..93b35f3c92c18 100644
--- a/drivers/of/dynamic.c
+++ b/drivers/of/dynamic.c
@@ -227,7 +227,7 @@ static void __of_attach_node(struct device_node *np)
 	of_node_clear_flag(np, OF_DETACHED);
 }
 
-/**
+/*
  * of_attach_node() - Plug a device node into the tree and global list.
  */
 int of_attach_node(struct device_node *np)
@@ -279,7 +279,7 @@ void __of_detach_node(struct device_node *np)
 	__of_phandle_cache_inv_entry(np->phandle);
 }
 
-/**
+/*
  * of_detach_node() - "Unplug" a node from the device tree.
  */
 int of_detach_node(struct device_node *np)
@@ -318,7 +318,7 @@ static void property_list_free(struct property *prop_list)
 
 /**
  * of_node_release() - release a dynamically allocated node
- * @kref: kref element of the node to be released
+ * @kobj: kernel object of the node to be released
  *
  * In of_node_put() this function is passed to kref_put() as the destructor.
  */
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 03/10] of: platform: Demote kernel-doc abuse
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
  2021-03-12 11:07 ` [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse Lee Jones
  2021-03-12 11:07 ` [PATCH 02/10] of: dynamic: Fix incorrect parameter name " Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 11:07 ` [PATCH 04/10] of: base: Fix some formatting issues and demote non-conformant kernel-doc headers Lee Jones
                   ` (6 subsequent siblings)
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Rob Herring, Frank Rowand, Kees Cook,
	Anton Vorontsov, Colin Cross, Tony Luck, benh, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/platform.c:298: warning: Function parameter or member 'lookup' not described in 'of_dev_lookup'
 drivers/of/platform.c:298: warning: Function parameter or member 'np' not described in 'of_dev_lookup'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Kees Cook <keescook@chromium.org>
Cc: Anton Vorontsov <anton@enomsg.org>
Cc: Colin Cross <ccross@android.com>
Cc: Tony Luck <tony.luck@intel.com>
Cc: benh@kernel.crashing.org
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/platform.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/of/platform.c b/drivers/of/platform.c
index 0da86209ddaab..0ed46d301431b 100644
--- a/drivers/of/platform.c
+++ b/drivers/of/platform.c
@@ -290,7 +290,7 @@ static struct amba_device *of_amba_device_create(struct device_node *node,
 }
 #endif /* CONFIG_ARM_AMBA */
 
-/**
+/*
  * of_dev_lookup() - Given a device node, lookup the preferred Linux name
  */
 static const struct of_dev_auxdata *of_dev_lookup(const struct of_dev_auxdata *lookup,
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 04/10] of: base: Fix some formatting issues and demote non-conformant kernel-doc headers
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (2 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 03/10] of: platform: Demote " Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 11:07 ` [PATCH 05/10] of: property: Provide missing member description and remove excess param Lee Jones
                   ` (5 subsequent siblings)
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Rob Herring, Frank Rowand, David S. Miller, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/base.c:315: warning: Function parameter or member 'cpun' not described in '__of_find_n_match_cpu_property'
 drivers/of/base.c:315: warning: Function parameter or member 'prop_name' not described in '__of_find_n_match_cpu_property'
 drivers/of/base.c:315: warning: Function parameter or member 'cpu' not described in '__of_find_n_match_cpu_property'
 drivers/of/base.c:315: warning: Function parameter or member 'thread' not described in '__of_find_n_match_cpu_property'
 drivers/of/base.c:315: warning: expecting prototype for property holds the physical id of the(). Prototype was for __of_find_n_match_cpu_property() instead
 drivers/of/base.c:1139: warning: Function parameter or member 'match' not described in 'of_find_matching_node_and_match'
 drivers/of/base.c:1779: warning: Function parameter or member 'np' not described in '__of_add_property'
 drivers/of/base.c:1779: warning: Function parameter or member 'prop' not described in '__of_add_property'
 drivers/of/base.c:1800: warning: Function parameter or member 'np' not described in 'of_add_property'
 drivers/of/base.c:1800: warning: Function parameter or member 'prop' not described in 'of_add_property'
 drivers/of/base.c:1849: warning: Function parameter or member 'np' not described in 'of_remove_property'
 drivers/of/base.c:1849: warning: Function parameter or member 'prop' not described in 'of_remove_property'
 drivers/of/base.c:2137: warning: Function parameter or member 'dn' not described in 'of_console_check'
 drivers/of/base.c:2137: warning: Function parameter or member 'name' not described in 'of_console_check'
 drivers/of/base.c:2137: warning: Function parameter or member 'index' not described in 'of_console_check'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/base.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/of/base.c b/drivers/of/base.c
index 8a348f0d3c5e7..e0319e5f5793a 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -305,7 +305,7 @@ bool __weak arch_match_cpu_phys_id(int cpu, u64 phys_id)
 	return (u32)phys_id == cpu;
 }
 
-/**
+/*
  * Checks if the given "prop_name" property holds the physical id of the
  * core/thread corresponding to the logical cpu 'cpu'. If 'thread' is not
  * NULL, local thread number within the core is returned in it.
@@ -1128,7 +1128,7 @@ EXPORT_SYMBOL(of_match_node);
  *			will; typically, you pass what the previous call
  *			returned. of_node_put() will be called on it
  *	@matches:	array of of device match structures to search in
- *	@match		Updated to point at the matches entry which matched
+ *	@match:		Updated to point at the matches entry which matched
  *
  *	Returns a node pointer with refcount incremented, use
  *	of_node_put() on it when done.
@@ -1772,7 +1772,7 @@ int of_count_phandle_with_args(const struct device_node *np, const char *list_na
 }
 EXPORT_SYMBOL(of_count_phandle_with_args);
 
-/**
+/*
  * __of_add_property - Add a property to a node without lock operations
  */
 int __of_add_property(struct device_node *np, struct property *prop)
@@ -1793,7 +1793,7 @@ int __of_add_property(struct device_node *np, struct property *prop)
 	return 0;
 }
 
-/**
+/*
  * of_add_property - Add a property to a node
  */
 int of_add_property(struct device_node *np, struct property *prop)
@@ -1837,7 +1837,7 @@ int __of_remove_property(struct device_node *np, struct property *prop)
 	return 0;
 }
 
-/**
+/*
  * of_remove_property - Remove a property from a node.
  *
  * Note that we don't actually remove it, since we have given out
@@ -2125,9 +2125,9 @@ EXPORT_SYMBOL_GPL(of_alias_get_highest_id);
 
 /**
  * of_console_check() - Test and setup console for DT setup
- * @dn - Pointer to device node
- * @name - Name to use for preferred console without index. ex. "ttyS"
- * @index - Index to use for preferred console.
+ * @dn: Pointer to device node
+ * @name: Name to use for preferred console without index. ex. "ttyS"
+ * @index: Index to use for preferred console.
  *
  * Check if the given device node matches the stdout-path property in the
  * /chosen node. If it does then register it as the preferred console and return
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 05/10] of: property: Provide missing member description and remove excess param
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (3 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 04/10] of: base: Fix some formatting issues and demote non-conformant kernel-doc headers Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 11:07 ` [PATCH 06/10] of: address: Demote non-conformant kernel-doc header Lee Jones
                   ` (4 subsequent siblings)
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Rob Herring, Frank Rowand, David S. Miller, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/property.c:1239: warning: Function parameter or member 'optional' not described in 'supplier_bindings'
 drivers/of/property.c:1366: warning: Excess function parameter 'dev' description in 'of_link_property'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/property.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/of/property.c b/drivers/of/property.c
index 5036a362f52e7..5faf24a791c9d 100644
--- a/drivers/of/property.c
+++ b/drivers/of/property.c
@@ -1225,6 +1225,7 @@ static struct device_node *parse_##fname(struct device_node *np,	     \
  * @parse_prop.prop_name: Name of property holding a phandle value
  * @parse_prop.index: For properties holding a list of phandles, this is the
  *		      index into the list
+ * @optional: Describes whether a supplier is mandatory or not
  *
  * Returns:
  * parse_prop() return values are
@@ -1344,7 +1345,6 @@ static const struct supplier_bindings of_supplier_bindings[] = {
 
 /**
  * of_link_property - Create device links to suppliers listed in a property
- * @dev: Consumer device
  * @con_np: The consumer device tree node which contains the property
  * @prop_name: Name of property to be parsed
  *
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 06/10] of: address: Demote non-conformant kernel-doc header
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (4 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 05/10] of: property: Provide missing member description and remove excess param Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 11:07 ` [PATCH 07/10] of: fdt: Demote kernel-doc abuses Lee Jones
                   ` (3 subsequent siblings)
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones; +Cc: linux-kernel, Rob Herring, Frank Rowand, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/address.c:868: warning: Function parameter or member 'dev' not described in 'of_address_to_resource'
 drivers/of/address.c:868: warning: Function parameter or member 'index' not described in 'of_address_to_resource'
 drivers/of/address.c:868: warning: Function parameter or member 'r' not described in 'of_address_to_resource'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/address.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/of/address.c b/drivers/of/address.c
index 73ddf2540f3fe..9350697ae5aad 100644
--- a/drivers/of/address.c
+++ b/drivers/of/address.c
@@ -855,7 +855,7 @@ static int __of_address_to_resource(struct device_node *dev,
 	return 0;
 }
 
-/**
+/*
  * of_address_to_resource - Translate device tree address and return as resource
  *
  * Note that if your address is a PIO address, the conversion will fail if
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 07/10] of: fdt: Demote kernel-doc abuses
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (5 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 06/10] of: address: Demote non-conformant kernel-doc header Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 15:01   ` Rob Herring
  2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
                   ` (2 subsequent siblings)
  9 siblings, 1 reply; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones; +Cc: linux-kernel, Rob Herring, Frank Rowand, benh, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/fdt.c:478: warning: Function parameter or member 'node' not described in '__reserved_mem_reserve_reg'
 drivers/of/fdt.c:478: warning: Function parameter or member 'uname' not described in '__reserved_mem_reserve_reg'
 drivers/of/fdt.c:525: warning: Function parameter or member 'node' not described in '__reserved_mem_check_root'
 drivers/of/fdt.c:547: warning: Function parameter or member 'node' not described in '__fdt_scan_reserved_mem'
 drivers/of/fdt.c:547: warning: Function parameter or member 'uname' not described in '__fdt_scan_reserved_mem'
 drivers/of/fdt.c:547: warning: Function parameter or member 'depth' not described in '__fdt_scan_reserved_mem'
 drivers/of/fdt.c:547: warning: Function parameter or member 'data' not described in '__fdt_scan_reserved_mem'
 drivers/of/fdt.c:547: warning: expecting prototype for fdt_scan_reserved_mem(). Prototype was for __fdt_scan_reserved_mem() instead
 drivers/of/fdt.c:663: warning: Function parameter or member 'parent' not described in 'of_scan_flat_dt_subnodes'
 drivers/of/fdt.c:708: warning: Function parameter or member 'node' not described in 'of_get_flat_dt_prop'
 drivers/of/fdt.c:708: warning: Function parameter or member 'name' not described in 'of_get_flat_dt_prop'
 drivers/of/fdt.c:708: warning: Function parameter or member 'size' not described in 'of_get_flat_dt_prop'
 drivers/of/fdt.c:758: warning: Function parameter or member 'node' not described in 'of_flat_dt_match'
 drivers/of/fdt.c:758: warning: Function parameter or member 'compat' not described in 'of_flat_dt_match'
 drivers/of/fdt.c:778: warning: Function parameter or member 'node' not described in 'of_get_flat_dt_phandle'
 drivers/of/fdt.c:778: warning: expecting prototype for of_get_flat_dt_prop(). Prototype was for of_get_flat_dt_phandle() instead
 drivers/of/fdt.c:955: warning: Function parameter or member 'node' not described in 'early_init_dt_scan_root'
 drivers/of/fdt.c:955: warning: Function parameter or member 'uname' not described in 'early_init_dt_scan_root'
 drivers/of/fdt.c:955: warning: Function parameter or member 'depth' not described in 'early_init_dt_scan_root'
 drivers/of/fdt.c:955: warning: Function parameter or member 'data' not described in 'early_init_dt_scan_root'
 drivers/of/fdt.c:991: warning: Function parameter or member 'node' not described in 'early_init_dt_scan_memory'
 drivers/of/fdt.c:991: warning: Function parameter or member 'uname' not described in 'early_init_dt_scan_memory'
 drivers/of/fdt.c:991: warning: Function parameter or member 'depth' not described in 'early_init_dt_scan_memory'
 drivers/of/fdt.c:991: warning: Function parameter or member 'data' not described in 'early_init_dt_scan_memory'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: benh@kernel.crashing.org
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/fdt.c | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/drivers/of/fdt.c b/drivers/of/fdt.c
index dcc1dd96911a9..1fb3348eb9516 100644
--- a/drivers/of/fdt.c
+++ b/drivers/of/fdt.c
@@ -470,7 +470,7 @@ void *initial_boot_params __ro_after_init;
 
 static u32 of_fdt_crc32;
 
-/**
+/*
  * __reserved_mem_reserve_reg() - reserve all memory described in 'reg' property
  */
 static int __init __reserved_mem_reserve_reg(unsigned long node,
@@ -516,7 +516,7 @@ static int __init __reserved_mem_reserve_reg(unsigned long node,
 	return 0;
 }
 
-/**
+/*
  * __reserved_mem_check_root() - check if #size-cells, #address-cells provided
  * in /reserved-memory matches the values supported by the current implementation,
  * also check if ranges property has been provided
@@ -539,7 +539,7 @@ static int __init __reserved_mem_check_root(unsigned long node)
 	return 0;
 }
 
-/**
+/*
  * fdt_scan_reserved_mem() - scan a single FDT node for reserved memory
  */
 static int __init __fdt_scan_reserved_mem(unsigned long node, const char *uname,
@@ -650,6 +650,7 @@ int __init of_scan_flat_dt(int (*it)(unsigned long node,
 
 /**
  * of_scan_flat_dt_subnodes - scan sub-nodes of a node call callback on each.
+ * @parent: parent node
  * @it: callback function
  * @data: context data pointer
  *
@@ -689,7 +690,7 @@ int __init of_get_flat_dt_subnode_by_name(unsigned long node, const char *uname)
 	return fdt_subnode_offset(initial_boot_params, node, uname);
 }
 
-/**
+/*
  * of_get_flat_dt_root - find the root node in the flat blob
  */
 unsigned long __init of_get_flat_dt_root(void)
@@ -697,7 +698,7 @@ unsigned long __init of_get_flat_dt_root(void)
 	return 0;
 }
 
-/**
+/*
  * of_get_flat_dt_prop - Given a node in the flat blob, return the property ptr
  *
  * This function can be used within scan_flattened_dt callback to get
@@ -751,7 +752,7 @@ int __init of_flat_dt_is_compatible(unsigned long node, const char *compat)
 	return of_fdt_is_compatible(initial_boot_params, node, compat);
 }
 
-/**
+/*
  * of_flat_dt_match - Return true if node matches a list of compatible values
  */
 static int __init of_flat_dt_match(unsigned long node, const char *const *compat)
@@ -771,7 +772,7 @@ static int __init of_flat_dt_match(unsigned long node, const char *const *compat
 	return score;
 }
 
-/**
+/*
  * of_get_flat_dt_prop - Given a node in the flat blob, return the phandle
  */
 uint32_t __init of_get_flat_dt_phandle(unsigned long node)
@@ -947,7 +948,7 @@ int __init early_init_dt_scan_chosen_stdout(void)
 }
 #endif
 
-/**
+/*
  * early_init_dt_scan_root - fetch the top level address and size cells
  */
 int __init early_init_dt_scan_root(unsigned long node, const char *uname,
@@ -983,7 +984,7 @@ u64 __init dt_mem_next_cell(int s, const __be32 **cellp)
 	return of_read_number(p, s);
 }
 
-/**
+/*
  * early_init_dt_scan_memory - Look for and parse memory nodes
  */
 int __init early_init_dt_scan_memory(unsigned long node, const char *uname,
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (6 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 07/10] of: fdt: Demote kernel-doc abuses Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 14:05   ` Andrew Lunn
  2021-03-12 11:07 ` [PATCH 09/10] of: overlay: Fix function name disparity Lee Jones
  2021-03-12 11:07 ` [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses Lee Jones
  9 siblings, 1 reply; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Andrew Lunn, Heiner Kallweit, Russell King,
	Rob Herring, Frank Rowand, netdev, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'
 drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead

Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Heiner Kallweit <hkallweit1@gmail.com>
Cc: Russell King <linux@armlinux.org.uk>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: netdev@vger.kernel.org
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/of_net.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
index 6e411821583e4..9b41a343e88ab 100644
--- a/drivers/of/of_net.c
+++ b/drivers/of/of_net.c
@@ -78,7 +78,7 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)
 	return mac;
 }
 
-/**
+/*
  * Search the device tree for the best MAC address to use.  'mac-address' is
  * checked first, because that is supposed to contain to "most recent" MAC
  * address. If that isn't set, then 'local-mac-address' is checked next,
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 09/10] of: overlay: Fix function name disparity
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (7 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  2021-03-12 11:07 ` [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses Lee Jones
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Pantelis Antoniou, Frank Rowand, Rob Herring, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/overlay.c:147: warning: expecting prototype for of_overlay_notifier_register(). Prototype was for of_overlay_notifier_unregister() instead

Cc: Pantelis Antoniou <pantelis.antoniou@konsulko.com>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/overlay.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
index 50bbe0edf5380..1c867a5e4c7c2 100644
--- a/drivers/of/overlay.c
+++ b/drivers/of/overlay.c
@@ -140,7 +140,7 @@ int of_overlay_notifier_register(struct notifier_block *nb)
 EXPORT_SYMBOL_GPL(of_overlay_notifier_register);
 
 /**
- * of_overlay_notifier_register() - Unregister notifier for overlay operations
+ * of_overlay_notifier_unregister() - Unregister notifier for overlay operations
  * @nb:		Notifier block to unregister
  */
 int of_overlay_notifier_unregister(struct notifier_block *nb)
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses
  2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
                   ` (8 preceding siblings ...)
  2021-03-12 11:07 ` [PATCH 09/10] of: overlay: Fix function name disparity Lee Jones
@ 2021-03-12 11:07 ` Lee Jones
  9 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 11:07 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Rob Herring, Frank Rowand, Marek Szyprowski,
	Josh Cartwright, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'node' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'uname' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'base' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'size' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'node' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'uname' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'res_base' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'res_size' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:171: warning: Function parameter or member 'rmem' not described in '__reserved_mem_init_node'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
Cc: Josh Cartwright <joshc@codeaurora.org>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/of_reserved_mem.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/of/of_reserved_mem.c b/drivers/of/of_reserved_mem.c
index a7fbc5e37e19e..15e2417974d67 100644
--- a/drivers/of/of_reserved_mem.c
+++ b/drivers/of/of_reserved_mem.c
@@ -45,7 +45,7 @@ static int __init early_init_dt_alloc_reserved_memory_arch(phys_addr_t size,
 	return memblock_reserve(base, size);
 }
 
-/**
+/*
  * fdt_reserved_mem_save_node() - save fdt node for second pass initialization
  */
 void __init fdt_reserved_mem_save_node(unsigned long node, const char *uname,
@@ -67,7 +67,7 @@ void __init fdt_reserved_mem_save_node(unsigned long node, const char *uname,
 	return;
 }
 
-/**
+/*
  * __reserved_mem_alloc_size() - allocate reserved memory described by
  *	'size', 'alignment'  and 'alloc-ranges' properties.
  */
@@ -164,7 +164,7 @@ static int __init __reserved_mem_alloc_size(unsigned long node,
 static const struct of_device_id __rmem_of_table_sentinel
 	__used __section("__reservedmem_of_table_end");
 
-/**
+/*
  * __reserved_mem_init_node() - call region specific reserved memory init code
  */
 static int __init __reserved_mem_init_node(struct reserved_mem *rmem)
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
  2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
@ 2021-03-12 14:05   ` Andrew Lunn
  2021-03-12 15:18     ` Lee Jones
  0 siblings, 1 reply; 18+ messages in thread
From: Andrew Lunn @ 2021-03-12 14:05 UTC (permalink / raw)
  To: Lee Jones
  Cc: linux-kernel, Heiner Kallweit, Russell King, Rob Herring,
	Frank Rowand, netdev, devicetree

On Fri, Mar 12, 2021 at 11:07:56AM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'
>  drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead
> 
> Cc: Andrew Lunn <andrew@lunn.ch>
> Cc: Heiner Kallweit <hkallweit1@gmail.com>
> Cc: Russell King <linux@armlinux.org.uk>
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Frank Rowand <frowand.list@gmail.com>
> Cc: netdev@vger.kernel.org
> Cc: devicetree@vger.kernel.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/of/of_net.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
> index 6e411821583e4..9b41a343e88ab 100644
> --- a/drivers/of/of_net.c
> +++ b/drivers/of/of_net.c
> @@ -78,7 +78,7 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)
>  	return mac;
>  }
>  
> -/**
> +/*
>   * Search the device tree for the best MAC address to use.  'mac-address' is
>   * checked first, because that is supposed to contain to "most recent" MAC
>   * address. If that isn't set, then 'local-mac-address' is checked next,

Hi Lee

of_get_mac_address() is a pretty important API function. So it would
be better to add the missing header to make this valid kdoc.

/**
 * of_get_mac_address - Get MAC address from device tree
 * @np: Pointer to the device_node of the interface
 *

 Andrew

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse
  2021-03-12 11:07 ` [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse Lee Jones
@ 2021-03-12 14:54   ` Rob Herring
  2021-03-12 15:07     ` Lee Jones
  0 siblings, 1 reply; 18+ messages in thread
From: Rob Herring @ 2021-03-12 14:54 UTC (permalink / raw)
  To: Lee Jones; +Cc: linux-kernel, Frank Rowand, devicetree

On Fri, Mar 12, 2021 at 4:08 AM Lee Jones <lee.jones@linaro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/of/device.c:72: warning: expecting prototype for of_dma_configure(). Prototype was for of_dma_configure_id() instead
>  drivers/of/device.c:263: warning: Function parameter or member 'dev' not described in 'of_device_modalias'
>  drivers/of/device.c:263: warning: Function parameter or member 'str' not described in 'of_device_modalias'
>  drivers/of/device.c:263: warning: Function parameter or member 'len' not described in 'of_device_modalias'
>  drivers/of/device.c:280: warning: Function parameter or member 'dev' not described in 'of_device_uevent'
>  drivers/of/device.c:280: warning: Function parameter or member 'env' not described in 'of_device_uevent'
>
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Frank Rowand <frowand.list@gmail.com>
> Cc: devicetree@vger.kernel.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/of/device.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/of/device.c b/drivers/of/device.c
> index 6cb86de404f1c..64ee363abde24 100644
> --- a/drivers/of/device.c
> +++ b/drivers/of/device.c
> @@ -53,7 +53,7 @@ int of_device_add(struct platform_device *ofdev)
>  }
>
>  /**
> - * of_dma_configure - Setup DMA configuration
> + * of_dma_configure_id - Setup DMA configuration
>   * @dev:       Device to apply DMA configuration
>   * @np:                Pointer to OF node having DMA configuration
>   * @force_dma:  Whether device is to be set up by of_dma_configure() even if
> @@ -256,7 +256,7 @@ int of_device_request_module(struct device *dev)
>  }
>  EXPORT_SYMBOL_GPL(of_device_request_module);
>
> -/**
> +/*

We should fix the kerneldoc on public functions. Demoting is fine on
static or internal to the DT code.

>   * of_device_modalias - Fill buffer with newline terminated modalias string
>   */
>  ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
> @@ -273,7 +273,7 @@ ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
>  }
>  EXPORT_SYMBOL_GPL(of_device_modalias);
>
> -/**
> +/*
>   * of_device_uevent - Display OF related uevent information
>   */
>  void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
> --
> 2.27.0
>

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [PATCH 07/10] of: fdt: Demote kernel-doc abuses
  2021-03-12 11:07 ` [PATCH 07/10] of: fdt: Demote kernel-doc abuses Lee Jones
@ 2021-03-12 15:01   ` Rob Herring
  2021-03-12 15:09     ` Lee Jones
  0 siblings, 1 reply; 18+ messages in thread
From: Rob Herring @ 2021-03-12 15:01 UTC (permalink / raw)
  To: Lee Jones; +Cc: linux-kernel, Frank Rowand, Benjamin Herrenschmidt, devicetree

On Fri, Mar 12, 2021 at 4:08 AM Lee Jones <lee.jones@linaro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/of/fdt.c:478: warning: Function parameter or member 'node' not described in '__reserved_mem_reserve_reg'
>  drivers/of/fdt.c:478: warning: Function parameter or member 'uname' not described in '__reserved_mem_reserve_reg'
>  drivers/of/fdt.c:525: warning: Function parameter or member 'node' not described in '__reserved_mem_check_root'
>  drivers/of/fdt.c:547: warning: Function parameter or member 'node' not described in '__fdt_scan_reserved_mem'
>  drivers/of/fdt.c:547: warning: Function parameter or member 'uname' not described in '__fdt_scan_reserved_mem'
>  drivers/of/fdt.c:547: warning: Function parameter or member 'depth' not described in '__fdt_scan_reserved_mem'
>  drivers/of/fdt.c:547: warning: Function parameter or member 'data' not described in '__fdt_scan_reserved_mem'
>  drivers/of/fdt.c:547: warning: expecting prototype for fdt_scan_reserved_mem(). Prototype was for __fdt_scan_reserved_mem() instead
>  drivers/of/fdt.c:663: warning: Function parameter or member 'parent' not described in 'of_scan_flat_dt_subnodes'
>  drivers/of/fdt.c:708: warning: Function parameter or member 'node' not described in 'of_get_flat_dt_prop'
>  drivers/of/fdt.c:708: warning: Function parameter or member 'name' not described in 'of_get_flat_dt_prop'
>  drivers/of/fdt.c:708: warning: Function parameter or member 'size' not described in 'of_get_flat_dt_prop'
>  drivers/of/fdt.c:758: warning: Function parameter or member 'node' not described in 'of_flat_dt_match'
>  drivers/of/fdt.c:758: warning: Function parameter or member 'compat' not described in 'of_flat_dt_match'
>  drivers/of/fdt.c:778: warning: Function parameter or member 'node' not described in 'of_get_flat_dt_phandle'
>  drivers/of/fdt.c:778: warning: expecting prototype for of_get_flat_dt_prop(). Prototype was for of_get_flat_dt_phandle() instead
>  drivers/of/fdt.c:955: warning: Function parameter or member 'node' not described in 'early_init_dt_scan_root'
>  drivers/of/fdt.c:955: warning: Function parameter or member 'uname' not described in 'early_init_dt_scan_root'
>  drivers/of/fdt.c:955: warning: Function parameter or member 'depth' not described in 'early_init_dt_scan_root'
>  drivers/of/fdt.c:955: warning: Function parameter or member 'data' not described in 'early_init_dt_scan_root'
>  drivers/of/fdt.c:991: warning: Function parameter or member 'node' not described in 'early_init_dt_scan_memory'
>  drivers/of/fdt.c:991: warning: Function parameter or member 'uname' not described in 'early_init_dt_scan_memory'
>  drivers/of/fdt.c:991: warning: Function parameter or member 'depth' not described in 'early_init_dt_scan_memory'
>  drivers/of/fdt.c:991: warning: Function parameter or member 'data' not described in 'early_init_dt_scan_memory'
>
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Frank Rowand <frowand.list@gmail.com>
> Cc: benh@kernel.crashing.org
> Cc: devicetree@vger.kernel.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/of/fdt.c | 19 ++++++++++---------
>  1 file changed, 10 insertions(+), 9 deletions(-)
>
> diff --git a/drivers/of/fdt.c b/drivers/of/fdt.c
> index dcc1dd96911a9..1fb3348eb9516 100644
> --- a/drivers/of/fdt.c
> +++ b/drivers/of/fdt.c
> @@ -470,7 +470,7 @@ void *initial_boot_params __ro_after_init;
>
>  static u32 of_fdt_crc32;
>
> -/**
> +/*
>   * __reserved_mem_reserve_reg() - reserve all memory described in 'reg' property
>   */
>  static int __init __reserved_mem_reserve_reg(unsigned long node,
> @@ -516,7 +516,7 @@ static int __init __reserved_mem_reserve_reg(unsigned long node,
>         return 0;
>  }
>
> -/**
> +/*
>   * __reserved_mem_check_root() - check if #size-cells, #address-cells provided
>   * in /reserved-memory matches the values supported by the current implementation,
>   * also check if ranges property has been provided
> @@ -539,7 +539,7 @@ static int __init __reserved_mem_check_root(unsigned long node)
>         return 0;
>  }
>
> -/**
> +/*
>   * fdt_scan_reserved_mem() - scan a single FDT node for reserved memory

This is still wrong. Should be __fdt_scan_reserved_mem.

>   */
>  static int __init __fdt_scan_reserved_mem(unsigned long node, const char *uname,
> @@ -650,6 +650,7 @@ int __init of_scan_flat_dt(int (*it)(unsigned long node,
>
>  /**
>   * of_scan_flat_dt_subnodes - scan sub-nodes of a node call callback on each.
> + * @parent: parent node
>   * @it: callback function
>   * @data: context data pointer
>   *
> @@ -689,7 +690,7 @@ int __init of_get_flat_dt_subnode_by_name(unsigned long node, const char *uname)
>         return fdt_subnode_offset(initial_boot_params, node, uname);
>  }
>
> -/**
> +/*
>   * of_get_flat_dt_root - find the root node in the flat blob
>   */
>  unsigned long __init of_get_flat_dt_root(void)
> @@ -697,7 +698,7 @@ unsigned long __init of_get_flat_dt_root(void)
>         return 0;
>  }
>
> -/**
> +/*
>   * of_get_flat_dt_prop - Given a node in the flat blob, return the property ptr
>   *
>   * This function can be used within scan_flattened_dt callback to get
> @@ -751,7 +752,7 @@ int __init of_flat_dt_is_compatible(unsigned long node, const char *compat)
>         return of_fdt_is_compatible(initial_boot_params, node, compat);
>  }
>
> -/**
> +/*
>   * of_flat_dt_match - Return true if node matches a list of compatible values
>   */
>  static int __init of_flat_dt_match(unsigned long node, const char *const *compat)
> @@ -771,7 +772,7 @@ static int __init of_flat_dt_match(unsigned long node, const char *const *compat
>         return score;
>  }
>
> -/**
> +/*
>   * of_get_flat_dt_prop - Given a node in the flat blob, return the phandle

This one too.

>   */
>  uint32_t __init of_get_flat_dt_phandle(unsigned long node)
> @@ -947,7 +948,7 @@ int __init early_init_dt_scan_chosen_stdout(void)
>  }
>  #endif
>
> -/**
> +/*
>   * early_init_dt_scan_root - fetch the top level address and size cells
>   */
>  int __init early_init_dt_scan_root(unsigned long node, const char *uname,
> @@ -983,7 +984,7 @@ u64 __init dt_mem_next_cell(int s, const __be32 **cellp)
>         return of_read_number(p, s);
>  }
>
> -/**
> +/*
>   * early_init_dt_scan_memory - Look for and parse memory nodes
>   */
>  int __init early_init_dt_scan_memory(unsigned long node, const char *uname,
> --
> 2.27.0
>

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse
  2021-03-12 14:54   ` Rob Herring
@ 2021-03-12 15:07     ` Lee Jones
  0 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 15:07 UTC (permalink / raw)
  To: Rob Herring; +Cc: linux-kernel, Frank Rowand, devicetree

On Fri, 12 Mar 2021, Rob Herring wrote:

> On Fri, Mar 12, 2021 at 4:08 AM Lee Jones <lee.jones@linaro.org> wrote:
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> >  drivers/of/device.c:72: warning: expecting prototype for of_dma_configure(). Prototype was for of_dma_configure_id() instead
> >  drivers/of/device.c:263: warning: Function parameter or member 'dev' not described in 'of_device_modalias'
> >  drivers/of/device.c:263: warning: Function parameter or member 'str' not described in 'of_device_modalias'
> >  drivers/of/device.c:263: warning: Function parameter or member 'len' not described in 'of_device_modalias'
> >  drivers/of/device.c:280: warning: Function parameter or member 'dev' not described in 'of_device_uevent'
> >  drivers/of/device.c:280: warning: Function parameter or member 'env' not described in 'of_device_uevent'
> >
> > Cc: Rob Herring <robh+dt@kernel.org>
> > Cc: Frank Rowand <frowand.list@gmail.com>
> > Cc: devicetree@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> >  drivers/of/device.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/drivers/of/device.c b/drivers/of/device.c
> > index 6cb86de404f1c..64ee363abde24 100644
> > --- a/drivers/of/device.c
> > +++ b/drivers/of/device.c
> > @@ -53,7 +53,7 @@ int of_device_add(struct platform_device *ofdev)
> >  }
> >
> >  /**
> > - * of_dma_configure - Setup DMA configuration
> > + * of_dma_configure_id - Setup DMA configuration
> >   * @dev:       Device to apply DMA configuration
> >   * @np:                Pointer to OF node having DMA configuration
> >   * @force_dma:  Whether device is to be set up by of_dma_configure() even if
> > @@ -256,7 +256,7 @@ int of_device_request_module(struct device *dev)
> >  }
> >  EXPORT_SYMBOL_GPL(of_device_request_module);
> >
> > -/**
> > +/*
> 
> We should fix the kerneldoc on public functions. Demoting is fine on
> static or internal to the DT code.

This file is not referenced by Kernel-Doc.

  `git grep kernel-doc:: | grep drivers/of`

> >   * of_device_modalias - Fill buffer with newline terminated modalias string
> >   */
> >  ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
> > @@ -273,7 +273,7 @@ ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
> >  }
> >  EXPORT_SYMBOL_GPL(of_device_modalias);
> >
> > -/**
> > +/*
> >   * of_device_uevent - Display OF related uevent information
> >   */
> >  void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
> >

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [PATCH 07/10] of: fdt: Demote kernel-doc abuses
  2021-03-12 15:01   ` Rob Herring
@ 2021-03-12 15:09     ` Lee Jones
  0 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 15:09 UTC (permalink / raw)
  To: Rob Herring
  Cc: linux-kernel, Frank Rowand, Benjamin Herrenschmidt, devicetree

On Fri, 12 Mar 2021, Rob Herring wrote:

> On Fri, Mar 12, 2021 at 4:08 AM Lee Jones <lee.jones@linaro.org> wrote:
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> >  drivers/of/fdt.c:478: warning: Function parameter or member 'node' not described in '__reserved_mem_reserve_reg'
> >  drivers/of/fdt.c:478: warning: Function parameter or member 'uname' not described in '__reserved_mem_reserve_reg'
> >  drivers/of/fdt.c:525: warning: Function parameter or member 'node' not described in '__reserved_mem_check_root'
> >  drivers/of/fdt.c:547: warning: Function parameter or member 'node' not described in '__fdt_scan_reserved_mem'
> >  drivers/of/fdt.c:547: warning: Function parameter or member 'uname' not described in '__fdt_scan_reserved_mem'
> >  drivers/of/fdt.c:547: warning: Function parameter or member 'depth' not described in '__fdt_scan_reserved_mem'
> >  drivers/of/fdt.c:547: warning: Function parameter or member 'data' not described in '__fdt_scan_reserved_mem'
> >  drivers/of/fdt.c:547: warning: expecting prototype for fdt_scan_reserved_mem(). Prototype was for __fdt_scan_reserved_mem() instead
> >  drivers/of/fdt.c:663: warning: Function parameter or member 'parent' not described in 'of_scan_flat_dt_subnodes'
> >  drivers/of/fdt.c:708: warning: Function parameter or member 'node' not described in 'of_get_flat_dt_prop'
> >  drivers/of/fdt.c:708: warning: Function parameter or member 'name' not described in 'of_get_flat_dt_prop'
> >  drivers/of/fdt.c:708: warning: Function parameter or member 'size' not described in 'of_get_flat_dt_prop'
> >  drivers/of/fdt.c:758: warning: Function parameter or member 'node' not described in 'of_flat_dt_match'
> >  drivers/of/fdt.c:758: warning: Function parameter or member 'compat' not described in 'of_flat_dt_match'
> >  drivers/of/fdt.c:778: warning: Function parameter or member 'node' not described in 'of_get_flat_dt_phandle'
> >  drivers/of/fdt.c:778: warning: expecting prototype for of_get_flat_dt_prop(). Prototype was for of_get_flat_dt_phandle() instead
> >  drivers/of/fdt.c:955: warning: Function parameter or member 'node' not described in 'early_init_dt_scan_root'
> >  drivers/of/fdt.c:955: warning: Function parameter or member 'uname' not described in 'early_init_dt_scan_root'
> >  drivers/of/fdt.c:955: warning: Function parameter or member 'depth' not described in 'early_init_dt_scan_root'
> >  drivers/of/fdt.c:955: warning: Function parameter or member 'data' not described in 'early_init_dt_scan_root'
> >  drivers/of/fdt.c:991: warning: Function parameter or member 'node' not described in 'early_init_dt_scan_memory'
> >  drivers/of/fdt.c:991: warning: Function parameter or member 'uname' not described in 'early_init_dt_scan_memory'
> >  drivers/of/fdt.c:991: warning: Function parameter or member 'depth' not described in 'early_init_dt_scan_memory'
> >  drivers/of/fdt.c:991: warning: Function parameter or member 'data' not described in 'early_init_dt_scan_memory'
> >
> > Cc: Rob Herring <robh+dt@kernel.org>
> > Cc: Frank Rowand <frowand.list@gmail.com>
> > Cc: benh@kernel.crashing.org
> > Cc: devicetree@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> >  drivers/of/fdt.c | 19 ++++++++++---------
> >  1 file changed, 10 insertions(+), 9 deletions(-)
> >
> > diff --git a/drivers/of/fdt.c b/drivers/of/fdt.c
> > index dcc1dd96911a9..1fb3348eb9516 100644
> > --- a/drivers/of/fdt.c
> > +++ b/drivers/of/fdt.c
> > @@ -470,7 +470,7 @@ void *initial_boot_params __ro_after_init;
> >
> >  static u32 of_fdt_crc32;
> >
> > -/**
> > +/*
> >   * __reserved_mem_reserve_reg() - reserve all memory described in 'reg' property
> >   */
> >  static int __init __reserved_mem_reserve_reg(unsigned long node,
> > @@ -516,7 +516,7 @@ static int __init __reserved_mem_reserve_reg(unsigned long node,
> >         return 0;
> >  }
> >
> > -/**
> > +/*
> >   * __reserved_mem_check_root() - check if #size-cells, #address-cells provided
> >   * in /reserved-memory matches the values supported by the current implementation,
> >   * also check if ranges property has been provided
> > @@ -539,7 +539,7 @@ static int __init __reserved_mem_check_root(unsigned long node)
> >         return 0;
> >  }
> >
> > -/**
> > +/*
> >   * fdt_scan_reserved_mem() - scan a single FDT node for reserved memory
> 
> This is still wrong. Should be __fdt_scan_reserved_mem.

Ah, the warning went away because I demoted it.

Will fix.  The others too.

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header
  2021-03-12 14:05   ` Andrew Lunn
@ 2021-03-12 15:18     ` Lee Jones
  0 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-12 15:18 UTC (permalink / raw)
  To: Andrew Lunn
  Cc: linux-kernel, Heiner Kallweit, Russell King, Rob Herring,
	Frank Rowand, netdev, devicetree

On Fri, 12 Mar 2021, Andrew Lunn wrote:

> On Fri, Mar 12, 2021 at 11:07:56AM +0000, Lee Jones wrote:
> > Fixes the following W=1 kernel build warning(s):
> > 
> >  drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'
> >  drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead
> > 
> > Cc: Andrew Lunn <andrew@lunn.ch>
> > Cc: Heiner Kallweit <hkallweit1@gmail.com>
> > Cc: Russell King <linux@armlinux.org.uk>
> > Cc: Rob Herring <robh+dt@kernel.org>
> > Cc: Frank Rowand <frowand.list@gmail.com>
> > Cc: netdev@vger.kernel.org
> > Cc: devicetree@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> >  drivers/of/of_net.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
> > index 6e411821583e4..9b41a343e88ab 100644
> > --- a/drivers/of/of_net.c
> > +++ b/drivers/of/of_net.c
> > @@ -78,7 +78,7 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)
> >  	return mac;
> >  }
> >  
> > -/**
> > +/*
> >   * Search the device tree for the best MAC address to use.  'mac-address' is
> >   * checked first, because that is supposed to contain to "most recent" MAC
> >   * address. If that isn't set, then 'local-mac-address' is checked next,
> 
> Hi Lee
> 
> of_get_mac_address() is a pretty important API function. So it would
> be better to add the missing header to make this valid kdoc.

Pretty important, yes.  Referenced/documented, no. :)

  `git grep kernel-doc:: | grep drivers/of`

> /**
>  * of_get_mac_address - Get MAC address from device tree
>  * @np: Pointer to the device_node of the interface
>  *
> 
>  Andrew

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses
  2021-03-18 10:40 [PATCH v2 00/10] Rid W=1 warnings from OF Lee Jones
@ 2021-03-18 10:40 ` Lee Jones
  0 siblings, 0 replies; 18+ messages in thread
From: Lee Jones @ 2021-03-18 10:40 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-kernel, Rob Herring, Frank Rowand, Marek Szyprowski,
	Josh Cartwright, devicetree

Fixes the following W=1 kernel build warning(s):

 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'node' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'uname' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'base' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:53: warning: Function parameter or member 'size' not described in 'fdt_reserved_mem_save_node'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'node' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'uname' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'res_base' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:76: warning: Function parameter or member 'res_size' not described in '__reserved_mem_alloc_size'
 drivers/of/of_reserved_mem.c:171: warning: Function parameter or member 'rmem' not described in '__reserved_mem_init_node'

Cc: Rob Herring <robh+dt@kernel.org>
Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
Cc: Josh Cartwright <joshc@codeaurora.org>
Cc: devicetree@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/of/of_reserved_mem.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/of/of_reserved_mem.c b/drivers/of/of_reserved_mem.c
index a7fbc5e37e19e..15e2417974d67 100644
--- a/drivers/of/of_reserved_mem.c
+++ b/drivers/of/of_reserved_mem.c
@@ -45,7 +45,7 @@ static int __init early_init_dt_alloc_reserved_memory_arch(phys_addr_t size,
 	return memblock_reserve(base, size);
 }
 
-/**
+/*
  * fdt_reserved_mem_save_node() - save fdt node for second pass initialization
  */
 void __init fdt_reserved_mem_save_node(unsigned long node, const char *uname,
@@ -67,7 +67,7 @@ void __init fdt_reserved_mem_save_node(unsigned long node, const char *uname,
 	return;
 }
 
-/**
+/*
  * __reserved_mem_alloc_size() - allocate reserved memory described by
  *	'size', 'alignment'  and 'alloc-ranges' properties.
  */
@@ -164,7 +164,7 @@ static int __init __reserved_mem_alloc_size(unsigned long node,
 static const struct of_device_id __rmem_of_table_sentinel
 	__used __section("__reservedmem_of_table_end");
 
-/**
+/*
  * __reserved_mem_init_node() - call region specific reserved memory init code
  */
 static int __init __reserved_mem_init_node(struct reserved_mem *rmem)
-- 
2.27.0


^ permalink raw reply	[flat|nested] 18+ messages in thread

end of thread, other threads:[~2021-03-18 10:41 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-12 11:07 ` [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse Lee Jones
2021-03-12 14:54   ` Rob Herring
2021-03-12 15:07     ` Lee Jones
2021-03-12 11:07 ` [PATCH 02/10] of: dynamic: Fix incorrect parameter name " Lee Jones
2021-03-12 11:07 ` [PATCH 03/10] of: platform: Demote " Lee Jones
2021-03-12 11:07 ` [PATCH 04/10] of: base: Fix some formatting issues and demote non-conformant kernel-doc headers Lee Jones
2021-03-12 11:07 ` [PATCH 05/10] of: property: Provide missing member description and remove excess param Lee Jones
2021-03-12 11:07 ` [PATCH 06/10] of: address: Demote non-conformant kernel-doc header Lee Jones
2021-03-12 11:07 ` [PATCH 07/10] of: fdt: Demote kernel-doc abuses Lee Jones
2021-03-12 15:01   ` Rob Herring
2021-03-12 15:09     ` Lee Jones
2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
2021-03-12 14:05   ` Andrew Lunn
2021-03-12 15:18     ` Lee Jones
2021-03-12 11:07 ` [PATCH 09/10] of: overlay: Fix function name disparity Lee Jones
2021-03-12 11:07 ` [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses Lee Jones
2021-03-18 10:40 [PATCH v2 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-18 10:40 ` [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses Lee Jones

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).