From: Rob Herring <robh@kernel.org>
To: Krzysztof Kozlowski <krzk@kernel.org>
Cc: "Mark Rutland" <mark.rutland@arm.com>,
"Kukjin Kim" <kgene@kernel.org>,
"Benoît Cousson" <bcousson@baylibre.com>,
"Tony Lindgren" <tony@atomide.com>,
"Jason Cooper" <jason@lakedaemon.net>,
"Andrew Lunn" <andrew@lunn.ch>,
"Sebastian Hesselbarth" <sebastian.hesselbarth@gmail.com>,
"Gregory Clement" <gregory.clement@bootlin.com>,
"Shawn Guo" <shawnguo@kernel.org>,
"Sascha Hauer" <s.hauer@pengutronix.de>,
"Pengutronix Kernel Team" <kernel@pengutronix.de>,
"Fabio Estevam" <festevam@gmail.com>,
"NXP Linux Team" <linux-imx@nxp.com>,
"Santosh Shilimkar" <ssantosh@kernel.org>,
"Thierry Reding" <thierry.reding@gmail.com>,
"Jonathan Hunter" <jonathanh@nvidia.com>,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-samsung-soc@vger.kernel.org, linux-omap@vger.kernel.org,
linux-tegra@vger.kernel.org
Subject: Re: [PATCH v3 01/10] dt-bindings: sram: Convert SRAM bindings to json-schema
Date: Thu, 10 Oct 2019 14:12:40 -0500 [thread overview]
Message-ID: <20191010191240.GA15006@bogus> (raw)
Message-ID: <20191010191240.gZD0iQ8b5Ml8OJ6JRKoykd7ue-7YLvNVwsny0oZ-HDs@z> (raw)
In-Reply-To: <20191002164316.14905-1-krzk@kernel.org>
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
>
next prev parent reply other threads:[~2019-10-10 19:12 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-02 16:43 [PATCH v3 01/10] dt-bindings: sram: Convert SRAM bindings to json-schema Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 02/10] dt-bindings: sram: Convert Samsung Exynos SYSRAM " Krzysztof Kozlowski
2019-10-10 19:33 ` Rob Herring
2019-10-10 19:33 ` Rob Herring
2019-10-11 7:52 ` Krzysztof Kozlowski
2019-10-11 7:52 ` Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 03/10] ARM: dts: exynos: Rename SysRAM node to "sram" Krzysztof Kozlowski
2019-10-06 15:48 ` Krzysztof Kozlowski
2019-10-06 15:48 ` Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 04/10] arm64: dts: tegra: Rename sysram " Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 05/10] ARM: dts: dove: Rename "sa-sram" " Krzysztof Kozlowski
2019-10-08 9:44 ` Gregory CLEMENT
2019-10-02 16:43 ` [PATCH v3 06/10] ARM: dts: imx: Rename "iram" " Krzysztof Kozlowski
2019-10-14 11:32 ` Shawn Guo
2019-10-14 11:32 ` Shawn Guo
2019-10-16 16:18 ` Krzysztof Kozlowski
2019-10-25 2:39 ` Shawn Guo
2019-10-02 16:43 ` [PATCH v3 07/10] ARM: dts: keystone: Rename "msmram" " Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 08/10] ARM: dts: tegra: Rename "iram" " Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 09/10] ARM: dts: am: Rename "ocmcram" " Krzysztof Kozlowski
2019-10-02 16:43 ` [PATCH v3 10/10] ARM: dts: omap: " Krzysztof Kozlowski
2019-10-22 16:35 ` Tony Lindgren
2019-10-10 19:12 ` Rob Herring [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191010191240.GA15006@bogus \
--to=robh@kernel.org \
--cc=andrew@lunn.ch \
--cc=bcousson@baylibre.com \
--cc=devicetree@vger.kernel.org \
--cc=festevam@gmail.com \
--cc=gregory.clement@bootlin.com \
--cc=jason@lakedaemon.net \
--cc=jonathanh@nvidia.com \
--cc=kernel@pengutronix.de \
--cc=kgene@kernel.org \
--cc=krzk@kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-imx@nxp.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-omap@vger.kernel.org \
--cc=linux-samsung-soc@vger.kernel.org \
--cc=linux-tegra@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=s.hauer@pengutronix.de \
--cc=sebastian.hesselbarth@gmail.com \
--cc=shawnguo@kernel.org \
--cc=ssantosh@kernel.org \
--cc=thierry.reding@gmail.com \
--cc=tony@atomide.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).