[v3,1/3] dt-bindings: net: add qca,ar71xx.txt documentation
diff mbox series

Message ID 20190422064046.2822-2-o.rempel@pengutronix.de
State Changes Requested
Headers show
Series
  • MIPS: ath79: add ag71xx support
Related show

Checks

Context Check Description
robh/checkpatch success

Commit Message

Oleksij Rempel April 22, 2019, 6:40 a.m. UTC
Add binding documentation for Atheros/QCA networking IP core used
in many routers.

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
 .../devicetree/bindings/net/qca,ar71xx.txt    | 44 +++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/qca,ar71xx.txt

Comments

Rob Herring April 30, 2019, 10:51 p.m. UTC | #1
On Mon, Apr 22, 2019 at 08:40:44AM +0200, Oleksij Rempel wrote:
> Add binding documentation for Atheros/QCA networking IP core used
> in many routers.
> 
> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> ---
>  .../devicetree/bindings/net/qca,ar71xx.txt    | 44 +++++++++++++++++++
>  1 file changed, 44 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/qca,ar71xx.txt
> 
> diff --git a/Documentation/devicetree/bindings/net/qca,ar71xx.txt b/Documentation/devicetree/bindings/net/qca,ar71xx.txt
> new file mode 100644
> index 000000000000..56abf224de2c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/qca,ar71xx.txt
> @@ -0,0 +1,44 @@

Needs some title and info about what this h/w is.

> +Required properties:
> +- compatible:	Should be "qca,<soc>-eth". Currently support compatibles are:
> +		qca,ar7100-eth - Atheros AR7100
> +		qca,ar7240-eth - Atheros AR7240
> +		qca,ar7241-eth - Atheros AR7241
> +		qca,ar7242-eth - Atheros AR7242
> +		qca,ar9130-eth - Atheros AR9130
> +		qca,ar9330-eth - Atheros AR9330
> +		qca,ar9340-eth - Atheros AR9340
> +		qca,qca9530-eth - Qualcomm Atheros QCA9530
> +		qca,qca9550-eth - Qualcomm Atheros QCA9550
> +		qca,qca9560-eth - Qualcomm Atheros QCA9560
> +
> +- reg : Address and length of the register set for the device
> +- interrupts : Should contain eth interrupt
> +- phy-mode : See ethernet.txt file in the same directory

Is there a subset of valid modes?

> +- clocks: the clock used by the core
> +- clock-names: the names of the clock listed in the clocks property. These are
> +	"mdio".

Seems strange that's the only clock.

> +- resets: Should contain phandles to the reset signals
> +- reset-names: Should contain the names of reset signal listed in the resets
> +		property. These are "mac" and "mdio"
> +
> +Optional properties:
> +- phy-handle : phandle to the PHY device connected to this device.
> +- fixed-link : Assume a fixed link. See fixed-link.txt in the same directory.
> +  Use instead of phy-handle.
> +
> +Optional subnodes:
> +- mdio : specifies the mdio bus, used as a container for phy nodes
> +  according to phy.txt in the same directory
> +
> +Example:
> +
> +ethernet@1a000000 {
> +	compatible = "qca,ar9330-eth";
> +	reg = <0x1a000000 0x200>;
> +	interrupts = <5>;
> +	resets = <&rst 13>, <&rst 23>;
> +	reset-names = "mac", "mdio";
> +	clocks = <&pll ATH79_CLK_MDIO>;
> +	clock-names = "mdio";
> +	phy-mode = "gmii";
> +};
> -- 
> 2.20.1
>

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/net/qca,ar71xx.txt b/Documentation/devicetree/bindings/net/qca,ar71xx.txt
new file mode 100644
index 000000000000..56abf224de2c
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/qca,ar71xx.txt
@@ -0,0 +1,44 @@ 
+Required properties:
+- compatible:	Should be "qca,<soc>-eth". Currently support compatibles are:
+		qca,ar7100-eth - Atheros AR7100
+		qca,ar7240-eth - Atheros AR7240
+		qca,ar7241-eth - Atheros AR7241
+		qca,ar7242-eth - Atheros AR7242
+		qca,ar9130-eth - Atheros AR9130
+		qca,ar9330-eth - Atheros AR9330
+		qca,ar9340-eth - Atheros AR9340
+		qca,qca9530-eth - Qualcomm Atheros QCA9530
+		qca,qca9550-eth - Qualcomm Atheros QCA9550
+		qca,qca9560-eth - Qualcomm Atheros QCA9560
+
+- reg : Address and length of the register set for the device
+- interrupts : Should contain eth interrupt
+- phy-mode : See ethernet.txt file in the same directory
+- clocks: the clock used by the core
+- clock-names: the names of the clock listed in the clocks property. These are
+	"mdio".
+- resets: Should contain phandles to the reset signals
+- reset-names: Should contain the names of reset signal listed in the resets
+		property. These are "mac" and "mdio"
+
+Optional properties:
+- phy-handle : phandle to the PHY device connected to this device.
+- fixed-link : Assume a fixed link. See fixed-link.txt in the same directory.
+  Use instead of phy-handle.
+
+Optional subnodes:
+- mdio : specifies the mdio bus, used as a container for phy nodes
+  according to phy.txt in the same directory
+
+Example:
+
+ethernet@1a000000 {
+	compatible = "qca,ar9330-eth";
+	reg = <0x1a000000 0x200>;
+	interrupts = <5>;
+	resets = <&rst 13>, <&rst 23>;
+	reset-names = "mac", "mdio";
+	clocks = <&pll ATH79_CLK_MDIO>;
+	clock-names = "mdio";
+	phy-mode = "gmii";
+};