diff mbox

[4/4] Documentation: dt-bindings: Describe SROMc configuration

Message ID 7ac097efc649bac4e9f2b991baaa969ce4cbc3ef.1445859834.git.p.fedin@samsung.com (mailing list archive)
State New, archived
Headers show

Commit Message

Pavel Fedin Oct. 26, 2015, 11:47 a.m. UTC
Add documentation for new properties, allowing bank configuration.

Signed-off-by: Pavel Fedin <p.fedin@samsung.com>
---
 .../devicetree/bindings/arm/samsung/exynos-srom.txt   | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

Comments

Pankaj Dubey Oct. 27, 2015, 5:11 a.m. UTC | #1
Hi Pavel,

On Monday 26 October 2015 05:17 PM, Pavel Fedin wrote:
> Add documentation for new properties, allowing bank configuration.
>
> Signed-off-by: Pavel Fedin <p.fedin@samsung.com>
> ---
>   .../devicetree/bindings/arm/samsung/exynos-srom.txt   | 19 ++++++++++++++++++-
>   1 file changed, 18 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt b/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt
> index 33886d5..73750da 100644
> --- a/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt
> +++ b/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt
> @@ -5,8 +5,25 @@ Required properties:
>
>   - reg: offset and length of the register set
>
> -Example:
> +Bank configurations can be defined as an optional subnodes. They can have the
> +following properties:
> +- bank : bank number (0 - 3)
> +- width : data width in bytes (1 or 2). If omitted, default of 1 is used.
> +- srom-timing : array of 7 integers: Tacp, Tcah, Tcoh, Tacc, Tcos, Tacs
> +

I think these will be optional properties as all Exynos SoC may not be 
having these. So better to add them under "Optional Properties" heading, 
and move this above the "-Example" heading

> +Example: basic definition, no banks are configured
> +	sromc@12570000 {
> +		compatible = "samsung,exynos-srom";
> +		reg = <0x12570000 0x10>;
> +	};
> +
> +Example: SROMc with bank3 configuration
>   	sromc@12570000 {
>   		compatible = "samsung,exynos-srom";
>   		reg = <0x12570000 0x10>;
> +		bank@3 {
> +			bank = <3>;
> +			width = <2>;
> +			srom-timing = <1 9 12 1 9 1 1>;
> +		};
>   	};
>

Thanks,
Pankaj Dubey
Pavel Fedin Oct. 27, 2015, 6:59 a.m. UTC | #2
Hello!

> > +Bank configurations can be defined as an optional subnodes. They can have the
> > +following properties:
> > +- bank : bank number (0 - 3)
> > +- width : data width in bytes (1 or 2). If omitted, default of 1 is used.
> > +- srom-timing : array of 7 integers: Tacp, Tcah, Tcoh, Tacc, Tcos, Tacs
> > +
> 
> I think these will be optional properties as all Exynos SoC may not be
> having these. So better to add them under "Optional Properties" heading,
> and move this above the "-Example" heading

 Not really. Actually 'bank' is not optional, because it actually identifies to which bank properties are applied, and srom-timings
are settings by themselves. Without both of them the definition just doesn't make sense. The only really optional specifier is
'width', which has a default.
 Could you give me an example of how to write this correctly?

Kind regards,
Pavel Fedin
Expert Engineer
Samsung Electronics Research center Russia
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt b/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt
index 33886d5..73750da 100644
--- a/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt
+++ b/Documentation/devicetree/bindings/arm/samsung/exynos-srom.txt
@@ -5,8 +5,25 @@  Required properties:
 
 - reg: offset and length of the register set
 
-Example:
+Bank configurations can be defined as an optional subnodes. They can have the
+following properties:
+- bank : bank number (0 - 3)
+- width : data width in bytes (1 or 2). If omitted, default of 1 is used.
+- srom-timing : array of 7 integers: Tacp, Tcah, Tcoh, Tacc, Tcos, Tacs
+
+Example: basic definition, no banks are configured
+	sromc@12570000 {
+		compatible = "samsung,exynos-srom";
+		reg = <0x12570000 0x10>;
+	};
+
+Example: SROMc with bank3 configuration
 	sromc@12570000 {
 		compatible = "samsung,exynos-srom";
 		reg = <0x12570000 0x10>;
+		bank@3 {
+			bank = <3>;
+			width = <2>;
+			srom-timing = <1 9 12 1 9 1 1>;
+		};
 	};