diff mbox series

thunderbolt: Add missing kernel-doc parameter descriptions

Message ID 20200213100207.1942-1-mika.westerberg@linux.intel.com (mailing list archive)
State Superseded
Headers show
Series thunderbolt: Add missing kernel-doc parameter descriptions | expand

Commit Message

Mika Westerberg Feb. 13, 2020, 10:02 a.m. UTC
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(+)

Comments

Lukas Wunner Feb. 13, 2020, 10:09 a.m. UTC | #1
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".
Mika Westerberg Feb. 13, 2020, 10:12 a.m. UTC | #2
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.
diff mbox series

Patch

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