Hi Maxime, On Tue, Feb 25, 2020 at 10:11 AM Maxime Ripard <maxime@xxxxxxxxxx> wrote: > > Hi Mateusz, > > On Tue, Feb 25, 2020 at 09:46:45AM +0100, Mateusz Holenko wrote: > > From: Pawel Czarnecki <pczarnecki@xxxxxxxxxxxxxxxxxxxxxxxx> > > > > Add documentation for LiteX SoC Controller bindings. > > > > Signed-off-by: Pawel Czarnecki <pczarnecki@xxxxxxxxxxxxxxxxxxxxxxxx> > > Signed-off-by: Mateusz Holenko <mholenko@xxxxxxxxxxxx> > > --- > > > > 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@xxxxxxxxxxxx> > > + - Mateusz Holenko <mholenko@xxxxxxxxxxxx> > > + > > +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
