[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20240425213701.655540-7-eajames@linux.ibm.com>
Date: Thu, 25 Apr 2024 16:36:53 -0500
From: Eddie James <eajames@...ux.ibm.com>
To: linux-aspeed@...ts.ozlabs.org
Cc: eajames@...ux.ibm.com, devicetree@...r.kernel.org,
linux-kernel@...r.kernel.org, linux-fsi@...ts.ozlabs.org,
linux-spi@...r.kernel.org, linux-i2c@...r.kernel.org,
lakshmiy@...ibm.com, robh@...nel.org, krzk+dt@...nel.org,
conor+dt@...nel.org, joel@....id.au, andrew@...econstruct.com.au
Subject: [PATCH v3 06/14] dt-bindings: fsi: Document the FSI controller common properties
Since there are multiple FSI controllers documented, the common
properties should be documented separately and then referenced
from the specific controller documentation.
Signed-off-by: Eddie James <eajames@...ux.ibm.com>
---
.../bindings/fsi/fsi-controller.yaml | 65 +++++++++++++++++++
1 file changed, 65 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 000000000000..9e917295996d
--- /dev/null
+++ b/Documentation/devicetree/bindings/fsi/fsi-controller.yaml
@@ -0,0 +1,65 @@
+# 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@...ux.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
+
+ 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
+
+ reg:
+ maxItems: 1
+
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 1
+
+ required:
+ - reg
+
+ additionalProperties: true
+
+additionalProperties: true
+
+examples:
+ - |
+ fsi@...0 {
+ #address-cells = <2>;
+ #size-cells = <0>;
+ compatible = "fsi-controller";
+ reg = <0x3400 0x400>;
+
+ cfam@0,0 {
+ #address-cells = <1>;
+ #size-cells = <1>;
+ reg = <0 0>;
+ };
+ };
--
2.39.3
Powered by blists - more mailing lists