phy: qcom-qusb2: Re add "qcom,sdm845-qusb2-phy" compat string

Commit Message

John Stultz April 2, 2020, 10:37 p.m. UTC

In commit 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2
PHY support"), the change was made to add "qcom,qusb2-v2-phy"
as a generic compat string. However the change also removed
the "qcom,sdm845-qusb2-phy" compat string, which is documented
in the binding and already in use.

This patch re-adds the "qcom,sdm845-qusb2-phy" compat string
which allows the driver to continue to work with existing dts
entries such as found on the db845c.

Cc: Andy Gross <[e-mail]>
Cc: Bjorn Andersson <[e-mail]>
Cc: Rob Herring <[e-mail]>
Cc: Mark Rutland <[e-mail]>
Cc: Doug Anderson <[e-mail]>
Cc: Manu Gautam <[e-mail]>
Cc: Sandeep Maheswaram <[e-mail]>
Cc: Matthias Kaehlcke <[e-mail]>
Cc: Stephen Boyd <[e-mail]>
Cc: Kishon Vijay Abraham I <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
Fixes: 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2 PHY support")
Reported-by: YongQin Liu <[e-mail]>
Signed-off-by: John Stultz <[e-mail]>
---
 drivers/phy/qualcomm/phy-qcom-qusb2.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Doug Anderson April 2, 2020, 10:56 p.m. UTC | #1

Hi,

On Thu, Apr 2, 2020 at 3:37 PM John Stultz <[e-mail]> wrote:
>
> In commit 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2
> PHY support"), the change was made to add "qcom,qusb2-v2-phy"
> as a generic compat string. However the change also removed
> the "qcom,sdm845-qusb2-phy" compat string, which is documented
> in the binding and already in use.
>
> This patch re-adds the "qcom,sdm845-qusb2-phy" compat string
> which allows the driver to continue to work with existing dts
> entries such as found on the db845c.
>
> Cc: Andy Gross <[e-mail]>
> Cc: Bjorn Andersson <[e-mail]>
> Cc: Rob Herring <[e-mail]>
> Cc: Mark Rutland <[e-mail]>
> Cc: Doug Anderson <[e-mail]>
> Cc: Manu Gautam <[e-mail]>
> Cc: Sandeep Maheswaram <[e-mail]>
> Cc: Matthias Kaehlcke <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: Kishon Vijay Abraham I <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> Fixes: 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2 PHY support")
> Reported-by: YongQin Liu <[e-mail]>
> Signed-off-by: John Stultz <[e-mail]>
> ---
>  drivers/phy/qualcomm/phy-qcom-qusb2.c | 3 +++
>  1 file changed, 3 insertions(+)

Do you have an out-of-tree dts file?  If not, I'd prefer that the fix
was for this patch to land instead:

https://lore.kernel.org/r/[e-mail]

While we can land your patch if someone needs it for supporting an
out-of-tree dts, it gives people supporting future SoCs the idea that
they need to add themselves to this table too.  That's now discouraged
unless there's a specific quirk that needs to be handled just for this
SoC.

-Doug

Bjorn Andersson April 2, 2020, 11:01 p.m. UTC | #2

On Thu 02 Apr 15:37 PDT 2020, John Stultz wrote:

> In commit 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2
> PHY support"), the change was made to add "qcom,qusb2-v2-phy"
> as a generic compat string. However the change also removed
> the "qcom,sdm845-qusb2-phy" compat string, which is documented
> in the binding and already in use.
> 
> This patch re-adds the "qcom,sdm845-qusb2-phy" compat string
> which allows the driver to continue to work with existing dts
> entries such as found on the db845c.
> 
> Cc: Andy Gross <[e-mail]>
> Cc: Bjorn Andersson <[e-mail]>
> Cc: Rob Herring <[e-mail]>
> Cc: Mark Rutland <[e-mail]>
> Cc: Doug Anderson <[e-mail]>
> Cc: Manu Gautam <[e-mail]>
> Cc: Sandeep Maheswaram <[e-mail]>
> Cc: Matthias Kaehlcke <[e-mail]>
> Cc: Stephen Boyd <[e-mail]>
> Cc: Kishon Vijay Abraham I <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> Fixes: 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2 PHY support")
> Reported-by: YongQin Liu <[e-mail]>
> Signed-off-by: John Stultz <[e-mail]>

Reviewed-by: Bjorn Andersson <[e-mail]>

Regards,
Bjorn

