ARM: 9318/1: locomo: move kernel-doc to prevent warnings

Move the kernel-doc comments for locomo_probe() to immediately before
that function instead of before __locomo_probe() to prevent
kernel-doc warnings. Adjust the documented function parameters and
make the return values compatible with ReST by adding bullets to them.
Add more possible return values to the list.

Prevents these warnings:

  arch/arm/common/locomo.c:368: warning: Function parameter or member 'me' not described in '__locomo_probe'
  arch/arm/common/locomo.c:368: warning: Function parameter or member 'mem' not described in '__locomo_probe'
  arch/arm/common/locomo.c:368: warning: Function parameter or member 'irq' not described in '__locomo_probe'
  arch/arm/common/locomo.c:368: warning: expecting prototype for locomo_probe(). Prototype was for __locomo_probe() instead

Link: lore.kernel.org/r/202308050851.zAvHe6y7-lkp@intel.com

Fixes: 5eb6e280432d ("ARM: 9289/1: Allow pre-ARMv5 builds with ld.lld 16.0.0 and newer")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Nick Desaulniers <ndesaulniers@google.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Nathan Chancellor <nathan@kernel.org>
Cc: linux-arm-kernel@lists.infradead.org
Cc: patches@armlinux.org.uk
Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>

diff --git a/arch/arm/common/locomo.c b/arch/arm/common/locomo.c
index 309b747..70480dd 100644 (file)
--- a/arch/arm/common/locomo.c
+++ b/arch/arm/common/locomo.c
@@ -350,19 +350,6 @@ static int locomo_resume(struct platform_device *dev)
 }
 #endif
 
-
-/**
- *     locomo_probe - probe for a single LoCoMo chip.
- *     @phys_addr: physical address of device.
- *
- *     Probe for a LoCoMo chip.  This must be called
- *     before any other locomo-specific code.
- *
- *     Returns:
- *     %-ENODEV        device not found.
- *     %-EBUSY         physical address already marked in-use.
- *     %0              successful.
- */
 static int
 __locomo_probe(struct device *me, struct resource *mem, int irq)
 {
@@ -479,6 +466,21 @@ static void __locomo_remove(struct locomo *lchip)
        kfree(lchip);
 }
 
+/**
+ *     locomo_probe - probe for a single LoCoMo chip.
+ *     @dev: platform device
+ *
+ *     Probe for a LoCoMo chip.  This must be called
+ *     before any other locomo-specific code.
+ *
+ *     Returns:
+ *     * %-EINVAL      - device's IORESOURCE_MEM not found
+ *     * %-ENXIO       - could not allocate an IRQ for the device
+ *     * %-ENODEV      - device not found.
+ *     * %-EBUSY       - physical address already marked in-use.
+ *     * %-ENOMEM      - could not allocate or iomap memory.
+ *     * %0            - successful.
+ */
 static int locomo_probe(struct platform_device *dev)
 {
        struct resource *mem;