Skip to content

Commit 79ad0cc

Browse files
committed
[doxygen] add doxygen comment for clk.c and clk.h
Accroding to #9947 and #9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations. - rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies. - clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify. - clk_release implements may be incomplete, so I just marked in comment. Signed-off-by: 1078249029 <[email protected]>
1 parent 524a038 commit 79ad0cc

File tree

1 file changed

+12
-9
lines changed
  • components/drivers/clk

1 file changed

+12
-9
lines changed

components/drivers/clk/clk.c

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -454,9 +454,9 @@ static void clk_unprepare(struct rt_clk *clk, struct rt_clk_node *clk_np)
454454
}
455455
}
456456

457-
458457
rt_err_t rt_clk_unprepare(struct rt_clk *clk)
459458
{
459+
rt_err_t err = RT_EOK;
460460

461461
RT_DEBUG_NOT_IN_INTERRUPT;
462462

@@ -469,6 +469,7 @@ rt_err_t rt_clk_unprepare(struct rt_clk *clk)
469469
rt_hw_spin_unlock(&_clk_lock.lock);
470470
}
471471

472+
return err;
472473
}
473474

474475
/**
@@ -646,23 +647,25 @@ rt_err_t rt_clk_array_prepare(struct rt_clk_array *clk_arr)
646647
return err;
647648
}
648649

649-
/**
650-
* @brief Unprepare clock array for mutipule out clock
651-
*
652-
* @param clk_arr point to clock array
653-
*
654-
*/
655-
void rt_clk_array_unprepare(struct rt_clk_array *clk_arr)
650+
rt_err_t rt_clk_array_unprepare(struct rt_clk_array *clk_arr)
656651
{
652+
rt_err_t err = RT_EOK;
657653

658654
if (clk_arr)
659655
{
660656
for (int i = 0; i < clk_arr->count; ++i)
661657
{
662-
rt_clk_unprepare(clk_arr->clks[i]);
658+
if ((err = rt_clk_unprepare(clk_arr->clks[i])))
659+
{
660+
LOG_E("CLK Array[%d] %s failed error = %s", i,
661+
"unprepare", rt_strerror(err));
662+
663+
break;
664+
}
663665
}
664666
}
665667

668+
return err;
666669
}
667670

668671
/**

0 commit comments

Comments
 (0)