GNU Linux-libre 4.4.295-gnu1
[releases.git] / Documentation / devicetree / bindings / net / hisilicon-hns-nic.txt
1 Hisilicon Network Subsystem NIC controller
2
3 Required properties:
4 - compatible: "hisilicon,hns-nic-v1" or "hisilicon,hns-nic-v2".
5   "hisilicon,hns-nic-v1" is for hip05.
6   "hisilicon,hns-nic-v2" is for Hi1610 and Hi1612.
7 - ae-name: accelerator name who provides this interface,
8   is simply a name referring to the name of name in the accelerator node.
9 - port-id: is the index of port provided by DSAF (the accelerator). DSAF can
10   connect to 8 PHYs. Port 0 to 1 are both used for adminstration purpose. They
11   are called debug ports.
12
13   The remaining 6 PHYs are taken according to the mode of DSAF.
14
15   In NIC mode of DSAF, all 6 PHYs are taken as ethernet ports to the CPU. The
16   port-id can be 2 to 7. Here is the diagram:
17             +-----+---------------+
18             |            CPU      |
19             +-+-+-+---+-+-+-+-+-+-+
20               | |     | | | | | |
21              debug       service
22              port         port
23              (0,1)       (2-7)
24
25   In Switch mode of DSAF, all 6 PHYs are taken as physical ports connect to a
26   LAN Switch while the CPU side assume itself have one single NIC connect to
27   this switch. In this case, the port-id will be 2 only.
28             +-----+---------------+
29             |            CPU      |
30             +-+-+-+---+-+-+-+-+-+-+
31               | |   service| port(2)
32              debug   +------------+
33              port    |   switch   |
34              (0,1)   +-+-+-+-+-+-++
35                        | | | | | |
36                       external port
37
38 - local-mac-address: mac addr of the ethernet interface
39
40 Example:
41
42         ethernet@0{
43                 compatible = "hisilicon,hns-nic-v1";
44                 ae-name = "dsaf0";
45                 port-id = <0>;
46                 local-mac-address = [a2 14 e4 4b 56 76];
47         };