Skip to contentSkip to conversation

thunderbolt: Fix kernel-doc for tb_tunnel_alloc_dp()

PATCH Applied Gil Fine 2 participants 2 messages Apr 25, 2024 – Apr 27, 2024

Subsystems (2)
USB Thunderbolt driver
lore
Share & tools
lore

Gil Fine

author
#0 lore raw

PATCH 1/1 thunderbolt: Fix kernel-doc for tb_tunnel_alloc_dp()

In case of no bandwidth available for DP tunnel, the function get the arguments @max_up and @max_down set to zero. Fix the kernel-doc to describe more accurately the purpose of the function.

Signed-off-by Gil Fine <[email protected]>
---
 drivers/thunderbolt/tunnel.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/thunderbolt/tunnel.c +4 -4
index 1a3b197001da..41cf6378ad25 100644
@@ -1435,10 +1435,10 @@ struct tb_tunnel *tb_tunnel_discover_dp(struct tb *tb, struct tb_port *in,
  * @in: DP in adapter port
  * @out: DP out adapter port
  * @link_nr: Preferred lane adapter when the link is not bonded
- * @max_up: Maximum available upstream bandwidth for the DP tunnel (%0
- *	    if not limited)
- * @max_down: Maximum available downstream bandwidth for the DP tunnel
- *	      (%0 if not limited)
+ * @max_up: Maximum available upstream bandwidth for the DP tunnel.
+ *	    %0 if no available bandwidth.
+ * @max_down: Maximum available downstream bandwidth for the DP tunnel.
+ *	      %0 if no available bandwidth.
  *
  * Allocates a tunnel between @in and @out that is capable of tunneling
  * Display Port traffic.
Signature · 1 line
2.25.1
Applied
#1 lore raw
Quoted 5 lines · Gil Fine

In case of no bandwidth available for DP tunnel, the function get the arguments @max_up and @max_down set to zero. Fix the kernel-doc to describe more accurately the purpose of the function.

Signed-off-by Gil Fine <[email protected]>

Applied to thunderbolt.git/next, thanks!