tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

thunderbolt: Update lc.c function documentation

Make lc.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 4815b754 728ab0e4

+43 -15
+43 -15
drivers/thunderbolt/lc.c
··· 14 14 * tb_lc_read_uuid() - Read switch UUID from link controller common register 15 15 * @sw: Switch whose UUID is read 16 16 * @uuid: UUID is placed here 17 + * 18 + * Return: %0 on success, negative errno otherwise. 17 19 */ 18 20 int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid) 19 21 { ··· 54 52 * @port: Port that is reset 55 53 * 56 54 * Triggers downstream port reset through link controller registers. 57 - * Returns %0 in case of success negative errno otherwise. Only supports 58 - * non-USB4 routers with link controller (that's Thunderbolt 2 and 59 - * Thunderbolt 3). 55 + * Only supports non-USB4 routers with link controller (that's 56 + * Thunderbolt 2 and Thunderbolt 3). 57 + * 58 + * Return: %0 on success, negative errno otherwise. 60 59 */ 61 60 int tb_lc_reset_port(struct tb_port *port) 62 61 { ··· 135 132 * @port: Port that is set as configured 136 133 * 137 134 * Sets the port configured for power management purposes. 135 + * 136 + * Return: %0 on success, negative errno otherwise. 138 137 */ 139 138 int tb_lc_configure_port(struct tb_port *port) 140 139 { ··· 148 143 * @port: Port that is set as configured 149 144 * 150 145 * Sets the port unconfigured for power management purposes. 146 + * 147 + * Return: %0 on success, negative errno otherwise. 151 148 */ 152 149 void tb_lc_unconfigure_port(struct tb_port *port) 153 150 { ··· 191 184 * tb_lc_configure_xdomain() - Inform LC that the link is XDomain 192 185 * @port: Switch downstream port connected to another host 193 186 * 194 - * Sets the lane configured for XDomain accordingly so that the LC knows 195 - * about this. Returns %0 in success and negative errno in failure. 187 + * Sets the lane configured for XDomain accordingly so that LC knows 188 + * about this. 189 + * 190 + * Return: %0 on success, negative errno otherwise. 196 191 */ 197 192 int tb_lc_configure_xdomain(struct tb_port *port) 198 193 { ··· 220 211 * sleep. Should be called for those downstream lane adapters that were 221 212 * not connected (tb_lc_configure_port() was not called) before sleep. 222 213 * 223 - * Returns %0 in success and negative errno in case of failure. 214 + * Return: %0 on success, negative errno otherwise. 224 215 */ 225 216 int tb_lc_start_lane_initialization(struct tb_port *port) 226 217 { ··· 253 244 * 254 245 * TB_LC_LINK_ATTR_CPS bit reflects if the link supports CLx including 255 246 * active cables (if connected on the link). 247 + * 248 + * Return: %true if CLx is supported, %false otherwise. 256 249 */ 257 250 bool tb_lc_is_clx_supported(struct tb_port *port) 258 251 { ··· 277 266 * tb_lc_is_usb_plugged() - Is there USB device connected to port 278 267 * @port: Device router lane 0 adapter 279 268 * 280 - * Returns true if the @port has USB type-C device connected. 269 + * Return: %true if the @port has USB Type-C device connected, %false 270 + * otherwise. 281 271 */ 282 272 bool tb_lc_is_usb_plugged(struct tb_port *port) 283 273 { ··· 304 292 * tb_lc_is_xhci_connected() - Is the internal xHCI connected 305 293 * @port: Device router lane 0 adapter 306 294 * 307 - * Returns true if the internal xHCI has been connected to @port. 295 + * Return: %true if the internal xHCI has been connected to 296 + * @port, %false otherwise. 308 297 */ 309 298 bool tb_lc_is_xhci_connected(struct tb_port *port) 310 299 { ··· 356 343 * tb_lc_xhci_connect() - Connect internal xHCI 357 344 * @port: Device router lane 0 adapter 358 345 * 359 - * Tells LC to connect the internal xHCI to @port. Returns %0 on success 360 - * and negative errno in case of failure. Can be called for Thunderbolt 3 361 - * routers only. 346 + * Tells LC to connect the internal xHCI to @port. Can be called for 347 + * Thunderbolt 3 routers only. 348 + * 349 + * Return: %0 on success, negative errno otherwise. 362 350 */ 363 351 int tb_lc_xhci_connect(struct tb_port *port) 364 352 { ··· 422 408 * @flags: Wakeup flags (%0 to disable) 423 409 * 424 410 * For each LC sets wake bits accordingly. 411 + * 412 + * Return: %0 on success, negative errno otherwise. 425 413 */ 426 414 int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags) 427 415 { ··· 463 447 * 464 448 * Let the switch link controllers know that the switch is going to 465 449 * sleep. 450 + * 451 + * Return: %0 on success, negative errno otherwise. 466 452 */ 467 453 int tb_lc_set_sleep(struct tb_switch *sw) 468 454 { ··· 509 491 * 510 492 * Checks whether conditions for lane bonding from parent to @sw are 511 493 * possible. 494 + * 495 + * Return: %true if lane bonding is possible, %false otherwise. 512 496 */ 513 497 bool tb_lc_lane_bonding_possible(struct tb_switch *sw) 514 498 { ··· 582 562 * 583 563 * Queries through LC SNK_ALLOCATION registers whether DP sink is available 584 564 * for the given DP IN port or not. 565 + * 566 + * Return: %true if DP sink is available, %false otherwise. 585 567 */ 586 568 bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in) 587 569 { ··· 608 586 * @sw: Switch whose DP sink is allocated 609 587 * @in: DP IN port the DP sink is allocated for 610 588 * 611 - * Allocate DP sink for @in via LC SNK_ALLOCATION registers. If the 612 - * resource is available and allocation is successful returns %0. In all 613 - * other cases returs negative errno. In particular %-EBUSY is returned if 614 - * the resource was not available. 589 + * Allocate DP sink for @in via LC SNK_ALLOCATION registers. 590 + * 591 + * Return: 592 + * * %0 - If the resource is available and allocation is successful. 593 + * * %-EBUSY - If resource is not available. 594 + * * Negative errno - Another error occurred. 615 595 */ 616 596 int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in) 617 597 { ··· 661 637 * @in: DP IN port whose DP sink is de-allocated 662 638 * 663 639 * De-allocate DP sink from @in using LC SNK_ALLOCATION registers. 640 + * 641 + * Return: %0 on success, negative errno otherwise. 664 642 */ 665 643 int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in) 666 644 { ··· 706 680 * 707 681 * This is useful to let authentication cycle pass even without 708 682 * a Thunderbolt link present. 683 + * 684 + * Return: %0 on success, negative errno otherwise. 709 685 */ 710 686 int tb_lc_force_power(struct tb_switch *sw) 711 687 {