[PATCH v2 1/1] dt-bindings: net: wireless: convert marvel-8xxx.txt to yaml format

[PATCH v2 1/1] dt-bindings: net: wireless: convert marvel-8xxx.txt to yaml format

[Frank Li]

Convert binding doc marvel-8xxx.txt to yaml format.
Additional change:
- Remove marvell,caldata_00_txpwrlimit_2g_cfg_set in example.
- Remove mmc related property in example.
- Add wakeup-source property.
- Remove vmmc-supply and mmc-pwrseq.

Fix below warning:
arch/arm64/boot/dts/freescale/imx8mp-beacon-kit.dtb: /soc@0/bus@30800000/mmc@30b40000/wifi@1:
failed to match any schema with compatible: ['marvell,sd8997']

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
Change from v1 to v2
- Add Brian Norris <briannorris@chromium.org as maintainer
- Remove vmmc-supply and mmc-pwrseq
- Add wakeup-source
- rename to marvell,sd8787.yaml by using one compatible string, suggestted
by conor dooley at other binding doc convert review
---
 .../bindings/net/wireless/marvell,sd8787.yaml | 93 +++++++++++++++++++
 .../bindings/net/wireless/marvell-8xxx.txt    | 70 --------------
 2 files changed, 93 insertions(+), 70 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
 delete mode 100644 Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt

diff --git a/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml b/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
new file mode 100644
index 0000000000000..c6647672b7b1e
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/wireless/marvell,sd8787.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell 8787/8897/8978/8997 (sd8787/sd8897/sd8978/sd8997/pcie8997) SDIO/PCIE devices
+
+maintainers:
+  - Brian Norris <briannorris@chromium.org>
+  - Frank Li <Frank.Li@nxp.com>
+
+description:
+  This node provides properties for describing the Marvell SDIO/PCIE wireless device.
+  The node is expected to be specified as a child node to the SDIO/PCIE controller that
+  connects the device to the system.
+
+properties:
+  compatible:
+    enum:
+      - marvell,sd8787
+      - marvell,sd8897
+      - marvell,sd8978
+      - marvell,sd8997
+      - nxp,iw416
+      - pci11ab,2b42
+      - pci1b4b,2b42
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  wakeup-source: true
+
+  marvell,caldata-txpwrlimit-2g:
+    $ref: /schemas/types.yaml#/definitions/uint8-array
+    description: Calibration data for the 2GHz band.
+    maxItems: 566
+
+  marvell,caldata-txpwrlimit-5g-sub0:
+    $ref: /schemas/types.yaml#/definitions/uint8-array
+    description: Calibration data for sub-band 0 in the 5GHz band..
+    maxItems: 502
+
+  marvell,caldata-txpwrlimit-5g-sub1:
+    $ref: /schemas/types.yaml#/definitions/uint8-array
+    description: Calibration data for sub-band 1 in the 5GHz band..
+    maxItems: 688
+
+  marvell,caldata-txpwrlimit-5g-sub2:
+    $ref: /schemas/types.yaml#/definitions/uint8-array
+    description: Calibration data for sub-band 2 in the 5GHz band..
+    maxItems: 750
+
+  marvell,caldata-txpwrlimit-5g-sub3:
+    $ref: /schemas/types.yaml#/definitions/uint8-array
+    description: Calibration data for sub-band 3 in the 5GHz band.
+    maxItems: 502
+
+  marvell,wakeup-pin:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Provides the pin number for the wakeup pin from the device's point of
+      view. The wakeup pin is used for the device to wake the host system
+      from sleep. This property is only necessary if the wakeup pin is
+      wired in a non-standard way, such that the default pin assignments
+      are invalid.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    mmc {
+         #address-cells = <1>;
+         #size-cells = <0>;
+
+         wifi@1 {
+             compatible = "marvell,sd8897";
+             reg = <1>;
+             interrupt-parent = <&pio>;
+             interrupts = <38 IRQ_TYPE_LEVEL_LOW>;
+             marvell,wakeup-pin = <3>;
+        };
+    };
+
diff --git a/Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt b/Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt
deleted file mode 100644
index cdc303caf5f45..0000000000000
--- a/Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt
+++ /dev/null
@@ -1,70 +0,0 @@
-Marvell 8787/8897/8978/8997 (sd8787/sd8897/sd8978/sd8997/pcie8997) SDIO/PCIE devices
-------
-
-This node provides properties for controlling the Marvell SDIO/PCIE wireless device.
-The node is expected to be specified as a child node to the SDIO/PCIE controller that
-connects the device to the system.
-
-Required properties:
-
-  - compatible : should be one of the following:
-	* "marvell,sd8787"
-	* "marvell,sd8897"
-	* "marvell,sd8978"
-	* "marvell,sd8997"
-	* "nxp,iw416"
-	* "pci11ab,2b42"
-	* "pci1b4b,2b42"
-
-Optional properties:
-
-  - marvell,caldata* : A series of properties with marvell,caldata prefix,
-		      represent calibration data downloaded to the device during
-		      initialization. This is an array of unsigned 8-bit values.
-		      the properties should follow below property name and
-		      corresponding array length:
-	"marvell,caldata-txpwrlimit-2g" (length = 566).
-	"marvell,caldata-txpwrlimit-5g-sub0" (length = 502).
-	"marvell,caldata-txpwrlimit-5g-sub1" (length = 688).
-	"marvell,caldata-txpwrlimit-5g-sub2" (length = 750).
-	"marvell,caldata-txpwrlimit-5g-sub3" (length = 502).
-  - marvell,wakeup-pin : a wakeup pin number of wifi chip which will be configured
-		      to firmware. Firmware will wakeup the host using this pin
-		      during suspend/resume.
-  - interrupts : interrupt pin number to the cpu. driver will request an irq based on
-		 this interrupt number. during system suspend, the irq will be enabled
-		 so that the wifi chip can wakeup host platform under certain condition.
-		 during system resume, the irq will be disabled to make sure
-		 unnecessary interrupt is not received.
-  - vmmc-supply: a phandle of a regulator, supplying VCC to the card
-  - mmc-pwrseq:  phandle to the MMC power sequence node. See "mmc-pwrseq-*"
-		 for documentation of MMC power sequence bindings.
-
-Example:
-
-Tx power limit calibration data is configured in below example.
-The calibration data is an array of unsigned values, the length
-can vary between hw versions.
-IRQ pin 38 is used as system wakeup source interrupt. wakeup pin 3 is configured
-so that firmware can wakeup host using this device side pin.
-
-&mmc3 {
-	vmmc-supply = <&wlan_en_reg>;
-	mmc-pwrseq = <&wifi_pwrseq>;
-	bus-width = <4>;
-	cap-power-off-card;
-	keep-power-in-suspend;
-
-	#address-cells = <1>;
-	#size-cells = <0>;
-	mwifiex: wifi@1 {
-		compatible = "marvell,sd8897";
-		reg = <1>;
-		interrupt-parent = <&pio>;
-		interrupts = <38 IRQ_TYPE_LEVEL_LOW>;
-
-		marvell,caldata_00_txpwrlimit_2g_cfg_set = /bits/ 8 <
-	0x01 0x00 0x06 0x00 0x08 0x02 0x89 0x01>;
-		marvell,wakeup-pin = <3>;
-	};
-};
-- 
2.34.1

