thunderbolt: Update tb.h function documentation

+23 -14

1 changed file

expand all

drivers

thunderbolt

tb.h

+23 -14

drivers/thunderbolt/tb.h

··· 558 558 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for 559 559 * non root switches (on the NHI port remote is always NULL). 560 560 * 561 - * Return: Returns the upstream port of the switch. 561 + * Return: Pointer to &struct tb_port. 562 562 */ 563 563 static inline struct tb_port *tb_upstream_port(struct tb_switch *sw) 564 564 { ··· 569 569 * tb_is_upstream_port() - Is the port upstream facing 570 570 * @port: Port to check 571 571 * 572 - * Returns true if @port is upstream facing port. In case of dual link 573 - * ports both return true. 572 + * Return: %true if @port is upstream facing port. In case of dual link 573 + * ports, both return %true. 574 574 */ 575 575 static inline bool tb_is_upstream_port(const struct tb_port *port) 576 576 { ··· 613 613 * tb_port_has_remote() - Does the port have switch connected downstream 614 614 * @port: Port to check 615 615 * 616 - * Returns true only when the port is primary port and has remote set. 616 + * Return: %true only when the port is primary port and has remote set. 617 617 */ 618 618 static inline bool tb_port_has_remote(const struct tb_port *port) 619 619 { ··· 905 905 * tb_switch_downstream_port() - Return downstream facing port of parent router 906 906 * @sw: Device router pointer 907 907 * 908 - * Only call for device routers. Returns the downstream facing port of 909 - * the parent router. 908 + * Call only for device routers. 909 + * 910 + * Return: Pointer to &struct tb_port or %NULL in case of failure. 910 911 */ 911 912 static inline struct tb_port *tb_switch_downstream_port(struct tb_switch *sw) 912 913 { ··· 919 918 /** 920 919 * tb_switch_depth() - Returns depth of the connected router 921 920 * @sw: Router 921 + * 922 + * Return: Router depth level as a number. 922 923 */ 923 924 static inline int tb_switch_depth(const struct tb_switch *sw) 924 925 { ··· 1013 1010 * is handling @sw this function can be called. It is valid to call this 1014 1011 * after tb_switch_alloc() and tb_switch_configure() has been called 1015 1012 * (latter only for SW CM case). 1013 + * 1014 + * Return: %true if switch is handled by ICM, %false if handled by 1015 + * software CM. 1016 1016 */ 1017 1017 static inline bool tb_switch_is_icm(const struct tb_switch *sw) 1018 1018 { ··· 1043 1037 * 1044 1038 * Checks if given router TMU mode is configured to @mode. Note the 1045 1039 * router TMU might not be enabled to this mode. 1040 + * 1041 + * Return: %true if TMU mode is equal to @mode, %false otherwise. 1046 1042 */ 1047 1043 static inline bool tb_switch_tmu_is_configured(const struct tb_switch *sw, 1048 1044 enum tb_switch_tmu_mode mode) ··· 1056 1048 * tb_switch_tmu_is_enabled() - Checks if the specified TMU mode is enabled 1057 1049 * @sw: Router whose TMU mode to check 1058 1050 * 1059 - * Return true if hardware TMU configuration matches the requested 1060 - * configuration (and is not %TB_SWITCH_TMU_MODE_OFF). 1051 + * Return: %true if hardware TMU configuration matches the requested 1052 + * configuration (and is not %TB_SWITCH_TMU_MODE_OFF), %false otherwise. 1061 1053 */ 1062 1054 static inline bool tb_switch_tmu_is_enabled(const struct tb_switch *sw) 1063 1055 { ··· 1077 1069 * @clx: The CLx states to check for 1078 1070 * 1079 1071 * Checks if the specified CLx is enabled on the router upstream link. 1080 - * Returns true if any of the given states is enabled. 1081 1072 * 1082 1073 * Not applicable for a host router. 1074 + * 1075 + * Return: %true if any of the given states is enabled, %false otherwise. 1083 1076 */ 1084 1077 static inline bool tb_switch_clx_is_enabled(const struct tb_switch *sw, 1085 1078 unsigned int clx) ··· 1112 1103 * @src: Source adapter 1113 1104 * @dst: Destination adapter 1114 1105 * 1115 - * Returns %true only if the specified path from source adapter (@src) 1106 + * Return: %true only if the specified path from source adapter (@src) 1116 1107 * to destination adapter (@dst) is directed downstream. 1117 1108 */ 1118 1109 static inline bool ··· 1244 1235 * 1245 1236 * Port must not be the upstream port (otherwise a loop is created). 1246 1237 * 1247 - * Return: Returns a route to the switch behind @port. 1238 + * Return: Route to the switch behind @port. 1248 1239 */ 1249 1240 static inline u64 tb_downstream_route(struct tb_port *port) 1250 1241 { ··· 1272 1263 * tb_xdomain_downstream_port() - Return downstream facing port of parent router 1273 1264 * @xd: Xdomain pointer 1274 1265 * 1275 - * Returns the downstream port the XDomain is connected to. 1266 + * Return: Pointer to &struct tb_port or %NULL in case of failure. 1276 1267 */ 1277 1268 static inline struct tb_port *tb_xdomain_downstream_port(struct tb_xdomain *xd) 1278 1269 { ··· 1300 1291 * usb4_switch_version() - Returns USB4 version of the router 1301 1292 * @sw: Router to check 1302 1293 * 1303 - * Returns major version of USB4 router (%1 for v1, %2 for v2 and so 1294 + * Return: Major version of USB4 router (%1 for v1, %2 for v2 and so 1304 1295 * on). Can be called to pre-USB4 router too and in that case returns %0. 1305 1296 */ 1306 1297 static inline unsigned int usb4_switch_version(const struct tb_switch *sw) ··· 1312 1303 * tb_switch_is_usb4() - Is the switch USB4 compliant 1313 1304 * @sw: Switch to check 1314 1305 * 1315 - * Returns true if the @sw is USB4 compliant router, false otherwise. 1306 + * Return: %true if the @sw is USB4 compliant router, %false otherwise. 1316 1307 */ 1317 1308 static inline bool tb_switch_is_usb4(const struct tb_switch *sw) 1318 1309 {

Configure Feed

Configure Feed