MLK-15473-2: fsl-sec4.txt: Update CAAM device-tree documentation
authorAymen Sghaier <aymen.sghaier@nxp.com>
Fri, 10 Nov 2017 08:55:39 +0000 (09:55 +0100)
committerNitin Garg <nitin.garg@nxp.com>
Mon, 19 Mar 2018 20:46:52 +0000 (15:46 -0500)
 Add a new property in device tree specific to i.MX8 only: first-jr-index.

Signed-off-by: Aymen Sghaier <aymen.sghaier@nxp.com>
Documentation/devicetree/bindings/crypto/fsl-sec4.txt

index f6e6fba..2a3aee9 100644 (file)
@@ -1,6 +1,7 @@
 =====================================================================
 SEC 4 Device Tree Binding
 Copyright (C) 2008-2011 Freescale Semiconductor Inc.
+Copyright 2017 NXP
 
  CONTENTS
    -Overview
@@ -10,6 +11,7 @@ Copyright (C) 2008-2011 Freescale Semiconductor Inc.
    -Run Time Integrity Check (RTIC) Memory Node
    -Secure Non-Volatile Storage (SNVS) Node
    -Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node
+   -CAAM Secure Memory Storage Interface
    -Full Example
 
 NOTE: the SEC 4 is also known as Freescale's Cryptographic Accelerator
@@ -118,6 +120,12 @@ PROPERTIES
       Definition: A list of clock name strings in the same order as the
           clocks property.
 
+   - first-jr-index
+      Usage: required only for i.MX8QM and i.MX8QXP
+      Value type: <u32>
+      Definition: Specifies the first job ring index assigned to kernel
+          to read aliased register since CAAM page 0 is not accessible.
+
    Note: All other standard properties (see the ePAPR) are allowed
    but are optional.
 
@@ -453,6 +461,27 @@ EXAMPLE:
                wakeup-source;
        };
 
+=====================================================================
+CAAM Secure Memory Storage Interface
+
+  A CAAM-SM child node that defines Secure Memory.
+
+  - compatible
+    Usage: required
+    Value type: <string>
+    Definition: Must include "fsl,imx6q-caam-sm".
+
+  - regmap
+    Usage: required
+    Value type: <phandle>
+    Definition: this is phandle to the register map node.
+
+EXAMPLE
+  caam_sm: caam-sm@31800000 {
+    compatible = "fsl,imx6q-caam-sm";
+    reg = <0 0x31800000 0 0x1ffff>;
+  };
+
 =====================================================================
 FULL EXAMPLE
 
@@ -543,4 +572,9 @@ FULL EXAMPLE
                };
        };
 
+  caam_sm: caam-sm@31800000 {
+    compatible = "fsl,imx6q-caam-sm";
+    reg = <0 0x31800000 0 0x1ffff>;
+  };
+
 =====================================================================