devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eddie James <eajames@linux.ibm.com>
To: linux-fsi@lists.ozlabs.org
Cc: eajames@linux.ibm.com, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, ninad@linux.ibm.com,
	lakshmiy@us.ibm.com, linux-i2c@vger.kernel.org,
	linux-spi@vger.kernel.org, linux-aspeed@lists.ozlabs.org,
	andrew@codeconstruct.com.au, joel@jms.id.au, robh@kernel.org,
	conor+dt@kernel.org, krzk+dt@kernel.org, andi.shyti@kernel.org,
	broonie@kernel.org
Subject: [PATCH v6 06/20] dt-bindings: fsi: Document the FSI controller common properties
Date: Wed, 22 May 2024 14:25:10 -0500	[thread overview]
Message-ID: <20240522192524.3286237-7-eajames@linux.ibm.com> (raw)
In-Reply-To: <20240522192524.3286237-1-eajames@linux.ibm.com>

Since there are multiple FSI controllers documented, the common
properties should be documented separately and then referenced
from the specific controller documentation. Add bus-frequency for
the FSI bus and CFAM local bus frequencies. Add interrupt
controller properties.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
---
Changes since v5:
 - Switch from clock-frequency to bus-frequency

 .../bindings/fsi/fsi-controller.yaml          | 66 +++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fsi/fsi-controller.yaml

diff --git a/Documentation/devicetree/bindings/fsi/fsi-controller.yaml b/Documentation/devicetree/bindings/fsi/fsi-controller.yaml
new file mode 100644
index 0000000000000..ffe191921b268
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/fsi-controller.yaml
@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fsi/fsi-controller.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: FSI Controller Common Properties
+
+maintainers:
+  - Eddie James <eajames@linux.ibm.com>
+
+description:
+  FSI (FRU (Field Replaceable Unit) Service Interface) is a two wire bus. The
+  FSI bus is connected to a CFAM (Common FRU Access Macro) which contains
+  various engines such as I2C controllers, SPI controllers, etc.
+
+properties:
+  "#address-cells":
+    const: 2
+
+  "#size-cells":
+    const: 0
+
+  '#interrupt-cells':
+    const: 1
+
+  bus-frequency:
+    minimum: 1
+    maximum: 200000000
+
+  interrupt-controller: true
+
+  no-scan-on-init:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      The FSI controller cannot scan the bus during initialization.
+
+patternProperties:
+  "cfam@[0-9a-f],[0-9a-f]":
+    type: object
+    properties:
+      chip-id:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description:
+          Processor index, a global unique chip ID which is used to identify
+          the physical location of the chip in a system specific way.
+
+      bus-frequency:
+        minimum: 1
+        maximum: 100000000
+
+      reg:
+        maxItems: 1
+
+      "#address-cells":
+        const: 1
+
+      "#size-cells":
+        const: 1
+
+    required:
+      - reg
+
+    additionalProperties: true
+
+additionalProperties: true
-- 
2.39.3


  parent reply	other threads:[~2024-05-22 19:26 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-22 19:25 [PATCH v6 00/20] ARM: dts: aspeed: Add IBM P11 BMC systems Eddie James
2024-05-22 19:25 ` [PATCH v6 01/20] spi: dt-bindings: Document the IBM FSI-attached SPI controller Eddie James
2024-05-22 19:25 ` [PATCH v6 02/20] dt-bindings: fsi: fsi2spi: Document SPI controller child nodes Eddie James
2024-05-22 19:25 ` [PATCH v6 03/20] dt-bindings: fsi: Document the IBM SCOM engine Eddie James
2024-05-23  9:28   ` Markus Elfring
2024-05-23  9:43     ` Conor Dooley
2024-05-23 11:05       ` [v6 " Markus Elfring
2024-05-22 19:25 ` [PATCH v6 04/20] dt-bindings: fsi: p9-occ: Convert to json-schema Eddie James
2024-05-23 15:37   ` Markus Elfring
2024-05-22 19:25 ` [PATCH v6 05/20] dt-bindings: fsi: Document the IBM SBEFIFO engine Eddie James
2024-05-23 15:55   ` Markus Elfring
2024-05-22 19:25 ` Eddie James [this message]
2024-05-23  6:57   ` [PATCH v6 06/20] dt-bindings: fsi: Document the FSI controller common properties Krzysztof Kozlowski
2024-05-22 19:25 ` [PATCH v6 07/20] dt-bindings: fsi: ibm,i2cr-fsi-master: Reference common FSI controller Eddie James
2024-05-22 19:25 ` [PATCH v6 08/20] dt-bindings: fsi: ast2600-fsi-master: Convert to json-schema Eddie James
2024-05-22 19:25 ` [PATCH v6 09/20] dt-bindings: fsi: Document the AST2700 FSI controller Eddie James
2024-05-22 19:25 ` [PATCH v6 10/20] dt-bindings: fsi: Document the FSI Hub Controller Eddie James
2024-05-22 19:25 ` [PATCH v6 11/20] dt-bindings: i2c: i2c-fsi: Convert to json-schema Eddie James
2024-05-23  6:59   ` Krzysztof Kozlowski
2024-05-28 14:52   ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 12/20] dt-bindings: arm: aspeed: add IBM P11 BMC boards Eddie James
2024-05-28 14:24   ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 13/20] ARM: dts: aspeed: Add IBM P11 FSI devices Eddie James
2024-05-22 19:25 ` [PATCH v6 14/20] ARM: dts: aspeed: Add IBM P11 Blueridge BMC system Eddie James
     [not found]   ` <dca4ac91-c18b-4271-a3f9-fbf3b5a3c43d@linux.ibm.com>
