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;
Date:   Mon, 21 Feb 2022 14:53:51 +0100
From:   Daniel Kestrel <kestrelseventyfour@gmail.com>
Cc:     Bjorn Andersson <bjorn.andersson@linaro.org>,
        Mathieu Poirier <mathieu.poirier@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Daniel Kestrel <kestrelseventyfour@gmail.com>,
        linux-remoteproc@vger.kernel.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: [PATCH 2/3] dt-bindings: remoteproc: Add AVM WASP
Message-ID: <20220221135351.GA7342@ubuntu>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.9.4 (2018-02-28)
To:     unlisted-recipients:; (no To-header on input)
Precedence: bulk

AVM Fritzbox router boards may contain an additional ATH79
based SoC that has the wifi cards connected.
This patch adds bindings for this remote processor.

Signed-off-by: Daniel Kestrel <kestrelseventyfour@gmail.com>
---
 .../bindings/remoteproc/avm,wasp-rproc.yaml   | 93 +++++++++++++++++++
 1 file changed, 93 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/remoteproc/avm,wasp-rproc.yaml

diff --git a/Documentation/devicetree/bindings/remoteproc/avm,wasp-rproc.yaml b/Documentation/devicetree/bindings/remoteproc/avm,wasp-rproc.yaml
new file mode 100644
index 000000000000..21f3bbcc4202
--- /dev/null
+++ b/Documentation/devicetree/bindings/remoteproc/avm,wasp-rproc.yaml
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/remoteproc/avm,wasp-rproc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AVM WASP processor controller bindings
+
+maintainers:
+  - Daniel Kestrel <kestrelseventyfour@gmail.com>
+
+description: |
+  This document defines the bindings for the remoteproc component that loads and
+  boots firmwares on the AVM Wireless Assistent Support Processor (WASP) SoC
+  that is attached to some AVM Fritzbox devices (3390, 3490, 5490, 5491, 7490).
+
+properties:
+  compatible:
+    const: avm,wasp
+
+  ath9k-firmware:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: |
+      Should contain the name of the ath9k eeprom that is to be loaded from
+      the lantiq host flash. Wifi on the WASP SoC does not work without it.
+      The file should be located on the firmware search path.
+
+  ath10k-caldata:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: |
+      Should contain the name of the ath10k caldata that is to be loaded from
+      the lantiq host flash. Wifi on the WASP SoC does not work without it.
+      The file should be located on the firmware search path.
+
+  wasp-netboot-firmware:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: |
+      Should contain the name of the netboot firmware that is to be loaded
+      and started on the WASP SoC using mdio in order to be able to load
+      the initramfs image as a second stage.
+      The file should be located on the firmware search path.
+
+  wasp-netboot-mdio:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: Reference to the Lantiq GSWIP switch mdio.
+
+  wasp-initramfs-port:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: Reference to the network port, where the WASP SoC is connected to.
+
+  wasp-initramfs-image:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: |
+      Should contain the name of the initramfs linux image that is to be loaded
+      and started on the WASP SoC.
+      The file should be located on the firmware search path.
+
+  reset-gpio:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description: Reference and parameters for the reset gpio of the WASP SoC.
+
+  startup-gpio:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description: Reference and parameters for the power switch gpio of the WASP SoC.
+
+required:
+  - compatible
+  - ath9k-firmware
+  - ath10k-caldata
+  - wasp-netboot-firmware
+  - wasp-netboot-mdio
+  - wasp-initramfs-port
+  - wasp-initramfs-image
+  - reset-gpio
+  - startup-gpio
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    avm-wasp {
+        compatible = "avm,wasp";
+        ath9k-firmware = "ath9k-eeprom-ahb-18100000.wmac.bin";
+        ath10k-caldata = "ath10k/cal-pci-0000:00:00.0.bin";
+        wasp-netboot-firmware = "netboot.fw";
+        wasp-netboot-mdio = <&gswip_mdio>;
+        wasp-initramfs-port = <&port5>;
+        wasp-initramfs-image = "avm_fritzx490-wasp-initramfs-kernel.bin";
+        reset-gpio = <&gpio 34 GPIO_ACTIVE_HIGH>;
+        startup-gpio = <&gpio 5 GPIO_ACTIVE_HIGH>;
+    };
-- 
2.17.1