of: address: Provide descriptions for 'of_address_to_resource's params
authorLee Jones <lee.jones@linaro.org>
Thu, 18 Mar 2021 10:40:32 +0000 (10:40 +0000)
committerRob Herring <robh@kernel.org>
Tue, 23 Mar 2021 21:27:52 +0000 (15:27 -0600)
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>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20210318104036.3175910-7-lee.jones@linaro.org
drivers/of/address.c

index 73ddf25..7de41ab 100644 (file)
@@ -857,6 +857,9 @@ static int __of_address_to_resource(struct device_node *dev,
 
 /**
  * of_address_to_resource - Translate device tree address and return as resource
+ * @dev:       Caller's Device Node
+ * @index:     Index into the array
+ * @r:         Pointer to resource array
  *
  * Note that if your address is a PIO address, the conversion will fail if
  * the physical address can't be internally converted to an IO token with