xref: /linux/Documentation/devicetree/bindings/net/fsl,fman-dtsec.yaml (revision d8d2b1f81530988abe2e2bfaceec1c5d30b9a0b4) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/net/fsl,fman-dtsec.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: NXP FMan MAC
8
9maintainers:
10  - Madalin Bucur <madalin.bucur@nxp.com>
11
12description: |
13  Each FMan has several MACs, each implementing an Ethernet interface. Earlier
14  versions of FMan used the Datapath Three Speed Ethernet Controller (dTSEC) for
15  10/100/1000 MBit/s speeds, and the 10-Gigabit Ethernet Media Access Controller
16  (10GEC) for 10 Gbit/s speeds. Later versions of FMan use the Multirate
17  Ethernet Media Access Controller (mEMAC) to handle all speeds.
18
19properties:
20  compatible:
21    enum:
22      - fsl,fman-dtsec
23      - fsl,fman-xgec
24      - fsl,fman-memac
25
26  cell-index:
27    maximum: 64
28    description: |
29      FManV2:
30      register[bit]           MAC             cell-index
31      ============================================================
32      FM_EPI[16]              XGEC            8
33      FM_EPI[16+n]            dTSECn          n-1
34      FM_NPI[11+n]            dTSECn          n-1
35              n = 1,..,5
36
37      FManV3:
38      register[bit]           MAC             cell-index
39      ============================================================
40      FM_EPI[16+n]            mEMACn          n-1
41      FM_EPI[25]              mEMAC10         9
42
43      FM_NPI[11+n]            mEMACn          n-1
44      FM_NPI[10]              mEMAC10         9
45      FM_NPI[11]              mEMAC9          8
46              n = 1,..8
47
48      FM_EPI and FM_NPI are located in the FMan memory map.
49
50      2. SoC registers:
51
52      - P2041, P3041, P4080 P5020, P5040:
53      register[bit]           FMan            MAC             cell
54                              Unit                            index
55      ============================================================
56      DCFG_DEVDISR2[7]        1               XGEC            8
57      DCFG_DEVDISR2[7+n]      1               dTSECn          n-1
58      DCFG_DEVDISR2[15]       2               XGEC            8
59      DCFG_DEVDISR2[15+n]     2               dTSECn          n-1
60              n = 1,..5
61
62      - T1040, T2080, T4240, B4860:
63      register[bit]                   FMan    MAC             cell
64                                      Unit                    index
65      ============================================================
66      DCFG_CCSR_DEVDISR2[n-1]         1       mEMACn          n-1
67      DCFG_CCSR_DEVDISR2[11+n]        2       mEMACn          n-1
68              n = 1,..6,9,10
69
70      EVDISR, DCFG_DEVDISR2 and DCFG_CCSR_DEVDISR2 are located in
71      the specific SoC "Device Configuration/Pin Control" Memory
72      Map.
73
74  reg:
75    maxItems: 1
76
77  fsl,fman-ports:
78    $ref: /schemas/types.yaml#/definitions/phandle-array
79    maxItems: 2
80    description: |
81      An array of two references: the first is the FMan RX port and the second
82      is the TX port used by this MAC.
83
84  phys:
85    description: A reference to the SerDes lane(s)
86    maxItems: 1
87
88  phy-names:
89    items:
90      - const: serdes
91
92  pcsphy-handle:
93    $ref: /schemas/types.yaml#/definitions/phandle-array
94    minItems: 1
95    maxItems: 3
96    deprecated: true
97    description: See pcs-handle.
98
99  pcs-handle:
100    minItems: 1
101    maxItems: 3
102    description: |
103      A reference to the various PCSs (typically found on the SerDes). If
104      pcs-handle-names is absent, and phy-connection-type is "xgmii", then the first
105      reference will be assumed to be for "xfi". Otherwise, if pcs-handle-names is
106      absent, then the first reference will be assumed to be for "sgmii".
107
108  pcs-handle-names:
109    minItems: 1
110    maxItems: 3
111    items:
112      enum:
113        - sgmii
114        - qsgmii
115        - xfi
116    description: The type of each PCS in pcsphy-handle.
117
118  tbi-handle:
119    $ref: /schemas/types.yaml#/definitions/phandle
120    description: A reference to the (TBI-based) PCS
121
122required:
123  - compatible
124  - cell-index
125  - reg
126  - fsl,fman-ports
127
128dependencies:
129  pcs-handle-names:
130    - pcs-handle
131
132allOf:
133  - $ref: ethernet-controller.yaml#
134  - if:
135      properties:
136        compatible:
137          contains:
138            const: fsl,fman-dtsec
139    then:
140      required:
141        - tbi-handle
142
143unevaluatedProperties: false
144
145examples:
146  - |
147    ethernet@e0000 {
148            compatible = "fsl,fman-dtsec";
149            cell-index = <0>;
150            reg = <0xe0000 0x1000>;
151            fsl,fman-ports = <&fman1_rx8 &fman1_tx28>;
152            ptp-timer = <&ptp_timer>;
153            tbi-handle = <&tbi0>;
154    };
155  - |
156    ethernet@e8000 {
157            cell-index = <4>;
158            compatible = "fsl,fman-memac";
159            reg = <0xe8000 0x1000>;
160            fsl,fman-ports = <&fman0_rx_0x0c &fman0_tx_0x2c>;
161            ptp-timer = <&ptp_timer0>;
162            pcs-handle = <&pcsphy4>, <&qsgmiib_pcs1>;
163            pcs-handle-names = "sgmii", "qsgmii";
164            phys = <&serdes1 1>;
165            phy-names = "serdes";
166    };
167...
168