xref: /linux/Documentation/devicetree/bindings/net/cpsw.txt (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
1TI SoC Ethernet Switch Controller Device Tree Bindings
2------------------------------------------------------
3
4Required 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- rx_descs		: Specifies number of Rx descriptors
19- mac_control		: Specifies Default MAC control register content
20			  for the specific platform
21- slaves		: Specifies number for slaves
22- active_slave		: Specifies the slave to use for time stamping,
23			  ethtool and SIOCGMIIPHY
24- cpts_clock_mult	: Numerator to convert input clock ticks into nanoseconds
25- cpts_clock_shift	: Denominator to convert input clock ticks into nanoseconds
26
27Optional properties:
28- ti,hwmods		: Must be "cpgmac0"
29- no_bd_ram		: Must be 0 or 1
30- dual_emac		: Specifies Switch to act as Dual EMAC
31- syscon		: Phandle to the system control device node, which is
32			  the control module device of the am33x
33
34Slave Properties:
35Required properties:
36- phy_id		: Specifies slave phy id
37- phy-mode		: See ethernet.txt file in the same directory
38
39Optional properties:
40- dual_emac_res_vlan	: Specifies VID to be used to segregate the ports
41- mac-address		: See ethernet.txt file in the same directory
42- phy-handle		: See ethernet.txt file in the same directory
43
44Note: "ti,hwmods" field is used to fetch the base address and irq
45resources from TI, omap hwmod data base during device registration.
46Future plan is to migrate hwmod data base contents into device tree
47blob so that, all the required data will be used from device tree dts
48file.
49
50Examples:
51
52	mac: ethernet@4A100000 {
53		compatible = "ti,cpsw";
54		reg = <0x4A100000 0x1000>;
55		interrupts = <55 0x4>;
56		interrupt-parent = <&intc>;
57		cpdma_channels = <8>;
58		ale_entries = <1024>;
59		bd_ram_size = <0x2000>;
60		no_bd_ram = <0>;
61		rx_descs = <64>;
62		mac_control = <0x20>;
63		slaves = <2>;
64		active_slave = <0>;
65		cpts_clock_mult = <0x80000000>;
66		cpts_clock_shift = <29>;
67		syscon = <&cm>;
68		cpsw_emac0: slave@0 {
69			phy_id = <&davinci_mdio>, <0>;
70			phy-mode = "rgmii-txid";
71			/* Filled in by U-Boot */
72			mac-address = [ 00 00 00 00 00 00 ];
73		};
74		cpsw_emac1: slave@1 {
75			phy_id = <&davinci_mdio>, <1>;
76			phy-mode = "rgmii-txid";
77			/* Filled in by U-Boot */
78			mac-address = [ 00 00 00 00 00 00 ];
79		};
80	};
81
82(or)
83	mac: ethernet@4A100000 {
84		compatible = "ti,cpsw";
85		ti,hwmods = "cpgmac0";
86		cpdma_channels = <8>;
87		ale_entries = <1024>;
88		bd_ram_size = <0x2000>;
89		no_bd_ram = <0>;
90		rx_descs = <64>;
91		mac_control = <0x20>;
92		slaves = <2>;
93		active_slave = <0>;
94		cpts_clock_mult = <0x80000000>;
95		cpts_clock_shift = <29>;
96		syscon = <&cm>;
97		cpsw_emac0: slave@0 {
98			phy_id = <&davinci_mdio>, <0>;
99			phy-mode = "rgmii-txid";
100			/* Filled in by U-Boot */
101			mac-address = [ 00 00 00 00 00 00 ];
102		};
103		cpsw_emac1: slave@1 {
104			phy_id = <&davinci_mdio>, <1>;
105			phy-mode = "rgmii-txid";
106			/* Filled in by U-Boot */
107			mac-address = [ 00 00 00 00 00 00 ];
108		};
109	};
110