Merge tag 'xilinx-for-v2021.01' of https://gitlab.denx.de/u-boot/custodians/u-boot...
[platform/kernel/u-boot.git] / doc / device-tree-bindings / soc / fsl / cpm_qe / qe / ucc.txt
1 * UCC (Unified Communications Controllers)
2
3 Required properties:
4 - compatible : ucc_geth
5 - cell-index : the ucc number(1-8), corresponding to UCCx in UM.
6 - reg : Offset and length of the register set for the device
7 - rx-clock-name: the UCC receive clock source
8   "none": clock source is disabled
9   "brg1" through "brg16": clock source is BRG1-BRG16, respectively
10   "clk1" through "clk24": clock source is CLK1-CLK24, respectively
11 - tx-clock-name: the UCC transmit clock source
12   "none": clock source is disabled
13   "brg1" through "brg16": clock source is BRG1-BRG16, respectively
14   "clk1" through "clk24": clock source is CLK1-CLK24, respectively
15 The following two properties are deprecated.  rx-clock has been replaced
16 with rx-clock-name, and tx-clock has been replaced with tx-clock-name.
17 Drivers that currently use the deprecated properties should continue to
18 do so, in order to support older device trees, but they should be updated
19 to check for the new properties first.
20 - rx-clock : represents the UCC receive clock source.
21   0x00 : clock source is disabled;
22   0x1~0x10 : clock source is BRG1~BRG16 respectively;
23   0x11~0x28: clock source is QE_CLK1~QE_CLK24 respectively.
24 - tx-clock: represents the UCC transmit clock source;
25   0x00 : clock source is disabled;
26   0x1~0x10 : clock source is BRG1~BRG16 respectively;
27   0x11~0x28: clock source is QE_CLK1~QE_CLK24 respectively.
28 - phy-handle : The phandle for the PHY connected to this controller.
29 - phy-connection-type : a string naming the controller/PHY interface type,
30   i.e., "mii" (default), "rmii", "gmii", "rgmii", "rgmii-id" (Internal
31   Delay), "rgmii-txid" (delay on TX only), "rgmii-rxid" (delay on RX only),
32   "tbi", or "rtbi".
33 - pio-handle : The phandle for the Parallel I/O port configuration.
34
35 Deprecated properties:
36 - device-id : the ucc number(1-8), corresponding to UCCx in UM.
37     you should use cell-index
38
39 Example:
40         ucc@2000 {
41                 device_type = "network";
42                 compatible = "ucc_geth";
43                 cell-index = <1>;
44                 reg = <2000 200>;
45                 interrupts = <a0 0>;
46                 interrupt-parent = <700>;
47                 mac-address = [ 00 04 9f 00 23 23 ];
48                 rx-clock = "none";
49                 tx-clock = "clk9";
50                 phy-handle = <212000>;
51                 phy-connection-type = "gmii";
52                 pio-handle = <140001>;
53         };