diff mbox series

[1/5] db-dinding: crypto: Add DT bindings documentation for sl3516-ce

Message ID 20210518151655.125153-2-clabbe@baylibre.com
State Superseded
Headers show
Series crypto: add gemini/sl3516 crypto driver | expand

Commit Message

Corentin Labbe May 18, 2021, 3:16 p.m. UTC
This patch adds documentation for Device-Tree bindings for the
SL3516-ce cryptographic offloader driver.
Signed-off-by: Corentin Labbe <clabbe@baylibre.com>
---
 .../crypto/cortina,sl3516-crypto.yaml         | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/crypto/cortina,sl3516-crypto.yaml

Comments

Rob Herring (Arm) May 20, 2021, 12:04 a.m. UTC | #1
On Tue, May 18, 2021 at 11:38:38PM +0200, Linus Walleij wrote:
> On Tue, May 18, 2021 at 5:17 PM Corentin Labbe <clabbe@baylibre.com> wrote:
> 
> > This patch adds documentation for Device-Tree bindings for the
> > SL3516-ce cryptographic offloader driver.
> > Signed-off-by: Corentin Labbe <clabbe@baylibre.com>
> 
> Apart from misspelled subject "db-binding" I don't see any problems
> so

And try not to say 'dt binding' twice in the subject and 'documentation' 
is redundant as that's all bindings.

> Reviewed-by: Linus Walleij <linus.walleij@linaro.org>

Reviewed-by: Rob Herring <robh@kernel.org>

> 
> Yours,
> Linus Walleij
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/crypto/cortina,sl3516-crypto.yaml b/Documentation/devicetree/bindings/crypto/cortina,sl3516-crypto.yaml
new file mode 100644
index 000000000000..8330b16a07e8
--- /dev/null
+++ b/Documentation/devicetree/bindings/crypto/cortina,sl3516-crypto.yaml
@@ -0,0 +1,50 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/crypto/cortina,sl3516-crypto.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: SL3516 cryptographic offloader driver
+
+maintainers:
+  - Corentin Labbe <clabbe@baylibre.com>
+
+properties:
+  compatible:
+    enum:
+      - cortina,sl3516-crypto
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - resets
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/clock/cortina,gemini-clock.h>
+    #include <dt-bindings/reset/cortina,gemini-reset.h>
+
+    crypto@62000000 {
+        compatible = "cortina,sl3516-crypto";
+        reg = <0x62000000 0x10000>;
+        interrupts = <7 IRQ_TYPE_EDGE_RISING>;
+        resets = <&syscon GEMINI_RESET_SECURITY>;
+        clocks = <&syscon GEMINI_CLK_GATE_SECURITY>;
+    };