| Message ID | 20220126200350.3633576-1-clabbe@baylibre.com (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | dt-bindings: hwmon: gpio-fan: convert to YAML | expand |
On Wed, 26 Jan 2022 20:03:50 +0000, Corentin Labbe wrote: > Converts hwmon/gpio-fan.txt to YAML > > Signed-off-by: Corentin Labbe <clabbe@baylibre.com> > --- > > I didnt found any clear maintainer and since DT yaml mandates a > maintainer section, I set devicetree@vger.kernel.org. > > .../devicetree/bindings/hwmon/gpio-fan.txt | 41 -------- > .../devicetree/bindings/hwmon/gpio-fan.yaml | 96 +++++++++++++++++++ > 2 files changed, 96 insertions(+), 41 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.txt > create mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13): yamllint warnings/errors: dtschema/dtc warnings/errors: Documentation/devicetree/bindings/hwmon/gpio-fan.example.dt.yaml:0:0: /example-0/gpio@4d000000: failed to match any schema with compatible: ['cortina,gemini-gpio', 'faraday,ftgpio010'] Documentation/devicetree/bindings/hwmon/gpio-fan.example.dt.yaml:0:0: /example-0/gpio@4d000000: failed to match any schema with compatible: ['cortina,gemini-gpio', 'faraday,ftgpio010'] Documentation/devicetree/bindings/hwmon/gpio-fan.example.dt.yaml:0:0: /example-1/gpio@4d000000: failed to match any schema with compatible: ['cortina,gemini-gpio', 'faraday,ftgpio010'] Documentation/devicetree/bindings/hwmon/gpio-fan.example.dt.yaml:0:0: /example-1/gpio@4d000000: failed to match any schema with compatible: ['cortina,gemini-gpio', 'faraday,ftgpio010'] doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/patch/1584654 This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit.
On Wed, Jan 26, 2022 at 08:03:50PM +0000, Corentin Labbe wrote: > Converts hwmon/gpio-fan.txt to YAML > > Signed-off-by: Corentin Labbe <clabbe@baylibre.com> > --- > > I didnt found any clear maintainer and since DT yaml mandates a > maintainer section, I set devicetree@vger.kernel.org. > > .../devicetree/bindings/hwmon/gpio-fan.txt | 41 -------- > .../devicetree/bindings/hwmon/gpio-fan.yaml | 96 +++++++++++++++++++ > 2 files changed, 96 insertions(+), 41 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.txt > create mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > > diff --git a/Documentation/devicetree/bindings/hwmon/gpio-fan.txt b/Documentation/devicetree/bindings/hwmon/gpio-fan.txt > deleted file mode 100644 > index f4cfa350f6a1..000000000000 > --- a/Documentation/devicetree/bindings/hwmon/gpio-fan.txt > +++ /dev/null > @@ -1,41 +0,0 @@ > -Bindings for fan connected to GPIO lines > - > -Required properties: > -- compatible : "gpio-fan" > - > -Optional properties: > -- gpios: Specifies the pins that map to bits in the control value, > - ordered MSB-->LSB. > -- gpio-fan,speed-map: A mapping of possible fan RPM speeds and the > - control value that should be set to achieve them. This array > - must have the RPM values in ascending order. > -- alarm-gpios: This pin going active indicates something is wrong with > - the fan, and a udev event will be fired. > -- #cooling-cells: If used as a cooling device, must be <2> > - Also see: > - Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml > - min and max states are derived from the speed-map of the fan. > - > -Note: At least one the "gpios" or "alarm-gpios" properties must be set. > - > -Examples: > - > - gpio_fan { > - compatible = "gpio-fan"; > - gpios = <&gpio1 14 1 > - &gpio1 13 1>; > - gpio-fan,speed-map = <0 0 > - 3000 1 > - 6000 2>; > - alarm-gpios = <&gpio1 15 1>; > - }; > - gpio_fan_cool: gpio_fan { > - compatible = "gpio-fan"; > - gpios = <&gpio2 14 1 > - &gpio2 13 1>; > - gpio-fan,speed-map = <0 0>, > - <3000 1>, > - <6000 2>; > - alarm-gpios = <&gpio2 15 1>; > - #cooling-cells = <2>; /* min followed by max */ > - }; > diff --git a/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml b/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > new file mode 100644 > index 000000000000..15bb5efd3cb4 > --- /dev/null > +++ b/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > @@ -0,0 +1,96 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/hwmon/gpio-fan.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Bindings for fan connected to GPIO lines > + > +maintainers: > + - OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <devicetree@vger.kernel.org> > + > +properties: > + compatible: > + const: gpio-fan > + > + gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + description: Specifies the pins that map to bits in the control value, > + ordered MSB-->LSB. > + > + gpio-fan,speed-map: > + $ref: /schemas/types.yaml#/definitions/uint32-matrix > + description: A mapping of possible fan RPM speeds and the > + control value that should be set to achieve them. This array > + must have the RPM values in ascending order. > + > + alarm-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + description: This pin going active indicates something is wrong with > + the fan, and a udev event will be fired. > + > + "#cooling-cells": > + const: 2 > + description: If used as a cooling device, must be <2> > + Also see Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml > + min and max states are derived from the speed-map of the fan. > + > +anyOf: > + - required: > + - gpios > + - required: > + - alarm-gpios > + > +additionalProperties: False > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + #include <dt-bindings/clock/cortina,gemini-clock.h> > + #include <dt-bindings/reset/cortina,gemini-reset.h> > + #include <dt-bindings/gpio/gpio.h> > + gpio1: gpio@4d000000 { > + compatible = "cortina,gemini-gpio", "faraday,ftgpio010"; > + reg = <0x4d000000 0x100>; > + interrupts = <22 IRQ_TYPE_LEVEL_HIGH>; > + resets = <&syscon GEMINI_RESET_GPIO0>; > + clocks = <&syscon GEMINI_CLK_APB>; > + gpio-controller; > + #gpio-cells = <2>; > + interrupt-controller; > + #interrupt-cells = <2>; > + }; No need to show providers in examples. And one example is probably sufficient here. > + gpio_fan { > + compatible = "gpio-fan"; > + gpios = <&gpio1 8 GPIO_ACTIVE_HIGH>; > + gpio-fan,speed-map = <0 0>, > + <3000 1>, > + <6000 2>; > + alarm-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>; > + }; > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + #include <dt-bindings/clock/cortina,gemini-clock.h> > + #include <dt-bindings/reset/cortina,gemini-reset.h> > + #include <dt-bindings/gpio/gpio.h> > + gpio2: gpio@4d000000 { > + compatible = "cortina,gemini-gpio", "faraday,ftgpio010"; > + reg = <0x4d000000 0x100>; > + interrupts = <22 IRQ_TYPE_LEVEL_HIGH>; > + resets = <&syscon GEMINI_RESET_GPIO0>; > + clocks = <&syscon GEMINI_CLK_APB>; > + gpio-controller; > + #gpio-cells = <2>; > + interrupt-controller; > + #interrupt-cells = <2>; > + }; > + gpio_fan_cool: gpio_fan { > + compatible = "gpio-fan"; > + gpios = <&gpio2 8 GPIO_ACTIVE_HIGH > + &gpio2 1 GPIO_ACTIVE_HIGH>; > + gpio-fan,speed-map = <0 0 > + 3000 1 > + 6000 2>; > + alarm-gpios = <&gpio2 15 GPIO_ACTIVE_HIGH>; > + #cooling-cells = <2>; /* min followed by max */ > + }; > -- > 2.34.1 > >
On Wed, Jan 26, 2022 at 08:03:50PM +0000, Corentin Labbe wrote: > Converts hwmon/gpio-fan.txt to YAML > > Signed-off-by: Corentin Labbe <clabbe@baylibre.com> > --- > > I didnt found any clear maintainer and since DT yaml mandates a > maintainer section, I set devicetree@vger.kernel.org. Hey Corentin, Looks like there were only some minor comments from Rob on this patch, but I do not see a v2 on lore. Just never get around to sending a v2, or did it fall through the cracks? Thanks, Conor. > > .../devicetree/bindings/hwmon/gpio-fan.txt | 41 -------- > .../devicetree/bindings/hwmon/gpio-fan.yaml | 96 +++++++++++++++++++ > 2 files changed, 96 insertions(+), 41 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.txt > create mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > > diff --git a/Documentation/devicetree/bindings/hwmon/gpio-fan.txt b/Documentation/devicetree/bindings/hwmon/gpio-fan.txt > deleted file mode 100644 > index f4cfa350f6a1..000000000000 > --- a/Documentation/devicetree/bindings/hwmon/gpio-fan.txt > +++ /dev/null > @@ -1,41 +0,0 @@ > -Bindings for fan connected to GPIO lines > - > -Required properties: > -- compatible : "gpio-fan" > - > -Optional properties: > -- gpios: Specifies the pins that map to bits in the control value, > - ordered MSB-->LSB. > -- gpio-fan,speed-map: A mapping of possible fan RPM speeds and the > - control value that should be set to achieve them. This array > - must have the RPM values in ascending order. > -- alarm-gpios: This pin going active indicates something is wrong with > - the fan, and a udev event will be fired. > -- #cooling-cells: If used as a cooling device, must be <2> > - Also see: > - Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml > - min and max states are derived from the speed-map of the fan. > - > -Note: At least one the "gpios" or "alarm-gpios" properties must be set. > - > -Examples: > - > - gpio_fan { > - compatible = "gpio-fan"; > - gpios = <&gpio1 14 1 > - &gpio1 13 1>; > - gpio-fan,speed-map = <0 0 > - 3000 1 > - 6000 2>; > - alarm-gpios = <&gpio1 15 1>; > - }; > - gpio_fan_cool: gpio_fan { > - compatible = "gpio-fan"; > - gpios = <&gpio2 14 1 > - &gpio2 13 1>; > - gpio-fan,speed-map = <0 0>, > - <3000 1>, > - <6000 2>; > - alarm-gpios = <&gpio2 15 1>; > - #cooling-cells = <2>; /* min followed by max */ > - }; > diff --git a/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml b/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > new file mode 100644 > index 000000000000..15bb5efd3cb4 > --- /dev/null > +++ b/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml > @@ -0,0 +1,96 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/hwmon/gpio-fan.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Bindings for fan connected to GPIO lines > + > +maintainers: > + - OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <devicetree@vger.kernel.org> > + > +properties: > + compatible: > + const: gpio-fan > + > + gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + description: Specifies the pins that map to bits in the control value, > + ordered MSB-->LSB. > + > + gpio-fan,speed-map: > + $ref: /schemas/types.yaml#/definitions/uint32-matrix > + description: A mapping of possible fan RPM speeds and the > + control value that should be set to achieve them. This array > + must have the RPM values in ascending order. > + > + alarm-gpios: > + $ref: /schemas/types.yaml#/definitions/phandle-array > + description: This pin going active indicates something is wrong with > + the fan, and a udev event will be fired. > + > + "#cooling-cells": > + const: 2 > + description: If used as a cooling device, must be <2> > + Also see Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml > + min and max states are derived from the speed-map of the fan. > + > +anyOf: > + - required: > + - gpios > + - required: > + - alarm-gpios > + > +additionalProperties: False > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + #include <dt-bindings/clock/cortina,gemini-clock.h> > + #include <dt-bindings/reset/cortina,gemini-reset.h> > + #include <dt-bindings/gpio/gpio.h> > + gpio1: gpio@4d000000 { > + compatible = "cortina,gemini-gpio", "faraday,ftgpio010"; > + reg = <0x4d000000 0x100>; > + interrupts = <22 IRQ_TYPE_LEVEL_HIGH>; > + resets = <&syscon GEMINI_RESET_GPIO0>; > + clocks = <&syscon GEMINI_CLK_APB>; > + gpio-controller; > + #gpio-cells = <2>; > + interrupt-controller; > + #interrupt-cells = <2>; > + }; > + gpio_fan { > + compatible = "gpio-fan"; > + gpios = <&gpio1 8 GPIO_ACTIVE_HIGH>; > + gpio-fan,speed-map = <0 0>, > + <3000 1>, > + <6000 2>; > + alarm-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>; > + }; > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + #include <dt-bindings/clock/cortina,gemini-clock.h> > + #include <dt-bindings/reset/cortina,gemini-reset.h> > + #include <dt-bindings/gpio/gpio.h> > + gpio2: gpio@4d000000 { > + compatible = "cortina,gemini-gpio", "faraday,ftgpio010"; > + reg = <0x4d000000 0x100>; > + interrupts = <22 IRQ_TYPE_LEVEL_HIGH>; > + resets = <&syscon GEMINI_RESET_GPIO0>; > + clocks = <&syscon GEMINI_CLK_APB>; > + gpio-controller; > + #gpio-cells = <2>; > + interrupt-controller; > + #interrupt-cells = <2>; > + }; > + gpio_fan_cool: gpio_fan { > + compatible = "gpio-fan"; > + gpios = <&gpio2 8 GPIO_ACTIVE_HIGH > + &gpio2 1 GPIO_ACTIVE_HIGH>; > + gpio-fan,speed-map = <0 0 > + 3000 1 > + 6000 2>; > + alarm-gpios = <&gpio2 15 GPIO_ACTIVE_HIGH>; > + #cooling-cells = <2>; /* min followed by max */ > + }; > -- > 2.34.1 > >
Le Sat, Dec 17, 2022 at 05:50:38PM +0000, Conor Dooley a écrit : > On Wed, Jan 26, 2022 at 08:03:50PM +0000, Corentin Labbe wrote: > > Converts hwmon/gpio-fan.txt to YAML > > > > Signed-off-by: Corentin Labbe <clabbe@baylibre.com> > > --- > > > > I didnt found any clear maintainer and since DT yaml mandates a > > maintainer section, I set devicetree@vger.kernel.org. > > Hey Corentin, > Looks like there were only some minor comments from Rob on this patch, > but I do not see a v2 on lore. Just never get around to sending a v2, or > did it fall through the cracks? > Thanks, > Conor. > I just forgot it. I will send v2 soon. Thanks for the reminder Regards
On 17/12/2022 21:00, Corentin LABBE wrote: > Le Sat, Dec 17, 2022 at 05:50:38PM +0000, Conor Dooley a écrit : >> On Wed, Jan 26, 2022 at 08:03:50PM +0000, Corentin Labbe wrote: >>> Converts hwmon/gpio-fan.txt to YAML >>> >>> Signed-off-by: Corentin Labbe <clabbe@baylibre.com> >>> --- >>> >>> I didnt found any clear maintainer and since DT yaml mandates a >>> maintainer section, I set devicetree@vger.kernel.org. >> >> Hey Corentin, >> Looks like there were only some minor comments from Rob on this patch, >> but I do not see a v2 on lore. Just never get around to sending a v2, or >> did it fall through the cracks? >> Thanks, >> Conor. >> > > I just forgot it. > > I will send v2 soon. I didn't expect soon to mean 4 minutes later! Thanks!
diff --git a/Documentation/devicetree/bindings/hwmon/gpio-fan.txt b/Documentation/devicetree/bindings/hwmon/gpio-fan.txt deleted file mode 100644 index f4cfa350f6a1..000000000000 --- a/Documentation/devicetree/bindings/hwmon/gpio-fan.txt +++ /dev/null @@ -1,41 +0,0 @@ -Bindings for fan connected to GPIO lines - -Required properties: -- compatible : "gpio-fan" - -Optional properties: -- gpios: Specifies the pins that map to bits in the control value, - ordered MSB-->LSB. -- gpio-fan,speed-map: A mapping of possible fan RPM speeds and the - control value that should be set to achieve them. This array - must have the RPM values in ascending order. -- alarm-gpios: This pin going active indicates something is wrong with - the fan, and a udev event will be fired. -- #cooling-cells: If used as a cooling device, must be <2> - Also see: - Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml - min and max states are derived from the speed-map of the fan. - -Note: At least one the "gpios" or "alarm-gpios" properties must be set. - -Examples: - - gpio_fan { - compatible = "gpio-fan"; - gpios = <&gpio1 14 1 - &gpio1 13 1>; - gpio-fan,speed-map = <0 0 - 3000 1 - 6000 2>; - alarm-gpios = <&gpio1 15 1>; - }; - gpio_fan_cool: gpio_fan { - compatible = "gpio-fan"; - gpios = <&gpio2 14 1 - &gpio2 13 1>; - gpio-fan,speed-map = <0 0>, - <3000 1>, - <6000 2>; - alarm-gpios = <&gpio2 15 1>; - #cooling-cells = <2>; /* min followed by max */ - }; diff --git a/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml b/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml new file mode 100644 index 000000000000..15bb5efd3cb4 --- /dev/null +++ b/Documentation/devicetree/bindings/hwmon/gpio-fan.yaml @@ -0,0 +1,96 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/hwmon/gpio-fan.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Bindings for fan connected to GPIO lines + +maintainers: + - OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS <devicetree@vger.kernel.org> + +properties: + compatible: + const: gpio-fan + + gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + description: Specifies the pins that map to bits in the control value, + ordered MSB-->LSB. + + gpio-fan,speed-map: + $ref: /schemas/types.yaml#/definitions/uint32-matrix + description: A mapping of possible fan RPM speeds and the + control value that should be set to achieve them. This array + must have the RPM values in ascending order. + + alarm-gpios: + $ref: /schemas/types.yaml#/definitions/phandle-array + description: This pin going active indicates something is wrong with + the fan, and a udev event will be fired. + + "#cooling-cells": + const: 2 + description: If used as a cooling device, must be <2> + Also see Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml + min and max states are derived from the speed-map of the fan. + +anyOf: + - required: + - gpios + - required: + - alarm-gpios + +additionalProperties: False + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + #include <dt-bindings/clock/cortina,gemini-clock.h> + #include <dt-bindings/reset/cortina,gemini-reset.h> + #include <dt-bindings/gpio/gpio.h> + gpio1: gpio@4d000000 { + compatible = "cortina,gemini-gpio", "faraday,ftgpio010"; + reg = <0x4d000000 0x100>; + interrupts = <22 IRQ_TYPE_LEVEL_HIGH>; + resets = <&syscon GEMINI_RESET_GPIO0>; + clocks = <&syscon GEMINI_CLK_APB>; + gpio-controller; + #gpio-cells = <2>; + interrupt-controller; + #interrupt-cells = <2>; + }; + gpio_fan { + compatible = "gpio-fan"; + gpios = <&gpio1 8 GPIO_ACTIVE_HIGH>; + gpio-fan,speed-map = <0 0>, + <3000 1>, + <6000 2>; + alarm-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>; + }; + - | + #include <dt-bindings/interrupt-controller/irq.h> + #include <dt-bindings/clock/cortina,gemini-clock.h> + #include <dt-bindings/reset/cortina,gemini-reset.h> + #include <dt-bindings/gpio/gpio.h> + gpio2: gpio@4d000000 { + compatible = "cortina,gemini-gpio", "faraday,ftgpio010"; + reg = <0x4d000000 0x100>; + interrupts = <22 IRQ_TYPE_LEVEL_HIGH>; + resets = <&syscon GEMINI_RESET_GPIO0>; + clocks = <&syscon GEMINI_CLK_APB>; + gpio-controller; + #gpio-cells = <2>; + interrupt-controller; + #interrupt-cells = <2>; + }; + gpio_fan_cool: gpio_fan { + compatible = "gpio-fan"; + gpios = <&gpio2 8 GPIO_ACTIVE_HIGH + &gpio2 1 GPIO_ACTIVE_HIGH>; + gpio-fan,speed-map = <0 0 + 3000 1 + 6000 2>; + alarm-gpios = <&gpio2 15 GPIO_ACTIVE_HIGH>; + #cooling-cells = <2>; /* min followed by max */ + };
Converts hwmon/gpio-fan.txt to YAML Signed-off-by: Corentin Labbe <clabbe@baylibre.com> --- I didnt found any clear maintainer and since DT yaml mandates a maintainer section, I set devicetree@vger.kernel.org. .../devicetree/bindings/hwmon/gpio-fan.txt | 41 -------- .../devicetree/bindings/hwmon/gpio-fan.yaml | 96 +++++++++++++++++++ 2 files changed, 96 insertions(+), 41 deletions(-) delete mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.txt create mode 100644 Documentation/devicetree/bindings/hwmon/gpio-fan.yaml