Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
thunderbolt: Update path.c function documentation
Make path.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
a6e3f939
fe83a273
+9
-5
+9
-5
drivers/thunderbolt/path.c
+9
-5
drivers/thunderbolt/path.c
···
96
96
* that the @dst port is the expected one. If it is not, the path can be
97
97
* cleaned up by calling tb_path_deactivate() before tb_path_free().
98
98
*
99
-
* Return: Discovered path on success, %NULL in case of failure
99
+
* Return: Pointer to &struct tb_path, %NULL in case of failure.
100
100
*/
101
101
struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
102
102
struct tb_port *dst, int dst_hopid,
···
233
233
* links on the path, prioritizes using @link_nr but takes into account
234
234
* that the lanes may be bonded.
235
235
*
236
-
* Return: Returns a tb_path on success or NULL on failure.
236
+
* Return: Pointer to &struct tb_path, %NULL in case of failure.
237
237
*/
238
238
struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
239
239
struct tb_port *dst, int dst_hopid, int link_nr,
···
452
452
* @hop_index: HopID of the path to be cleared
453
453
*
454
454
* This deactivates or clears a single path config space entry at
455
-
* @hop_index. Returns %0 in success and negative errno otherwise.
455
+
* @hop_index.
456
+
*
457
+
* Return: %0 on success, negative errno otherwise.
456
458
*/
457
459
int tb_path_deactivate_hop(struct tb_port *port, int hop_index)
458
460
{
···
500
498
* Activate a path starting with the last hop and iterating backwards. The
501
499
* caller must fill path->hops before calling tb_path_activate().
502
500
*
503
-
* Return: Returns 0 on success or an error code on failure.
501
+
* Return: %0 on success, negative errno otherwise.
504
502
*/
505
503
int tb_path_activate(struct tb_path *path)
506
504
{
···
594
592
* tb_path_is_invalid() - check whether any ports on the path are invalid
595
593
* @path: Path to check
596
594
*
597
-
* Return: Returns true if the path is invalid, false otherwise.
595
+
* Return: %true if the path is invalid, %false otherwise.
598
596
*/
599
597
bool tb_path_is_invalid(struct tb_path *path)
600
598
{
···
615
613
*
616
614
* Goes over all hops on path and checks if @port is any of them.
617
615
* Direction does not matter.
616
+
*
617
+
* Return: %true if port is on the path, %false otherwise.
618
618
*/
619
619
bool tb_path_port_on_path(const struct tb_path *path, const struct tb_port *port)
620
620
{