clk: document that clk_get_parent() returns NULL

The documentation in the clk.h file says that clk_get_parent() returns
error pointers but it doesn't.  It's also not consistent with the
comments next to the clk_get_parent() implementation which say that
it returns NULL when the clk is NULL.  Update the comments so they
are consistent and accurate and say that it returns NULL.

Signed-off-by: Dan Carpenter <error27@gmail.com>
Reviewed-by: Brian Masney <bmasney@redhat.com>
Signed-off-by: Brian Masney <bmasney@redhat.com>
This commit is contained in:
Dan Carpenter 2026-07-14 18:50:18 +03:00 committed by Brian Masney
parent 18e9d14cba
commit d304518469

View File

@ -951,8 +951,8 @@ int clk_set_parent(struct clk *clk, struct clk *parent);
* clk_get_parent - get the parent clock source for this clock
* @clk: clock source
*
* Returns struct clk corresponding to parent clock source, or
* valid IS_ERR() condition containing errno.
* Returns struct clk corresponding to parent clock source, or NULL
* if clk is NULL.
*/
struct clk *clk_get_parent(struct clk *clk);