Skip to content

Commit b30234f

Browse files
aborzeszwesteri
authored andcommitted
thunderbolt: Add missing documentation in tb.h
Add missing parameters and struct/enum description in tb.h kernel-doc comments. 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 978a3d6 commit b30234f

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

  • drivers/thunderbolt

drivers/thunderbolt/tb.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ struct usb4_port {
324324
};
325325

326326
/**
327-
* tb_retimer: Thunderbolt retimer
327+
* struct tb_retimer - Thunderbolt retimer
328328
* @dev: Device for the retimer
329329
* @tb: Pointer to the domain the retimer belongs to
330330
* @index: Retimer index facing the router USB4 port
@@ -552,6 +552,7 @@ static inline void *tb_priv(struct tb *tb)
552552

553553
/**
554554
* tb_upstream_port() - return the upstream port of a switch
555+
* @sw: Router
555556
*
556557
* Every switch has an upstream port (for the root switch it is the NHI).
557558
*
@@ -1241,6 +1242,7 @@ static inline int tb_route_length(u64 route)
12411242

12421243
/**
12431244
* tb_downstream_route() - get route to downstream switch
1245+
* @port: Port to check
12441246
*
12451247
* Port must not be the upstream port (otherwise a loop is created).
12461248
*
@@ -1364,7 +1366,7 @@ int usb4_port_asym_set_link_width(struct tb_port *port, enum tb_link_width width
13641366
int usb4_port_asym_start(struct tb_port *port);
13651367

13661368
/**
1367-
* enum tb_sb_target - Sideband transaction target
1369+
* enum usb4_sb_target - Sideband transaction target
13681370
* @USB4_SB_TARGET_ROUTER: Target is the router itself
13691371
* @USB4_SB_TARGET_PARTNER: Target is partner
13701372
* @USB4_SB_TARGET_RETIMER: Target is retimer
@@ -1409,6 +1411,8 @@ enum usb4_margining_lane {
14091411
* @voltage_time_offset: Offset for voltage / time for software margining
14101412
* @optional_voltage_offset_range: Enable optional extended voltage range
14111413
* @right_high: %false if left/low margin test is performed, %true if right/high
1414+
* @upper_eye: %true if margin test is done on upper eye, %false if done on
1415+
* lower eye
14121416
* @time: %true if time margining is used instead of voltage
14131417
*/
14141418
struct usb4_port_margining_params {

0 commit comments

Comments
 (0)