[PATCH] of: correct of_console_check()'s return value

[PATCH] of: correct of_console_check()'s return value

[Brian Norris]

The comments above of_console_check() say that it will return TRUE if it
registers a preferred console, but add_preferred_console() uses a
0-equals-success convention, so ths leaves of_console_check() with an
inconsistent policy for its return values.

Fortunately, nobody was actually checking the return value of
of_console_check(), so this isn't significant at the moment.

But let's match the comments, so we're doing what we say.

Fixes: 3482f2c52b77 ('of: Create of_console_check() for selecting a console specified in /chosen')
Signed-off-by: Brian Norris <computersforpeace@gmail.com>
Cc: Grant Likely <grant.likely@linaro.org>
---
This is one way to fix it. Another possibility includes changing
of_console_check() to use 0-as-success

 drivers/of/base.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/of/base.c b/drivers/of/base.c
index d8574adf0d62..bcfd08c2795c 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -1986,7 +1986,7 @@ bool of_console_check(struct device_node *dn, char *name, int index)
 {
 	if (!dn || dn != of_stdout || console_set_on_cmdline)
 		return false;
-	return add_preferred_console(name, index, NULL);
+	return !add_preferred_console(name, index, NULL);
 }
 EXPORT_SYMBOL_GPL(of_console_check);
 
-- 
1.9.1

Re: [PATCH] of: correct of_console_check()'s return value

[Grant Likely]

On Wed,  3 Sep 2014 11:06:43 -0700, Brian Norris <computersforpeace@gmail.com> wrote:
> The comments above of_console_check() say that it will return TRUE if it
> registers a preferred console, but add_preferred_console() uses a
> 0-equals-success convention, so ths leaves of_console_check() with an
> inconsistent policy for its return values.
> 
> Fortunately, nobody was actually checking the return value of
> of_console_check(), so this isn't significant at the moment.
> 
> But let's match the comments, so we're doing what we say.
> 
> Fixes: 3482f2c52b77 ('of: Create of_console_check() for selecting a console specified in /chosen')
> Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> Cc: Grant Likely <grant.likely@linaro.org>

Good catch. Applied, thanks.

g.

> ---
> This is one way to fix it. Another possibility includes changing
> of_console_check() to use 0-as-success
> 
>  drivers/of/base.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/of/base.c b/drivers/of/base.c
> index d8574adf0d62..bcfd08c2795c 100644
> --- a/drivers/of/base.c
> +++ b/drivers/of/base.c
> @@ -1986,7 +1986,7 @@ bool of_console_check(struct device_node *dn, char *name, int index)
>  {
>  	if (!dn || dn != of_stdout || console_set_on_cmdline)
>  		return false;
> -	return add_preferred_console(name, index, NULL);
> +	return !add_preferred_console(name, index, NULL);
>  }
>  EXPORT_SYMBOL_GPL(of_console_check);
>  
> -- 
> 1.9.1
> 

Re: [PATCH] of: correct of_console_check()'s return value

[Brian Norris]

Hi Grant,

On Mon, Sep 08, 2014 at 11:42:38AM +0100, Grant Likely wrote:
> On Wed,  3 Sep 2014 11:06:43 -0700, Brian Norris <computersforpeace@gmail.com> wrote:
> > The comments above of_console_check() say that it will return TRUE if it
> > registers a preferred console, but add_preferred_console() uses a
> > 0-equals-success convention, so ths leaves of_console_check() with an
> > inconsistent policy for its return values.
> > 
> > Fortunately, nobody was actually checking the return value of
> > of_console_check(), so this isn't significant at the moment.
> > 
> > But let's match the comments, so we're doing what we say.
> > 
> > Fixes: 3482f2c52b77 ('of: Create of_console_check() for selecting a console specified in /chosen')
> > Signed-off-by: Brian Norris <computersforpeace@gmail.com>
> > Cc: Grant Likely <grant.likely@linaro.org>
> 
> Good catch. Applied, thanks.

Applied to what? I don't see it in linux-next.

Regards,
Brian

Re: [PATCH] of: correct of_console_check()'s return value

[Grant Likely]

On Fri, Sep 26, 2014 at 12:53 AM, Brian Norris
<computersforpeace@gmail.com> wrote:
> Hi Grant,
>
> On Mon, Sep 08, 2014 at 11:42:38AM +0100, Grant Likely wrote:
>> On Wed,  3 Sep 2014 11:06:43 -0700, Brian Norris <computersforpeace@gmail.com> wrote:
>> > The comments above of_console_check() say that it will return TRUE if it
>> > registers a preferred console, but add_preferred_console() uses a
>> > 0-equals-success convention, so ths leaves of_console_check() with an
>> > inconsistent policy for its return values.
>> >
>> > Fortunately, nobody was actually checking the return value of
>> > of_console_check(), so this isn't significant at the moment.
>> >
>> > But let's match the comments, so we're doing what we say.
>> >
>> > Fixes: 3482f2c52b77 ('of: Create of_console_check() for selecting a console specified in /chosen')
>> > Signed-off-by: Brian Norris <computersforpeace@gmail.com>
>> > Cc: Grant Likely <grant.likely@linaro.org>
>>
>> Good catch. Applied, thanks.
>
> Applied to what? I don't see it in linux-next.

It got merged into mainline on Thursday.

g.