| Message ID | 20220315083723.97822-1-krzysztof.kozlowski@canonical.com |
|---|---|
| State | New |
| Headers | show |
| Series | dt-bindings: gpio: add common consumer GPIO lines | expand |
On Tue, Mar 15, 2022 at 09:37:23AM +0100, Krzysztof Kozlowski wrote: > Typical GPIO lines like enable, powerdown, reset or wakeup are not > documented as common, which leads to new variations of these (e.g. > pwdn-gpios). Add a common schema which serves also as a documentation > for preferred naming. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> > --- > .../bindings/gpio/gpio-consumer-common.yaml | 36 +++++++++++++++++++ > 1 file changed, 36 insertions(+) > create mode 100644 Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml > > diff --git a/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml b/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml > new file mode 100644 > index 000000000000..098dc913f9e5 > --- /dev/null > +++ b/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml > @@ -0,0 +1,36 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/gpio/gpio-consumer-common.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Common GPIO lines > + > +maintainers: > + - Bartosz Golaszewski <brgl@bgdev.pl> > + - Linus Walleij <linus.walleij@linaro.org> > + > +# do not select this schema for GPIO hogs > +select: > + properties: > + gpio-hog: false 'select: true' should be sufficient here. > + > +properties: > + enable-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array Perhaps some sort of description on these. I think these are always a single line, so 'maxItems: 1'. > + > + reset-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + > + powerdown-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + > + pwdn-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + description: Use powerdown-gpios > + deprecated: true > + > + wakeup-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + > +additionalProperties: true > -- > 2.32.0 > >
On 21/03/2022 19:20, Rob Herring wrote: > On Tue, Mar 15, 2022 at 09:37:23AM +0100, Krzysztof Kozlowski wrote: >> Typical GPIO lines like enable, powerdown, reset or wakeup are not >> documented as common, which leads to new variations of these (e.g. >> pwdn-gpios). Add a common schema which serves also as a documentation >> for preferred naming. >> >> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> >> --- >> .../bindings/gpio/gpio-consumer-common.yaml | 36 +++++++++++++++++++ >> 1 file changed, 36 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml >> >> diff --git a/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml b/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml >> new file mode 100644 >> index 000000000000..098dc913f9e5 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml >> @@ -0,0 +1,36 @@ >> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/gpio/gpio-consumer-common.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Common GPIO lines >> + >> +maintainers: >> + - Bartosz Golaszewski <brgl@bgdev.pl> >> + - Linus Walleij <linus.walleij@linaro.org> >> + >> +# do not select this schema for GPIO hogs >> +select: >> + properties: >> + gpio-hog: false > > 'select: true' should be sufficient here. > >> + >> +properties: >> + enable-gpios: >> + $ref: /schemas/types.yaml#/definitions/phandle-array > > Perhaps some sort of description on these. > > I think these are always a single line, so 'maxItems: 1'. I assume you meant all other as well (so reset-gpios, powerdown-gpios) - also with maxItems:1. I'll fix it. Best regards, Krzysztof
diff --git a/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml b/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml new file mode 100644 index 000000000000..098dc913f9e5 --- /dev/null +++ b/Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml @@ -0,0 +1,36 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/gpio/gpio-consumer-common.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Common GPIO lines + +maintainers: + - Bartosz Golaszewski <brgl@bgdev.pl> + - Linus Walleij <linus.walleij@linaro.org> + +# do not select this schema for GPIO hogs +select: + properties: + gpio-hog: false + +properties: + enable-gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + + reset-gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + + powerdown-gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + + pwdn-gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + description: Use powerdown-gpios + deprecated: true + + wakeup-gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + +additionalProperties: true
Typical GPIO lines like enable, powerdown, reset or wakeup are not documented as common, which leads to new variations of these (e.g. pwdn-gpios). Add a common schema which serves also as a documentation for preferred naming. Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> --- .../bindings/gpio/gpio-consumer-common.yaml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Documentation/devicetree/bindings/gpio/gpio-consumer-common.yaml