Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / d5935b07da53f74726e2a65dd4281d0f2c70e5d4 / . / Documentation / devicetree / bindings / net / cpsw.txt
blob: ae2b8b7f9c38f0bb3d233588b1b2a4cc01f6c900 [file] [log] [blame]
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]1TI SoC Ethernet Switch Controller Device Tree Bindings
2------------------------------------------------------
3
4Required 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
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]12- ale_entries : Specifies No of entries ALE can hold
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]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
Mugunthan V Ne86ac132013-03-11 23:16:35 +0000[diff] [blame]18- active_slave : Specifies the slave to use for time stamping,
19 ethtool and SIOCGMIIPHY
Richard Cochran00ab94e2012-10-29 08:45:19 +0000[diff] [blame]20- cpts_clock_mult : Numerator to convert input clock ticks into nanoseconds
21- cpts_clock_shift : Denominator to convert input clock ticks into nanoseconds
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]22
23Optional properties:
24- ti,hwmods : Must be "cpgmac0"
25- no_bd_ram : Must be 0 or 1
Mugunthan V Nd9ba8f92013-02-11 09:52:20 +0000[diff] [blame]26- dual_emac : Specifies Switch to act as Dual EMAC
Mugunthan V N470d1472013-03-11 23:16:34 +0000[diff] [blame]27
28Slave Properties:
29Required properties:
30- phy_id : Specifies slave phy id
Sergei Shtylyove8f08ee2014-02-18 02:41:59 +0300[diff] [blame]31- phy-mode : See ethernet.txt file in the same directory
32- mac-address : See ethernet.txt file in the same directory
Mugunthan V N470d1472013-03-11 23:16:34 +0000[diff] [blame]33
34Optional properties:
Mugunthan V Nd9ba8f92013-02-11 09:52:20 +0000[diff] [blame]35- dual_emac_res_vlan : Specifies VID to be used to segregate the ports
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]36
37Note: "ti,hwmods" field is used to fetch the base address and irq
38resources from TI, omap hwmod data base during device registration.
39Future plan is to migrate hwmod data base contents into device tree
40blob so that, all the required data will be used from device tree dts
41file.
42
43Examples:
44
45 mac: ethernet@4A100000 {
46 compatible = "ti,cpsw";
47 reg = <0x4A100000 0x1000>;
48 interrupts = <55 0x4>;
49 interrupt-parent = <&intc>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]50 cpdma_channels = <8>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]51 ale_entries = <1024>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]52 bd_ram_size = <0x2000>;
53 no_bd_ram = <0>;
54 rx_descs = <64>;
55 mac_control = <0x20>;
56 slaves = <2>;
Mugunthan V Ne86ac132013-03-11 23:16:35 +0000[diff] [blame]57 active_slave = <0>;
Richard Cochran00ab94e2012-10-29 08:45:19 +0000[diff] [blame]58 cpts_clock_mult = <0x80000000>;
59 cpts_clock_shift = <29>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]60 cpsw_emac0: slave@0 {
Richard Cochran549985e2012-11-14 09:07:56 +0000[diff] [blame]61 phy_id = <&davinci_mdio>, <0>;
Mugunthan V Nc5ceea72013-06-03 20:10:10 +0000[diff] [blame]62 phy-mode = "rgmii-txid";
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]63 /* Filled in by U-Boot */
64 mac-address = [ 00 00 00 00 00 00 ];
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]65 };
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]66 cpsw_emac1: slave@1 {
Richard Cochran549985e2012-11-14 09:07:56 +0000[diff] [blame]67 phy_id = <&davinci_mdio>, <1>;
Mugunthan V Nc5ceea72013-06-03 20:10:10 +0000[diff] [blame]68 phy-mode = "rgmii-txid";
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]69 /* Filled in by U-Boot */
70 mac-address = [ 00 00 00 00 00 00 ];
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]71 };
72 };
73
74(or)
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]75 mac: ethernet@4A100000 {
76 compatible = "ti,cpsw";
77 ti,hwmods = "cpgmac0";
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]78 cpdma_channels = <8>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]79 ale_entries = <1024>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]80 bd_ram_size = <0x2000>;
81 no_bd_ram = <0>;
82 rx_descs = <64>;
83 mac_control = <0x20>;
84 slaves = <2>;
Mugunthan V Ne86ac132013-03-11 23:16:35 +0000[diff] [blame]85 active_slave = <0>;
Richard Cochran00ab94e2012-10-29 08:45:19 +0000[diff] [blame]86 cpts_clock_mult = <0x80000000>;
87 cpts_clock_shift = <29>;
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]88 cpsw_emac0: slave@0 {
Richard Cochran549985e2012-11-14 09:07:56 +0000[diff] [blame]89 phy_id = <&davinci_mdio>, <0>;
Mugunthan V Nc5ceea72013-06-03 20:10:10 +0000[diff] [blame]90 phy-mode = "rgmii-txid";
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]91 /* Filled in by U-Boot */
92 mac-address = [ 00 00 00 00 00 00 ];
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]93 };
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]94 cpsw_emac1: slave@1 {
Richard Cochran549985e2012-11-14 09:07:56 +0000[diff] [blame]95 phy_id = <&davinci_mdio>, <1>;
Mugunthan V Nc5ceea72013-06-03 20:10:10 +0000[diff] [blame]96 phy-mode = "rgmii-txid";
Mugunthan V Ne07b94f2012-08-06 05:05:58 +0000[diff] [blame]97 /* Filled in by U-Boot */
98 mac-address = [ 00 00 00 00 00 00 ];
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]99 };
Mugunthan V N2eb32b02012-07-30 10:17:14 +0000[diff] [blame]100 };