diff mbox series

[2/2] thunderbolt: Add missing kernel-doc comment to tb_tunnel_maximum_bandwidth()

Message ID 20230124090938.58825-2-mika.westerberg@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series [1/2] thunderbolt: Handle bandwidth allocation mode enablement notification | expand

Commit Message

Mika Westerberg Jan. 24, 2023, 9:09 a.m. UTC
These were missing from the original commit so add them now. No
functional changes.

Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
---
 drivers/thunderbolt/tunnel.c | 10 ++++++++++
 drivers/thunderbolt/tunnel.h |  2 +-
 2 files changed, 11 insertions(+), 1 deletion(-)

Comments

Lukas Wunner Jan. 24, 2023, 10:26 a.m. UTC | #1
On Tue, Jan 24, 2023 at 11:09:38AM +0200, Mika Westerberg wrote:
> +/**
> + * tb_tunnel_maximum_bandwidth() - Return maximum possible bandwidth
> + * @tunnel: Tunnel to check
> + * @max_up: Maximum upstream bandwidth in Mb/s
> + * @max_down: Maximum upstream bandwidth in Mb/s
                         ^^^^^^^^
			 downstream?

I'm sure you're just testing whether anyone is reading your patches ;)
Mika Westerberg Jan. 24, 2023, 10:33 a.m. UTC | #2
On Tue, Jan 24, 2023 at 11:26:26AM +0100, Lukas Wunner wrote:
> On Tue, Jan 24, 2023 at 11:09:38AM +0200, Mika Westerberg wrote:
> > +/**
> > + * tb_tunnel_maximum_bandwidth() - Return maximum possible bandwidth
> > + * @tunnel: Tunnel to check
> > + * @max_up: Maximum upstream bandwidth in Mb/s
> > + * @max_down: Maximum upstream bandwidth in Mb/s
>                          ^^^^^^^^
> 			 downstream?
> 
> I'm sure you're just testing whether anyone is reading your patches ;)

Hehe, thanks for reading them ;-) Fixed it now.
diff mbox series

Patch

diff --git a/drivers/thunderbolt/tunnel.c b/drivers/thunderbolt/tunnel.c
index c406675a8966..8af9397f272e 100644
--- a/drivers/thunderbolt/tunnel.c
+++ b/drivers/thunderbolt/tunnel.c
@@ -2081,6 +2081,16 @@  static bool tb_tunnel_is_active(const struct tb_tunnel *tunnel)
 	return true;
 }
 
+/**
+ * tb_tunnel_maximum_bandwidth() - Return maximum possible bandwidth
+ * @tunnel: Tunnel to check
+ * @max_up: Maximum upstream bandwidth in Mb/s
+ * @max_down: Maximum upstream bandwidth in Mb/s
+ *
+ * Returns maximum possible bandwidth this tunnel can go if not limited
+ * by other bandwidth clients. If the tunnel does not support this
+ * returns %-EOPNOTSUPP.
+ */
 int tb_tunnel_maximum_bandwidth(struct tb_tunnel *tunnel, int *max_up,
 				int *max_down)
 {
diff --git a/drivers/thunderbolt/tunnel.h b/drivers/thunderbolt/tunnel.h
index d7bbdf8c8186..bf690f7beeee 100644
--- a/drivers/thunderbolt/tunnel.h
+++ b/drivers/thunderbolt/tunnel.h
@@ -29,7 +29,7 @@  enum tb_tunnel_type {
  * @init: Optional tunnel specific initialization
  * @deinit: Optional tunnel specific de-initialization
  * @activate: Optional tunnel specific activation/deactivation
- * @maximum_bandwidth:
+ * @maximum_bandwidth: Returns maximum possible bandwidth for this tunnel
  * @allocated_bandwidth: Return how much bandwidth is allocated for the tunnel
  * @alloc_bandwidth: Change tunnel bandwidth allocation
  * @consumed_bandwidth: Return how much bandwidth the tunnel consumes