RE: [EXT] [PATCH] dt-bindings: crypto: fsl,sec-v4.0: Convert to DT schema

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Reviewed-by: Gaurav Jain <gaurav.jain@xxxxxxx>

> -----Original Message-----
> From: Rob Herring <robh@xxxxxxxxxx>
> Sent: Tuesday, February 21, 2023 3:04 AM
> To: Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>; David S. Miller
> <davem@xxxxxxxxxxxxx>; Krzysztof Kozlowski
> <krzysztof.kozlowski+dt@xxxxxxxxxx>; Horia Geanta <horia.geanta@xxxxxxx>;
> Pankaj Gupta <pankaj.gupta@xxxxxxx>; Gaurav Jain <gaurav.jain@xxxxxxx>
> Cc: linux-crypto@xxxxxxxxxxxxxxx; devicetree@xxxxxxxxxxxxxxx; linux-
> kernel@xxxxxxxxxxxxxxx
> Subject: [EXT] [PATCH] dt-bindings: crypto: fsl,sec-v4.0: Convert to DT schema
> 
> Caution: EXT Email
> 
> Convert Freescale CAAM/SEC4 binding to DT schema format. The 'fsl,sec-v4.0'
> and 'fsl,sec-v4.0-mon' parts are independent, so split them into separate schema
> files.
> 
> Add a bunch of missing compatibles for v5.0, v5.4, etc. Drop unused 'ranges',
> '#address-cells', and '#size-cells' from fsl,sec-v4.0-mon nodes.
> 
> There's one DTB warning for LS1012a which has a 2nd 'reg' entry for 'fsl,sec-
> v4.0-rtic'. Leaving that as there is no clue as to what it is for.
> 
> Signed-off-by: Rob Herring <robh@xxxxxxxxxx>
> ---
>  .../bindings/crypto/fsl,sec-v4.0-mon.yaml     | 150 +++++
>  .../bindings/crypto/fsl,sec-v4.0.yaml         | 266 +++++++++
>  .../devicetree/bindings/crypto/fsl-sec4.txt   | 553 ------------------
>  3 files changed, 416 insertions(+), 553 deletions(-)  create mode 100644
> Documentation/devicetree/bindings/crypto/fsl,sec-v4.0-mon.yaml
>  create mode 100644 Documentation/devicetree/bindings/crypto/fsl,sec-
> v4.0.yaml
>  delete mode 100644 Documentation/devicetree/bindings/crypto/fsl-sec4.txt
> 
> diff --git a/Documentation/devicetree/bindings/crypto/fsl,sec-v4.0-mon.yaml
> b/Documentation/devicetree/bindings/crypto/fsl,sec-v4.0-mon.yaml
> new file mode 100644
> index 000000000000..353d9140dcea
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/fsl,sec-v4.0-mon.yaml
> @@ -0,0 +1,150 @@
> +# SPDX-License-Identifier: GPL-2.0
> +# Copyright (C) 2008-2011 Freescale Semiconductor Inc.
> +%YAML 1.2
> +---
> +$id:
> +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevice
> +tree.org%2Fschemas%2Fcrypto%2Ffsl%2Csec-v4.0-
> mon.yaml%23&data=05%7C01%7
> +Cgaurav.jain%40nxp.com%7C2c3978ea487741ba95a108db138a2f5b%7C686ea
> 1d3bc2
> +b4c6fa92cd99c5c301635%7C0%7C0%7C638125256474297643%7CUnknown%
> 7CTWFpbGZs
> +b3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0
> %3D%
> +7C3000%7C%7C%7C&sdata=O3ZvUXTeDSZkwyi%2Fpy%2FcPKT7ScpE3yOKmZKl
> LKMto%2Fo
> +%3D&reserved=0
> +$schema:
> +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevice
> +tree.org%2Fmeta-
> schemas%2Fcore.yaml%23&data=05%7C01%7Cgaurav.jain%40nxp
> +.com%7C2c3978ea487741ba95a108db138a2f5b%7C686ea1d3bc2b4c6fa92cd9
> 9c5c301
> +635%7C0%7C0%7C638125256474297643%7CUnknown%7CTWFpbGZsb3d8eyJ
> WIjoiMC4wLj
> +AwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7
> C%7C&sd
> +ata=zKV%2FzBKG43TPLsJnF7sjIfCyg4t1D6i1nngwWuDZPS8%3D&reserved=0
> +
> +title: Freescale Secure Non-Volatile Storage (SNVS)
> +
> +maintainers:
> +  - '"Horia Geantă" <horia.geanta@xxxxxxx>'
> +  - Pankaj Gupta <pankaj.gupta@xxxxxxx>
> +  - Gaurav Jain <gaurav.jain@xxxxxxx>
> +
> +description:
> +  Node defines address range and the associated interrupt for the SNVS
> function.
> +  This function monitors security state information & reports security
> +  violations. This also included rtc, system power off and ON/OFF key.
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - const: fsl,sec-v4.0-mon
> +          - const: syscon
> +          - const: simple-mfd
> +      - items:
> +          - const: fsl,sec-v5.0-mon
> +          - const: fsl,sec-v4.0-mon
> +      - items:
> +          - enum:
> +              - fsl,sec-v5.3-mon
> +              - fsl,sec-v5.4-mon
> +          - const: fsl,sec-v5.0-mon
> +          - const: fsl,sec-v4.0-mon
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 2
> +
> +  snvs-rtc-lp:
> +    type: object
> +    additionalProperties: false
> +    description:
> +      Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node
> +
> +    properties:
> +      compatible:
> +        const: fsl,sec-v4.0-mon-rtc-lp
> +
> +      clocks:
> +        maxItems: 1
> +
> +      clock-names:
> +        const: snvs-rtc
> +
> +      interrupts:
> +        # VFxxx has only one. What is the 2nd one?
> +        minItems: 1
> +        maxItems: 2
> +
> +      regmap:
> +        description: Parent node containing registers
> +        $ref: /schemas/types.yaml#/definitions/phandle
> +
> +      offset:
> +        description: LP register offset
> +        $ref: /schemas/types.yaml#/definitions/uint32
> +        default: 0x34
> +
> +    required:
> +      - compatible
> +      - interrupts
> +      - regmap
> +
> +  snvs-powerkey:
> +    type: object
> +    additionalProperties: false
> +    description:
> +      The snvs-pwrkey is designed to enable POWER key function which
> controlled
> +      by SNVS ONOFF, the driver can report the status of POWER key and wakeup
> +      system if pressed after system suspend.
> +
> +    properties:
> +      compatible:
> +        const: fsl,sec-v4.0-pwrkey
> +
> +      clocks:
> +        maxItems: 1
> +
> +      clock-names:
> +        const: snvs-pwrkey
> +
> +      interrupts:
> +        maxItems: 1
> +
> +      regmap:
> +        description: Parent node containing registers
> +        $ref: /schemas/types.yaml#/definitions/phandle
> +
> +      wakeup-source: true
> +
> +      linux,keycode:
> +        default: 116
> +
> +    required:
> +      - compatible
> +      - interrupts
> +      - regmap
> +
> +  snvs-lpgpr:
> +    $ref: /schemas/nvmem/snvs-lpgpr.yaml#
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/clock/imx7d-clock.h>
> +
> +    sec_mon: sec-mon@314000 {
> +        compatible = "fsl,sec-v4.0-mon", "syscon", "simple-mfd";
> +        reg = <0x314000 0x1000>;
> +
> +        snvs-rtc-lp {
> +            compatible = "fsl,sec-v4.0-mon-rtc-lp";
> +            regmap = <&sec_mon>;
> +            offset = <0x34>;
> +            clocks = <&clks IMX7D_SNVS_CLK>;
> +            clock-names = "snvs-rtc";
> +            interrupts = <GIC_SPI 19 IRQ_TYPE_LEVEL_HIGH>,
> +                         <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>;
> +        };
> +
> +        snvs-powerkey {
> +            compatible = "fsl,sec-v4.0-pwrkey";
> +            regmap = <&sec_mon>;
> +            clocks = <&clks IMX7D_SNVS_CLK>;
> +            clock-names = "snvs-pwrkey";
> +            interrupts = <GIC_SPI 4 IRQ_TYPE_LEVEL_HIGH>;
> +            linux,keycode = <116>; /* KEY_POWER */
> +            wakeup-source;
> +        };
> +    };
> diff --git a/Documentation/devicetree/bindings/crypto/fsl,sec-v4.0.yaml
> b/Documentation/devicetree/bindings/crypto/fsl,sec-v4.0.yaml
> new file mode 100644
> index 000000000000..0a9ed2848b7c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/crypto/fsl,sec-v4.0.yaml
> @@ -0,0 +1,266 @@
> +# SPDX-License-Identifier: GPL-2.0
> +# Copyright (C) 2008-2011 Freescale Semiconductor Inc.
> +%YAML 1.2
> +---
> +$id:
> +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevice
> +tree.org%2Fschemas%2Fcrypto%2Ffsl%2Csec-
> v4.0.yaml%23&data=05%7C01%7Cgau
> +rav.jain%40nxp.com%7C2c3978ea487741ba95a108db138a2f5b%7C686ea1d3b
> c2b4c6
> +fa92cd99c5c301635%7C0%7C0%7C638125256474297643%7CUnknown%7CT
> WFpbGZsb3d8
> +eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D
> %7C30
> +00%7C%7C%7C&sdata=hQwpaVvIJxJGQDEwWRlo0oO2oSrzw%2FcaFdfYSJmV
> mOA%3D&rese
> +rved=0
> +$schema:
> +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevice
> +tree.org%2Fmeta-
> schemas%2Fcore.yaml%23&data=05%7C01%7Cgaurav.jain%40nxp
> +.com%7C2c3978ea487741ba95a108db138a2f5b%7C686ea1d3bc2b4c6fa92cd9
> 9c5c301
> +635%7C0%7C0%7C638125256474297643%7CUnknown%7CTWFpbGZsb3d8eyJ
> WIjoiMC4wLj
> +AwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7
> C%7C&sd
> +ata=zKV%2FzBKG43TPLsJnF7sjIfCyg4t1D6i1nngwWuDZPS8%3D&reserved=0
> +
> +title: Freescale SEC 4
> +
> +maintainers:
> +  - '"Horia Geantă" <horia.geanta@xxxxxxx>'
> +  - Pankaj Gupta <pankaj.gupta@xxxxxxx>
> +  - Gaurav Jain <gaurav.jain@xxxxxxx>
> +
> +description: |
> +  NOTE: the SEC 4 is also known as Freescale's Cryptographic
> +Accelerator
> +  Accelerator and Assurance Module (CAAM).
> +
> +  SEC 4 h/w can process requests from 2 types of sources.
> +  1. DPAA Queue Interface (HW interface between Queue Manager & SEC 4).
> +  2. Job Rings (HW interface between cores & SEC 4 registers).
> +
> +  High Speed Data Path Configuration:
> +
> +  HW interface between QM & SEC 4 and also BM & SEC 4, on DPAA-enabled
> + parts  such as the P4080.  The number of simultaneous dequeues the QI
> + can make is  equal to the number of Descriptor Controller (DECO)
> + engines in a particular  SEC version.  E.g., the SEC 4.0 in the P4080
> + has 5 DECOs and can thus  dequeue from 5 subportals simultaneously.
> +
> +  Job Ring Data Path Configuration:
> +
> +  Each JR is located on a separate 4k page, they may (or may not) be
> + made visible  in the memory partition devoted to a particular core.
> + The P4080 has 4 JRs, so  up to 4 JRs can be configured; and all 4 JRs process
> requests in parallel.
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - const: fsl,sec-v5.4
> +          - const: fsl,sec-v5.0
> +          - const: fsl,sec-v4.0
> +      - items:
> +          - enum:
> +              - fsl,imx6ul-caam
> +              - fsl,sec-v5.0
> +          - const: fsl,sec-v4.0
> +      - const: fsl,sec-v4.0
> +
> +  reg:
> +    maxItems: 1
> +
> +  ranges:
> +    maxItems: 1
> +
> +  '#address-cells':
> +    enum: [1, 2]
> +
> +  '#size-cells':
> +    enum: [1, 2]
> +
> +  clocks:
> +    minItems: 1
> +    maxItems: 4
> +
> +  clock-names:
> +    minItems: 1
> +    maxItems: 4
> +    items:
> +      enum: [mem, aclk, ipg, emi_slow]
> +
> +  dma-coherent: true
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  fsl,sec-era:
> +    description: Defines the 'ERA' of the SEC device.
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +
> +patternProperties:
> +  '^jr@[0-9a-f]+$':
> +    type: object
> +    additionalProperties: false
> +    description:
> +      Job Ring (JR) Node. Defines data processing interface to SEC 4 across the
> +      peripheral bus for purposes of processing cryptographic descriptors. The
> +      specified address range can be made visible to one (or more) cores. The
> +      interrupt defined for this node is controlled within the address range of
> +      this node.
> +
> +    properties:
> +      compatible:
> +        oneOf:
> +          - items:
> +              - const: fsl,sec-v5.4-job-ring
> +              - const: fsl,sec-v5.0-job-ring
> +              - const: fsl,sec-v4.0-job-ring
> +          - items:
> +              - const: fsl,sec-v5.0-job-ring
> +              - const: fsl,sec-v4.0-job-ring
> +          - const: fsl,sec-v4.0-job-ring
> +
> +      reg:
> +        maxItems: 1
> +
> +      interrupts:
> +        maxItems: 1
> +
> +      fsl,liodn:
> +        description:
> +          Specifies the LIODN to be used in conjunction with the ppid-to-liodn
> +          table that specifies the PPID to LIODN mapping. Needed if the PAMU is
> +          used.  Value is a 12 bit value where value is a LIODN ID for this JR.
> +          This property is normally set by boot firmware.
> +        $ref: /schemas/types.yaml#/definitions/uint32
> +        maximum: 0xfff
> +
> +  '^rtic@[0-9a-f]+$':
> +    type: object
> +    additionalProperties: false
> +    description:
> +      Run Time Integrity Check (RTIC) Node. Defines a register space that
> +      contains up to 5 sets of addresses and their lengths (sizes) that will be
> +      checked at run time.  After an initial hash result is calculated, these
> +      addresses are checked by HW to monitor any change.  If any memory is
> +      modified, a Security Violation is triggered (see SNVS definition).
> +
> +    properties:
> +      compatible:
> +        oneOf:
> +          - items:
> +              - const: fsl,sec-v5.4-rtic
> +              - const: fsl,sec-v5.0-rtic
> +              - const: fsl,sec-v4.0-rtic
> +          - const: fsl,sec-v4.0-rtic
> +
> +      reg:
> +        maxItems: 1
> +
> +      ranges:
> +        maxItems: 1
> +
> +      interrupts:
> +        maxItems: 1
> +
> +      '#address-cells':
> +        const: 1
> +
> +      '#size-cells':
> +        const: 1
> +
> +    patternProperties:
> +      '^rtic-[a-z]@[0-9a-f]+$':
> +        type: object
> +        additionalProperties: false
> +        description:
> +          Run Time Integrity Check (RTIC) Memory Node defines individual RTIC
> +          memory regions that are used to perform run-time integrity check of
> +          memory areas that should not modified. The node defines a register
> +          that contains the memory address & length (combined) and a second
> +          register that contains the hash result in big endian format.
> +
> +        properties:
> +          compatible:
> +            oneOf:
> +              - items:
> +                  - const: fsl,sec-v5.4-rtic-memory
> +                  - const: fsl,sec-v5.0-rtic-memory
> +                  - const: fsl,sec-v4.0-rtic-memory
> +              - const: fsl,sec-v4.0-rtic-memory
> +
> +          reg:
> +            items:
> +              - description: RTIC memory address
> +              - description: RTIC hash result
> +
> +          fsl,liodn:
> +            description:
> +              Specifies the LIODN to be used in conjunction with the
> +              ppid-to-liodn table that specifies the PPID to LIODN mapping.
> +              Needed if the PAMU is used.  Value is a 12 bit value where value
> +              is a LIODN ID for this JR. This property is normally set by boot
> +              firmware.
> +            $ref: /schemas/types.yaml#/definitions/uint32
> +            maximum: 0xfff
> +
> +          fsl,rtic-region:
> +            description:
> +              Specifies the HW address (36 bit address) for this region
> +              followed by the length of the HW partition to be checked;
> +              the address is represented as a 64 bit quantity followed
> +              by a 32 bit length.
> +            $ref: /schemas/types.yaml#/definitions/uint32-array
> +
> +required:
> +  - compatible
> +  - reg
> +  - ranges
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    crypto@300000 {
> +        compatible = "fsl,sec-v4.0";
> +        #address-cells = <1>;
> +        #size-cells = <1>;
> +        reg = <0x300000 0x10000>;
> +        ranges = <0 0x300000 0x10000>;
> +        interrupts = <92 2>;
> +
> +        jr@1000 {
> +            compatible = "fsl,sec-v4.0-job-ring";
> +            reg = <0x1000 0x1000>;
> +            interrupts = <88 2>;
> +        };
> +
> +        jr@2000 {
> +            compatible = "fsl,sec-v4.0-job-ring";
> +            reg = <0x2000 0x1000>;
> +            interrupts = <89 2>;
> +        };
> +
> +        jr@3000 {
> +            compatible = "fsl,sec-v4.0-job-ring";
> +            reg = <0x3000 0x1000>;
> +            interrupts = <90 2>;
> +        };
> +
> +        jr@4000 {
> +            compatible = "fsl,sec-v4.0-job-ring";
> +            reg = <0x4000 0x1000>;
> +            interrupts = <91 2>;
> +        };
> +
> +        rtic@6000 {
> +            compatible = "fsl,sec-v4.0-rtic";
> +            #address-cells = <1>;
> +            #size-cells = <1>;
> +            reg = <0x6000 0x100>;
> +            ranges = <0x0 0x6100 0xe00>;
> +
> +            rtic-a@0 {
> +                compatible = "fsl,sec-v4.0-rtic-memory";
> +                reg = <0x00 0x20>, <0x100 0x80>;
> +            };
> +
> +            rtic-b@20 {
> +                compatible = "fsl,sec-v4.0-rtic-memory";
> +                reg = <0x20 0x20>, <0x200 0x80>;
> +            };
> +
> +            rtic-c@40 {
> +                compatible = "fsl,sec-v4.0-rtic-memory";
> +                reg = <0x40 0x20>, <0x300 0x80>;
> +            };
> +
> +            rtic-d@60 {
> +                compatible = "fsl,sec-v4.0-rtic-memory";
> +                reg = <0x60 0x20>, <0x500 0x80>;
> +            };
> +        };
> +    };
> +...
> diff --git a/Documentation/devicetree/bindings/crypto/fsl-sec4.txt
> b/Documentation/devicetree/bindings/crypto/fsl-sec4.txt
> deleted file mode 100644
> index 8f359f473ada..000000000000
> --- a/Documentation/devicetree/bindings/crypto/fsl-sec4.txt
> +++ /dev/null
> @@ -1,553 +0,0 @@
> -
> =================================================================
> ====
> -SEC 4 Device Tree Binding
> -Copyright (C) 2008-2011 Freescale Semiconductor Inc.
> -
> - CONTENTS
> -   -Overview
> -   -SEC 4 Node
> -   -Job Ring Node
> -   -Run Time Integrity Check (RTIC) Node
> -   -Run Time Integrity Check (RTIC) Memory Node
> -   -Secure Non-Volatile Storage (SNVS) Node
> -   -Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node
> -   -Full Example
> -
> -NOTE: the SEC 4 is also known as Freescale's Cryptographic Accelerator -
> Accelerator and Assurance Module (CAAM).
> -
> -
> =================================================================
> ====
> -Overview
> -
> -DESCRIPTION
> -
> -SEC 4 h/w can process requests from 2 types of sources.
> -1. DPAA Queue Interface (HW interface between Queue Manager & SEC 4).
> -2. Job Rings (HW interface between cores & SEC 4 registers).
> -
> -High Speed Data Path Configuration:
> -
> -HW interface between QM & SEC 4 and also BM & SEC 4, on DPAA-enabled
> parts -such as the P4080.  The number of simultaneous dequeues the QI can
> make is -equal to the number of Descriptor Controller (DECO) engines in a
> particular -SEC version.  E.g., the SEC 4.0 in the P4080 has 5 DECOs and can thus
> -dequeue from 5 subportals simultaneously.
> -
> -Job Ring Data Path Configuration:
> -
> -Each JR is located on a separate 4k page, they may (or may not) be made visible
> -in the memory partition devoted to a particular core.  The P4080 has 4 JRs, so -
> up to 4 JRs can be configured; and all 4 JRs process requests in parallel.
> -
> -
> =================================================================
> ====
> -SEC 4 Node
> -
> -Description
> -
> -    Node defines the base address of the SEC 4 block.
> -    This block specifies the address range of all global
> -    configuration registers for the SEC 4 block.  It
> -    also receives interrupts from the Run Time Integrity Check
> -    (RTIC) function within the SEC 4 block.
> -
> -PROPERTIES
> -
> -   - compatible
> -      Usage: required
> -      Value type: <string>
> -      Definition: Must include "fsl,sec-v4.0"
> -
> -   - fsl,sec-era
> -      Usage: optional
> -      Value type: <u32>
> -      Definition: A standard property. Define the 'ERA' of the SEC
> -          device.
> -
> -   - #address-cells
> -       Usage: required
> -       Value type: <u32>
> -       Definition: A standard property.  Defines the number of cells
> -           for representing physical addresses in child nodes.
> -
> -   - #size-cells
> -       Usage: required
> -       Value type: <u32>
> -       Definition: A standard property.  Defines the number of cells
> -           for representing the size of physical addresses in
> -           child nodes.
> -
> -   - reg
> -      Usage: required
> -      Value type: <prop-encoded-array>
> -      Definition: A standard property.  Specifies the physical
> -          address and length of the SEC4 configuration registers.
> -          registers
> -
> -   - ranges
> -       Usage: required
> -       Value type: <prop-encoded-array>
> -       Definition: A standard property.  Specifies the physical address
> -           range of the SEC 4.0 register space (-SNVS not included).  A
> -           triplet that includes the child address, parent address, &
> -           length.
> -
> -   - interrupts
> -      Usage: required
> -      Value type: <prop_encoded-array>
> -      Definition:  Specifies the interrupts generated by this
> -           device.  The value of the interrupts property
> -           consists of one interrupt specifier. The format
> -           of the specifier is defined by the binding document
> -           describing the node's interrupt parent.
> -
> -   - clocks
> -      Usage: required if SEC 4.0 requires explicit enablement of clocks
> -      Value type: <prop_encoded-array>
> -      Definition:  A list of phandle and clock specifier pairs describing
> -          the clocks required for enabling and disabling SEC 4.0.
> -
> -   - clock-names
> -      Usage: required if SEC 4.0 requires explicit enablement of clocks
> -      Value type: <string>
> -      Definition: A list of clock name strings in the same order as the
> -          clocks property.
> -
> -   Note: All other standard properties (see the Devicetree Specification)
> -   are allowed but are optional.
> -
> -
> -EXAMPLE
> -
> -iMX6QDL/SX requires four clocks
> -
> -       crypto@300000 {
> -               compatible = "fsl,sec-v4.0";
> -               fsl,sec-era = <2>;
> -               #address-cells = <1>;
> -               #size-cells = <1>;
> -               reg = <0x300000 0x10000>;
> -               ranges = <0 0x300000 0x10000>;
> -               interrupt-parent = <&mpic>;
> -               interrupts = <92 2>;
> -               clocks = <&clks IMX6QDL_CLK_CAAM_MEM>,
> -                        <&clks IMX6QDL_CLK_CAAM_ACLK>,
> -                        <&clks IMX6QDL_CLK_CAAM_IPG>,
> -                        <&clks IMX6QDL_CLK_EIM_SLOW>;
> -               clock-names = "mem", "aclk", "ipg", "emi_slow";
> -       };
> -
> -
> -iMX6UL does only require three clocks
> -
> -       crypto: crypto@2140000 {
> -               compatible = "fsl,sec-v4.0";
> -               #address-cells = <1>;
> -               #size-cells = <1>;
> -               reg = <0x2140000 0x3c000>;
> -               ranges = <0 0x2140000 0x3c000>;
> -               interrupts = <GIC_SPI 48 IRQ_TYPE_LEVEL_HIGH>;
> -
> -               clocks = <&clks IMX6UL_CLK_CAAM_MEM>,
> -                        <&clks IMX6UL_CLK_CAAM_ACLK>,
> -                        <&clks IMX6UL_CLK_CAAM_IPG>;
> -               clock-names = "mem", "aclk", "ipg";
> -       };
> -
> -
> =================================================================
> ====
> -Job Ring (JR) Node
> -
> -    Child of the crypto node defines data processing interface to SEC 4
> -    across the peripheral bus for purposes of processing
> -    cryptographic descriptors. The specified address
> -    range can be made visible to one (or more) cores.
> -    The interrupt defined for this node is controlled within
> -    the address range of this node.
> -
> -  - compatible
> -      Usage: required
> -      Value type: <string>
> -      Definition: Must include "fsl,sec-v4.0-job-ring"
> -
> -  - reg
> -      Usage: required
> -      Value type: <prop-encoded-array>
> -      Definition: Specifies a two JR parameters:  an offset from
> -          the parent physical address and the length the JR registers.
> -
> -   - fsl,liodn
> -       Usage: optional-but-recommended
> -       Value type: <prop-encoded-array>
> -       Definition:
> -           Specifies the LIODN to be used in conjunction with
> -           the ppid-to-liodn table that specifies the PPID to LIODN mapping.
> -           Needed if the PAMU is used.  Value is a 12 bit value
> -           where value is a LIODN ID for this JR. This property is
> -           normally set by boot firmware.
> -
> -   - interrupts
> -      Usage: required
> -      Value type: <prop_encoded-array>
> -      Definition:  Specifies the interrupts generated by this
> -           device.  The value of the interrupts property
> -           consists of one interrupt specifier. The format
> -           of the specifier is defined by the binding document
> -           describing the node's interrupt parent.
> -
> -EXAMPLE
> -       jr@1000 {
> -               compatible = "fsl,sec-v4.0-job-ring";
> -               reg = <0x1000 0x1000>;
> -               fsl,liodn = <0x081>;
> -               interrupt-parent = <&mpic>;
> -               interrupts = <88 2>;
> -       };
> -
> -
> -
> =================================================================
> ====
> -Run Time Integrity Check (RTIC) Node
> -
> -  Child node of the crypto node.  Defines a register space that
> -  contains up to 5 sets of addresses and their lengths (sizes) that
> -  will be checked at run time.  After an initial hash result is
> -  calculated, these addresses are checked by HW to monitor any
> -  change.  If any memory is modified, a Security Violation is
> -  triggered (see SNVS definition).
> -
> -
> -  - compatible
> -      Usage: required
> -      Value type: <string>
> -      Definition: Must include "fsl,sec-v4.0-rtic".
> -
> -   - #address-cells
> -       Usage: required
> -       Value type: <u32>
> -       Definition: A standard property.  Defines the number of cells
> -           for representing physical addresses in child nodes.  Must
> -           have a value of 1.
> -
> -   - #size-cells
> -       Usage: required
> -       Value type: <u32>
> -       Definition: A standard property.  Defines the number of cells
> -           for representing the size of physical addresses in
> -           child nodes.  Must have a value of 1.
> -
> -  - reg
> -      Usage: required
> -      Value type: <prop-encoded-array>
> -      Definition: A standard property.  Specifies a two parameters:
> -          an offset from the parent physical address and the length
> -          the SEC4 registers.
> -
> -   - ranges
> -       Usage: required
> -       Value type: <prop-encoded-array>
> -       Definition: A standard property.  Specifies the physical address
> -           range of the SEC 4 register space (-SNVS not included).  A
> -           triplet that includes the child address, parent address, &
> -           length.
> -
> -EXAMPLE
> -       rtic@6000 {
> -               compatible = "fsl,sec-v4.0-rtic";
> -               #address-cells = <1>;
> -               #size-cells = <1>;
> -               reg = <0x6000 0x100>;
> -               ranges = <0x0 0x6100 0xe00>;
> -       };
> -
> -
> =================================================================
> ====
> -Run Time Integrity Check (RTIC) Memory Node
> -  A child node that defines individual RTIC memory regions that are used to
> -  perform run-time integrity check of memory areas that should not modified.
> -  The node defines a register that contains the memory address &
> -  length (combined) and a second register that contains the hash result
> -  in big endian format.
> -
> -  - compatible
> -      Usage: required
> -      Value type: <string>
> -      Definition: Must include "fsl,sec-v4.0-rtic-memory".
> -
> -  - reg
> -      Usage: required
> -      Value type: <prop-encoded-array>
> -      Definition: A standard property.  Specifies two parameters:
> -          an offset from the parent physical address and the length:
> -
> -          1. The location of the RTIC memory address & length registers.
> -          2. The location RTIC hash result.
> -
> -  - fsl,rtic-region
> -       Usage: optional-but-recommended
> -       Value type: <prop-encoded-array>
> -       Definition:
> -           Specifies the HW address (36 bit address) for this region
> -           followed by the length of the HW partition to be checked;
> -           the address is represented as a 64 bit quantity followed
> -           by a 32 bit length.
> -
> -   - fsl,liodn
> -       Usage: optional-but-recommended
> -       Value type: <prop-encoded-array>
> -       Definition:
> -           Specifies the LIODN to be used in conjunction with
> -           the ppid-to-liodn table that specifies the PPID to LIODN
> -           mapping.  Needed if the PAMU is used.  Value is a 12 bit value
> -           where value is a LIODN ID for this RTIC memory region. This
> -           property is normally set by boot firmware.
> -
> -EXAMPLE
> -       rtic-a@0 {
> -               compatible = "fsl,sec-v4.0-rtic-memory";
> -               reg = <0x00 0x20 0x100 0x80>;
> -               fsl,liodn   = <0x03c>;
> -               fsl,rtic-region  = <0x12345678 0x12345678 0x12345678>;
> -       };
> -
> -
> =================================================================
> ====
> -Secure Non-Volatile Storage (SNVS) Node
> -
> -    Node defines address range and the associated
> -    interrupt for the SNVS function.  This function
> -    monitors security state information & reports
> -    security violations. This also included rtc,
> -    system power off and ON/OFF key.
> -
> -  - compatible
> -      Usage: required
> -      Value type: <string>
> -      Definition: Must include "fsl,sec-v4.0-mon" and "syscon".
> -
> -  - reg
> -      Usage: required
> -      Value type: <prop-encoded-array>
> -      Definition: A standard property.  Specifies the physical
> -          address and length of the SEC4 configuration
> -          registers.
> -
> -   - #address-cells
> -       Usage: required
> -       Value type: <u32>
> -       Definition: A standard property.  Defines the number of cells
> -           for representing physical addresses in child nodes.  Must
> -           have a value of 1.
> -
> -   - #size-cells
> -       Usage: required
> -       Value type: <u32>
> -       Definition: A standard property.  Defines the number of cells
> -           for representing the size of physical addresses in
> -           child nodes.  Must have a value of 1.
> -
> -   - ranges
> -       Usage: required
> -       Value type: <prop-encoded-array>
> -       Definition: A standard property.  Specifies the physical address
> -           range of the SNVS register space.  A triplet that includes
> -           the child address, parent address, & length.
> -
> -   - interrupts
> -      Usage: optional
> -      Value type: <prop_encoded-array>
> -      Definition:  Specifies the interrupts generated by this
> -           device.  The value of the interrupts property
> -           consists of one interrupt specifier. The format
> -           of the specifier is defined by the binding document
> -           describing the node's interrupt parent.
> -
> -EXAMPLE
> -       sec_mon@314000 {
> -               compatible = "fsl,sec-v4.0-mon", "syscon";
> -               reg = <0x314000 0x1000>;
> -               ranges = <0 0x314000 0x1000>;
> -               interrupt-parent = <&mpic>;
> -               interrupts = <93 2>;
> -       };
> -
> -
> =================================================================
> ====
> -Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node
> -
> -  A SNVS child node that defines SNVS LP RTC.
> -
> -  - compatible
> -      Usage: required
> -      Value type: <string>
> -      Definition: Must include "fsl,sec-v4.0-mon-rtc-lp".
> -
> -  - interrupts
> -      Usage: required
> -      Value type: <prop_encoded-array>
> -      Definition: Specifies the interrupts generated by this
> -          device.  The value of the interrupts property
> -          consists of one interrupt specifier. The format
> -          of the specifier is defined by the binding document
> -          describing the node's interrupt parent.
> -
> - - regmap
> -       Usage: required
> -       Value type: <phandle>
> -       Definition: this is phandle to the register map node.
> -
> - - offset
> -       Usage: option
> -       value type: <u32>
> -       Definition: LP register offset. default it is 0x34.
> -
> -   - clocks
> -      Usage: optional, required if SNVS LP RTC requires explicit
> -          enablement of clocks
> -      Value type: <prop_encoded-array>
> -      Definition:  a clock specifier describing the clock required for
> -          enabling and disabling SNVS LP RTC.
> -
> -   - clock-names
> -      Usage: optional, required if SNVS LP RTC requires explicit
> -          enablement of clocks
> -      Value type: <string>
> -      Definition: clock name string should be "snvs-rtc".
> -
> -EXAMPLE
> -       sec_mon_rtc_lp@1 {
> -               compatible = "fsl,sec-v4.0-mon-rtc-lp";
> -               interrupts = <93 2>;
> -               regmap = <&snvs>;
> -               offset = <0x34>;
> -               clocks = <&clks IMX7D_SNVS_CLK>;
> -               clock-names = "snvs-rtc";
> -       };
> -
> -
> =================================================================
> ====
> -System ON/OFF key driver
> -
> -  The snvs-pwrkey is designed to enable POWER key function which controlled
> -  by SNVS ONOFF, the driver can report the status of POWER key and wakeup
> -  system if pressed after system suspend.
> -
> -  - compatible:
> -      Usage: required
> -      Value type: <string>
> -      Definition: Mush include "fsl,sec-v4.0-pwrkey".
> -
> -  - interrupts:
> -      Usage: required
> -      Value type: <prop_encoded-array>
> -      Definition: The SNVS ON/OFF interrupt number to the CPU(s).
> -
> -  - linux,keycode:
> -      Usage: option
> -      Value type: <int>
> -      Definition: Keycode to emit, KEY_POWER by default.
> -
> -  - wakeup-source:
> -      Usage: option
> -      Value type: <boo>
> -      Definition: Button can wake-up the system.
> -
> - - regmap:
> -      Usage: required:
> -      Value type: <phandle>
> -      Definition: this is phandle to the register map node.
> -
> -EXAMPLE:
> -       snvs-pwrkey@020cc000 {
> -               compatible = "fsl,sec-v4.0-pwrkey";
> -               regmap = <&snvs>;
> -               interrupts = <0 4 0x4>
> -               linux,keycode = <116>; /* KEY_POWER */
> -               wakeup-source;
> -       };
> -
> -
> =================================================================
> ====
> -FULL EXAMPLE
> -
> -       crypto: crypto@300000 {
> -               compatible = "fsl,sec-v4.0";
> -               #address-cells = <1>;
> -               #size-cells = <1>;
> -               reg = <0x300000 0x10000>;
> -               ranges = <0 0x300000 0x10000>;
> -               interrupt-parent = <&mpic>;
> -               interrupts = <92 2>;
> -
> -               sec_jr0: jr@1000 {
> -                       compatible = "fsl,sec-v4.0-job-ring";
> -                       reg = <0x1000 0x1000>;
> -                       interrupt-parent = <&mpic>;
> -                       interrupts = <88 2>;
> -               };
> -
> -               sec_jr1: jr@2000 {
> -                       compatible = "fsl,sec-v4.0-job-ring";
> -                       reg = <0x2000 0x1000>;
> -                       interrupt-parent = <&mpic>;
> -                       interrupts = <89 2>;
> -               };
> -
> -               sec_jr2: jr@3000 {
> -                       compatible = "fsl,sec-v4.0-job-ring";
> -                       reg = <0x3000 0x1000>;
> -                       interrupt-parent = <&mpic>;
> -                       interrupts = <90 2>;
> -               };
> -
> -               sec_jr3: jr@4000 {
> -                       compatible = "fsl,sec-v4.0-job-ring";
> -                       reg = <0x4000 0x1000>;
> -                       interrupt-parent = <&mpic>;
> -                       interrupts = <91 2>;
> -               };
> -
> -               rtic@6000 {
> -                       compatible = "fsl,sec-v4.0-rtic";
> -                       #address-cells = <1>;
> -                       #size-cells = <1>;
> -                       reg = <0x6000 0x100>;
> -                       ranges = <0x0 0x6100 0xe00>;
> -
> -                       rtic_a: rtic-a@0 {
> -                               compatible = "fsl,sec-v4.0-rtic-memory";
> -                               reg = <0x00 0x20 0x100 0x80>;
> -                       };
> -
> -                       rtic_b: rtic-b@20 {
> -                               compatible = "fsl,sec-v4.0-rtic-memory";
> -                               reg = <0x20 0x20 0x200 0x80>;
> -                       };
> -
> -                       rtic_c: rtic-c@40 {
> -                               compatible = "fsl,sec-v4.0-rtic-memory";
> -                               reg = <0x40 0x20 0x300 0x80>;
> -                       };
> -
> -                       rtic_d: rtic-d@60 {
> -                               compatible = "fsl,sec-v4.0-rtic-memory";
> -                               reg = <0x60 0x20 0x500 0x80>;
> -                       };
> -               };
> -       };
> -
> -       sec_mon: sec_mon@314000 {
> -               compatible = "fsl,sec-v4.0-mon";
> -               reg = <0x314000 0x1000>;
> -               ranges = <0 0x314000 0x1000>;
> -
> -               sec_mon_rtc_lp@34 {
> -                       compatible = "fsl,sec-v4.0-mon-rtc-lp";
> -                       regmap = <&sec_mon>;
> -                       offset = <0x34>;
> -                       interrupts = <93 2>;
> -                       clocks = <&clks IMX7D_SNVS_CLK>;
> -                       clock-names = "snvs-rtc";
> -               };
> -
> -               snvs-pwrkey@020cc000 {
> -                       compatible = "fsl,sec-v4.0-pwrkey";
> -                       regmap = <&sec_mon>;
> -                       interrupts = <0 4 0x4>;
> -                       linux,keycode = <116>; /* KEY_POWER */
> -                       wakeup-source;
> -               };
> -       };
> -
> -
> =================================================================
> ====
> --
> 2.39.1





[Index of Archives]     [Device Tree Compilter]     [Device Tree Spec]     [Linux Driver Backports]     [Video for Linux]     [Linux USB Devel]     [Linux PCI Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Yosemite Backpacking]


  Powered by Linux