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

thunderbolt: Update tmu.c function documentation

Make tmu.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
371c2374 b30234f2

+13 -3
+13 -3
drivers/thunderbolt/tmu.c
··· 405 405 * This function must be called before other TMU related functions to 406 406 * makes the internal structures are filled in correctly. Does not 407 407 * change any hardware configuration. 408 + * 409 + * Return: %0 on success, negative errno otherwise. 408 410 */ 409 411 int tb_switch_tmu_init(struct tb_switch *sw) 410 412 { ··· 441 439 * @sw: Switch whose time to update 442 440 * 443 441 * Updates switch local time using time posting procedure. 442 + * 443 + * Return: %0 on success, negative errno otherwise. 444 444 */ 445 445 int tb_switch_tmu_post_time(struct tb_switch *sw) 446 446 { ··· 559 555 * @sw: Switch whose TMU to disable 560 556 * 561 557 * Turns off TMU of @sw if it is enabled. If not enabled does nothing. 558 + * 559 + * Return: %0 on success, negative errno otherwise. 562 560 */ 563 561 int tb_switch_tmu_disable(struct tb_switch *sw) 564 562 { ··· 944 938 * Enables TMU of a router to be in uni-directional Normal/HiFi or 945 939 * bi-directional HiFi mode. Calling tb_switch_tmu_configure() is 946 940 * required before calling this function. 941 + * 942 + * Return: %0 on success, negative errno otherwise. 947 943 */ 948 944 int tb_switch_tmu_enable(struct tb_switch *sw) 949 945 { ··· 1025 1017 * Selects the TMU mode that is enabled when tb_switch_tmu_enable() is 1026 1018 * next called. 1027 1019 * 1028 - * Returns %0 in success and negative errno otherwise. Specifically 1029 - * returns %-EOPNOTSUPP if the requested mode is not possible (not 1030 - * supported by the router and/or topology). 1020 + * Return: 1021 + * * %0 - On success. 1022 + * * %-EOPNOTSUPP - If the requested mode is not possible (not supported by 1023 + * the router and/or topology). 1024 + * * Negative errno - Another error occurred. 1031 1025 */ 1032 1026 int tb_switch_tmu_configure(struct tb_switch *sw, enum tb_switch_tmu_mode mode) 1033 1027 {