Merge tag 'tegra-for-4.8-i2c' of git://git.kernel.org/pub/scm/linux/kernel/git/tegra...
[cascardo/linux.git] / Documentation / devicetree / bindings / net / cpsw.txt
1 TI SoC Ethernet Switch Controller Device Tree Bindings
2 ------------------------------------------------------
3
4 Required properties:
5 - compatible            : Should be one of the below:-
6                           "ti,cpsw" for backward compatible
7                           "ti,am335x-cpsw" for AM335x controllers
8                           "ti,am4372-cpsw" for AM437x controllers
9                           "ti,dra7-cpsw" for DRA7x controllers
10 - reg                   : physical base address and size of the cpsw
11                           registers map
12 - interrupts            : property with a value describing the interrupt
13                           number
14 - interrupt-parent      : The parent interrupt controller
15 - cpdma_channels        : Specifies number of channels in CPDMA
16 - ale_entries           : Specifies No of entries ALE can hold
17 - bd_ram_size           : Specifies internal descriptor RAM size
18 - mac_control           : Specifies Default MAC control register content
19                           for the specific platform
20 - slaves                : Specifies number for slaves
21 - active_slave          : Specifies the slave to use for time stamping,
22                           ethtool and SIOCGMIIPHY
23 - cpts_clock_mult       : Numerator to convert input clock ticks into nanoseconds
24 - cpts_clock_shift      : Denominator to convert input clock ticks into nanoseconds
25
26 Optional properties:
27 - ti,hwmods             : Must be "cpgmac0"
28 - no_bd_ram             : Must be 0 or 1
29 - dual_emac             : Specifies Switch to act as Dual EMAC
30 - syscon                : Phandle to the system control device node, which is
31                           the control module device of the am33x
32 - mode-gpios            : Should be added if one/multiple gpio lines are
33                           required to be driven so that cpsw data lines
34                           can be connected to the phy via selective mux.
35                           For example in dra72x-evm, pcf gpio has to be
36                           driven low so that cpsw slave 0 and phy data
37                           lines are connected via mux.
38
39
40 Slave Properties:
41 Required properties:
42 - phy-mode              : See ethernet.txt file in the same directory
43
44 Optional properties:
45 - dual_emac_res_vlan    : Specifies VID to be used to segregate the ports
46 - mac-address           : See ethernet.txt file in the same directory
47 - phy_id                : Specifies slave phy id (deprecated, use phy-handle)
48 - phy-handle            : See ethernet.txt file in the same directory
49
50 Slave sub-nodes:
51 - fixed-link            : See fixed-link.txt file in the same directory
52
53 Note: Exactly one of phy_id, phy-handle, or fixed-link must be specified.
54
55 Note: "ti,hwmods" field is used to fetch the base address and irq
56 resources from TI, omap hwmod data base during device registration.
57 Future plan is to migrate hwmod data base contents into device tree
58 blob so that, all the required data will be used from device tree dts
59 file.
60
61 Examples:
62
63         mac: ethernet@4A100000 {
64                 compatible = "ti,cpsw";
65                 reg = <0x4A100000 0x1000>;
66                 interrupts = <55 0x4>;
67                 interrupt-parent = <&intc>;
68                 cpdma_channels = <8>;
69                 ale_entries = <1024>;
70                 bd_ram_size = <0x2000>;
71                 no_bd_ram = <0>;
72                 rx_descs = <64>;
73                 mac_control = <0x20>;
74                 slaves = <2>;
75                 active_slave = <0>;
76                 cpts_clock_mult = <0x80000000>;
77                 cpts_clock_shift = <29>;
78                 syscon = <&cm>;
79                 cpsw_emac0: slave@0 {
80                         phy_id = <&davinci_mdio>, <0>;
81                         phy-mode = "rgmii-txid";
82                         /* Filled in by U-Boot */
83                         mac-address = [ 00 00 00 00 00 00 ];
84                 };
85                 cpsw_emac1: slave@1 {
86                         phy_id = <&davinci_mdio>, <1>;
87                         phy-mode = "rgmii-txid";
88                         /* Filled in by U-Boot */
89                         mac-address = [ 00 00 00 00 00 00 ];
90                 };
91         };
92
93 (or)
94         mac: ethernet@4A100000 {
95                 compatible = "ti,cpsw";
96                 ti,hwmods = "cpgmac0";
97                 cpdma_channels = <8>;
98                 ale_entries = <1024>;
99                 bd_ram_size = <0x2000>;
100                 no_bd_ram = <0>;
101                 rx_descs = <64>;
102                 mac_control = <0x20>;
103                 slaves = <2>;
104                 active_slave = <0>;
105                 cpts_clock_mult = <0x80000000>;
106                 cpts_clock_shift = <29>;
107                 syscon = <&cm>;
108                 cpsw_emac0: slave@0 {
109                         phy_id = <&davinci_mdio>, <0>;
110                         phy-mode = "rgmii-txid";
111                         /* Filled in by U-Boot */
112                         mac-address = [ 00 00 00 00 00 00 ];
113                 };
114                 cpsw_emac1: slave@1 {
115                         phy_id = <&davinci_mdio>, <1>;
116                         phy-mode = "rgmii-txid";
117                         /* Filled in by U-Boot */
118                         mac-address = [ 00 00 00 00 00 00 ];
119                 };
120         };