diff mbox series

[v3,03/14] dt-bindings: fsi: Document the FSI2PIB engine

Message ID 20240425213701.655540-4-eajames@linux.ibm.com
State Not Applicable
Headers show
Series ARM: dts: aspeed: Add IBM P11 BMC Boards | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

Eddie James April 25, 2024, 9:36 p.m. UTC
The FSI2PIB or SCOM engine provides an interface to the POWER processor
PIB (Pervasive Interconnect Bus).

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
 .../devicetree/bindings/fsi/ibm,fsi2pib.yaml  | 38 +++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml

Comments

Krzysztof Kozlowski April 26, 2024, 6:17 a.m. UTC | #1
On 25/04/2024 23:36, Eddie James wrote:
> The FSI2PIB or SCOM engine provides an interface to the POWER processor
> PIB (Pervasive Interconnect Bus).
> 
> Signed-off-by: Eddie James <eajames@linux.ibm.com>
> ---


Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>


---

This is an automated instruction, just in case, because many review tags
are being ignored. If you know the process, you can skip it (please do
not feel offended by me posting it here - no bad intentions intended).
If you do not know the process, here is a short explanation:

Please add Acked-by/Reviewed-by/Tested-by tags when posting new
versions, under or above your Signed-off-by tag. Tag is "received", when
provided in a message replied to you on the mailing list. Tools like b4
can help here. However, there's no need to repost patches *only* to add
the tags. The upstream maintainer will do that for tags received on the
version they apply.

https://elixir.bootlin.com/linux/v6.5-rc3/source/Documentation/process/submitting-patches.rst#L577

Best regards,
Krzysztof
Krzysztof Kozlowski April 26, 2024, 6:18 a.m. UTC | #2
On 25/04/2024 23:36, Eddie James wrote:
> The FSI2PIB or SCOM engine provides an interface to the POWER processor
> PIB (Pervasive Interconnect Bus).
> 
> Signed-off-by: Eddie James <eajames@linux.ibm.com>
> ---
>  .../devicetree/bindings/fsi/ibm,fsi2pib.yaml  | 38 +++++++++++++++++++
>  1 file changed, 38 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
> 
> diff --git a/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
> new file mode 100644
> index 000000000000..4d557150c2e3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/fsi/ibm,fsi2pib.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: IBM FSI-attached SCOM engine
> +
> +maintainers:
> +  - Eddie James <eajames@linux.ibm.com>
> +
> +description:
> +  The SCOM engine is an interface to the POWER processor PIB (Pervasive
> +  Interconnect Bus). This node will always be a child of an FSI CFAM node;
> +  see fsi.txt for details on FSI slave and CFAM nodes.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ibm,fsi2pib
> +      - ibm,i2cr-scom

Sometimes you call these p9, sometimes p10... what is the system or SoC
here? Aren't you adding some generic compatibles? writing-bindings and
numerous guides are clear on that.

Best regards,
Krzysztof
Eddie James April 26, 2024, 3 p.m. UTC | #3
On 4/26/24 01:18, Krzysztof Kozlowski wrote:
> On 25/04/2024 23:36, Eddie James wrote:
>> The FSI2PIB or SCOM engine provides an interface to the POWER processor
>> PIB (Pervasive Interconnect Bus).
>>
>> Signed-off-by: Eddie James <eajames@linux.ibm.com>
>> ---
>>   .../devicetree/bindings/fsi/ibm,fsi2pib.yaml  | 38 +++++++++++++++++++
>>   1 file changed, 38 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>> new file mode 100644
>> index 000000000000..4d557150c2e3
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>> @@ -0,0 +1,38 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/fsi/ibm,fsi2pib.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: IBM FSI-attached SCOM engine
>> +
>> +maintainers:
>> +  - Eddie James <eajames@linux.ibm.com>
>> +
>> +description:
>> +  The SCOM engine is an interface to the POWER processor PIB (Pervasive
>> +  Interconnect Bus). This node will always be a child of an FSI CFAM node;
>> +  see fsi.txt for details on FSI slave and CFAM nodes.
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ibm,fsi2pib
>> +      - ibm,i2cr-scom
> Sometimes you call these p9, sometimes p10... what is the system or SoC
> here? Aren't you adding some generic compatibles? writing-bindings and
> numerous guides are clear on that.


Open source FSI support started with P9 chips so we initially added 
p9-sbefifo, p9-occ, etc. P10 has all of the same engines as P9 plus the 
SPI controller, so that's why SPI is p10-spi. P11 has the same engines 
as P10. For scom/fsi2pib we could call it p9-scom I suppose... This 
series isn't just documentation for a new system, I'm adding 
documentation that should have been added for P9. Anyway I'm not sure 
what you mean about generic compatibles? You mean just add a "scom" or 
"fsi2pib" compatible? writing-bindings says "DO make 'compatible' 
properties specific"


Thanks,

Eddie


