[PATCH v9 2/5] dt-bindings: soc: document LiteX SoC Controller bindings
From: Mateusz Holenko <mholenko@antmicro.com>
Date: 2020-07-22 10:28:02
Also in:
linux-devicetree, lkml
Subsystem:
litex platform, open firmware and flattened device tree bindings, the rest · Maintainers:
Karol Gugala, Mateusz Holenko, Gabriel Somlo, Joel Stanley, Rob Herring, Krzysztof Kozlowski, Conor Dooley, Linus Torvalds
From: Pawel Czarnecki <redacted>
Add documentation for LiteX SoC Controller bindings.
Signed-off-by: Pawel Czarnecki <redacted>
Signed-off-by: Mateusz Holenko <mholenko@antmicro.com>
Reviewed-by: Rob Herring <robh@kernel.org>
---
Notes:
Changes in v9:
- fixed the `reg` node notation in the DT example
No changes in v8.
No changes in v7.
Changes in v6:
- fixed license header
Changes in v5:
- added reviewed-by tag
Changes in v4:
- changes compatible to "litex,soc-controller"
- fixed yaml's header
- removed unnecessary sections from yaml
- fixed indentation in yaml
This commit has been introduced in v3 of the patchset.
.../soc/litex/litex,soc-controller.yaml | 39 +++++++++++++++++++
MAINTAINERS | 6 +++
2 files changed, 45 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..53121c1fbe4d
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/litex/litex,soc-controller.yaml@@ -0,0 +1,39 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +# Copyright 2020 Antmicro <www.antmicro.com> +%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: + maxItems: 1 + +required: + - compatible + - reg + +examples: + - | + soc_ctrl0: soc-controller@f0000000 { + compatible = "litex,soc-controller"; + reg = <0xf0000000 0xC>; + status = "okay"; + }; + +...
diff --git a/MAINTAINERS b/MAINTAINERS
index 7b58ca29cc80..39be98db7418 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS@@ -9835,6 +9835,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>
--
2.25.1