diff mbox series

thunderbolt: Fix kernel-doc for tb_tunnel_alloc_dp()

Message ID 20240425233754.3510505-1-gil.fine@linux.intel.com
State New
Headers show
Series thunderbolt: Fix kernel-doc for tb_tunnel_alloc_dp() | expand

Commit Message

Gil Fine April 25, 2024, 11:37 p.m. UTC 
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 <gil.fine@linux.intel.com>
---
 drivers/thunderbolt/tunnel.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Mika Westerberg April 27, 2024, 5:08 a.m. UTC | #1 
On Fri, Apr 26, 2024 at 02:37:54AM +0300, Gil Fine wrote:
> 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 <gil.fine@linux.intel.com>

Applied to thunderbolt.git/next, thanks!
diff mbox series

Patch

diff --git a/drivers/thunderbolt/tunnel.c b/drivers/thunderbolt/tunnel.c
index 1a3b197001da..41cf6378ad25 100644
--- a/drivers/thunderbolt/tunnel.c
+++ b/drivers/thunderbolt/tunnel.c
@@ -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.