GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / net / hisilicon-hns-dsaf.txt
1 Hisilicon DSA Fabric device controller
2
3 Required properties:
4 - compatible: should be "hisilicon,hns-dsaf-v1" or "hisilicon,hns-dsaf-v2".
5   "hisilicon,hns-dsaf-v1" is for hip05.
6   "hisilicon,hns-dsaf-v2" is for Hi1610 and Hi1612.
7 - mode: dsa fabric mode string. only support one of dsaf modes like these:
8                 "2port-64vf",
9                 "6port-16rss",
10                 "6port-16vf",
11                 "single-port".
12 - interrupt-parent: the interrupt parent of this device.
13 - interrupts: should contain the DSA Fabric and rcb interrupt.
14 - reg: specifies base physical address(es) and size of the device registers.
15   The first region is external interface control register base and size(optional,
16   only used when subctrl-syscon does not exist). It is recommended using
17   subctrl-syscon rather than this address.
18   The second region is SerDes base register and size(optional, only used when
19   serdes-syscon in port node does not exist). It is recommended using
20   serdes-syscon rather than this address.
21   The third region is the PPE register base and size.
22   The fourth region is dsa fabric base register and size. It is not required for
23   single-port mode.
24 - reg-names: may be ppe-base and(or) dsaf-base. It is used to find the
25   corresponding reg's index.
26
27 - phy-handle: phy handle of physical port, 0 if not any phy device. It is optional
28   attribute. If port node exists, phy-handle in each port node will be used.
29   see ethernet.txt [1].
30 - subctrl-syscon: is syscon handle for external interface control register.
31 - reset-field-offset: is offset of reset field. Its value depends on the hardware
32   user manual.
33 - buf-size: rx buffer size, should be 16-1024.
34 - desc-num: number of description in TX and RX queue, should be 512, 1024, 2048 or 4096.
35
36 - port: subnodes of dsaf. A dsaf node may contain several port nodes(Depending
37   on mode of dsaf). Port node contain some attributes listed below:
38 - reg: is physical port index in one dsaf.
39 - phy-handle: phy handle of physical port. It is not required if there isn't
40   phy device. see ethernet.txt [1].
41 - serdes-syscon: is syscon handle for SerDes register.
42 - cpld-syscon: is syscon handle + register offset pair for cpld register. It is
43   not required if there isn't cpld device.
44 - port-rst-offset: is offset of reset field for each port in dsaf. Its value
45   depends on the hardware user manual.
46 - port-mode-offset: is offset of port mode field for each port in dsaf. Its
47   value depends on the hardware user manual.
48 - mc-mac-mask: mask of multicast address, determines bit in multicast address
49   to set:
50   1 stands for this bit will be precisely matched, TCAM will check this bit of
51     MAC address.
52   0 stands for this bit will be fuzzy matched, TCAM won't care about this bit
53     of MAC address.
54
55 [1] Documentation/devicetree/bindings/net/phy.txt
56
57 Example:
58
59 dsaf0: dsa@c7000000 {
60         compatible = "hisilicon,hns-dsaf-v1";
61         mode = "6port-16rss";
62         interrupt-parent = <&mbigen_dsa>;
63         reg = <0x0 0xc5000000 0x0 0x890000
64                0x0 0xc7000000 0x0 0x60000>;
65         reg-names = "ppe-base", "dsaf-base";
66         subctrl-syscon = <&subctrl>;
67         reset-field-offset = 0;
68         interrupts = <131 4>,<132 4>, <133 4>,<134 4>,
69                      <135 4>,<136 4>, <137 4>,<138 4>,
70                      <139 4>,<140 4>, <141 4>,<142 4>,
71                      <143 4>,<144 4>, <145 4>,<146 4>,
72                      <147 4>,<148 4>, <384 1>,<385 1>,
73                      <386 1>,<387 1>, <388 1>,<389 1>,
74                      <390 1>,<391 1>,
75         buf-size = <4096>;
76         desc-num = <1024>;
77         dma-coherent;
78
79         port@0 {
80                 reg = 0;
81                 phy-handle = <&phy0>;
82                 serdes-syscon = <&serdes>;
83                 mc-mac-mask = [ff f0 00 00 00 00];
84         };
85
86         port@1 {
87                 reg = 1;
88                 serdes-syscon = <&serdes>;
89                 mc-mac-mask = [ff f0 00 00 00 00];
90         };
91 };