Skip to content

Commit 414f28a

Browse files
rddunlapRussell King (Oracle)
authored andcommitted
ARM: 9319/1: sa1111: fix sa1111_probe kernel-doc warnings
Document only the platform_driver probe entry point in kernel-doc to prevent kernel-doc warnings: sa1111.c:802: warning: Function parameter or member 'me' not described in '__sa1111_probe' sa1111.c:802: warning: Function parameter or member 'mem' not described in '__sa1111_probe' sa1111.c:802: warning: Function parameter or member 'irq' not described in '__sa1111_probe' sa1111.c:802: warning: expecting prototype for sa1111_probe(). Prototype was for __sa1111_probe() instead Also, use ReST list format to enumerate the return values. Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Signed-off-by: Randy Dunlap <[email protected]> Reported-by: kernel test robot <[email protected]> Cc: [email protected] Cc: [email protected] Signed-off-by: Russell King (Oracle) <[email protected]>
1 parent 0bb80ec commit 414f28a

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

arch/arm/common/sa1111.c

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -785,19 +785,6 @@ sa1111_init_one_child(struct sa1111 *sachip, struct resource *parent,
785785
return ret;
786786
}
787787

788-
/**
789-
* sa1111_probe - probe for a single SA1111 chip.
790-
* @phys_addr: physical address of device.
791-
*
792-
* Probe for a SA1111 chip. This must be called
793-
* before any other SA1111-specific code.
794-
*
795-
* Returns:
796-
* %-ENODEV device not found.
797-
* %-EBUSY physical address already marked in-use.
798-
* %-EINVAL no platform data passed
799-
* %0 successful.
800-
*/
801788
static int __sa1111_probe(struct device *me, struct resource *mem, int irq)
802789
{
803790
struct sa1111_platform_data *pd = me->platform_data;
@@ -1108,6 +1095,20 @@ static int sa1111_resume_noirq(struct device *dev)
11081095
#define sa1111_resume_noirq NULL
11091096
#endif
11101097

1098+
/**
1099+
* sa1111_probe - probe for a single SA1111 chip.
1100+
* @pdev: platform device.
1101+
*
1102+
* Probe for a SA1111 chip. This must be called
1103+
* before any other SA1111-specific code.
1104+
*
1105+
* Returns:
1106+
* * %-ENODEV - device not found.
1107+
* * %-ENOMEM - memory allocation failure.
1108+
* * %-EBUSY - physical address already marked in-use.
1109+
* * %-EINVAL - no platform data passed
1110+
* * %0 - successful.
1111+
*/
11111112
static int sa1111_probe(struct platform_device *pdev)
11121113
{
11131114
struct resource *mem;

0 commit comments

Comments
 (0)