of: base: Fix some formatting issues and provide missing descriptions

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>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20210318104036.3175910-5-lee.jones@linaro.org
This commit is contained in:
Lee Jones 2021-03-18 10:40:30 +00:00 committed by Rob Herring
parent f3896a7eb7
commit 3637d49e11

View File

@ -305,7 +305,7 @@ bool __weak arch_match_cpu_phys_id(int cpu, u64 phys_id)
return (u32)phys_id == cpu; return (u32)phys_id == cpu;
} }
/** /*
* Checks if the given "prop_name" property holds the physical id of the * 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 * core/thread corresponding to the logical cpu 'cpu'. If 'thread' is not
* NULL, local thread number within the core is returned in it. * 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 * will; typically, you pass what the previous call
* returned. of_node_put() will be called on it * returned. of_node_put() will be called on it
* @matches: array of of device match structures to search in * @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 * Returns a node pointer with refcount incremented, use
* of_node_put() on it when done. * of_node_put() on it when done.
@ -1774,6 +1774,8 @@ EXPORT_SYMBOL(of_count_phandle_with_args);
/** /**
* __of_add_property - Add a property to a node without lock operations * __of_add_property - Add a property to a node without lock operations
* @np: Caller's Device Node
* @prob: Property to add
*/ */
int __of_add_property(struct device_node *np, struct property *prop) int __of_add_property(struct device_node *np, struct property *prop)
{ {
@ -1795,6 +1797,8 @@ int __of_add_property(struct device_node *np, struct property *prop)
/** /**
* of_add_property - Add a property to a node * of_add_property - Add a property to a node
* @np: Caller's Device Node
* @prob: Property to add
*/ */
int of_add_property(struct device_node *np, struct property *prop) int of_add_property(struct device_node *np, struct property *prop)
{ {
@ -1839,6 +1843,8 @@ int __of_remove_property(struct device_node *np, struct property *prop)
/** /**
* of_remove_property - Remove a property from a node. * of_remove_property - Remove a property from a node.
* @np: Caller's Device Node
* @prob: Property to remove
* *
* Note that we don't actually remove it, since we have given out * Note that we don't actually remove it, since we have given out
* who-knows-how-many pointers to the data using get-property. * who-knows-how-many pointers to the data using get-property.
@ -2125,9 +2131,9 @@ EXPORT_SYMBOL_GPL(of_alias_get_highest_id);
/** /**
* of_console_check() - Test and setup console for DT setup * of_console_check() - Test and setup console for DT setup
* @dn - Pointer to device node * @dn: Pointer to device node
* @name - Name to use for preferred console without index. ex. "ttyS" * @name: Name to use for preferred console without index. ex. "ttyS"
* @index - Index to use for preferred console. * @index: Index to use for preferred console.
* *
* Check if the given device node matches the stdout-path property in the * 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 * /chosen node. If it does then register it as the preferred console and return