clk: Document of_parse_clkspec() some more
authorStephen Boyd <sboyd@kernel.org>
Mon, 26 Aug 2019 21:20:42 +0000 (14:20 -0700)
committerStephen Boyd <sboyd@kernel.org>
Thu, 5 Sep 2019 18:51:31 +0000 (11:51 -0700)
commit226fd70209451428c563977f5ce022a41d077110
tree68f7733b1d36a99452588d8af3174af617a6d564
parentef13e55c27e128b6d84aa939dcc565b1d2ee7724
clk: Document of_parse_clkspec() some more

The return value of of_parse_clkspec() is peculiar. If the function is
called with a NULL argument for 'name' it will return -ENOENT, but if
it's called with a non-NULL argument for 'name' it will return -EINVAL.
This peculiarity is documented by commit 5c56dfe63b6e ("clk: Add comment
about __of_clk_get_by_name() error values").

Let's further document this function so that it's clear what the return
value is and how to use the arguments to parse clk specifiers.

Cc: Phil Edworthy <phil.edworthy@renesas.com>
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
Link: https://lkml.kernel.org/r/20190826212042.48642-1-sboyd@kernel.org
Reviewed-by: Phil Edworthy <phil.edworthy@renesas.com>
drivers/clk/clk.c