Re: [PATCH v2 1/1] dt-bindings: net: wireless: convert marvel-8xxx.txt to yaml format

[Rob Herring (Arm)]

On Fri, 16 Aug 2024 13:12:01 -0400, Frank Li wrote:
> Convert binding doc marvel-8xxx.txt to yaml format.
> Additional change:
> - Remove marvell,caldata_00_txpwrlimit_2g_cfg_set in example.
> - Remove mmc related property in example.
> - Add wakeup-source property.
> - Remove vmmc-supply and mmc-pwrseq.
> 
> Fix below warning:
> arch/arm64/boot/dts/freescale/imx8mp-beacon-kit.dtb: /soc@0/bus@30800000/mmc@30b40000/wifi@1:
> failed to match any schema with compatible: ['marvell,sd8997']
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> Change from v1 to v2
> - Add Brian Norris <briannorris@chromium.org as maintainer
> - Remove vmmc-supply and mmc-pwrseq
> - Add wakeup-source
> - rename to marvell,sd8787.yaml by using one compatible string, suggestted
> by conor dooley at other binding doc convert review
> ---
>  .../bindings/net/wireless/marvell,sd8787.yaml | 93 +++++++++++++++++++
>  .../bindings/net/wireless/marvell-8xxx.txt    | 70 --------------
>  2 files changed, 93 insertions(+), 70 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
>  delete mode 100644 Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>

Re: [PATCH v2 1/1] dt-bindings: net: wireless: convert marvel-8xxx.txt to yaml format

[Brian Norris]

Hi Frank,

On Fri, Aug 16, 2024 at 01:12:01PM -0400, Frank Li wrote:
> Convert binding doc marvel-8xxx.txt to yaml format.
> Additional change:
> - Remove marvell,caldata_00_txpwrlimit_2g_cfg_set in example.
> - Remove mmc related property in example.
> - Add wakeup-source property.
> - Remove vmmc-supply and mmc-pwrseq.
> 
> Fix below warning:
> arch/arm64/boot/dts/freescale/imx8mp-beacon-kit.dtb: /soc@0/bus@30800000/mmc@30b40000/wifi@1:
> failed to match any schema with compatible: ['marvell,sd8997']
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> Change from v1 to v2
> - Add Brian Norris <briannorris@chromium.org as maintainer
> - Remove vmmc-supply and mmc-pwrseq
> - Add wakeup-source
> - rename to marvell,sd8787.yaml by using one compatible string, suggestted
> by conor dooley at other binding doc convert review
> ---
>  .../bindings/net/wireless/marvell,sd8787.yaml | 93 +++++++++++++++++++
>  .../bindings/net/wireless/marvell-8xxx.txt    | 70 --------------
>  2 files changed, 93 insertions(+), 70 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
>  delete mode 100644 Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt
> 
> diff --git a/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml b/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
> new file mode 100644
> index 0000000000000..c6647672b7b1e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
> @@ -0,0 +1,93 @@

