linux/Documentation/devicetree/bindings
Martin Blumenstingl e5f3a4a56c Documentation: devicetree: clarify usage of the RGMII phy-modes
RGMII requires special RX and/or TX delays depending on the actual
hardware circuit/wiring. These delays can be added by the MAC, the PHY
or the designer of the circuit (the latter means that no delay has to
be added by PHY or MAC).
There are 4 RGMII phy-modes used describe where a delay should be
applied:
- rgmii: the RX and TX delays are either added by the MAC (where the
  exact delay is typically configurable, and can be turned off when no
  extra delay is needed) or not needed at all (because the hardware
  wiring adds the delay already). The PHY should neither add the RX nor
  TX delay in this case.
- rgmii-rxid: configures the PHY to enable the RX delay. The MAC should
  not add the RX delay in this case.
- rgmii-txid: configures the PHY to enable the TX delay. The MAC should
  not add the TX delay in this case.
- rgmii-id: combines rgmii-rxid and rgmii-txid and thus configures the
  PHY to enable the RX and TX delays. The MAC should neither add the RX
  nor TX delay in this case.

Document these cases in the ethernet.txt documentation to make it clear
when to use each mode.
If applied incorrectly one might end up with MAC and PHY both enabling
for example the TX delay, which breaks ethernet TX traffic on 1000Mbit/s
links.

