From: Mika Westerberg Date: Wed, 18 Jan 2023 12:44:10 +0000 (+0200) Subject: thunderbolt: Add missing kernel-doc comment to tb_tunnel_maximum_bandwidth() X-Git-Tag: v6.3-rc1~110^2~16^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=06cbcbfaa6510eed406e3b6d5d071386b9830689;p=thirdparty%2Flinux.git thunderbolt: Add missing kernel-doc comment to tb_tunnel_maximum_bandwidth() These were missing from the original commit so add them now. No functional changes. Signed-off-by: Mika Westerberg --- diff --git a/drivers/thunderbolt/tunnel.c b/drivers/thunderbolt/tunnel.c index e87d378ca2cd3..554c44d4fab07 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 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) { diff --git a/drivers/thunderbolt/tunnel.h b/drivers/thunderbolt/tunnel.h index d7bbdf8c81867..bf690f7beeeeb 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