> ---
>  drivers/phy/qualcomm/phy-qcom-qusb2.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/phy/qualcomm/phy-qcom-qusb2.c b/drivers/phy/qualcomm/phy-qcom-qusb2.c
> index 3708d43b7508..ab7941ce5d3a 100644
> --- a/drivers/phy/qualcomm/phy-qcom-qusb2.c
> +++ b/drivers/phy/qualcomm/phy-qcom-qusb2.c
> @@ -815,6 +815,9 @@ static const struct of_device_id qusb2_phy_of_match_table[] = {
>  	}, {
>  		.compatible	= "qcom,msm8998-qusb2-phy",
>  		.data		= &msm8998_phy_cfg,
> +	}, {
> +		.compatible	= "qcom,sdm845-qusb2-phy",
> +		.data		= &qusb2_v2_phy_cfg,
>  	}, {
>  		.compatible	= "qcom,qusb2-v2-phy",
>  		.data		= &qusb2_v2_phy_cfg,
> -- 
> 2.17.1
>

John Stultz April 2, 2020, 11:08 p.m. UTC | #3

On Thu, Apr 2, 2020 at 3:56 PM Doug Anderson <[e-mail]> wrote:
>
> Hi,
>
> On Thu, Apr 2, 2020 at 3:37 PM John Stultz <[e-mail]> wrote:
> >
> > In commit 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2
> > PHY support"), the change was made to add "qcom,qusb2-v2-phy"
> > as a generic compat string. However the change also removed
> > the "qcom,sdm845-qusb2-phy" compat string, which is documented
> > in the binding and already in use.
> >
> > This patch re-adds the "qcom,sdm845-qusb2-phy" compat string
> > which allows the driver to continue to work with existing dts
> > entries such as found on the db845c.
> >
> > Cc: Andy Gross <[e-mail]>
> > Cc: Bjorn Andersson <[e-mail]>
> > Cc: Rob Herring <[e-mail]>
> > Cc: Mark Rutland <[e-mail]>
> > Cc: Doug Anderson <[e-mail]>
> > Cc: Manu Gautam <[e-mail]>
> > Cc: Sandeep Maheswaram <[e-mail]>
> > Cc: Matthias Kaehlcke <[e-mail]>
> > Cc: Stephen Boyd <[e-mail]>
> > Cc: Kishon Vijay Abraham I <[e-mail]>
> > Cc: [e-mail]
> > Cc: [e-mail]
> > Fixes: 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2 PHY support")
> > Reported-by: YongQin Liu <[e-mail]>
> > Signed-off-by: John Stultz <[e-mail]>
> > ---
> >  drivers/phy/qualcomm/phy-qcom-qusb2.c | 3 +++
> >  1 file changed, 3 insertions(+)
>
> Do you have an out-of-tree dts file?  If not, I'd prefer that the fix
> was for this patch to land instead:
>
> https://lore.kernel.org/r/[e-mail]

No, no out of tree dts.  The usage is already in tree:
  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/arch/arm64/boot/dts/qcom/sdm845.dtsi#n2389


> While we can land your patch if someone needs it for supporting an
> out-of-tree dts, it gives people supporting future SoCs the idea that
> they need to add themselves to this table too.  That's now discouraged
> unless there's a specific quirk that needs to be handled just for this
> SoC.

My understanding with dts bindings is that they are effectively an
ABI. While maybe it makes sense to deprecate the
"qcom,sdm845-qusb2-phy" string in the Documentation to avoid new
users, I'd think we'd want to keep the support in the driver as we
aren't supposed to have tight coupling between the DTB and kernel (at
least for official bindings).

Granted, I've not gotten much experience with boards that were fully
upstream and thus didn't have an eternally evolving dts file that had
to be kept in sync with the kernel, so in practice either solution
does work for me, but in theory it seems like we should at least
pretend these things are stable. :)

thanks
-john

Bjorn Andersson April 2, 2020, 11:18 p.m. UTC | #4

On Thu 02 Apr 15:56 PDT 2020, Doug Anderson wrote:

