Received-SPF: pass (google.com: domain of linux-kernel+bounces-43594-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Charles Perry <charles.perry@savoirfairelinux.com>
To: mdf@kernel.org
Cc: hao.wu@intel.com,
	yilun.xu@intel.com,
	trix@redhat.com,
	krzysztof.kozlowski+dt@linaro.org,
	bcody@markem-imaje.com,
	avandiver@markem-imaje.com,
	linux-fpga@vger.kernel.org,
	devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Charles Perry <charles.perry@savoirfairelinux.com>
Subject: [PATCH 2/3] dt-bindings: fpga: xlnx,fpga-slave-selectmap: add DT schema
Date: Mon, 29 Jan 2024 17:56:01 -0500
Message-ID: <20240129225602.3832449-2-charles.perry@savoirfairelinux.com>
In-Reply-To: <20240129225602.3832449-1-charles.perry@savoirfairelinux.com>
References: <20240129225602.3832449-1-charles.perry@savoirfairelinux.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Document the slave SelectMAP interface of Xilinx 7 series FPGA.

Signed-off-by: Charles Perry <charles.perry@savoirfairelinux.com>
---
 .../fpga/xlnx,fpga-slave-selectmap.yaml       | 85 +++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fpga/xlnx,fpga-slav=
e-selectmap.yaml

diff --git a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-selec=
tmap.yaml b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-select=
map.yaml
new file mode 100644
index 0000000000000..20cea24e3e39a
--- /dev/null
+++ b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-selectmap.ya=
ml
@@ -0,0 +1,85 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/fpga/xlnx,fpga-slave-selectmap.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx Slave SelectMAP FPGA
+
+description: |
+  Xilinx 7 Series FPGAs support a method of loading the bitstream over a
+  parallel port named the slave SelectMAP interface in the documentation=
 Only
+  the x8 mode is supported where data is loaded at one byte per rising e=
dge of
+  the clock, with the MSB of each byte presented to the D0 pin.
+
+  Datasheets:
+    https://www.xilinx.com/support/documentation/user_guides/ug470_7Seri=
es_Config.pdf
+
+properties:
+  compatible:
+    enum:
+      - xlnx,fpga-slave-selectmap
+
+  reg:
+    description:
+      At least 1 byte of memory mapped IO
+    maxItems: 1
+
+  prog_b-gpios:
+    description:
+      config pin (referred to as PROGRAM_B in the manual)
+    maxItems: 1
+
+  done-gpios:
+    description:
+      config status pin (referred to as DONE in the manual)
+    maxItems: 1
+
+  init-b-gpios:
+    description:
+      initialization status and configuration error pin
+      (referred to as INIT_B in the manual)
+    maxItems: 1
+
+  csi-b-gpios:
+    description:
+      chip select pin (referred to as CSI_B in the manual)
+      Optional gpio for if the bus controller does not provide a chip se=
lect.
+    maxItems: 1
+
+  rdwr-b-gpios:
+    description:
+      read/write select pin (referred to as RDWR_B in the manual)
+      Optional gpio for if the bus controller does not provide this pin.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - prog_b-gpios
+  - done-gpios
+  - init-b-gpios
+
+additionalProperties: true
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    &weim {
+      status =3D "okay";
+      ranges =3D <0 0 0x08000000 0x04000000>;
+
+      fpga_mgr: fpga_programmer@0,0 {
+        compatible =3D "xlnx,fpga-slave-selectmap";
+        reg =3D <0 0 0x4000000>;
+        fsl,weim-cs-timing =3D <0x00070031 0x00000142
+              0x00020000 0x00000000
+              0x0c000645 0x00000000>;
+        prog_b-gpios =3D <&gpio5 5 GPIO_ACTIVE_LOW>;
+        init-b-gpios =3D <&gpio5 8 GPIO_ACTIVE_LOW>;
+        done-gpios =3D <&gpio2 30 GPIO_ACTIVE_HIGH>;
+        csi-b-gpios =3D <&gpio3 19 GPIO_ACTIVE_LOW>;
+        rdwr-b-gpios =3D <&gpio3 10 GPIO_ACTIVE_LOW>;
+      };
+    };
+...
--=20
2.43.0