> +  marvell,caldata-txpwrlimit-5g-sub0:
> +    $ref: /schemas/types.yaml#/definitions/uint8-array
> +    description: Calibration data for sub-band 0 in the 5GHz band..

You have an extra period in this line.

> +  marvell,caldata-txpwrlimit-5g-sub1:
> +    $ref: /schemas/types.yaml#/definitions/uint8-array
> +    description: Calibration data for sub-band 1 in the 5GHz band..

Same.

> +    maxItems: 688
> +
> +  marvell,caldata-txpwrlimit-5g-sub2:
> +    $ref: /schemas/types.yaml#/definitions/uint8-array
> +    description: Calibration data for sub-band 2 in the 5GHz band..

Same.

Otherwise, this looks good to me, so feel free to carry my:

Acked-by: Brian Norris <briannorris@chromium.org>

(Sometimes Kalle will make trivial fixes like this when applying. I'm
not sure if that means you should send v3 anyway, or see if he'll apply
this on his own soon enough.)

Brian

Re: [PATCH v2 1/1] dt-bindings: net: wireless: convert marvel-8xxx.txt to yaml format

[Kalle Valo]

Brian Norris <briannorris@chromium.org> writes:

> Hi Frank,
>
> On Fri, Aug 16, 2024 at 01:12:01PM -0400, Frank Li wrote:
>> Convert binding doc marvel-8xxx.txt to yaml format.
>> Additional change:
>> - Remove marvell,caldata_00_txpwrlimit_2g_cfg_set in example.
>> - Remove mmc related property in example.
>> - Add wakeup-source property.
>> - Remove vmmc-supply and mmc-pwrseq.
>> 
>> Fix below warning:
>> arch/arm64/boot/dts/freescale/imx8mp-beacon-kit.dtb: /soc@0/bus@30800000/mmc@30b40000/wifi@1:
>> failed to match any schema with compatible: ['marvell,sd8997']
>> 
>> Signed-off-by: Frank Li <Frank.Li@nxp.com>
>> ---
>> Change from v1 to v2
>> - Add Brian Norris <briannorris@chromium.org as maintainer
>> - Remove vmmc-supply and mmc-pwrseq
>> - Add wakeup-source
>> - rename to marvell,sd8787.yaml by using one compatible string, suggestted
>> by conor dooley at other binding doc convert review
>> ---
>>  .../bindings/net/wireless/marvell,sd8787.yaml | 93 +++++++++++++++++++
>>  .../bindings/net/wireless/marvell-8xxx.txt    | 70 --------------
>>  2 files changed, 93 insertions(+), 70 deletions(-)
>>  create mode 100644 Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
>>  delete mode 100644 Documentation/devicetree/bindings/net/wireless/marvell-8xxx.txt
>> 
>> diff --git a/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml b/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
>> new file mode 100644
>> index 0000000000000..c6647672b7b1e
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/wireless/marvell,sd8787.yaml
>> @@ -0,0 +1,93 @@
>
>> +  marvell,caldata-txpwrlimit-5g-sub0:
>> +    $ref: /schemas/types.yaml#/definitions/uint8-array
>> +    description: Calibration data for sub-band 0 in the 5GHz band..
>
> You have an extra period in this line.
>
>> +  marvell,caldata-txpwrlimit-5g-sub1:
>> +    $ref: /schemas/types.yaml#/definitions/uint8-array
>> +    description: Calibration data for sub-band 1 in the 5GHz band..
>
> Same.
>
>> +    maxItems: 688
>> +
>> +  marvell,caldata-txpwrlimit-5g-sub2:
>> +    $ref: /schemas/types.yaml#/definitions/uint8-array
>> +    description: Calibration data for sub-band 2 in the 5GHz band..
>
> Same.
>
> Otherwise, this looks good to me, so feel free to carry my:
>
> Acked-by: Brian Norris <briannorris@chromium.org>
>
> (Sometimes Kalle will make trivial fixes like this when applying. I'm
> not sure if that means you should send v3 anyway, or see if he'll apply
> this on his own soon enough.)

For wireless-next patches I can easily edit commit messages but not the
actual patch, so please send v3.

-- 
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches