linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 1/1] dt-bindings: net: convert qca,qca7000.txt yaml format
@ 2025-06-02 22:44 Frank Li
  2025-06-03  0:45 ` Jakub Kicinski
  2025-06-06 13:28 ` Rob Herring
  0 siblings, 2 replies; 3+ messages in thread
From: Frank Li @ 2025-06-02 22:44 UTC (permalink / raw)
  To: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Rob Herring, Krzysztof Kozlowski, Conor Dooley,
	Stefan Wahren, open list:NETWORKING DRIVERS,
	open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS,
	open list
  Cc: imx

Convert qca,qca7000.txt yaml format.

Additional changes:
- add refs: spi-peripheral-props.yaml, serial-peripheral-props.yaml and
  ethernet-controller.yaml.
- simple spi and uart node name.
- use low case for mac address in examples.
- add check reg choose spi-peripheral-props.yaml or
  spi-peripheral-props.yaml.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
change in v2
- add Ethernet over UART" description here back
- add add check reg choose spi-peripheral-props.yaml
- move spi related properties in if-then branch
- move uart related properies in if-else branch
---
 .../devicetree/bindings/net/qca,qca7000.txt   |  87 ---------------
 .../devicetree/bindings/net/qca,qca7000.yaml  | 104 ++++++++++++++++++
 MAINTAINERS                                   |   2 +-
 3 files changed, 105 insertions(+), 88 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/net/qca,qca7000.txt
 create mode 100644 Documentation/devicetree/bindings/net/qca,qca7000.yaml

diff --git a/Documentation/devicetree/bindings/net/qca,qca7000.txt b/Documentation/devicetree/bindings/net/qca,qca7000.txt
deleted file mode 100644
index 8f5ae0b84eec2..0000000000000
--- a/Documentation/devicetree/bindings/net/qca,qca7000.txt
+++ /dev/null
@@ -1,87 +0,0 @@
-* Qualcomm QCA7000
-
-The QCA7000 is a serial-to-powerline bridge with a host interface which could
-be configured either as SPI or UART slave. This configuration is done by
-the QCA7000 firmware.
-
-(a) Ethernet over SPI
-
-In order to use the QCA7000 as SPI device it must be defined as a child of a
-SPI master in the device tree.
-
-Required properties:
-- compatible	    : Should be "qca,qca7000"
-- reg		    : Should specify the SPI chip select
-- interrupts	    : The first cell should specify the index of the source
-		      interrupt and the second cell should specify the trigger
-		      type as rising edge
-- spi-cpha	    : Must be set
-- spi-cpol	    : Must be set
-
-Optional properties:
-- spi-max-frequency : Maximum frequency of the SPI bus the chip can operate at.
-		      Numbers smaller than 1000000 or greater than 16000000
-		      are invalid. Missing the property will set the SPI
-		      frequency to 8000000 Hertz.
-- qca,legacy-mode   : Set the SPI data transfer of the QCA7000 to legacy mode.
-		      In this mode the SPI master must toggle the chip select
-		      between each data word. In burst mode these gaps aren't
-		      necessary, which is faster. This setting depends on how
-		      the QCA7000 is setup via GPIO pin strapping. If the
-		      property is missing the driver defaults to burst mode.
-
-The MAC address will be determined using the optional properties
-defined in ethernet.txt.
-
-SPI Example:
-
-/* Freescale i.MX28 SPI master*/
-ssp2: spi@80014000 {
-	#address-cells = <1>;
-	#size-cells = <0>;
-	compatible = "fsl,imx28-spi";
-	pinctrl-names = "default";
-	pinctrl-0 = <&spi2_pins_a>;
-
-	qca7000: ethernet@0 {
-		compatible = "qca,qca7000";
-		reg = <0x0>;
-		interrupt-parent = <&gpio3>;      /* GPIO Bank 3 */
-		interrupts = <25 0x1>;            /* Index: 25, rising edge */
-		spi-cpha;                         /* SPI mode: CPHA=1 */
-		spi-cpol;                         /* SPI mode: CPOL=1 */
-		spi-max-frequency = <8000000>;    /* freq: 8 MHz */
-		local-mac-address = [ A0 B0 C0 D0 E0 F0 ];
-	};
-};
-
-(b) Ethernet over UART
-
-In order to use the QCA7000 as UART slave it must be defined as a child of a
-UART master in the device tree. It is possible to preconfigure the UART
-settings of the QCA7000 firmware, but it's not possible to change them during
-runtime.
-
-Required properties:
-- compatible        : Should be "qca,qca7000"
-
-Optional properties:
-- local-mac-address : see ./ethernet.txt
-- current-speed     : current baud rate of QCA7000 which defaults to 115200
-		      if absent, see also ../serial/serial.yaml
-
-UART Example:
-
-/* Freescale i.MX28 UART */
-auart0: serial@8006a000 {
-	compatible = "fsl,imx28-auart", "fsl,imx23-auart";
-	reg = <0x8006a000 0x2000>;
-	pinctrl-names = "default";
-	pinctrl-0 = <&auart0_2pins_a>;
-
-	qca7000: ethernet {
-		compatible = "qca,qca7000";
-		local-mac-address = [ A0 B0 C0 D0 E0 F0 ];
-		current-speed = <38400>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/net/qca,qca7000.yaml b/Documentation/devicetree/bindings/net/qca,qca7000.yaml
new file mode 100644
index 0000000000000..5258288132968
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/qca,qca7000.yaml
@@ -0,0 +1,104 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/qca,qca7000.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm QCA7000
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+description: |
+  The QCA7000 is a serial-to-powerline bridge with a host interface which could
+  be configured either as SPI or UART slave. This configuration is done by
+  the QCA7000 firmware.
+
+  (a) Ethernet over SPI
+
+  In order to use the QCA7000 as SPI device it must be defined as a child of a
+  SPI master in the device tree.
+
+  (b) Ethernet over UART
+
+  In order to use the QCA7000 as UART slave it must be defined as a child of a
+  UART master in the device tree. It is possible to preconfigure the UART
+  settings of the QCA7000 firmware, but it's not possible to change them during
+  runtime
+
+properties:
+  compatible:
+    const: qca,qca7000
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+if:
+  required:
+    - reg
+
+then:
+  properties:
+    spi-cpha: true
+
+    spi-cpol: true
+
+    spi-max-frequency:
+      default: 8000000
+      maximum: 16000000
+      minimum: 1000000
+
+    qca,legacy-mode:
+      $ref: /schemas/types.yaml#/definitions/flag
+      description:
+        Set the SPI data transfer of the QCA7000 to legacy mode.
+        In this mode the SPI master must toggle the chip select
+        between each data word. In burst mode these gaps aren't
+        necessary, which is faster. This setting depends on how
+        the QCA7000 is setup via GPIO pin strapping. If the
+        property is missing the driver defaults to burst mode.
+
+  allOf:
+    - $ref: /schemas/spi/spi-peripheral-props.yaml#
+    - $ref: ethernet-controller.yaml#
+
+else:
+  properties:
+    current-speed:
+      default: 115200
+
+  allOf:
+    - $ref: /schemas/serial/serial-peripheral-props.yaml#
+    - $ref: ethernet-controller.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        ethernet@0 {
+            compatible = "qca,qca7000";
+            reg = <0x0>;
+            interrupt-parent = <&gpio3>;      /* GPIO Bank 3 */
+            interrupts = <25 0x1>;            /* Index: 25, rising edge */
+            spi-cpha;                         /* SPI mode: CPHA=1 */
+            spi-cpol;                         /* SPI mode: CPOL=1 */
+            spi-max-frequency = <8000000>;    /* freq: 8 MHz */
+            local-mac-address = [ a0 b0 c0 d0 e0 f0 ];
+        };
+    };
+
+  - |
+    serial {
+        ethernet {
+            compatible = "qca,qca7000";
+            local-mac-address = [ a0 b0 c0 d0 e0 f0 ];
+            current-speed = <38400>;
+        };
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index c14da518a214c..6416ada9900af 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -20295,7 +20295,7 @@ QUALCOMM ATHEROS QCA7K ETHERNET DRIVER
 M:	Stefan Wahren <wahrenst@gmx.net>
 L:	netdev@vger.kernel.org
 S:	Maintained
-F:	Documentation/devicetree/bindings/net/qca,qca7000.txt
+F:	Documentation/devicetree/bindings/net/qca,qca7000.yaml
 F:	drivers/net/ethernet/qualcomm/qca*
 
 QUALCOMM BAM-DMUX WWAN NETWORK DRIVER
-- 
2.34.1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH v2 1/1] dt-bindings: net: convert qca,qca7000.txt yaml format
  2025-06-02 22:44 [PATCH v2 1/1] dt-bindings: net: convert qca,qca7000.txt yaml format Frank Li
@ 2025-06-03  0:45 ` Jakub Kicinski
  2025-06-06 13:28 ` Rob Herring
  1 sibling, 0 replies; 3+ messages in thread
From: Jakub Kicinski @ 2025-06-03  0:45 UTC (permalink / raw)
  To: Frank Li
  Cc: Andrew Lunn, David S. Miller, Eric Dumazet, Paolo Abeni,
	Rob Herring, Krzysztof Kozlowski, Conor Dooley, Stefan Wahren,
	open list:NETWORKING DRIVERS,
	open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS,
	open list, imx

On Mon,  2 Jun 2025 18:44:01 -0400 Frank Li wrote:
> Convert qca,qca7000.txt yaml format.
> 
> Additional changes:
> - add refs: spi-peripheral-props.yaml, serial-peripheral-props.yaml and
>   ethernet-controller.yaml.
> - simple spi and uart node name.
> - use low case for mac address in examples.
> - add check reg choose spi-peripheral-props.yaml or
>   spi-peripheral-props.yaml.

## Form letter - net-next-closed

Linus has already merged our PR with features for v6.16.
net-next is closed for new drivers, features, code refactoring and
optimizations for the remained for the merge window.

Please repost when net-next reopens after June 9th.

RFC patches sent for review only are obviously welcome at any time.

See: https://www.kernel.org/doc/html/next/process/maintainer-netdev.html#development-cycle
-- 
pw-bot: defer
pv-bot: closed

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2 1/1] dt-bindings: net: convert qca,qca7000.txt yaml format
  2025-06-02 22:44 [PATCH v2 1/1] dt-bindings: net: convert qca,qca7000.txt yaml format Frank Li
  2025-06-03  0:45 ` Jakub Kicinski
@ 2025-06-06 13:28 ` Rob Herring
  1 sibling, 0 replies; 3+ messages in thread
