summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/board/emulation/qemu-ppce500.rst5
-rw-r--r--doc/device-tree-bindings/fsp/fsp2/apollolake/fsp-s.txt19
-rw-r--r--doc/device-tree-bindings/net/fixed-link.txt48
-rw-r--r--doc/device-tree-bindings/net/fsl-tsec-phy.txt19
4 files changed, 69 insertions, 22 deletions
diff --git a/doc/board/emulation/qemu-ppce500.rst b/doc/board/emulation/qemu-ppce500.rst
index 0a5c86c61a..5de0aaf55d 100644
--- a/doc/board/emulation/qemu-ppce500.rst
+++ b/doc/board/emulation/qemu-ppce500.rst
@@ -70,6 +70,11 @@ interface at PCI address 0.1.0, but we can switch that to an e1000 NIC by::
$ qemu-system-ppc -nographic -machine ppce500 -bios u-boot \
-nic tap,ifname=tap0,script=no,downscript=no,model=e1000
+The QEMU ppce500 machine can also dynamically instantiate an eTSEC device if
+"-device eTSEC" is given to QEMU::
+
+ -netdev tap,ifname=tap0,script=no,downscript=no,id=net0 -device eTSEC,netdev=net0
+
VirtIO BLK driver is also enabled to support booting from a disk image where
a kernel image is stored. Append the following to QEMU::
diff --git a/doc/device-tree-bindings/fsp/fsp2/apollolake/fsp-s.txt b/doc/device-tree-bindings/fsp/fsp2/apollolake/fsp-s.txt
index b605ed0056..dc8e3251a3 100644
--- a/doc/device-tree-bindings/fsp/fsp2/apollolake/fsp-s.txt
+++ b/doc/device-tree-bindings/fsp/fsp2/apollolake/fsp-s.txt
@@ -258,19 +258,20 @@ Optional properties:
- fsps,pcie-rp-clk-req-detect: CLKREQ# Detection
- fsps,advanced-error-reportingt: Advanced Error Reporting
- fsps,pme-interrupt: PME Interrupt
-- fsps,fatal-error-report: URR
-- fsps,no-fatal-error-report: FER
-- fsps,correctable-error-report: NFER
-- fsps,system-error-on-fatal-error: CER
-- fsps,system-error-on-non-fatal-error: SEFE
-- fsps,system-error-on-correctable-error: SENFE
-- fsps,pcie-rp-speed: SECE
-- fsps,physical-slot-number: PCIe Speed
+- fsps,unsupported-request-report: URR
+- fsps,fatal-error-report: FER
+- fsps,no-fatal-error-report: NFER
+- fsps,correctable-error-report: CER
+- fsps,system-error-on-fatal-error: SEFE
+- fsps,system-error-on-non-fatal-error: SENFE
+- fsps,system-error-on-correctable-error: SECE
+- fsps,pcie-rp-speed: PCIe Speed
+- fsps,physical-slot-number: Physical Slot Number
0: Auto (default)
1: Gen1
2: Gen2
3: Gen3
-- fsps,pcie-rp-completion-timeout: Physical Slot Number
+- fsps,pcie-rp-completion-timeout: CTO
0x00, 0x01, 0x02, 0x03, 0x04, 0x05 (default)
- fsps,enable-ptm: PTM Support
- fsps,pcie-rp-aspm: ASPM
diff --git a/doc/device-tree-bindings/net/fixed-link.txt b/doc/device-tree-bindings/net/fixed-link.txt
index 5829bd81a2..5efeeb6fc5 100644
--- a/doc/device-tree-bindings/net/fixed-link.txt
+++ b/doc/device-tree-bindings/net/fixed-link.txt
@@ -5,21 +5,37 @@ Some Ethernet MACs have a "fixed link", and are not connected to a
normal MDIO-managed PHY device. For those situations, a Device Tree
binding allows to describe a "fixed link".
-Such a fixed link situation is described by creating a 'fixed-link'
-sub-node of the Ethernet MAC device node, with the following
-properties:
-
-* 'speed' (integer, mandatory), to indicate the link speed. Accepted
- values are 10, 100 and 1000
-* 'full-duplex' (boolean, optional), to indicate that full duplex is
- used. When absent, half duplex is assumed.
-* 'pause' (boolean, optional), to indicate that pause should be
- enabled.
-* 'asym-pause' (boolean, optional), to indicate that asym_pause should
- be enabled.
+Note there are two ways to describe a fixed PHY attached to an
+Ethernet device:
+
+- The new DT binding, where 'fixed-link' is a sub-node of the Ethernet
+ MAC device node, with the following properties:
+
+ * 'speed' (integer, mandatory), to indicate the link speed. Accepted
+ values are 10, 100 and 1000
+ * 'full-duplex' (boolean, optional), to indicate that full duplex is
+ used. When absent, half duplex is assumed.
+ * 'pause' (boolean, optional), to indicate that pause should be
+ enabled.
+ * 'asym-pause' (boolean, optional), to indicate that asym_pause should
+ be enabled.
+
+- The old DT binding, where 'fixed-link' is a property with 5 cells
+ encoding various information about the fixed PHY, in the form of
+ <phy_id, full-duplex, speed, pause, asym-pause>.
+
+ * 'phy_id', emulated PHY ID, choose any but unique to the all specified
+ fixed-links. Note U-Boot deliberately ignores the 'phy_id' and
+ unconditionally uses PHY_FIXED_ID.
+ * 'full-duplex', 0 for half duplex or 1 for full duplex
+ * 'speed', link speed in Mbits/sec, accepts only 10, 100 and 1000
+ * 'pause', 0 for no pause, 1 for pause
+ * 'asym-pause', 0 for no asymmetric pause, 1 for asymmetric pause
Examples:
+The new binding:
+
ethernet@0 {
...
fixed-link {
@@ -28,3 +44,11 @@ ethernet@0 {
};
...
};
+
+The old binding:
+
+ethernet@0 {
+ ...
+ fixed-link = <0 1 1000 0 0>;
+ ...
+};
diff --git a/doc/device-tree-bindings/net/fsl-tsec-phy.txt b/doc/device-tree-bindings/net/fsl-tsec-phy.txt
index a44c5fd9d9..f68980352b 100644
--- a/doc/device-tree-bindings/net/fsl-tsec-phy.txt
+++ b/doc/device-tree-bindings/net/fsl-tsec-phy.txt
@@ -3,12 +3,17 @@
Properties:
- compatible : Should be "fsl,etsec2" or "gianfar"
- - reg : Offset and length of the register set for the device
+ - reg : Offset and length of the register set for the device. If this is
+ missing, a subnode with a name prefix "queue-group" must be provided to
+ provide the <reg> property.
- phy-handle : See ethernet.txt file in the same directory.
- phy-connection-type : See ethernet.txt file in the same directory. This
property is only really needed if the connection is of type "rgmii-id",
"rgmii-rxid" and "rgmii-txid" as all other connection types are detected
by hardware.
+ - ranges : an <empty> value if subnode "queue-group" is present, specifying
+ that no address translation is required between them TSEC parent node and
+ the child "queue-group" node.
Example:
ethernet@24000 {
@@ -18,6 +23,18 @@ Example:
phy-connection-type = "sgmii";
};
+An alternate description with "queue-group" subnode example:
+ ethernet@24000 {
+ compatible = "fsl,etsec2";
+ phy-handle = <&phy0>;
+ phy-connection-type = "sgmii";
+ ranges;
+
+ queue-group {
+ reg = <0x24000 0x1000>;
+ };
+ };
+
Child nodes of the TSEC controller are typically the individual PHY devices
connected via the MDIO bus (sometimes the MDIO bus controller is separate).