GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / net / samsung-sxgbe.txt
1 * Samsung 10G Ethernet driver (SXGBE)
2
3 Required properties:
4 - compatible: Should be "samsung,sxgbe-v2.0a"
5 - reg: Address and length of the register set for the device
6 - interrupt-parent: Should be the phandle for the interrupt controller
7   that services interrupts for this device
8 - interrupts: Should contain the SXGBE interrupts
9   These interrupts are ordered by fixed and follows variable
10   trasmit DMA interrupts, receive DMA interrupts and lpi interrupt.
11   index 0 - this is fixed common interrupt of SXGBE and it is always
12   available.
13   index 1 to 25 - 8 variable trasmit interrupts, variable 16 receive interrupts
14   and 1 optional lpi interrupt.
15 - phy-mode: String, operation mode of the PHY interface.
16   Supported values are: "sgmii", "xgmii".
17 - samsung,pbl: Integer, Programmable Burst Length.
18   Supported values are 1, 2, 4, 8, 16, or 32.
19 - samsung,burst-map: Integer, Program the possible bursts supported by sxgbe
20   This is an integer and represents allowable DMA bursts when fixed burst.
21   Allowable range is 0x01-0x3F. When this field is set fixed burst is enabled.
22   When fixed length is needed for burst mode, it can be set within allowable
23   range.
24
25 Optional properties:
26 - mac-address: 6 bytes, mac address
27 - max-frame-size: Maximum Transfer Unit (IEEE defined MTU), rather
28                   than the maximum frame size.
29
30 Example:
31
32         aliases {
33                 ethernet0 = <&sxgbe0>;
34         };
35
36         sxgbe0: ethernet@1a040000 {
37                 compatible = "samsung,sxgbe-v2.0a";
38                 reg = <0 0x1a040000 0 0x10000>;
39                 interrupt-parent = <&gic>;
40                 interrupts = <0 209 4>, <0 185 4>, <0 186 4>, <0 187 4>,
41                              <0 188 4>, <0 189 4>, <0 190 4>, <0 191 4>,
42                              <0 192 4>, <0 193 4>, <0 194 4>, <0 195 4>,
43                              <0 196 4>, <0 197 4>, <0 198 4>, <0 199 4>,
44                              <0 200 4>, <0 201 4>, <0 202 4>, <0 203 4>,
45                              <0 204 4>, <0 205 4>, <0 206 4>, <0 207 4>,
46                              <0 208 4>, <0 210 4>;
47                 samsung,pbl = <0x08>
48                 samsung,burst-map = <0x20>
49                 mac-address = [ 00 11 22 33 44 55 ]; /* Filled in by U-Boot */
50                 max-frame-size = <9000>;
51                 phy-mode = "xgmii";
52         };