From: Rob Herring @ 2025-06-06 13:28 UTC (permalink / raw)
  To: Frank Li
  Cc: Andrew Lunn, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Krzysztof Kozlowski, Conor Dooley, Stefan Wahren,
	open list:NETWORKING DRIVERS,
	open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS,
	open list, imx

On Mon, Jun 02, 2025 at 06:44:01PM -0400, Frank Li wrote:
> Convert qca,qca7000.txt yaml format.
> 
> Additional changes:
> - add refs: spi-peripheral-props.yaml, serial-peripheral-props.yaml and
>   ethernet-controller.yaml.
> - simple spi and uart node name.
> - use low case for mac address in examples.
> - add check reg choose spi-peripheral-props.yaml or
>   spi-peripheral-props.yaml.
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> change in v2
> - add Ethernet over UART" description here back
> - add add check reg choose spi-peripheral-props.yaml
> - move spi related properties in if-then branch
> - move uart related properies in if-else branch
> ---
>  .../devicetree/bindings/net/qca,qca7000.txt   |  87 ---------------
>  .../devicetree/bindings/net/qca,qca7000.yaml  | 104 ++++++++++++++++++
>  MAINTAINERS                                   |   2 +-
>  3 files changed, 105 insertions(+), 88 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/net/qca,qca7000.txt
>  create mode 100644 Documentation/devicetree/bindings/net/qca,qca7000.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/qca,qca7000.txt b/Documentation/devicetree/bindings/net/qca,qca7000.txt
> deleted file mode 100644
> index 8f5ae0b84eec2..0000000000000
> --- a/Documentation/devicetree/bindings/net/qca,qca7000.txt
> +++ /dev/null
> @@ -1,87 +0,0 @@
> -* Qualcomm QCA7000
> -
> -The QCA7000 is a serial-to-powerline bridge with a host interface which could
> -be configured either as SPI or UART slave. This configuration is done by
> -the QCA7000 firmware.
> -
> -(a) Ethernet over SPI
> -
> -In order to use the QCA7000 as SPI device it must be defined as a child of a
> -SPI master in the device tree.
> -
> -Required properties:
> -- compatible	    : Should be "qca,qca7000"
> -- reg		    : Should specify the SPI chip select
> -- interrupts	    : The first cell should specify the index of the source
> -		      interrupt and the second cell should specify the trigger
> -		      type as rising edge
> -- spi-cpha	    : Must be set
> -- spi-cpol	    : Must be set
> -
> -Optional properties:
> -- spi-max-frequency : Maximum frequency of the SPI bus the chip can operate at.
> -		      Numbers smaller than 1000000 or greater than 16000000
> -		      are invalid. Missing the property will set the SPI
> -		      frequency to 8000000 Hertz.
> -- qca,legacy-mode   : Set the SPI data transfer of the QCA7000 to legacy mode.
> -		      In this mode the SPI master must toggle the chip select
> -		      between each data word. In burst mode these gaps aren't
> -		      necessary, which is faster. This setting depends on how
> -		      the QCA7000 is setup via GPIO pin strapping. If the
> -		      property is missing the driver defaults to burst mode.
> -
> -The MAC address will be determined using the optional properties
> -defined in ethernet.txt.
> -
> -SPI Example:
> -
> -/* Freescale i.MX28 SPI master*/
> -ssp2: spi@80014000 {
> -	#address-cells = <1>;
> -	#size-cells = <0>;
> -	compatible = "fsl,imx28-spi";
> -	pinctrl-names = "default";
> -	pinctrl-0 = <&spi2_pins_a>;
> -
> -	qca7000: ethernet@0 {
> -		compatible = "qca,qca7000";
> -		reg = <0x0>;
> -		interrupt-parent = <&gpio3>;      /* GPIO Bank 3 */
> -		interrupts = <25 0x1>;            /* Index: 25, rising edge */
> -		spi-cpha;                         /* SPI mode: CPHA=1 */
> -		spi-cpol;                         /* SPI mode: CPOL=1 */
> -		spi-max-frequency = <8000000>;    /* freq: 8 MHz */
> -		local-mac-address = [ A0 B0 C0 D0 E0 F0 ];
> -	};
> -};
> -
> -(b) Ethernet over UART
> -
> -In order to use the QCA7000 as UART slave it must be defined as a child of a
> -UART master in the device tree. It is possible to preconfigure the UART
> -settings of the QCA7000 firmware, but it's not possible to change them during
> -runtime.
> -
> -Required properties:
> -- compatible        : Should be "qca,qca7000"
> -
> -Optional properties:
> -- local-mac-address : see ./ethernet.txt
> -- current-speed     : current baud rate of QCA7000 which defaults to 115200
> -		      if absent, see also ../serial/serial.yaml
> -
> -UART Example:
> -
> -/* Freescale i.MX28 UART */
> -auart0: serial@8006a000 {
> -	compatible = "fsl,imx28-auart", "fsl,imx23-auart";
> -	reg = <0x8006a000 0x2000>;
> -	pinctrl-names = "default";
> -	pinctrl-0 = <&auart0_2pins_a>;
> -
> -	qca7000: ethernet {
> -		compatible = "qca,qca7000";
> -		local-mac-address = [ A0 B0 C0 D0 E0 F0 ];
> -		current-speed = <38400>;
> -	};
> -};
> diff --git a/Documentation/devicetree/bindings/net/qca,qca7000.yaml b/Documentation/devicetree/bindings/net/qca,qca7000.yaml
> new file mode 100644
> index 0000000000000..5258288132968
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/qca,qca7000.yaml
> @@ -0,0 +1,104 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/qca,qca7000.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm QCA7000
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +description: |
> +  The QCA7000 is a serial-to-powerline bridge with a host interface which could
> +  be configured either as SPI or UART slave. This configuration is done by
> +  the QCA7000 firmware.
> +
> +  (a) Ethernet over SPI
> +
> +  In order to use the QCA7000 as SPI device it must be defined as a child of a
> +  SPI master in the device tree.
> +
> +  (b) Ethernet over UART
> +
> +  In order to use the QCA7000 as UART slave it must be defined as a child of a
> +  UART master in the device tree. It is possible to preconfigure the UART
> +  settings of the QCA7000 firmware, but it's not possible to change them during
> +  runtime
> +
> +properties:
> +  compatible:
> +    const: qca,qca7000
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +if:
> +  required:
> +    - reg
> +
> +then:
> +  properties:
> +    spi-cpha: true
> +
> +    spi-cpol: true
> +
> +    spi-max-frequency:
> +      default: 8000000
> +      maximum: 16000000
> +      minimum: 1000000
> +
> +    qca,legacy-mode:
> +      $ref: /schemas/types.yaml#/definitions/flag
> +      description:
> +        Set the SPI data transfer of the QCA7000 to legacy mode.
> +        In this mode the SPI master must toggle the chip select
> +        between each data word. In burst mode these gaps aren't
> +        necessary, which is faster. This setting depends on how
> +        the QCA7000 is setup via GPIO pin strapping. If the
> +        property is missing the driver defaults to burst mode.
> +
> +  allOf:
> +    - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +    - $ref: ethernet-controller.yaml#

