Merge branch 'async-scsi-resume' of git://git.kernel.org/pub/scm/linux/kernel/git...
[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 "ti,cpsw"
6 - reg                   : physical base address and size of the cpsw
7                           registers map
8 - interrupts            : property with a value describing the interrupt
9                           number
10 - interrupt-parent      : The parent interrupt controller
11 - cpdma_channels        : Specifies number of channels in CPDMA
12 - ale_entries           : Specifies No of entries ALE can hold
13 - bd_ram_size           : Specifies internal descriptor RAM size
14 - rx_descs              : Specifies number of Rx descriptors
15 - mac_control           : Specifies Default MAC control register content
16                           for the specific platform
17 - slaves                : Specifies number for slaves
18 - active_slave          : Specifies the slave to use for time stamping,
19                           ethtool and SIOCGMIIPHY
20 - cpts_clock_mult       : Numerator to convert input clock ticks into nanoseconds
21 - cpts_clock_shift      : Denominator to convert input clock ticks into nanoseconds
22
23 Optional properties:
24 - ti,hwmods             : Must be "cpgmac0"
25 - no_bd_ram             : Must be 0 or 1
26 - dual_emac             : Specifies Switch to act as Dual EMAC
27
28 Slave Properties:
29 Required properties:
30 - phy_id                : Specifies slave phy id
31 - phy-mode              : See ethernet.txt file in the same directory
32 - mac-address           : See ethernet.txt file in the same directory
33
34 Optional properties:
35 - dual_emac_res_vlan    : Specifies VID to be used to segregate the ports
36
37 Note: "ti,hwmods" field is used to fetch the base address and irq
38 resources from TI, omap hwmod data base during device registration.
39 Future plan is to migrate hwmod data base contents into device tree
40 blob so that, all the required data will be used from device tree dts
41 file.
42
43 Examples:
44
45         mac: ethernet@4A100000 {
46                 compatible = "ti,cpsw";
47                 reg = <0x4A100000 0x1000>;
48                 interrupts = <55 0x4>;
49                 interrupt-parent = <&intc>;
50                 cpdma_channels = <8>;
51                 ale_entries = <1024>;
52                 bd_ram_size = <0x2000>;
53                 no_bd_ram = <0>;
54                 rx_descs = <64>;
55                 mac_control = <0x20>;
56                 slaves = <2>;
57                 active_slave = <0>;
58                 cpts_clock_mult = <0x80000000>;
59                 cpts_clock_shift = <29>;
60                 cpsw_emac0: slave@0 {
61                         phy_id = <&davinci_mdio>, <0>;
62                         phy-mode = "rgmii-txid";
63                         /* Filled in by U-Boot */
64                         mac-address = [ 00 00 00 00 00 00 ];
65                 };
66                 cpsw_emac1: slave@1 {
67                         phy_id = <&davinci_mdio>, <1>;
68                         phy-mode = "rgmii-txid";
69                         /* Filled in by U-Boot */
70                         mac-address = [ 00 00 00 00 00 00 ];
71                 };
72         };
73
74 (or)
75         mac: ethernet@4A100000 {
76                 compatible = "ti,cpsw";
77                 ti,hwmods = "cpgmac0";
78                 cpdma_channels = <8>;
79                 ale_entries = <1024>;
80                 bd_ram_size = <0x2000>;
81                 no_bd_ram = <0>;
82                 rx_descs = <64>;
83                 mac_control = <0x20>;
84                 slaves = <2>;
85                 active_slave = <0>;
86                 cpts_clock_mult = <0x80000000>;
87                 cpts_clock_shift = <29>;
88                 cpsw_emac0: slave@0 {
89                         phy_id = <&davinci_mdio>, <0>;
90                         phy-mode = "rgmii-txid";
91                         /* Filled in by U-Boot */
92                         mac-address = [ 00 00 00 00 00 00 ];
93                 };
94                 cpsw_emac1: slave@1 {
95                         phy_id = <&davinci_mdio>, <1>;
96                         phy-mode = "rgmii-txid";
97                         /* Filled in by U-Boot */
98                         mac-address = [ 00 00 00 00 00 00 ];
99                 };
100         };