Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20201027211154.3371691-1-enric.balletbo@collabora.com> <CAK8P3a0r8vaL8Mc=EVZCrqW4s8uvhfBjLRfGCEc4jp7W6Z_dUQ@mail.gmail.com>
In-Reply-To: <CAK8P3a0r8vaL8Mc=EVZCrqW4s8uvhfBjLRfGCEc4jp7W6Z_dUQ@mail.gmail.com>
From:   Arnd Bergmann <arnd@kernel.org>
Date:   Fri, 6 Nov 2020 11:23:05 +0100
Message-ID: <CAK8P3a1uZndNOq0SfBt8C78COAy70gMws47FPNS8CdoLHNdvyw@mail.gmail.com>
Subject: Re: [PATCH] mfd: syscon: Add syscon_regmap_lookup_by_phandle_optional()
 function.
To:     Arnd Bergmann <arnd@arndb.de>
Cc:     Enric Balletbo i Serra <enric.balletbo@collabora.com>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        Collabora Kernel ML <kernel@collabora.com>,
        Nicolas Boichat <drinkcat@chromium.org>,
        Lee Jones <lee.jones@linaro.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

I noticed that my earlier reply was rejected by some mail servers,
resending from @kernel.org to make sure everyone has it.

On Tue, Oct 27, 2020 at 10:57 PM Arnd Bergmann <arnd@arndb.de> wrote:
>
> On Tue, Oct 27, 2020 at 10:11 PM Enric Balletbo i Serra
> <enric.balletbo@collabora.com> wrote:
> >
> > This adds syscon_regmap_lookup_by_phandle_optional() function to get an
> > optional regmap.
> >
> > It behaves the same as syscon_regmap_lookup_by_phandle() except where
> > there is no regmap phandle. In this case, instead of returning -ENODEV,
> > the function returns NULL. This makes error checking simpler when the
> > regmap phandle is optional.
> >
> > Suggested-by: Nicolas Boichat <drinkcat@chromium.org>
> > Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
>
> Looks good in principle.
>
> > @@ -255,6 +255,19 @@ struct regmap *syscon_regmap_lookup_by_phandle_args(struct device_node *np,
> >  }
> >  EXPORT_SYMBOL_GPL(syscon_regmap_lookup_by_phandle_args);
> >
> > +struct regmap *syscon_regmap_lookup_by_phandle_optional(struct device_node *np,
> > +                                       const char *property)
> > +{
> > +       struct regmap *regmap;
> > +
> > +       regmap = syscon_regmap_lookup_by_phandle(np, property);
> > +       if (IS_ERR(regmap) && PTR_ERR(regmap) == -ENODEV)
> > +               return NULL;
> > +
> > +       return regmap;
> > +}
>
> I think the explanation from the patch description is needed here as well,
> as an interface that might either return an error code or NULL is generally
> a really bad idea. I understand what this is for, but it's easy to misread.
>
> >  static inline struct regmap *device_node_to_regmap(struct device_node *np)
> >  {
> > @@ -59,6 +62,14 @@ static inline struct regmap *syscon_regmap_lookup_by_phandle_args(
> >  {
> >         return ERR_PTR(-ENOTSUPP);
> >  }
> > +
> > +static inline struct regmap *syscon_regmap_lookup_by_phandle_optional(
> > +                                       struct device_node *np,
> > +                                       const char *property)
> > +{
> > +       return ERR_PTR(-ENOTSUPP);
> > +}
>
> Shouldn't this also return NULL then?
>
>           Arnd