* [PATCH] thunderbolt: Add missing kernel-doc parameter descriptions
@ 2020-02-13 10:02 Mika Westerberg
2020-02-13 10:09 ` Lukas Wunner
0 siblings, 1 reply; 3+ messages in thread
From: Mika Westerberg @ 2020-02-13 10:02 UTC (permalink / raw)
To: linux-usb
Cc: Andreas Noever, Michael Jamet, Mika Westerberg, Yehezkel Bernat,
Lukas Wunner
Two functions that were added for USB4 support miss kernel-doc parameter
descriptions so add them now.
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
---
drivers/thunderbolt/usb4.c | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/drivers/thunderbolt/usb4.c b/drivers/thunderbolt/usb4.c
index b341fc60c4ba..06592738b653 100644
--- a/drivers/thunderbolt/usb4.c
+++ b/drivers/thunderbolt/usb4.c
@@ -259,6 +259,7 @@ int usb4_switch_setup(struct tb_switch *sw)
/**
* usb4_switch_read_uid() - Read UID from USB4 router
* @sw: USB4 router
+ * @uid: UID is stored here
*
* Reads 64-bit UID from USB4 router config space.
*/
@@ -296,6 +297,9 @@ static int usb4_switch_drom_read_block(struct tb_switch *sw,
/**
* usb4_switch_drom_read() - Read arbitrary bytes from USB4 router DROM
* @sw: USB4 router
+ * @address: Byte address inside DROM to start reading
+ * @buf: Buffer where the DROM contens is stored
+ * @size: Number of bytes to read from DROM
*
* Uses USB4 router operations to read router DROM. For devices this
* should always work but for hosts it may return %-EOPNOTSUPP in which
--
2.25.0
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] thunderbolt: Add missing kernel-doc parameter descriptions
2020-02-13 10:02 [PATCH] thunderbolt: Add missing kernel-doc parameter descriptions Mika Westerberg
@ 2020-02-13 10:09 ` Lukas Wunner
2020-02-13 10:12 ` Mika Westerberg
0 siblings, 1 reply; 3+ messages in thread
From: Lukas Wunner @ 2020-02-13 10:09 UTC (permalink / raw)
To: Mika Westerberg; +Cc: linux-usb, Andreas Noever, Michael Jamet, Yehezkel Bernat
On Thu, Feb 13, 2020 at 01:02:07PM +0300, Mika Westerberg wrote:
> @@ -296,6 +297,9 @@ static int usb4_switch_drom_read_block(struct tb_switch *sw,
> /**
> * usb4_switch_drom_read() - Read arbitrary bytes from USB4 router DROM
> * @sw: USB4 router
> + * @address: Byte address inside DROM to start reading
> + * @buf: Buffer where the DROM contens is stored
Either "content is" or "contents are".
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] thunderbolt: Add missing kernel-doc parameter descriptions
2020-02-13 10:09 ` Lukas Wunner
@ 2020-02-13 10:12 ` Mika Westerberg
0 siblings, 0 replies; 3+ messages in thread
From: Mika Westerberg @ 2020-02-13 10:12 UTC (permalink / raw)
To: Lukas Wunner; +Cc: linux-usb, Andreas Noever, Michael Jamet, Yehezkel Bernat
On Thu, Feb 13, 2020 at 11:09:07AM +0100, Lukas Wunner wrote:
> On Thu, Feb 13, 2020 at 01:02:07PM +0300, Mika Westerberg wrote:
> > @@ -296,6 +297,9 @@ static int usb4_switch_drom_read_block(struct tb_switch *sw,
> > /**
> > * usb4_switch_drom_read() - Read arbitrary bytes from USB4 router DROM
> > * @sw: USB4 router
> > + * @address: Byte address inside DROM to start reading
> > + * @buf: Buffer where the DROM contens is stored
>
> Either "content is" or "contents are".
Heh, indeed. I'll use "content is" in v2.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-02-13 10:16 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-13 10:02 [PATCH] thunderbolt: Add missing kernel-doc parameter descriptions Mika Westerberg
2020-02-13 10:09 ` Lukas Wunner
2020-02-13 10:12 ` Mika Westerberg
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.