2024-05-28 14:50     ` Eddie James
2024-05-22 19:25 ` [PATCH v6 15/20] ARM: dts: aspeed: Add IBM P11 Blueridge 4U " Eddie James
2024-05-24 22:27   ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 16/20] ARM: dts: aspeed: Add IBM P11 Fuji " Eddie James
     [not found]   ` <3ac517f0-0394-4310-8840-d806de5ec082@linux.ibm.com>
2024-05-28 14:47     ` Eddie James
2024-05-22 19:25 ` [PATCH v6 17/20] ARM: dts: aspeed: Add IBM Huygens " Eddie James
2024-05-23 12:48   ` kernel test robot
2024-05-23 19:07     ` Eddie James
2024-05-23 18:45   ` Markus Elfring
2024-05-23 19:00     ` Eddie James
2024-05-23 19:30       ` [v6 " Markus Elfring
2024-05-23 19:33         ` Conor Dooley
2024-05-23 19:46           ` Markus Elfring
2024-05-23 20:33             ` Al Viro
2024-05-24  6:38               ` Markus Elfring
2024-05-23 20:24       ` [PATCH v6 " Krzysztof Kozlowski
2024-05-23 20:33         ` [v6 " Markus Elfring
2024-05-23 21:38   ` [PATCH v6 " Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 18/20] fsi: occ: Get device number from FSI minor number API Eddie James
2024-05-23 21:36   ` Ninad Palsule
2024-05-22 19:25 ` [PATCH v6 19/20] fsi: occ: Find next available child rather than node name match Eddie James
2024-05-22 19:25 ` [PATCH v6 20/20] fsi: scom: Update compatible string to match documentation Eddie James
2024-05-23 21:29   ` Ninad Palsule
2024-05-23 21:31   ` [PATCH v6 19/20] fsi: occ: Find next available child rather than node name match Ninad Palsule
2024-06-05 15:47 ` [PATCH v6 00/20] ARM: dts: aspeed: Add IBM P11 BMC systems Eddie James
2024-06-06  1:31   ` Andrew Jeffery
2024-07-08 13:47 ` Rob Herring

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240522192524.3286237-7-eajames@linux.ibm.com \
    --to=eajames@linux.ibm.com \
    --cc=andi.shyti@kernel.org \
    --cc=andrew@codeconstruct.com.au \
    --cc=broonie@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=joel@jms.id.au \
    --cc=krzk+dt@kernel.org \
    --cc=lakshmiy@us.ibm.com \
    --cc=linux-aspeed@lists.ozlabs.org \
    --cc=linux-fsi@lists.ozlabs.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-spi@vger.kernel.org \
    --cc=ninad@linux.ibm.com \
    --cc=robh@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).