lkml.org 
[lkml]   [2020]   [Feb]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[PATCH v3 2/5] dt-bindings: soc: document LiteX SoC Controller bindings
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
+
+ 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>
--
2.25.0
\
 
 \ /
  Last update: 2020-02-25 09:47    [W:0.136 / U:0.268 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site