Merge tag 'docs-4.16' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / net / fsl-fec.txt
1 * Freescale Fast Ethernet Controller (FEC)
2
3 Required properties:
4 - compatible : Should be "fsl,<soc>-fec"
5 - reg : Address and length of the register set for the device
6 - interrupts : Should contain fec interrupt
7 - phy-mode : See ethernet.txt file in the same directory
8
9 Optional properties:
10 - phy-reset-gpios : Should specify the gpio for phy reset
11 - phy-reset-duration : Reset duration in milliseconds.  Should present
12   only if property "phy-reset-gpios" is available.  Missing the property
13   will have the duration be 1 millisecond.  Numbers greater than 1000 are
14   invalid and 1 millisecond will be used instead.
15 - phy-reset-active-high : If present then the reset sequence using the GPIO
16   specified in the "phy-reset-gpios" property is reversed (H=reset state,
17   L=operation state).
18 - phy-reset-post-delay : Post reset delay in milliseconds. If present then
19   a delay of phy-reset-post-delay milliseconds will be observed after the
20   phy-reset-gpios has been toggled. Can be omitted thus no delay is
21   observed. Delay is in range of 1ms to 1000ms. Other delays are invalid.
22 - phy-supply : regulator that powers the Ethernet PHY.
23 - phy-handle : phandle to the PHY device connected to this device.
24 - fixed-link : Assume a fixed link. See fixed-link.txt in the same directory.
25   Use instead of phy-handle.
26 - fsl,num-tx-queues : The property is valid for enet-avb IP, which supports
27   hw multi queues. Should specify the tx queue number, otherwise set tx queue
28   number to 1.
29 - fsl,num-rx-queues : The property is valid for enet-avb IP, which supports
30   hw multi queues. Should specify the rx queue number, otherwise set rx queue
31   number to 1.
32 - fsl,magic-packet : If present, indicates that the hardware supports waking
33   up via magic packet.
34 - fsl,err006687-workaround-present: If present indicates that the system has
35   the hardware workaround for ERR006687 applied and does not need a software
36   workaround.
37  -interrupt-names:  names of the interrupts listed in interrupts property in
38   the same order. The defaults if not specified are
39   __Number of interrupts__   __Default__
40         1                       "int0"
41         2                       "int0", "pps"
42         3                       "int0", "int1", "int2"
43         4                       "int0", "int1", "int2", "pps"
44   The order may be changed as long as they correspond to the interrupts
45   property. Currently, only i.mx7 uses "int1" and "int2". They correspond to
46   tx/rx queues 1 and 2. "int0" will be used for queue 0 and ENET_MII interrupts.
47   For imx6sx, "int0" handles all 3 queues and ENET_MII. "pps" is for the pulse
48   per second interrupt associated with 1588 precision time protocol(PTP).
49
50
51 Optional subnodes:
52 - mdio : specifies the mdio bus in the FEC, used as a container for phy nodes
53   according to phy.txt in the same directory
54
55 Example:
56
57 ethernet@83fec000 {
58         compatible = "fsl,imx51-fec", "fsl,imx27-fec";
59         reg = <0x83fec000 0x4000>;
60         interrupts = <87>;
61         phy-mode = "mii";
62         phy-reset-gpios = <&gpio2 14 GPIO_ACTIVE_LOW>; /* GPIO2_14 */
63         local-mac-address = [00 04 9F 01 1B B9];
64         phy-supply = <&reg_fec_supply>;
65 };
66
67 Example with phy specified:
68
69 ethernet@83fec000 {
70         compatible = "fsl,imx51-fec", "fsl,imx27-fec";
71         reg = <0x83fec000 0x4000>;
72         interrupts = <87>;
73         phy-mode = "mii";
74         phy-reset-gpios = <&gpio2 14 GPIO_ACTIVE_LOW>; /* GPIO2_14 */
75         local-mac-address = [00 04 9F 01 1B B9];
76         phy-supply = <&reg_fec_supply>;
77         phy-handle = <&ethphy>;
78         mdio {
79                 ethphy: ethernet-phy@6 {
80                         compatible = "ethernet-phy-ieee802.3-c22";
81                         reg = <6>;
82                         max-speed = <100>;
83                 };
84         };
85 };