diff mbox

[8/8] ftgmac100: Document device-tree binding

Message ID 20170412224443.17906-9-benh@kernel.crashing.org
State Changes Requested, archived
Delegated to: David Miller
Headers show

Commit Message

Benjamin Herrenschmidt April 12, 2017, 10:44 p.m. UTC
Signed-off-by: Benjamin Herrenschmidt <benh@kernel.crashing.org>
---
 .../devicetree/bindings/net/ftgmac100.txt          | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/ftgmac100.txt

Comments

Andrew Lunn April 13, 2017, 1:42 p.m. UTC | #1
> +- phy-mode: See ethernet.txt file in the same directory. If the property is
> +  absent, "rgmii" is assumed. Supported values are "rgmii" and "rmii"

You might want to say rgmii*, or similar, it indicate the delayed
versions are accepted as well.

	 Andrew
Benjamin Herrenschmidt April 13, 2017, 1:58 p.m. UTC | #2
On Thu, 2017-04-13 at 15:42 +0200, Andrew Lunn wrote:
> > +- phy-mode: See ethernet.txt file in the same directory. If the
> > property is
> > +  absent, "rgmii" is assumed. Supported values are "rgmii" and
> > "rmii"
> 
> You might want to say rgmii*, or similar, it indicate the delayed
> versions are accepted as well.

You are right. I originally didn't accept them, then fixed that
up in the code but forgot to update the binding.

Dave, if that's the only issue, I'd rather send a separate later
tomorrow or so patch to amend the binding rather than send the whole
series all over again as this is rather a minor detail.

Cheers,
Ben.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/net/ftgmac100.txt b/Documentation/devicetree/bindings/net/ftgmac100.txt
new file mode 100644
index 0000000..68a694a
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/ftgmac100.txt
@@ -0,0 +1,36 @@ 
+* Faraday Technology FTGMAC100 gigabit ethernet controller
+
+Required properties:
+- compatible: "faraday,ftgmac100"
+
+  Must also contain one of these if used as part of an Aspeed AST2400
+  or 2500 family SoC as they have some subtle tweaks to the
+  implementation:
+
+     - "aspeed,ast2400-mac"
+     - "aspeed,ast2500-mac"
+
+- reg: Address and length of the register set for the device
+- interrupts: Should contain ethernet controller interrupt
+
+Optional properties:
+- phy-mode: See ethernet.txt file in the same directory. If the property is
+  absent, "rgmii" is assumed. Supported values are "rgmii" and "rmii"
+- use-ncsi: Use the NC-SI stack instead of an MDIO PHY. Currently assumes
+  rmii (100bT) but kept as a separate property in case NC-SI grows support
+  for a gigabit link.
+- no-hw-checksum: Used to disable HW checksum support. Here for backward
+  compatibility as the driver now should have correct defaults based on
+  the SoC.
+
+Example:
+
+	mac0: ethernet@1e660000 {
+		compatible = "aspeed,ast2500-mac", "faraday,ftgmac100";
+		reg = <0x1e660000 0x180>;
+		interrupts = <2>;
+		status = "okay";
+		use-ncsi;
+	};
+
+