linux-tegra.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
  • * Re: [PATCH v3 01/10] dt-bindings: sram: Convert SRAM bindings to json-schema
           [not found] <20191002164316.14905-1-krzk@kernel.org>
           [not found] ` <20191002164316.14905-3-krzk@kernel.org>
    @ 2019-10-10 19:12 ` Rob Herring
      2019-10-21 13:25   ` Krzysztof Kozlowski
           [not found] ` <20191002164316.14905-2-krzk@kernel.org>
                       ` (2 subsequent siblings)
      4 siblings, 1 reply; 9+ messages in thread
    From: Rob Herring @ 2019-10-10 19:12 UTC (permalink / raw)
      To: Krzysztof Kozlowski
      Cc: Mark Rutland, Kukjin Kim, Benoît Cousson, Tony Lindgren,
    	Jason Cooper, Andrew Lunn, Sebastian Hesselbarth, Gregory Clement,
    	Shawn Guo, Sascha Hauer, Pengutronix Kernel Team, Fabio Estevam,
    	NXP Linux Team, Santosh Shilimkar, Thierry Reding,
    	Jonathan Hunter, devicetree, linux-kernel, linux-arm-kernel
    
    On Wed, Oct 02, 2019 at 06:43:07PM +0200, Krzysztof Kozlowski wrote:
    > Convert generic mmio-sram bindings to DT schema format using
    > json-schema.  Require the address/size cells to be 1, not equal to root
    > node.
    > 
    > Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
    > 
    > ---
    > 
    > Changes since v2:
    > 1. Add Rob as maintainer,
    > 2. Use "contains" for compatible,
    > 3. Fix address and size cells to 1,
    > 4. Add maxitems to reg under children,
    > 5. Remove unneeded string type from label.
    > 
    > Changes since v1:
    > 1. Indent example with four spaces (more readable).
    > ---
    >  .../devicetree/bindings/sram/sram.txt         |  80 -----------
    >  .../devicetree/bindings/sram/sram.yaml        | 134 ++++++++++++++++++
    >  2 files changed, 134 insertions(+), 80 deletions(-)
    >  delete mode 100644 Documentation/devicetree/bindings/sram/sram.txt
    >  create mode 100644 Documentation/devicetree/bindings/sram/sram.yaml
    
    
    > diff --git a/Documentation/devicetree/bindings/sram/sram.yaml b/Documentation/devicetree/bindings/sram/sram.yaml
    > new file mode 100644
    > index 000000000000..a1c1ec2183f2
    > --- /dev/null
    > +++ b/Documentation/devicetree/bindings/sram/sram.yaml
    > @@ -0,0 +1,134 @@
    > +# SPDX-License-Identifier: GPL-2.0
    > +%YAML 1.2
    > +---
    > +$id: http://devicetree.org/schemas/sram/sram.yaml#
    > +$schema: http://devicetree.org/meta-schemas/core.yaml#
    > +
    > +title: Generic on-chip SRAM
    > +
    > +maintainers:
    > +  - Rob Herring <robh@kernel.org>
    > +
    > +description: |+
    > +  Simple IO memory regions to be managed by the genalloc API.
    > +
    > +  Each child of the sram node specifies a region of reserved memory. Each
    > +  child node should use a 'reg' property to specify a specific range of
    > +  reserved memory.
    > +
    > +  Following the generic-names recommended practice, node names should
    > +  reflect the purpose of the node. Unit address (@<address>) should be
    > +  appended to the name.
    > +
    > +properties:
    > +  $nodename:
    > +    pattern: "^sram(@.*)?"
    > +
    > +  compatible:
    > +    contains:
    > +      enum:
    > +        - mmio-sram
    > +        - atmel,sama5d2-securam
    > +
    > +  reg:
    > +    maxItems: 1
    > +
    > +  "#address-cells":
    > +    const: 1
    > +
    > +  "#size-cells":
    > +    const: 1
    > +
    > +  ranges:
    > +    description:
    > +      Should translate from local addresses within the sram to bus addresses.
    > +
    > +  no-memory-wc:
    > +    description:
    > +      The flag indicating, that SRAM memory region has not to be remapped
    > +      as write combining. WC is used by default.
    > +    type: boolean
    > +
    > +patternProperties:
    > +  "^([a-z]*-)?sram@[a-f0-9]$":
    > +    type: object
    > +    description:
    > +      Each child of the sram node specifies a region of reserved memory.
    > +    properties:
    > +      reg:
    > +        description:
    > +          IO mem address range, relative to the SRAM range.
    > +        maxItems: 1
    > +
    > +      compatible:
    > +        $ref: /schemas/types.yaml#/definitions/string
    
    No need to define the type again. We can say 'maxItems: 1' if we really 
    want to force it to 1 entry.
    
    > +        description:
    > +          Should contain a vendor specific string in the form
    > +          <vendor>,[<device>-]<usage>
    > +
    > +      pool:
    > +        description:
    > +          Indicates that the particular reserved SRAM area is addressable
    > +          and in use by another device or devices.
    > +        type: boolean
    > +
    > +      export:
    > +        description:
    > +          Indicates that the reserved SRAM area may be accessed outside
    > +          of the kernel, e.g. by bootloader or userspace.
    > +        type: boolean
    > +
    > +      protect-exec:
    > +        description: |
    > +          Same as 'pool' above but with the additional constraint that code
    > +          will be run from the region and that the memory is maintained as
    > +          read-only, executable during code execution. NOTE: This region must
    > +          be page aligned on start and end in order to properly allow
    > +          manipulation of the page attributes.
    > +        type: boolean
    > +
    > +      label:
    > +        description:
    > +          The name for the reserved partition, if omitted, the label is taken
    > +          from the node name excluding the unit address.
    > +
    > +      clocks:
    
    Shouldn't this be up one level? Looks like this is the only case 
    (Marvell and i.MX are the only ones I see with clocks).
    
    > +        description:
    > +          A list of phandle and clock specifier pair that controls the
    > +          single SRAM clock.
    
    maxItems: 1
    
    > +
    > +    required:
    > +      - reg
    > +
    > +required:
    > +  - compatible
    > +  - reg
    > +  - "#address-cells"
    > +  - "#size-cells"
    > +  - ranges
    
    Does 'additionalProperties' work here and/or in the child node? I guess 
    not if we keep some node names.
    
    > +
    > +examples:
    > +  - |
    > +    sram: sram@5c000000 {
    > +        compatible = "mmio-sram";
    > +        reg = <0x5c000000 0x40000>; /* 256 KiB SRAM at address 0x5c000000 */
    > +
    > +        #address-cells = <1>;
    > +        #size-cells = <1>;
    > +        ranges = <0 0x5c000000 0x40000>;
    > +
    > +        smp-sram@100 {
    > +            compatible = "socvendor,smp-sram";
    > +            reg = <0x100 0x50>;
    > +        };
    > +
    > +        device-sram@1000 {
    > +            reg = <0x1000 0x1000>;
    > +            pool;
    > +        };
    > +
    > +        exported@20000 {
    
    This one doesn't match the pattern. That's fine I guess for dts files, 
    but examples should be good examples.
    
    > +            reg = <0x20000 0x20000>;
    > +            export;
    > +        };
    > +    };
    > -- 
    > 2.17.1
    > 
    
    ^ permalink raw reply	[flat|nested] 9+ messages in thread
  • [parent not found: <20191002164316.14905-2-krzk@kernel.org>]
  • [parent not found: <20191002164316.14905-6-krzk@kernel.org>]
  • [parent not found: <20191002164316.14905-10-krzk@kernel.org>]

  • end of thread, other threads:[~2019-10-25  2:39 UTC | newest]
    
    Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
    -- links below jump to the message on this page --
         [not found] <20191002164316.14905-1-krzk@kernel.org>
         [not found] ` <20191002164316.14905-3-krzk@kernel.org>
    2019-10-06 15:48   ` [PATCH v3 03/10] ARM: dts: exynos: Rename SysRAM node to "sram" Krzysztof Kozlowski
    2019-10-10 19:12 ` [PATCH v3 01/10] dt-bindings: sram: Convert SRAM bindings to json-schema Rob Herring
    2019-10-21 13:25   ` Krzysztof Kozlowski
         [not found] ` <20191002164316.14905-2-krzk@kernel.org>
    2019-10-10 19:33   ` [PATCH v3 02/10] dt-bindings: sram: Convert Samsung Exynos SYSRAM " Rob Herring
    2019-10-11  7:52     ` Krzysztof Kozlowski
         [not found] ` <20191002164316.14905-6-krzk@kernel.org>
    2019-10-14 11:32   ` [PATCH v3 06/10] ARM: dts: imx: Rename "iram" node to "sram" Shawn Guo
    2019-10-16 16:18     ` Krzysztof Kozlowski
    2019-10-25  2:39   ` Shawn Guo
         [not found] ` <20191002164316.14905-10-krzk@kernel.org>
    2019-10-22 16:35   ` [PATCH v3 10/10] ARM: dts: omap: Rename "ocmcram" " Tony Lindgren
    

    This is a public inbox, see mirroring instructions
    for how to clone and mirror all data and code used for this inbox;
    as well as URLs for NNTP newsgroup(s).