| Message ID | 20230403004138.326482-1-hack3r-0m@proton.me (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | dt-bindings: watchdog: alphascale-asm9260: convert to DT schema | expand |
On 03/04/2023 02:42, Om Parikh wrote: > this patch replaces the txt file and adds YAML bindings file Do not use "This commit/patch", but imperative mood. See: https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95 Use full sentences, so start with capital letter. > adhering to the json-schema for alphascale-asm9260. It is a > demo patch for potential further contributions to the GSOC > project. Drop unrelated messages. > > (see: https://wiki.linuxfoundation.org/gsoc/2023-gsoc-device-tree-bindings) Drop, not related to Linux kernel. Anyway, send your patches first through you mentor, so we won't have to comment on trivial things. Daniel, Are you doing a review of your mentees? > > Signed-off-by: Om Parikh <hack3r-0m@proton.me> > --- > .../watchdog/alphascale,asm9260-wdt.yaml | 76 +++++++++++++++++++ > .../bindings/watchdog/alphascale-asm9260.txt | 35 --------- > 2 files changed, 76 insertions(+), 35 deletions(-) > create mode 100644 Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > delete mode 100644 Documentation/devicetree/bindings/watchdog/alphascale-asm9260.txt > > diff --git a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > new file mode 100644 > index 000000000000..1f7baaf6b0f3 > --- /dev/null > +++ b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > @@ -0,0 +1,76 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/watchdog/alphascale,asm9260-wdt.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Alphascale asm9260 Watchdog timer > + > +allOf: > + - $ref: "watchdog.yaml#" Drop quotes. > + > +maintainers: > + - Oleksij Rempel <linux@rempel-privat.de> > + - Olof Johansson <olof@lixom.net> > + > +properties: > + compatible: > + enum: > + - alphascale,asm9260 > + - alphascale,asm9260devkit NAK, this does not make any sense. I don't understand what do you want to document here. These are boards. Best regards, Krzysztof
On Mon, 03 Apr 2023 00:42:35 +0000, Om Parikh wrote: > this patch replaces the txt file and adds YAML bindings file > adhering to the json-schema for alphascale-asm9260. It is a > demo patch for potential further contributions to the GSOC > project. > > (see: https://wiki.linuxfoundation.org/gsoc/2023-gsoc-device-tree-bindings) > > Signed-off-by: Om Parikh <hack3r-0m@proton.me> > --- > .../watchdog/alphascale,asm9260-wdt.yaml | 76 +++++++++++++++++++ > .../bindings/watchdog/alphascale-asm9260.txt | 35 --------- > 2 files changed, 76 insertions(+), 35 deletions(-) > create mode 100644 Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml > delete mode 100644 Documentation/devicetree/bindings/watchdog/alphascale-asm9260.txt > 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/watchdog/alphascale,asm9260-wdt.example.dtb: /example-0/watchdog@80048000: failed to match any schema with compatible: ['alphascale,asm9260-wdt'] doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230403004138.326482-1-hack3r-0m@proton.me The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch. 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 after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.
diff --git a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml new file mode 100644 index 000000000000..1f7baaf6b0f3 --- /dev/null +++ b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml @@ -0,0 +1,76 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/watchdog/alphascale,asm9260-wdt.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Alphascale asm9260 Watchdog timer + +allOf: + - $ref: "watchdog.yaml#" + +maintainers: + - Oleksij Rempel <linux@rempel-privat.de> + - Olof Johansson <olof@lixom.net> + +properties: + compatible: + enum: + - alphascale,asm9260 + - alphascale,asm9260devkit + + reg: + maxItems: 1 + + clocks: + items: + - description: source clock, used for tick counter + - description: ahb gate + + clock-names: + items: + - const: mod + - const: ahb + + interrupts: + maxItems: 1 + + resets: + items: + - description: phandle pointing to the system reset controller with line + index for the watchdog. + + reset-names: + items: + - const: wdt_rst + + timeout-sec: true + + alphascale,mode: + description: to specify the reset mode of operation + $ref: /schemas/types.yaml#/definitions/string + enum: [hw, sw, debug] + +required: + - compatible + - reg + - clocks + - clock-names + - interrupts + - resets + - reset-names + +unevaluatedProperties: false + +examples: + - | + #include <dt-bindings/clock/alphascale,asm9260.h> + watchdog0: watchdog@80048000 { + compatible = "alphascale,asm9260-wdt"; + reg = <0x80048000 0x10>; + clocks = <&acc CLKID_SYS_WDT>, <&acc CLKID_AHB_WDT>; + clock-names = "mod", "ahb"; + interrupts = <55>; + timeout-sec = <30>; + alphascale,mode = "hw"; + }; diff --git a/Documentation/devicetree/bindings/watchdog/alphascale-asm9260.txt b/Documentation/devicetree/bindings/watchdog/alphascale-asm9260.txt deleted file mode 100644 index 75b265a04047..000000000000 --- a/Documentation/devicetree/bindings/watchdog/alphascale-asm9260.txt +++ /dev/null @@ -1,35 +0,0 @@ -Alphascale asm9260 Watchdog timer - -Required properties: - -- compatible : should be "alphascale,asm9260-wdt". -- reg : Specifies base physical address and size of the registers. -- clocks : the clocks feeding the watchdog timer. See clock-bindings.txt -- clock-names : should be set to - "mod" - source for tick counter. - "ahb" - ahb gate. -- resets : phandle pointing to the system reset controller with - line index for the watchdog. -- reset-names : should be set to "wdt_rst". - -Optional properties: -- timeout-sec : shall contain the default watchdog timeout in seconds, - if unset, the default timeout is 30 seconds. -- alphascale,mode : three modes are supported - "hw" - hw reset (default). - "sw" - sw reset. - "debug" - no action is taken. - -Example: - -watchdog0: watchdog@80048000 { - compatible = "alphascale,asm9260-wdt"; - reg = <0x80048000 0x10>; - clocks = <&acc CLKID_SYS_WDT>, <&acc CLKID_AHB_WDT>; - clock-names = "mod", "ahb"; - interrupts = <55>; - resets = <&rst WDT_RESET>; - reset-names = "wdt_rst"; - timeout-sec = <30>; - alphascale,mode = "hw"; -};
this patch replaces the txt file and adds YAML bindings file adhering to the json-schema for alphascale-asm9260. It is a demo patch for potential further contributions to the GSOC project. (see: https://wiki.linuxfoundation.org/gsoc/2023-gsoc-device-tree-bindings) Signed-off-by: Om Parikh <hack3r-0m@proton.me> --- .../watchdog/alphascale,asm9260-wdt.yaml | 76 +++++++++++++++++++ .../bindings/watchdog/alphascale-asm9260.txt | 35 --------- 2 files changed, 76 insertions(+), 35 deletions(-) create mode 100644 Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml delete mode 100644 Documentation/devicetree/bindings/watchdog/alphascale-asm9260.txt