MAINTAINERS: fix sorting
[pandora-kernel.git] / Documentation / powerpc / dts-bindings / fsl / tsec.txt
1 * MDIO IO device
2
3 The MDIO is a bus to which the PHY devices are connected.  For each
4 device that exists on this bus, a child node should be created.  See
5 the definition of the PHY node in booting-without-of.txt for an example
6 of how to define a PHY.
7
8 Required properties:
9   - reg : Offset and length of the register set for the device
10   - compatible : Should define the compatible device type for the
11     mdio.  Currently, this is most likely to be "fsl,gianfar-mdio"
12
13 Example:
14
15         mdio@24520 {
16                 reg = <24520 20>;
17                 compatible = "fsl,gianfar-mdio";
18
19                 ethernet-phy@0 {
20                         ......
21                 };
22         };
23
24 * TBI Internal MDIO bus
25
26 As of this writing, every tsec is associated with an internal TBI PHY.
27 This PHY is accessed through the local MDIO bus.  These buses are defined
28 similarly to the mdio buses, except they are compatible with "fsl,gianfar-tbi".
29 The TBI PHYs underneath them are similar to normal PHYs, but the reg property
30 is considered instructive, rather than descriptive.  The reg property should
31 be chosen so it doesn't interfere with other PHYs on the bus.
32
33 * Gianfar-compatible ethernet nodes
34
35 Properties:
36
37   - device_type : Should be "network"
38   - model : Model of the device.  Can be "TSEC", "eTSEC", or "FEC"
39   - compatible : Should be "gianfar"
40   - reg : Offset and length of the register set for the device
41   - local-mac-address : List of bytes representing the ethernet address of
42     this controller
43   - interrupts : For FEC devices, the first interrupt is the device's
44     interrupt.  For TSEC and eTSEC devices, the first interrupt is
45     transmit, the second is receive, and the third is error.
46   - phy-handle : The phandle for the PHY connected to this ethernet
47     controller.
48   - fixed-link : <a b c d e> where a is emulated phy id - choose any,
49     but unique to the all specified fixed-links, b is duplex - 0 half,
50     1 full, c is link speed - d#10/d#100/d#1000, d is pause - 0 no
51     pause, 1 pause, e is asym_pause - 0 no asym_pause, 1 asym_pause.
52   - phy-connection-type : a string naming the controller/PHY interface type,
53     i.e., "mii" (default), "rmii", "gmii", "rgmii", "rgmii-id", "sgmii",
54     "tbi", or "rtbi".  This property is only really needed if the connection
55     is of type "rgmii-id", as all other connection types are detected by
56     hardware.
57   - fsl,magic-packet : If present, indicates that the hardware supports
58     waking up via magic packet.
59   - bd-stash : If present, indicates that the hardware supports stashing
60     buffer descriptors in the L2.
61   - rx-stash-len : Denotes the number of bytes of a received buffer to stash
62     in the L2.
63   - rx-stash-idx : Denotes the index of the first byte from the received
64     buffer to stash in the L2.
65
66 Example:
67         ethernet@24000 {
68                 device_type = "network";
69                 model = "TSEC";
70                 compatible = "gianfar";
71                 reg = <0x24000 0x1000>;
72                 local-mac-address = [ 00 E0 0C 00 73 00 ];
73                 interrupts = <29 2 30 2 34 2>;
74                 interrupt-parent = <&mpic>;
75                 phy-handle = <&phy0>
76         };