diff mbox

[1/3] Documentation: Update the APM X-Gene SoC EDAC DTS binding for missing RB

Message ID 1452639900-30919-2-git-send-email-lho@apm.com (mailing list archive)
State New, archived
Headers show

Commit Message

Loc Ho Jan. 12, 2016, 11:04 p.m. UTC
This patch updates the APM X-Gene SoC EDAC documentation binding to
reference the missing register bus for the the SoC EDAC.

Signed-off-by: Loc Ho <lho@apm.com>
---
 .../devicetree/bindings/edac/apm-xgene-edac.txt    |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

Comments

Arnd Bergmann Jan. 12, 2016, 11:07 p.m. UTC | #1
On Tuesday 12 January 2016 16:04:58 Loc Ho wrote:
> --- a/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
> +++ b/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
> @@ -16,6 +16,7 @@ Required properties:
>  - regmap-mcba          : Regmap of the MCB-A (memory bridge) resource.
>  - regmap-mcbb          : Regmap of the MCB-B (memory bridge) resource.
>  - regmap-efuse         : Regmap of the PMD efuse resource.
> +- regmap-rb            : Regmap of the register bus resource.
>  - reg                  : First resource shall be the CPU bus (PCP) resource.
>  - interrupts            : Interrupt-specifier for MCU, PMD, L3, or SoC error
>                           IRQ(s).
> @@ -64,6 +65,11 @@ Example:
>                 reg = <0x0 0x1054a000 0x0 0x20>;
>         };
>  
> +       rb: rb@7e000000 {
> +               compatible = "apm,xgene-rb", "syscon";
> +               reg = <0x0 0x7e000000 0x0 0x10>;
> +       };
> +
>         edac@78800000 {
>                 compatible = "apm,xgene-edac";
> 

When you add a property, please list that as "optional", not "required",
to ensure that the old dtb files still conform to the binding.

In the driver, make sure it is not a fatal error when the property is
missing and the driver can keep working without it.

	Arnd
Loc Ho Jan. 12, 2016, 11:24 p.m. UTC | #2
Hi Arnd,

>> --- a/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
>> +++ b/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
>> @@ -16,6 +16,7 @@ Required properties:
>>  - regmap-mcba          : Regmap of the MCB-A (memory bridge) resource.
>>  - regmap-mcbb          : Regmap of the MCB-B (memory bridge) resource.
>>  - regmap-efuse         : Regmap of the PMD efuse resource.
>> +- regmap-rb            : Regmap of the register bus resource.
>>  - reg                  : First resource shall be the CPU bus (PCP) resource.
>>  - interrupts            : Interrupt-specifier for MCU, PMD, L3, or SoC error
>>                           IRQ(s).
>> @@ -64,6 +65,11 @@ Example:
>>                 reg = <0x0 0x1054a000 0x0 0x20>;
>>         };
>>
>> +       rb: rb@7e000000 {
>> +               compatible = "apm,xgene-rb", "syscon";
>> +               reg = <0x0 0x7e000000 0x0 0x10>;
>> +       };
>> +
>>         edac@78800000 {
>>                 compatible = "apm,xgene-edac";
>>
>
> When you add a property, please list that as "optional", not "required",
> to ensure that the old dtb files still conform to the binding.
>
> In the driver, make sure it is not a fatal error when the property is
> missing and the driver can keep working without it.

From my view, this is required. Otherwise, the error condition will
NOT be cleared correctly and will get constant interrupt. Though, for
compatibility, we can make it optional but system will be unusable
should such error occurred. Though, it would be rare or with bad FW. I
will fix in the next version by making it optional such as it will
still probe correctly with older DT binding.

-Loc
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt b/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
index 78e2a31..6e66f99 100644
--- a/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
+++ b/Documentation/devicetree/bindings/edac/apm-xgene-edac.txt
@@ -16,6 +16,7 @@  Required properties:
 - regmap-mcba		: Regmap of the MCB-A (memory bridge) resource.
 - regmap-mcbb		: Regmap of the MCB-B (memory bridge) resource.
 - regmap-efuse		: Regmap of the PMD efuse resource.
+- regmap-rb		: Regmap of the register bus resource.
 - reg			: First resource shall be the CPU bus (PCP) resource.
 - interrupts            : Interrupt-specifier for MCU, PMD, L3, or SoC error
 			  IRQ(s).
@@ -64,6 +65,11 @@  Example:
 		reg = <0x0 0x1054a000 0x0 0x20>;
 	};
 
+	rb: rb@7e000000 {
+		compatible = "apm,xgene-rb", "syscon";
+		reg = <0x0 0x7e000000 0x0 0x10>;
+	};
+
 	edac@78800000 {
 		compatible = "apm,xgene-edac";
 		#address-cells = <2>;
@@ -73,6 +79,7 @@  Example:
 		regmap-mcba = <&mcba>;
 		regmap-mcbb = <&mcbb>;
 		regmap-efuse = <&efuse>;
+		regmap-rb = <&rb>;
 		reg = <0x0 0x78800000 0x0 0x100>;
 		interrupts = <0x0 0x20 0x4>,
 			     <0x0 0x21 0x4>,