Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Alan Borzeszkowski
and committed by
Mika Westerberg
d05cc39d
207b8a26
+19
-11
+19
-11
drivers/thunderbolt/tb.c
+19
-11
drivers/thunderbolt/tb.c
···
225
225
return ret == -EOPNOTSUPP ? 0 : ret;
226
226
}
227
227
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.
231
230
*
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.
236
234
*/
237
235
static bool tb_disable_clx(struct tb_switch *sw)
238
236
{
···
454
456
}
455
457
}
456
458
457
-
/**
458
-
* tb_find_unused_port() - return the first inactive port on @sw
459
-
* @sw: Switch to find the port on
460
-
* @type: Port type to look for
459
+
/*
460
+
* Returns the first inactive port on @sw.
461
461
*/
462
462
static struct tb_port *tb_find_unused_port(struct tb_switch *sw,
463
463
enum tb_port_type type)
···
545
549
* from @src_port to @dst_port. Does not take USB3 tunnel starting from
546
550
* @src_port and ending on @src_port into account because that bandwidth is
547
551
* already included in as part of the "first hop" USB3 tunnel.
552
+
*
553
+
* Return: %0 on success, negative errno otherwise.
548
554
*/
549
555
static int tb_consumed_usb3_pcie_bandwidth(struct tb *tb,
550
556
struct tb_port *src_port,
···
599
601
* If there is bandwidth reserved for any of the groups between
600
602
* @src_port and @dst_port (but not yet used) that is also taken into
601
603
* account in the returned consumed bandwidth.
604
+
*
605
+
* Return: %0 on success, negative errno otherwise.
602
606
*/
603
607
static int tb_consumed_dp_bandwidth(struct tb *tb,
604
608
struct tb_port *src_port,
···
701
701
* single link at @port. If @include_asym is set then includes the
702
702
* additional banwdith if the links are transitioned into asymmetric to
703
703
* direction from @src_port to @dst_port.
704
+
*
705
+
* Return: %0 on success, negative errno otherwise.
704
706
*/
705
707
static int tb_maximum_bandwidth(struct tb *tb, struct tb_port *src_port,
706
708
struct tb_port *dst_port, struct tb_port *port,
···
809
807
* If @include_asym is true then includes also bandwidth that can be
810
808
* added when the links are transitioned into asymmetric (but does not
811
809
* transition the links).
810
+
*
811
+
* Return: %0 on success, negative errno otherwise.
812
812
*/
813
813
static int tb_available_bandwidth(struct tb *tb, struct tb_port *src_port,
814
814
struct tb_port *dst_port, int *available_up,
···
1033
1029
* (requested + currently consumed) on that link exceed @asym_threshold.
1034
1030
*
1035
1031
* Must be called with available >= requested over all links.
1032
+
*
1033
+
* Return: %0 on success, negative errno otherwise.
1036
1034
*/
1037
1035
static int tb_configure_asym(struct tb *tb, struct tb_port *src_port,
1038
1036
struct tb_port *dst_port, int requested_up,
···
1141
1135
* Goes over each link from @src_port to @dst_port and tries to
1142
1136
* transition the link to symmetric if the currently consumed bandwidth
1143
1137
* allows and link asymmetric preference is ignored (if @keep_asym is %false).
1138
+
*
1139
+
* Return: %0 on success, negative errno otherwise.
1144
1140
*/
1145
1141
static int tb_configure_sym(struct tb *tb, struct tb_port *src_port,
1146
1142
struct tb_port *dst_port, bool keep_asym)