| Message ID | 20200225094437.4170502-2-mholenko@antmicro.com |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | LiteX SoC controller and LiteUART serial driver | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | success | |
| robh/dt-meta-schema | fail | build log |
Hi Mateusz, On Tue, Feb 25, 2020 at 09:46:45AM +0100, Mateusz Holenko wrote: > From: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > > Add documentation for LiteX SoC Controller bindings. > > Signed-off-by: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > Signed-off-by: Mateusz Holenko <mholenko@antmicro.com> > --- > > Notes: > This commit has been introduced in v3 of the patchset. > > .../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ > MAINTAINERS | 6 +++ > 2 files changed, 52 insertions(+) > create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > > diff --git a/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > new file mode 100644 > index 000000000000..039894265319 > --- /dev/null > +++ b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > @@ -0,0 +1,46 @@ > +PDX-License-Identifier: GPL-2.0 > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/soc/litex/litex,soc_controller.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: LiteX SoC Controller driver > + > +description: | > + This is the SoC Controller driver for the LiteX SoC Builder. > + It's purpose is to verify LiteX CSR (Control&Status Register) access > + operations and provide function for other drivers to read/write CSRs > + and to check if those accessors are ready to use. > + > +maintainers: > + - Karol Gugala <kgugala@antmicro.com> > + - Mateusz Holenko <mholenko@antmicro.com> > + > +properties: > + compatible: > + const: litex,soc_controller Usually compatible will use dash as separators, not underscores. > + reg: > + description: Base address and length of the register space This is usually removed since it's what's expected from the property anyway. However, what you should really test for in the number of address/size couples being set, and you can do that using maxItems: 1 > + status: > + description: | > + disables or enables node > + > + const: "okay" This is added automatically by the tooling, so you can leave it out. > +required: > + - compatible > + - reg > + - status And in general, status is not required. Leaving status out is equivalent to status = "okay" > +examples: > + - | > + > + soc_ctrl0: soc_controller@f0000000 { > + compatible = "litex,soc_controller"; > + reg = <0x0 0xf0000000 0x0 0xC>; > + status = "okay"; > + }; The indentation looks weird here? Maxime
On Tue, 25 Feb 2020 09:46:45 +0100, Mateusz Holenko wrote: > From: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > > Add documentation for LiteX SoC Controller bindings. > > Signed-off-by: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > Signed-off-by: Mateusz Holenko <mholenko@antmicro.com> > --- > > Notes: > This commit has been introduced in v3 of the patchset. > > .../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ > MAINTAINERS | 6 +++ > 2 files changed, 52 insertions(+) > create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > My bot found errors running 'make dt_binding_check' on your patch: warning: no schema found in file: Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml: ignoring, error parsing file Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node Traceback (most recent call last): File "/usr/local/bin/dt-doc-validate", line 35, in check_doc testtree = dtschema.load(filename, line_number=line_number, duplicate_keys=False) File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 513, in load return yaml.load(f.read()) File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/main.py", line 343, in load return constructor.get_single_data() File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py", line 111, in get_single_data node = self.composer.get_single_node() File "_ruamel_yaml.pyx", line 718, in _ruamel_yaml.CParser.get_single_node ruamel.yaml.composer.ComposerError: expected a single document in the stream in "<unicode string>", line 1, column 1 but found another document in "<unicode string>", line 2, column 1 During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/usr/local/bin/dt-doc-validate", line 74, in <module> ret = check_doc(args.yamldt) File "/usr/local/bin/dt-doc-validate", line 40, in check_doc print(filename + ":", exc.path[-1], exc.message) AttributeError: 'ComposerError' object has no attribute 'path' Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts' failed make[1]: *** [Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts] Error 1 Makefile:1263: recipe for target 'dt_binding_check' failed make: *** [dt_binding_check] Error 2 See https://patchwork.ozlabs.org/patch/1243930 Please check and re-submit.
Hi Maxime, On Tue, Feb 25, 2020 at 10:11 AM Maxime Ripard <maxime@cerno.tech> wrote: > > Hi Mateusz, > > On Tue, Feb 25, 2020 at 09:46:45AM +0100, Mateusz Holenko wrote: > > From: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > > > > Add documentation for LiteX SoC Controller bindings. > > > > Signed-off-by: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > > Signed-off-by: Mateusz Holenko <mholenko@antmicro.com> > > --- > > > > Notes: > > This commit has been introduced in v3 of the patchset. > > > > .../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ > > MAINTAINERS | 6 +++ > > 2 files changed, 52 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > > > > diff --git a/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > > new file mode 100644 > > index 000000000000..039894265319 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > > @@ -0,0 +1,46 @@ > > +PDX-License-Identifier: GPL-2.0 > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/soc/litex/litex,soc_controller.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: LiteX SoC Controller driver > > + > > +description: | > > + This is the SoC Controller driver for the LiteX SoC Builder. > > + It's purpose is to verify LiteX CSR (Control&Status Register) access > > + operations and provide function for other drivers to read/write CSRs > > + and to check if those accessors are ready to use. > > + > > +maintainers: > > + - Karol Gugala <kgugala@antmicro.com> > > + - Mateusz Holenko <mholenko@antmicro.com> > > + > > +properties: > > + compatible: > > + const: litex,soc_controller > > Usually compatible will use dash as separators, not underscores. > > > + reg: > > + description: Base address and length of the register space > > This is usually removed since it's what's expected from the property > anyway. However, what you should really test for in the number of > address/size couples being set, and you can do that using maxItems: 1 > > > + status: > > + description: | > > + disables or enables node > > + > > + const: "okay" > > This is added automatically by the tooling, so you can leave it out. > > > +required: > > + - compatible > > + - reg > > + - status > > And in general, status is not required. Leaving status out is > equivalent to status = "okay" > > > +examples: > > + - | > > + > > + soc_ctrl0: soc_controller@f0000000 { > > + compatible = "litex,soc_controller"; > > + reg = <0x0 0xf0000000 0x0 0xC>; > > + status = "okay"; > > + }; > > The indentation looks weird here? > > Maxime Thanks for all the comments! I'll fix this file and resubmit the whole patchset after addressing other remarks. -- Mateusz Holenko Antmicro Ltd | www.antmicro.com Roosevelta 22, 60-829 Poznan, Poland
On Tue, Feb 25, 2020 at 5:57 PM Rob Herring <robh@kernel.org> wrote: > > On Tue, 25 Feb 2020 09:46:45 +0100, Mateusz Holenko wrote: > > From: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > > > > Add documentation for LiteX SoC Controller bindings. > > > > Signed-off-by: Pawel Czarnecki <pczarnecki@internships.antmicro.com> > > Signed-off-by: Mateusz Holenko <mholenko@antmicro.com> > > --- > > > > Notes: > > This commit has been introduced in v3 of the patchset. > > > > .../soc/litex/litex,soc_controller.yaml | 46 +++++++++++++++++++ > > MAINTAINERS | 6 +++ > > 2 files changed, 52 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > > > > My bot found errors running 'make dt_binding_check' on your patch: > > warning: no schema found in file: Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml > /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml: ignoring, error parsing file > Documentation/devicetree/bindings/display/simple-framebuffer.example.dts:21.16-37.11: Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node > Traceback (most recent call last): > File "/usr/local/bin/dt-doc-validate", line 35, in check_doc > testtree = dtschema.load(filename, line_number=line_number, duplicate_keys=False) > File "/usr/local/lib/python3.6/dist-packages/dtschema/lib.py", line 513, in load > return yaml.load(f.read()) > File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/main.py", line 343, in load > return constructor.get_single_data() > File "/usr/local/lib/python3.6/dist-packages/ruamel/yaml/constructor.py", line 111, in get_single_data > node = self.composer.get_single_node() > File "_ruamel_yaml.pyx", line 718, in _ruamel_yaml.CParser.get_single_node > ruamel.yaml.composer.ComposerError: expected a single document in the stream > in "<unicode string>", line 1, column 1 > but found another document > in "<unicode string>", line 2, column 1 > > During handling of the above exception, another exception occurred: > > Traceback (most recent call last): > File "/usr/local/bin/dt-doc-validate", line 74, in <module> > ret = check_doc(args.yamldt) > File "/usr/local/bin/dt-doc-validate", line 40, in check_doc > print(filename + ":", exc.path[-1], exc.message) > AttributeError: 'ComposerError' object has no attribute 'path' > Documentation/devicetree/bindings/Makefile:12: recipe for target 'Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts' failed > make[1]: *** [Documentation/devicetree/bindings/soc/litex/litex,soc_controller.example.dts] Error 1 > Makefile:1263: recipe for target 'dt_binding_check' failed > make: *** [dt_binding_check] Error 2 > > See https://patchwork.ozlabs.org/patch/1243930 > Please check and re-submit. Thanks for spotting this. It looks like the first line of the document is broken - it should be a comment with a license descriptor, but the initial characters are missing. I'll fix this and resubmit the whole patchset after addressing all other remarks.
diff --git a/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml new file mode 100644 index 000000000000..039894265319 --- /dev/null +++ b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml @@ -0,0 +1,46 @@ +PDX-License-Identifier: GPL-2.0 +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/soc/litex/litex,soc_controller.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: LiteX SoC Controller driver + +description: | + This is the SoC Controller driver for the LiteX SoC Builder. + It's purpose is to verify LiteX CSR (Control&Status Register) access + operations and provide function for other drivers to read/write CSRs + and to check if those accessors are ready to use. + +maintainers: + - Karol Gugala <kgugala@antmicro.com> + - Mateusz Holenko <mholenko@antmicro.com> + +properties: + compatible: + const: litex,soc_controller + + reg: + description: Base address and length of the register space + + status: + description: | + disables or enables node + + const: "okay" + +required: + - compatible + - reg + - status + +examples: + - | + + soc_ctrl0: soc_controller@f0000000 { + compatible = "litex,soc_controller"; + reg = <0x0 0xf0000000 0x0 0xC>; + status = "okay"; + }; + +... diff --git a/MAINTAINERS b/MAINTAINERS index 4beb8dc4c7eb..ec925c081dd2 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -9725,6 +9725,12 @@ L: kunit-dev@googlegroups.com S: Maintained F: lib/list-test.c +LITEX PLATFORM +M: Karol Gugala <kgugala@antmicro.com> +M: Mateusz Holenko <mholenko@antmicro.com> +S: Maintained +F: Documentation/devicetree/bindings/*/litex,*.yaml + LIVE PATCHING M: Josh Poimboeuf <jpoimboe@redhat.com> M: Jiri Kosina <jikos@kernel.org>