Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
To:     Mark Brown <broonie@kernel.org>, Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Cc:     linux-spi@vger.kernel.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
Subject: [PATCH 1/2] dt-bindings: spi: Add Socionext F_OSPI controller bindings
Date:   Fri, 18 Nov 2022 09:59:03 +0900
Message-Id: <20221118005904.23557-2-hayashi.kunihiko@socionext.com>
In-Reply-To: <20221118005904.23557-1-hayashi.kunihiko@socionext.com>
References: <20221118005904.23557-1-hayashi.kunihiko@socionext.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Add devicetree binding documentation for Socionext F_OSPI SPI flash
controller.

Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
---
 .../bindings/spi/socionext,f-ospi.yaml        | 99 +++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/socionext,f-ospi.yaml

diff --git a/Documentation/devicetree/bindings/spi/socionext,f-ospi.yaml b/Documentation/devicetree/bindings/spi/socionext,f-ospi.yaml
new file mode 100644
index 000000000000..f52cac9ee9f8
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/socionext,f-ospi.yaml
@@ -0,0 +1,99 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/spi/socionext,f-ospi.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Socionext F_OSPI controller
+
+description: |
+  The Socionext F_OSPI is a controller used to interface with flash
+  memories using the SPI communication interface.
+
+maintainers:
+  - Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
+
+allOf:
+  - $ref: "spi-controller.yaml#"
+
+properties:
+  compatible:
+    const: socionext,f-ospi
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  num-cs:
+    minimum: 1
+    maximum: 4
+
+  socionext,cs-start-cycle:
+    description:
+      Specifies the number of SPI_CLK cycles between CS assertion and
+      command transfer.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    maximum: 15
+
+  socionext,cs-end-cycle:
+    description:
+      Specify the number of SPI_CLK cycles between data transfer and
+      CS deassertion.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    maximum: 15
+
+  socionext,cs-deassert-clk-cycle:
+    description:
+      Specify the number of SPI_CLK cycles to output while CS is deasserted.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    maximum: 15
+
+  socionext,alternative-byte:
+    description:
+      Specify the extra bytes to transfer after address transfer.
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    items:
+      - description: the number of bytes to transfer
+        maximum: 4
+      - description: value to transfer
+        default: 0
+      - description: bit-width to transfer
+        enum: [0, 1, 2, 4, 8]
+
+  socionext,data-swap-2byte:
+    description:
+      Indicates swap byte order per 2-bytes.
+    type: boolean
+
+  socionext,data-swap-4byte:
+    description:
+      Indicates swap byte order per 4-bytes.
+    type: boolean
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - "#address-cells"
+  - "#size-cells"
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    ospi0: spi@80000000 {
+        compatible = "socionext,f-ospi";
+        reg = <0x80000000 0x1000>;
+        clocks = <&clks 0>;
+        num-cs = <1>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        flash@0 {
+            compatible = "spansion,s25fl128s", "jedec,spi-nor";
+            reg = <0>;
+            spi-max-frequency = <50000000>;
+        };
+    };
-- 
2.25.1