> Hi,
> 
> On Thu, Apr 2, 2020 at 3:37 PM John Stultz <[e-mail]> wrote:
> >
> > In commit 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2
> > PHY support"), the change was made to add "qcom,qusb2-v2-phy"
> > as a generic compat string. However the change also removed
> > the "qcom,sdm845-qusb2-phy" compat string, which is documented
> > in the binding and already in use.
> >
> > This patch re-adds the "qcom,sdm845-qusb2-phy" compat string
> > which allows the driver to continue to work with existing dts
> > entries such as found on the db845c.
> >
> > Cc: Andy Gross <[e-mail]>
> > Cc: Bjorn Andersson <[e-mail]>
> > Cc: Rob Herring <[e-mail]>
> > Cc: Mark Rutland <[e-mail]>
> > Cc: Doug Anderson <[e-mail]>
> > Cc: Manu Gautam <[e-mail]>
> > Cc: Sandeep Maheswaram <[e-mail]>
> > Cc: Matthias Kaehlcke <[e-mail]>
> > Cc: Stephen Boyd <[e-mail]>
> > Cc: Kishon Vijay Abraham I <[e-mail]>
> > Cc: [e-mail]
> > Cc: [e-mail]
> > Fixes: 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2 PHY support")
> > Reported-by: YongQin Liu <[e-mail]>
> > Signed-off-by: John Stultz <[e-mail]>
> > ---
> >  drivers/phy/qualcomm/phy-qcom-qusb2.c | 3 +++
> >  1 file changed, 3 insertions(+)
> 
> Do you have an out-of-tree dts file?  If not, I'd prefer that the fix
> was for this patch to land instead:
> 
> https://lore.kernel.org/r/[e-mail]
> 
> While we can land your patch if someone needs it for supporting an
> out-of-tree dts, it gives people supporting future SoCs the idea that
> they need to add themselves to this table too.  That's now discouraged
> unless there's a specific quirk that needs to be handled just for this
> SoC.
> 

Afaict the compatible has been in use in the upstream sdm845.dtsi since
v4.20 and we do have an outspoken rule that we don't break backwards
compatibility with existing DTBs.

There are cases where it makes sense to break this rule, e.g. to fix
something that's clearly broken, but I don't see that this is such a
case.

Regards,
Bjorn

Doug Anderson April 2, 2020, 11:19 p.m. UTC | #5

Hi,

On Thu, Apr 2, 2020 at 4:08 PM John Stultz <[e-mail]> wrote:
>
> On Thu, Apr 2, 2020 at 3:56 PM Doug Anderson <[e-mail]> wrote:
> >
> > Hi,
> >
> > On Thu, Apr 2, 2020 at 3:37 PM John Stultz <[e-mail]> wrote:
> > >
> > > In commit 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2
> > > PHY support"), the change was made to add "qcom,qusb2-v2-phy"
> > > as a generic compat string. However the change also removed
> > > the "qcom,sdm845-qusb2-phy" compat string, which is documented
> > > in the binding and already in use.
> > >
> > > This patch re-adds the "qcom,sdm845-qusb2-phy" compat string
> > > which allows the driver to continue to work with existing dts
> > > entries such as found on the db845c.
> > >
> > > Cc: Andy Gross <[e-mail]>
> > > Cc: Bjorn Andersson <[e-mail]>
> > > Cc: Rob Herring <[e-mail]>
> > > Cc: Mark Rutland <[e-mail]>
> > > Cc: Doug Anderson <[e-mail]>
> > > Cc: Manu Gautam <[e-mail]>
> > > Cc: Sandeep Maheswaram <[e-mail]>
> > > Cc: Matthias Kaehlcke <[e-mail]>
> > > Cc: Stephen Boyd <[e-mail]>
> > > Cc: Kishon Vijay Abraham I <[e-mail]>
> > > Cc: [e-mail]
> > > Cc: [e-mail]
> > > Fixes: 8fe75cd4cddf ("phy: qcom-qusb2: Add generic QUSB2 V2 PHY support")
> > > Reported-by: YongQin Liu <[e-mail]>
> > > Signed-off-by: John Stultz <[e-mail]>
> > > ---
> > >  drivers/phy/qualcomm/phy-qcom-qusb2.c | 3 +++
> > >  1 file changed, 3 insertions(+)
> >
> > Do you have an out-of-tree dts file?  If not, I'd prefer that the fix
> > was for this patch to land instead:
> >
> > https://lore.kernel.org/r/[e-mail]
>
> No, no out of tree dts.  The usage is already in tree:
>   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/arch/arm64/boot/dts/qcom/sdm845.dtsi#n2389
>
>
> > While we can land your patch if someone needs it for supporting an
> > out-of-tree dts, it gives people supporting future SoCs the idea that
> > they need to add themselves to this table too.  That's now discouraged
> > unless there's a specific quirk that needs to be handled just for this
> > SoC.
>
> My understanding with dts bindings is that they are effectively an
> ABI. While maybe it makes sense to deprecate the
> "qcom,sdm845-qusb2-phy" string in the Documentation to avoid new
> users, I'd think we'd want to keep the support in the driver as we
> aren't supposed to have tight coupling between the DTB and kernel (at
> least for official bindings).

If nothing else if we're going to land your patch, can you at least
put a comment in there that says "only needed to support legacy device
trees that didn't include "qcom,qusb2-v2-phy" in the compatible
string.  Then the person who adds the next Qualcomm SoC will know not
to add themselves to the table too.


> Granted, I've not gotten much experience with boards that were fully
> upstream and thus didn't have an eternally evolving dts file that had
> to be kept in sync with the kernel, so in practice either solution
> does work for me, but in theory it seems like we should at least
> pretend these things are stable. :)

