diff mbox series

[v3,09/14] dt-bindings: fsi: Document the FSI Hub Controller

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

Commit Message

Eddie James April 25, 2024, 9:36 p.m. UTC 
Document the FSI Hub Controller CFAM engine.

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

Comments

Eddie James April 26, 2024, 3:19 p.m. UTC | #1 
On 4/26/24 01:26, Krzysztof Kozlowski wrote:
> On 25/04/2024 23:36, Eddie James wrote:
>> Document the FSI Hub Controller CFAM engine.
>>
>> Signed-off-by: Eddie James <eajames@linux.ibm.com>
>> ---
>>   .../bindings/fsi/ibm,hub-fsi-controller.yaml  | 44 +++++++++++++++++++
>>   1 file changed, 44 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml b/Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml
>> new file mode 100644
>> index 000000000000..d96d777d4d9f
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml
>> @@ -0,0 +1,44 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/fsi/ibm,hub-fsi-controller.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: IBM FSI-attached FSI Hub Controller
>> +
>> +maintainers:
>> +  - Eddie James <eajames@linux.ibm.com>
>> +
>> +description: |
> Do not need '|' unless you need to preserve formatting.


Ack.


>
>> +  The FSI Hub Controller is an FSI controller, providing a number of FSI links,
>> +  located on a CFAM. Therefore this node will always be a child of an FSI CFAM
>> +  node.
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ibm,hub-fsi-controller
> Again, is it for specific chip? SoC? Aren't you using generic
> compatibles (not allowed)?


This one is fairly universally supported on FSI (any POWER chip will 
have it) so I didn't add a specific chip... Should i? Do you mean 
generic compatibles are not allowed? How generic do you mean?


>
>
>
> Best regards,
> Krzysztof
>
Krzysztof Kozlowski April 28, 2024, 4:43 p.m. UTC | #2 
On 26/04/2024 17:19, Eddie James wrote:
>>
>>> +  The FSI Hub Controller is an FSI controller, providing a number of FSI links,
>>> +  located on a CFAM. Therefore this node will always be a child of an FSI CFAM
>>> +  node.
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - ibm,hub-fsi-controller
>> Again, is it for specific chip? SoC? Aren't you using generic
>> compatibles (not allowed)?
> 
> 
> This one is fairly universally supported on FSI (any POWER chip will 
> have it) so I didn't add a specific chip... Should i? Do you mean 
> generic compatibles are not allowed? How generic do you mean?

Maybe IBM is different here, but for every regular SoC the blocks of
that SoC should carry SoC model name/number.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml b/Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml
new file mode 100644
index 000000000000..d96d777d4d9f
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/ibm,hub-fsi-controller.yaml
@@ -0,0 +1,44 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fsi/ibm,hub-fsi-controller.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: IBM FSI-attached FSI Hub Controller
+
+maintainers:
+  - Eddie James <eajames@linux.ibm.com>
+
+description: |
+  The FSI Hub Controller is an FSI controller, providing a number of FSI links,
+  located on a CFAM. Therefore this node will always be a child of an FSI CFAM
+  node.
+
+properties:
+  compatible:
+    enum:
+      - ibm,hub-fsi-controller
+
+  reg:
+    items:
+      - description: FSI slave address
+
+allOf:
+  - $ref: fsi-controller.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+   fsi@3400 {
+        #address-cells = <2>;
+        #size-cells = <0>;
+        compatible = "ibm,hub-fsi-controller";
+        reg = <0x3400 0x400>;
+
+        cfam@0,0 {
+            #address-cells = <1>;
+            #size-cells = <1>;
+            reg = <0 0>;
+        };
+    };