diff mbox series

[v6,03/20] dt-bindings: fsi: Document the IBM SCOM engine

Message ID 20240522192524.3286237-4-eajames@linux.ibm.com (mailing list archive)
State Accepted
Commit 29aa58d5b14eda4a30fe7bc05f7348f8afe2453f
Headers show
Series ARM: dts: aspeed: Add IBM P11 BMC systems | expand

Commit Message

Eddie James May 22, 2024, 7:25 p.m. UTC
The 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>
---
 .../devicetree/bindings/fsi/ibm,p9-scom.yaml  | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fsi/ibm,p9-scom.yaml

Comments

Markus Elfring May 23, 2024, 9:28 a.m. UTC | #1
> The SCOM engine provides an interface to the POWER processor PIB
> (Pervasive Interconnect Bus).

Please improve this change description with a corresponding imperative wording.
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?h=v6.9#n94

Regards,
Markus
Conor Dooley May 23, 2024, 9:43 a.m. UTC | #2
On Thu, May 23, 2024 at 11:28:13AM +0200, Markus Elfring wrote:
> > The SCOM engine provides an interface to the POWER processor PIB
> > (Pervasive Interconnect Bus).
> 
> Please improve this change description with a corresponding imperative wording.
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?h=v6.9#n94

The tense used here is fine.
Markus Elfring May 23, 2024, 11:05 a.m. UTC | #3
>>> The SCOM engine provides an interface to the POWER processor PIB
>>> (Pervasive Interconnect Bus).
>>
>> Please improve this change description with a corresponding imperative wording.
>> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?h=v6.9#n94
>
> The tense used here is fine.

Is the imperative mood preferred for the final commit message (besides the summary phrase)?

Regards,
Markus
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/fsi/ibm,p9-scom.yaml b/Documentation/devicetree/bindings/fsi/ibm,p9-scom.yaml
new file mode 100644
index 0000000000000..8cd14a70bedf9
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/ibm,p9-scom.yaml
@@ -0,0 +1,37 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fsi/ibm,p9-scom.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.
+
+properties:
+  compatible:
+    enum:
+      - ibm,p9-scom
+      - ibm,i2cr-scom
+
+  reg:
+    items:
+      - description: FSI slave address
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    scom@1000 {
+        compatible = "ibm,p9-scom";
+        reg = <0x1000 0x400>;
+    };