dt-bindings: soc: document LiteX SoC Controller bindings
authorPawel Czarnecki <pczarnecki@internships.antmicro.com>
Tue, 13 Oct 2020 14:45:40 +0000 (16:45 +0200)
committerStafford Horne <shorne@gmail.com>
Mon, 9 Nov 2020 12:07:00 +0000 (21:07 +0900)
Add documentation for LiteX SoC Controller bindings.

Signed-off-by: Pawel Czarnecki <pczarnecki@internships.antmicro.com>
Signed-off-by: Mateusz Holenko <mholenko@antmicro.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Stafford Horne <shorne@gmail.com>
Documentation/devicetree/bindings/soc/litex/litex,soc-controller.yaml [new file with mode: 0644]
MAINTAINERS

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 (file)
index 0000000..e2b7887
--- /dev/null
@@ -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.
+  Its purpose is to verify LiteX CSR (Control&Status Register) access
+  operations and provide functions for other drivers to read/write CSRs
+  and to check if those accessors are ready to be used.
+
+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";
+    };
+
+...
index b516bb34a8d5a95f2be58fa2832c789a56fca450..049af639fdfc01b6e79c4ffcff7ef7376b7168f5 100644 (file)
@@ -10172,6 +10172,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>