Skip to contentSkip to conversation

thunderbolt: Add missing kernel-doc parameter descriptions

PATCH Superseded Mika Westerberg 2 participants 3 messages Feb 13, 2020

Subsystems (2)
USB Thunderbolt driver

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Mika Westerberg

author
#0 lore raw

PATCH 1/1 thunderbolt: Add missing kernel-doc parameter descriptions

Two functions that were added for USB4 support miss kernel-doc parameter descriptions so add them now.

Signed-off-by Mika Westerberg <[email protected]>
---
 drivers/thunderbolt/usb4.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/thunderbolt/usb4.c +4 -0
index b341fc60c4ba..06592738b653 100644
@@ -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
Signature · 1 line
2.25.0
#1 lore raw

drivers/thunderbolt/usb4.c static int usb4_switch_drom_read_block(struct tb_switch *sw, · line 301

Quoted 6 lines · Mika Westerberg
drivers/thunderbolt/usb4.c +2 -0
@@ -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".

author
#2 lore raw
Quoted 9 lines · Lukas Wunner

drivers/thunderbolt/usb4.c static int usb4_switch_drom_read_block(struct tb_switch *sw, · line 301

Quoted 6 lines · Mika Westerberg
drivers/thunderbolt/usb4.c +2 -0
@@ -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.