Yeah, I don't want to get into the whole stable ABI argument, but what
you say is the official word.  The bindings are supposed to be a
stable ABI and it's a good goal to strive for.

...but in reality most people are OK with it not being quite so stable
as long as it's not hurting anyone.  What should have happened here is
that the bindings and dts should have landed in one Linux version and
the driver change landed in the next Linux version.  Now we're stuck
with the breakage, though.  :(  In general for "new" architectures
it's considered more OK to break compatibility, though I guess you can
argue whether sdm845 is really new enough.  I guess to get at the meat
of the issue though: if you need a patch to fix your problem anyway,
why not land the patch that doesn't end up chewing extra up extra code
space and providing a bad example for someone to copy?

Now certainly if changing your DTS was an undue burden (like you've
already baked device trees into firmware) there's no question we
should land your patch.  I'm just not sure the lofty goal of "it's
supposed to be a stable ABI so let's add an entry to the table that
nobody will ever care about after the dts change lands" is enough of a
reason to land it now.

OK, I'll duck from the tomatoes now.

-Doug

John Stultz April 2, 2020, 11:54 p.m. UTC | #6

On Thu, Apr 2, 2020 at 4:19 PM Doug Anderson <[e-mail]> wrote:
> On Thu, Apr 2, 2020 at 4:08 PM John Stultz <[e-mail]> wrote:
> > My understanding with dts bindings is that they are effectively an
> > ABI. While maybe it makes sense to deprecate the
> > "qcom,sdm845-qusb2-phy" string in the Documentation to avoid new
> > users, I'd think we'd want to keep the support in the driver as we
> > aren't supposed to have tight coupling between the DTB and kernel (at
> > least for official bindings).
>
> If nothing else if we're going to land your patch, can you at least
> put a comment in there that says "only needed to support legacy device
> trees that didn't include "qcom,qusb2-v2-phy" in the compatible
> string.  Then the person who adds the next Qualcomm SoC will know not
> to add themselves to the table too.

Done.


> > Granted, I've not gotten much experience with boards that were fully
> > upstream and thus didn't have an eternally evolving dts file that had
> > to be kept in sync with the kernel, so in practice either solution
> > does work for me, but in theory it seems like we should at least
> > pretend these things are stable. :)
>
> Yeah, I don't want to get into the whole stable ABI argument, but what
> you say is the official word.  The bindings are supposed to be a
> stable ABI and it's a good goal to strive for.
>
> ...but in reality most people are OK with it not being quite so stable
> as long as it's not hurting anyone.  What should have happened here is
> that the bindings and dts should have landed in one Linux version and
> the driver change landed in the next Linux version.  Now we're stuck
> with the breakage, though.  :(  In general for "new" architectures
> it's considered more OK to break compatibility, though I guess you can
> argue whether sdm845 is really new enough.  I guess to get at the meat
> of the issue though: if you need a patch to fix your problem anyway,
> why not land the patch that doesn't end up chewing extra up extra code
> space and providing a bad example for someone to copy?
>
> Now certainly if changing your DTS was an undue burden (like you've
> already baked device trees into firmware) there's no question we
> should land your patch.  I'm just not sure the lofty goal of "it's
> supposed to be a stable ABI so let's add an entry to the table that
> nobody will ever care about after the dts change lands" is enough of a
> reason to land it now.

Personally, I'm fine with either solution (as there's still dts
changes for db845c pending that we're carrying), but I also want to
make sure we're setting a good standard for future changes (as these
sorts of things seem to bite me far too frequently on the db845c,
sometimes even resulting in forced userland changes that we've so far
been able to adapt to, but are not ideal).

So I've resubmitted my version to let the maintainers decide.  :)

thanks
-john

Patch

diff --git a/drivers/phy/qualcomm/phy-qcom-qusb2.c b/drivers/phy/qualcomm/phy-qcom-qusb2.c
index 3708d43b7508..ab7941ce5d3a 100644
--- a/drivers/phy/qualcomm/phy-qcom-qusb2.c
+++ b/drivers/phy/qualcomm/phy-qcom-qusb2.c
@@ -815,6 +815,9 @@  static const struct of_device_id qusb2_phy_of_match_table[] = {
 	}, {
 		.compatible	= "qcom,msm8998-qusb2-phy",
 		.data		= &msm8998_phy_cfg,
+	}, {
+		.compatible	= "qcom,sdm845-qusb2-phy",
+		.data		= &qusb2_v2_phy_cfg,
 	}, {
 		.compatible	= "qcom,qusb2-v2-phy",
 		.data		= &qusb2_v2_phy_cfg,