Signed-off-by: Martin Blumenstingl <martin.blumenstingl@googlemail.com>
Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
2016-11-28 12:06:54 -05:00
..
arc
arm ARM: SoC: late DT updates for v4.9 2016-10-07 21:34:49 -07:00
ata ARM: 64-bit DT updates for v4.8 2016-08-01 18:47:01 -04:00
auxdisplay dt-bindings: img-ascii-lcd: Document a binding for simple ASCII LCDs 2016-10-06 17:00:50 +02:00
board
bus bus: qcom: add EBI2 device tree bindings 2016-09-08 15:26:21 +02:00
c6x
clock clk: uniphier: rename MIO clock to SD clock for Pro5, PXs2, LD20 SoCs 2016-10-19 13:15:05 -07:00
cpufreq
cris
crypto
devfreq Documentation: bindings: add dt documentation for rk3399 dmc 2016-09-06 13:25:36 +09:00
display Merge tag 'drm-for-v4.9' of git://people.freedesktop.org/~airlied/linux 2016-10-11 18:12:22 -07:00
dma Merge branch 'topic/imx' into for-linus 2016-10-03 09:17:52 +05:30
edac
eeprom
extcon extcon: Add support for qcom SPMI PMIC USB id detection hardware 2016-09-13 11:26:26 +09:00
firmware documentation: Add secure monitor bindings documentation 2016-09-01 15:27:06 -07:00
fpga
fuse
goldfish
gpio dt-binding: mrvl-gpio: remove orion-gpio description 2016-09-14 16:24:17 +02:00
gpu
h8300
hsi
hwlock
hwmon hwmon: (max6650) Add initial rpm target devicetree documentation 2016-09-08 21:34:17 -07:00
i2c RTC for 4.9 2016-10-14 13:13:44 -07:00
iio iio:pressure: initial zpa2326 barometer support 2016-09-18 19:42:21 +01:00
infiniband IB/hns: Add node_guid definition to the bindings document 2016-10-03 11:43:10 -04:00
input Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input 2016-10-14 13:19:30 -07:00
interrupt-controller DeviceTree updates for 4.9: 2016-10-05 11:56:38 -07:00
iommu Docs: dt: document ARM SMMU generic binding usage 2016-09-16 09:34:21 +01:00
ipmi ipmi/bt-bmc: change compatible node to 'aspeed, ast2400-ibt-bmc' 2016-11-17 16:31:09 -08:00
leds leds: centralize definition of "default-state" property 2016-08-19 21:05:39 +02:00
lpddr2
mailbox dt-bindings: mailbox: Add Amlogic Meson MHU Bindings 2016-09-07 13:07:18 +05:30
media media updates for v4.9-rc1 2016-10-11 13:22:22 -07:00
memory-controllers EDAC, fsl_ddr: Add support for little endian 2016-09-01 10:28:02 +02:00
metag
mfd - Core Frameworks 2016-10-07 08:35:35 -07:00
mips MIPS: BMIPS: Add BCM6362 support 2016-10-04 16:13:57 +02:00
misc ramoops: use DT reserved-memory bindings 2016-08-05 11:21:36 -07:00
mmc Documentation: synopsys-dw-mshc: add binding for reset-names 2016-11-07 08:53:46 +01:00
mtd mtd: nand: Add an option to maximize the ECC strength 2016-09-23 09:35:16 +02:00
net Documentation: devicetree: clarify usage of the RGMII phy-modes 2016-11-28 12:06:54 -05:00
nios2
nvmem ARM: SoC: late DT updates for v4.9 2016-10-07 21:34:49 -07:00
opp
pci PCI: rockchip: Add three new resets as required properties 2016-11-10 11:14:37 -06:00
perf Documentation: Add documentation for APM X-Gene SoC PMU DTS binding 2016-09-15 11:20:52 -07:00
phy ARM: SoC: late DT updates for v4.9 2016-10-07 21:34:49 -07:00
pinctrl pinctrl: stm32: move gpio irqs binding to optional 2016-10-31 21:25:15 +01:00
power power: reset: st: Remove obsolete platforms from dt doc 2016-09-19 21:33:13 +02:00
powerpc EDAC, fsl_ddr: Add support for little endian 2016-09-01 10:28:02 +02:00
pps
pwm dt-bindings: pwm: sti: Update DT bindings for capture support 2016-09-08 10:55:06 +02:00
regmap Fix spelling errors in Documentation/devicetree 2016-07-22 14:54:05 -05:00
regulator Merge remote-tracking branches 'regulator/topic/of', 'regulator/topic/pv88080', 'regulator/topic/rk808', 'regulator/topic/set-voltage' and 'regulator/topic/tps65218' into regulator-next 2016-09-30 09:13:58 -07:00
remoteproc dt-binding: remoteproc: Introduce Qualcomm WCNSS loader binding 2016-08-18 12:48:46 -07:00
reserved-memory ramoops: use DT reserved-memory bindings 2016-08-05 11:21:36 -07:00
reset reset: uniphier: rename MIO reset to SD reset for Pro5, PXs2, LD20 SoCs 2016-10-22 18:31:42 +09:00
rng ARM: 64-bit DT updates for v4.8 2016-08-01 18:47:01 -04:00
rtc dt/bindings: Add bindings for Micro Crystal rv8803 2016-10-12 13:24:34 +02:00
scsi
security/tpm
serial sh-sci: document R8A7743/5 support 2016-10-27 16:41:56 +02:00
serio
soc First round of new features, device support and cleanups for IIO in the 4.9 cycle. 2016-08-23 17:50:16 -04:00
sound ASoC: omap-abe-twl6040: fix typo in bindings documentation 2016-11-07 16:28:53 -07:00
spi DeviceTree updates for 4.9: 2016-10-05 11:56:38 -07:00
spmi
sram
staging
thermal Merge branches 'thermal-soc', 'thermal-core', 'thermal-intel' and 'thermal-tegra-hw-throttle' into next 2016-09-27 14:03:19 +08:00
timer of: Add J-Core timer bindings 2016-10-20 20:10:17 +02:00
ufs
usb Revert "Documentation: devicetree: dwc2: Deprecate g-tx-fifo-size" 2016-10-18 14:21:43 +03:00
video/bridge
virtio
w1
watchdog watchdog: bindings: Remove obsolete platforms from dt doc. 2016-09-24 08:59:39 +02:00
x86
xillybus
ABI.txt
chosen.txt
common-properties.txt
graph.txt
marvell.txt
numa.txt
property-units.txt
resource-names.txt
sparc_sun_oracle_rng.txt
submitting-patches.txt
unittest.txt
vendor-prefixes.txt Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input 2016-10-14 13:19:30 -07:00
xilinx.txt