Re: [PATCH] dt-bindings: mmc: Make comment on wakeup-source less confusing

From: Ulf Hansson
Date: Tue Nov 29 2022 - 10:31:27 EST


On Tue, 29 Nov 2022 at 13:36, Krzysztof Kozlowski
<krzysztof.kozlowski@xxxxxxxxxx> wrote:
>
> On 22/11/2022 12:11, Christoph Niedermaier wrote:
> > The current comment on wakeup-source is a bit confusing, because it isn't
> > clear at first sight which property is actually deprecated.
> > Change the comment to one that is less confusing.
>
> It's still confusing - you mention some non-existing property. I don't
> think it's worth to touch it. If you insist, drop entire comment...

Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is
indeed a deprecated wakeup property [1], but it seems like it's not
really described somewhere. I wouldn't mind removing it (as it seems
to add some confusions), but in that case it needs to be entirely
removed from the DT docs, right?

Another option, would be to add a proper description of the property
and mark it with "deprecated: true".

>
> >
> > Signed-off-by: Christoph Niedermaier <cniedermaier@xxxxxxxxxxxxxxxxxx>
> > ---
> > Cc: Ulf Hansson <ulf.hansson@xxxxxxxxxx>
> > Cc: Rob Herring <robh+dt@xxxxxxxxxx>
> > Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@xxxxxxxxxx>
> > Cc: Marek Vasut <marex@xxxxxxx>
> > Cc: kernel@xxxxxxxxxxxxxxxxxx
> > Cc: linux-mmc@xxxxxxxxxxxxxxx
> > Cc: devicetree@xxxxxxxxxxxxxxx
> > To: linux-kernel@xxxxxxxxxxxxxxx
> > ---
> > Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> > index 802e3ca8be4d..a921442c6c1d 100644
> > --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> > +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> > @@ -293,7 +293,7 @@ properties:
> > description:
> > SDIO only. Preserves card power during a suspend/resume cycle.
> >
> > - # Deprecated: enable-sdio-wakeup
> > + # Use wakeup-source instead of the deprecated enable-sdio-wakeup
> > wakeup-source:
> > $ref: /schemas/types.yaml#/definitions/flag
> > description:

Kind regards
Uffe

[1]
Documentation/devicetree/bindings/power/wakeup-source.txt