Skip to content

Commit d05cc39

Browse files
aborzeszwesteri
authored andcommitted
thunderbolt: Update tb.c function documentation
Make tb.c function documentation compliant with current kernel-doc standards. No functional changes. Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com> Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
1 parent 207b8a2 commit d05cc39

1 file changed

Lines changed: 19 additions & 11 deletions

File tree

  • drivers/thunderbolt

drivers/thunderbolt/tb.c

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -225,14 +225,12 @@ static int tb_enable_clx(struct tb_switch *sw)
225225
return ret == -EOPNOTSUPP ? 0 : ret;
226226
}
227227

228-
/**
229-
* tb_disable_clx() - Disable CL states up to host router
230-
* @sw: Router to start
228+
/*
229+
* Disables CL states from @sw up to the host router.
231230
*
232-
* Disables CL states from @sw up to the host router. Returns true if
233-
* any CL state were disabled. This can be used to figure out whether
234-
* the link was setup by us or the boot firmware so we don't
235-
* accidentally enable them if they were not enabled during discovery.
231+
* This can be used to figure out whether the link was setup by us or the
232+
* boot firmware so we don't accidentally enable them if they were not
233+
* enabled during discovery.
236234
*/
237235
static bool tb_disable_clx(struct tb_switch *sw)
238236
{
@@ -456,10 +454,8 @@ static void tb_scan_xdomain(struct tb_port *port)
456454
}
457455
}
458456

459-
/**
460-
* tb_find_unused_port() - return the first inactive port on @sw
461-
* @sw: Switch to find the port on
462-
* @type: Port type to look for
457+
/*
458+
* Returns the first inactive port on @sw.
463459
*/
464460
static struct tb_port *tb_find_unused_port(struct tb_switch *sw,
465461
enum tb_port_type type)
@@ -549,6 +545,8 @@ static struct tb_tunnel *tb_find_first_usb3_tunnel(struct tb *tb,
549545
* from @src_port to @dst_port. Does not take USB3 tunnel starting from
550546
* @src_port and ending on @src_port into account because that bandwidth is
551547
* already included in as part of the "first hop" USB3 tunnel.
548+
*
549+
* Return: %0 on success, negative errno otherwise.
552550
*/
553551
static int tb_consumed_usb3_pcie_bandwidth(struct tb *tb,
554552
struct tb_port *src_port,
@@ -601,6 +599,8 @@ static int tb_consumed_usb3_pcie_bandwidth(struct tb *tb,
601599
* If there is bandwidth reserved for any of the groups between
602600
* @src_port and @dst_port (but not yet used) that is also taken into
603601
* account in the returned consumed bandwidth.
602+
*
603+
* Return: %0 on success, negative errno otherwise.
604604
*/
605605
static int tb_consumed_dp_bandwidth(struct tb *tb,
606606
struct tb_port *src_port,
@@ -701,6 +701,8 @@ static bool tb_asym_supported(struct tb_port *src_port, struct tb_port *dst_port
701701
* single link at @port. If @include_asym is set then includes the
702702
* additional banwdith if the links are transitioned into asymmetric to
703703
* direction from @src_port to @dst_port.
704+
*
705+
* Return: %0 on success, negative errno otherwise.
704706
*/
705707
static int tb_maximum_bandwidth(struct tb *tb, struct tb_port *src_port,
706708
struct tb_port *dst_port, struct tb_port *port,
@@ -807,6 +809,8 @@ static int tb_maximum_bandwidth(struct tb *tb, struct tb_port *src_port,
807809
* If @include_asym is true then includes also bandwidth that can be
808810
* added when the links are transitioned into asymmetric (but does not
809811
* transition the links).
812+
*
813+
* Return: %0 on success, negative errno otherwise.
810814
*/
811815
static int tb_available_bandwidth(struct tb *tb, struct tb_port *src_port,
812816
struct tb_port *dst_port, int *available_up,
@@ -1029,6 +1033,8 @@ static int tb_create_usb3_tunnels(struct tb_switch *sw)
10291033
* (requested + currently consumed) on that link exceed @asym_threshold.
10301034
*
10311035
* Must be called with available >= requested over all links.
1036+
*
1037+
* Return: %0 on success, negative errno otherwise.
10321038
*/
10331039
static int tb_configure_asym(struct tb *tb, struct tb_port *src_port,
10341040
struct tb_port *dst_port, int requested_up,
@@ -1135,6 +1141,8 @@ static int tb_configure_asym(struct tb *tb, struct tb_port *src_port,
11351141
* Goes over each link from @src_port to @dst_port and tries to
11361142
* transition the link to symmetric if the currently consumed bandwidth
11371143
* allows and link asymmetric preference is ignored (if @keep_asym is %false).
1144+
*
1145+
* Return: %0 on success, negative errno otherwise.
11381146
*/
11391147
static int tb_configure_sym(struct tb *tb, struct tb_port *src_port,
11401148
struct tb_port *dst_port, bool keep_asym)

0 commit comments

Comments
 (0)