thunderbolt: Add missing kernel-doc comment to tb_tunnel_maximum_bandwidth()
authorMika Westerberg <mika.westerberg@linux.intel.com>
Wed, 18 Jan 2023 12:44:10 +0000 (14:44 +0200)
committerMika Westerberg <mika.westerberg@linux.intel.com>
Fri, 27 Jan 2023 06:25:59 +0000 (08:25 +0200)
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
drivers/thunderbolt/tunnel.h

index e87d378ca2cd32e261630704f73d1adb00e29155..554c44d4fab07ed0326e9670bc7dbfb9c784e230 100644 (file)
@@ -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 downstream 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)
 {
index d7bbdf8c8186717300e8c8994916381799bca02d..bf690f7beeeeba554afabbe7674596c3eb315ebd 100644 (file)
@@ -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