>
> Best regards,
> Krzysztof
>
Krzysztof Kozlowski April 28, 2024, 4:41 p.m. UTC | #4
On 26/04/2024 17:00, Eddie James wrote:
> 
> On 4/26/24 01:18, Krzysztof Kozlowski wrote:
>> On 25/04/2024 23:36, Eddie James wrote:
>>> The FSI2PIB or SCOM engine provides an interface to the POWER processor
>>> PIB (Pervasive Interconnect Bus).
>>>
>>> Signed-off-by: Eddie James <eajames@linux.ibm.com>
>>> ---
>>>   .../devicetree/bindings/fsi/ibm,fsi2pib.yaml  | 38 +++++++++++++++++++
>>>   1 file changed, 38 insertions(+)
>>>   create mode 100644 Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>> new file mode 100644
>>> index 000000000000..4d557150c2e3
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>> @@ -0,0 +1,38 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/fsi/ibm,fsi2pib.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: IBM FSI-attached SCOM engine
>>> +
>>> +maintainers:
>>> +  - Eddie James <eajames@linux.ibm.com>
>>> +
>>> +description:
>>> +  The SCOM engine is an interface to the POWER processor PIB (Pervasive
>>> +  Interconnect Bus). This node will always be a child of an FSI CFAM node;
>>> +  see fsi.txt for details on FSI slave and CFAM nodes.
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - ibm,fsi2pib
>>> +      - ibm,i2cr-scom
>> Sometimes you call these p9, sometimes p10... what is the system or SoC
>> here? Aren't you adding some generic compatibles? writing-bindings and
>> numerous guides are clear on that.
> 
> 
> Open source FSI support started with P9 chips so we initially added 
> p9-sbefifo, p9-occ, etc. P10 has all of the same engines as P9 plus the 
> SPI controller, so that's why SPI is p10-spi. P11 has the same engines 
> as P10. For scom/fsi2pib we could call it p9-scom I suppose... This 
> series isn't just documentation for a new system, I'm adding 
> documentation that should have been added for P9. Anyway I'm not sure 
> what you mean about generic compatibles? You mean just add a "scom" or 
> "fsi2pib" compatible? writing-bindings says "DO make 'compatible' 
> properties specific"

Usually it means that parts of SoC must have the name of the SoC, as
first component of the name. Your boards are a bit different here,
because I suppose no one will ever make a product except you, but still
code could follow same set of rules.

Best regards,
Krzysztof
Eddie James April 29, 2024, 2:42 p.m. UTC | #5
On 4/28/24 11:41, Krzysztof Kozlowski wrote:
> On 26/04/2024 17:00, Eddie James wrote:
>> On 4/26/24 01:18, Krzysztof Kozlowski wrote:
>>> On 25/04/2024 23:36, Eddie James wrote:
>>>> The FSI2PIB or SCOM engine provides an interface to the POWER processor
>>>> PIB (Pervasive Interconnect Bus).
>>>>
>>>> Signed-off-by: Eddie James <eajames@linux.ibm.com>
>>>> ---
>>>>    .../devicetree/bindings/fsi/ibm,fsi2pib.yaml  | 38 +++++++++++++++++++
>>>>    1 file changed, 38 insertions(+)
>>>>    create mode 100644 Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>>> new file mode 100644
>>>> index 000000000000..4d557150c2e3
>>>> --- /dev/null
>>>> +++ b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
>>>> @@ -0,0 +1,38 @@
>>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>>> +%YAML 1.2
>>>> +---
>>>> +$id: http://devicetree.org/schemas/fsi/ibm,fsi2pib.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: IBM FSI-attached SCOM engine
>>>> +
>>>> +maintainers:
>>>> +  - Eddie James <eajames@linux.ibm.com>
>>>> +
>>>> +description:
>>>> +  The SCOM engine is an interface to the POWER processor PIB (Pervasive
>>>> +  Interconnect Bus). This node will always be a child of an FSI CFAM node;
>>>> +  see fsi.txt for details on FSI slave and CFAM nodes.
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    enum:
>>>> +      - ibm,fsi2pib
>>>> +      - ibm,i2cr-scom
>>> Sometimes you call these p9, sometimes p10... what is the system or SoC
>>> here? Aren't you adding some generic compatibles? writing-bindings and
>>> numerous guides are clear on that.
>>
>> Open source FSI support started with P9 chips so we initially added
>> p9-sbefifo, p9-occ, etc. P10 has all of the same engines as P9 plus the
>> SPI controller, so that's why SPI is p10-spi. P11 has the same engines
>> as P10. For scom/fsi2pib we could call it p9-scom I suppose... This
>> series isn't just documentation for a new system, I'm adding
>> documentation that should have been added for P9. Anyway I'm not sure
>> what you mean about generic compatibles? You mean just add a "scom" or
>> "fsi2pib" compatible? writing-bindings says "DO make 'compatible'
>> properties specific"
> Usually it means that parts of SoC must have the name of the SoC, as
> first component of the name. Your boards are a bit different here,
> because I suppose no one will ever make a product except you, but still
> code could follow same set of rules.


OK, this wasn't mentioned when fsi2spi binding was merged, and I thought 
to make fsi2pib the same. I can switch to p9-scom or something.


Thanks,

Eddie



>
> Best regards,
> Krzysztof
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
new file mode 100644
index 000000000000..4d557150c2e3
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/ibm,fsi2pib.yaml
@@ -0,0 +1,38 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fsi/ibm,fsi2pib.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: IBM FSI-attached SCOM engine
+
+maintainers:
+  - Eddie James <eajames@linux.ibm.com>
+
+description:
+  The SCOM engine is an interface to the POWER processor PIB (Pervasive
+  Interconnect Bus). This node will always be a child of an FSI CFAM node;
+  see fsi.txt for details on FSI slave and CFAM nodes.
+
+properties:
+  compatible:
+    enum:
+      - ibm,fsi2pib
+      - ibm,i2cr-scom
+
+  reg:
+    items:
+      - description: FSI slave address
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    scom@1000 {
+        compatible = "ibm,fsi2pib";
+        reg = <0x1000 0x400>;
+    };