linux-omap.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax
       [not found] <20200625064619.2775707-1-lee.jones@linaro.org>
@ 2020-06-25  6:46 ` Lee Jones
  2020-06-25  6:46 ` [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe() Lee Jones
  2020-06-25  6:46 ` [PATCH 07/10] mfd: omap-usb-tll: " Lee Jones
  2 siblings, 0 replies; 3+ messages in thread
From: Lee Jones @ 2020-06-25  6:46 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-arm-kernel, linux-kernel, stable, Tony Lindgren,
	Keshava Munegowda, Roger Quadros, linux-omap

Kerneldoc is for documenting function arguments and return values.

Prevents warnings like:

 drivers/mfd/omap-usb-host.c:128: warning: cannot understand function prototype: 'const char * const port_modes[] = '

Cc: <stable@vger.kernel.org>
Cc: Tony Lindgren <tony@atomide.com>
Cc: Keshava Munegowda <keshava_mgowda@ti.com>
Cc: Roger Quadros <rogerq@ti.com>
Cc: linux-omap@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/omap-usb-host.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/mfd/omap-usb-host.c b/drivers/mfd/omap-usb-host.c
index 1f4f01b02d98c..f56cdf3149dc0 100644
--- a/drivers/mfd/omap-usb-host.c
+++ b/drivers/mfd/omap-usb-host.c
@@ -120,7 +120,7 @@ static inline u32 usbhs_read(void __iomem *base, u32 reg)
 
 /*-------------------------------------------------------------------------*/
 
-/**
+/*
  * Map 'enum usbhs_omap_port_mode' found in <linux/platform_data/usb-omap.h>
  * to the device tree binding portN-mode found in
  * 'Documentation/devicetree/bindings/mfd/omap-usb-host.txt'
-- 
2.25.1


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

* [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe()
       [not found] <20200625064619.2775707-1-lee.jones@linaro.org>
  2020-06-25  6:46 ` [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax Lee Jones
@ 2020-06-25  6:46 ` Lee Jones
  2020-06-25  6:46 ` [PATCH 07/10] mfd: omap-usb-tll: " Lee Jones
  2 siblings, 0 replies; 3+ messages in thread
From: Lee Jones @ 2020-06-25  6:46 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-arm-kernel, linux-kernel, stable, Tony Lindgren,
	Keshava Munegowda, Roger Quadros, linux-omap

Kerneldoc syntax is used, but not complete.  Arg descriptions required.

Prevents warnings like:

 drivers/mfd/omap-usb-host.c:531: warning: Function parameter or member 'pdev' not described in 'usbhs_omap_probe'

Cc: <stable@vger.kernel.org>
Cc: Tony Lindgren <tony@atomide.com>
Cc: Keshava Munegowda <keshava_mgowda@ti.com>
Cc: Roger Quadros <rogerq@ti.com>
Cc: linux-omap@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/omap-usb-host.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/mfd/omap-usb-host.c b/drivers/mfd/omap-usb-host.c
index f56cdf3149dc0..aca5a160c1b24 100644
--- a/drivers/mfd/omap-usb-host.c
+++ b/drivers/mfd/omap-usb-host.c
@@ -526,6 +526,8 @@ static const struct of_device_id usbhs_child_match_table[] = {
  * usbhs_omap_probe - initialize TI-based HCDs
  *
  * Allocates basic resources for this USB host controller.
+ *
+ * @pdev: Pointer to this device's platform device structure
  */
 static int usbhs_omap_probe(struct platform_device *pdev)
 {
-- 
2.25.1


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

* [PATCH 07/10] mfd: omap-usb-tll: Provide description for 'pdev' argument to .probe()
       [not found] <20200625064619.2775707-1-lee.jones@linaro.org>
  2020-06-25  6:46 ` [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax Lee Jones
  2020-06-25  6:46 ` [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe() Lee Jones
@ 2020-06-25  6:46 ` Lee Jones
  2 siblings, 0 replies; 3+ messages in thread
From: Lee Jones @ 2020-06-25  6:46 UTC (permalink / raw)
  To: lee.jones
  Cc: linux-arm-kernel, linux-kernel, stable, Tony Lindgren,
	Keshava Munegowda, Roger Quadros, linux-omap

Kerneldoc syntax is used, but not complete.  Arg descriptions required.

Prevents warnings like:

 drivers/mfd/omap-usb-tll.c:204: warning: Function parameter or member 'pdev' not described in 'usbtll_omap_probe

Cc: <stable@vger.kernel.org>
Cc: Tony Lindgren <tony@atomide.com>
Cc: Keshava Munegowda <keshava_mgowda@ti.com>
Cc: Roger Quadros <rogerq@ti.com>
Cc: linux-omap@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/omap-usb-tll.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/mfd/omap-usb-tll.c b/drivers/mfd/omap-usb-tll.c
index 4b7f73c317e87..04a444007cf4e 100644
--- a/drivers/mfd/omap-usb-tll.c
+++ b/drivers/mfd/omap-usb-tll.c
@@ -199,6 +199,8 @@ static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
  * usbtll_omap_probe - initialize TI-based HCDs
  *
  * Allocates basic resources for this USB host controller.
+ *
+ * @pdev: Pointer to this device's platform device structure
  */
 static int usbtll_omap_probe(struct platform_device *pdev)
 {
-- 
2.25.1


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

end of thread, other threads:[~2020-06-25  6:47 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <20200625064619.2775707-1-lee.jones@linaro.org>
2020-06-25  6:46 ` [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax Lee Jones
2020-06-25  6:46 ` [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe() Lee Jones
2020-06-25  6:46 ` [PATCH 07/10] mfd: omap-usb-tll: " 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).