From: Sean Anderson <seanga2@gmail.com>
To: u-boot@lists.denx.de
Subject: [PATCH] clk: fix clk_get_rate() documentation
Date: Fri, 12 Feb 2021 18:25:41 -0500 [thread overview]
Message-ID: <cc5461f0-c29c-0123-9478-b6d02edea41b@gmail.com> (raw)
In-Reply-To: <20210210173722.4823-1-giulio.benetti@benettiengineering.com>
On 2/10/21 12:37 PM, Giulio Benetti wrote:
> clk_get_rate() can't and doesn't return -ve on error, it actually returns 0
> on error or a value greater than 0 on success. So let's fix its
> documentation.
>
> Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
> ---
> include/clk.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/clk.h b/include/clk.h
> index ca6b85fa6f..a833d6a27b 100644
> --- a/include/clk.h
> +++ b/include/clk.h
> @@ -344,7 +344,7 @@ int clk_free(struct clk *clk);
> *
> * @clk: A clock struct that was previously successfully requested by
> * clk_request/get_by_*().
> - * @return clock rate in Hz, or -ve error code.
> + * @return clock rate in Hz on success, or 0 on error.
> */
> ulong clk_get_rate(struct clk *clk);
>
>
NAK. This function *does* return negative errors (see e.g.
drivers/clk/clk-uclass.c). However, it may return 0 if passed an invalid
clock (see clk_valid).
--Sean
next prev parent reply other threads:[~2021-02-12 23:25 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-10 17:37 [PATCH] clk: fix clk_get_rate() documentation Giulio Benetti
2021-02-12 23:25 ` Sean Anderson [this message]
2021-02-13 1:17 ` Giulio Benetti
2021-02-13 4:17 ` Simon Glass
2021-02-13 8:47 ` Giulio Benetti
2021-02-13 18:24 ` Simon Glass
2021-02-14 2:05 ` Giulio Benetti
2021-02-14 2:17 ` [PATCH v2] " Giulio Benetti
2021-02-14 2:58 ` Jesse T
2021-02-14 3:17 ` Giulio Benetti
2021-02-14 3:49 ` Jesse T
2021-02-22 19:13 ` Heinrich Schuchardt
2021-02-23 0:25 ` Giulio Benetti
2021-04-04 18:56 ` Giulio Benetti
2021-11-24 4:01 ` Sean Anderson
2021-12-15 19:05 ` Sean Anderson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cc5461f0-c29c-0123-9478-b6d02edea41b@gmail.com \
--to=seanga2@gmail.com \
--cc=u-boot@lists.denx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).