ethernet-controller.yaml should be moved out of the 'if' schemas.

> +
> +else:
> +  properties:
> +    current-speed:
> +      default: 115200
> +
> +  allOf:
> +    - $ref: /schemas/serial/serial-peripheral-props.yaml#
> +    - $ref: ethernet-controller.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        ethernet@0 {
> +            compatible = "qca,qca7000";
> +            reg = <0x0>;
> +            interrupt-parent = <&gpio3>;      /* GPIO Bank 3 */
> +            interrupts = <25 0x1>;            /* Index: 25, rising edge */
> +            spi-cpha;                         /* SPI mode: CPHA=1 */
> +            spi-cpol;                         /* SPI mode: CPOL=1 */
> +            spi-max-frequency = <8000000>;    /* freq: 8 MHz */
> +            local-mac-address = [ a0 b0 c0 d0 e0 f0 ];
> +        };
> +    };
> +
> +  - |
> +    serial {
> +        ethernet {
> +            compatible = "qca,qca7000";
> +            local-mac-address = [ a0 b0 c0 d0 e0 f0 ];
> +            current-speed = <38400>;
> +        };
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index c14da518a214c..6416ada9900af 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -20295,7 +20295,7 @@ QUALCOMM ATHEROS QCA7K ETHERNET DRIVER
>  M:	Stefan Wahren <wahrenst@gmx.net>
>  L:	netdev@vger.kernel.org
>  S:	Maintained
> -F:	Documentation/devicetree/bindings/net/qca,qca7000.txt
> +F:	Documentation/devicetree/bindings/net/qca,qca7000.yaml
>  F:	drivers/net/ethernet/qualcomm/qca*
>  
>  QUALCOMM BAM-DMUX WWAN NETWORK DRIVER
> -- 
> 2.34.1
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-06-06 13:28 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-06-02 22:44 [PATCH v2 1/1] dt-bindings: net: convert qca,qca7000.txt yaml format Frank Li
2025-06-03  0:45 ` Jakub Kicinski
2025-06-06 13:28 ` Rob Herring

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).