Skip to content

Commit 371c237

Browse files
aborzeszwesteri
authored andcommitted
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>
1 parent b30234f commit 371c237

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

drivers/thunderbolt/tmu.c

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,8 @@ static int tmu_mode_init(struct tb_switch *sw)
405405
* This function must be called before other TMU related functions to
406406
* makes the internal structures are filled in correctly. Does not
407407
* change any hardware configuration.
408+
*
409+
* Return: %0 on success, negative errno otherwise.
408410
*/
409411
int tb_switch_tmu_init(struct tb_switch *sw)
410412
{
@@ -439,6 +441,8 @@ int tb_switch_tmu_init(struct tb_switch *sw)
439441
* @sw: Switch whose time to update
440442
*
441443
* Updates switch local time using time posting procedure.
444+
*
445+
* Return: %0 on success, negative errno otherwise.
442446
*/
443447
int tb_switch_tmu_post_time(struct tb_switch *sw)
444448
{
@@ -555,6 +559,8 @@ static int disable_enhanced(struct tb_port *up, struct tb_port *down)
555559
* @sw: Switch whose TMU to disable
556560
*
557561
* Turns off TMU of @sw if it is enabled. If not enabled does nothing.
562+
*
563+
* Return: %0 on success, negative errno otherwise.
558564
*/
559565
int tb_switch_tmu_disable(struct tb_switch *sw)
560566
{
@@ -938,6 +944,8 @@ static int tb_switch_tmu_change_mode(struct tb_switch *sw)
938944
* Enables TMU of a router to be in uni-directional Normal/HiFi or
939945
* bi-directional HiFi mode. Calling tb_switch_tmu_configure() is
940946
* required before calling this function.
947+
*
948+
* Return: %0 on success, negative errno otherwise.
941949
*/
942950
int tb_switch_tmu_enable(struct tb_switch *sw)
943951
{
@@ -1017,9 +1025,11 @@ int tb_switch_tmu_enable(struct tb_switch *sw)
10171025
* Selects the TMU mode that is enabled when tb_switch_tmu_enable() is
10181026
* next called.
10191027
*
1020-
* Returns %0 in success and negative errno otherwise. Specifically
1021-
* returns %-EOPNOTSUPP if the requested mode is not possible (not
1022-
* supported by the router and/or topology).
1028+
* Return:
1029+
* * %0 - On success.
1030+
* * %-EOPNOTSUPP - If the requested mode is not possible (not supported by
1031+
* the router and/or topology).
1032+
* * Negative errno - Another error occurred.
10231033
*/
10241034
int tb_switch_tmu_configure(struct tb_switch *sw, enum tb_switch_tmu_mode mode)
10251035
{

0 commit comments

Comments
 (0)